IgrRadialGauge

Constructors

new IgrRadialGauge(props: IIgrRadialGaugeProps): IgrRadialGauge

Returns IgrRadialGauge

Properties

actualRanges

The ranges actually present in the chart. Do not directly modify this array. This array's contents can be modified by causing Angular to reproject the child content. Or adding and removing ranges from the manual ranges collection on the ranges property.

actualRanges: IgrRadialGaugeRange[]

contentRanges

contentRanges: IgrRadialGaugeRange[]

Accessors

actualHighlightValueDisplayMode

Gets whether and how to display the highlighted value.

get actualHighlightValueDisplayMode(): HighlightedValueDisplayMode

Returns HighlightedValueDisplayMode

set actualHighlightValueDisplayMode(v: HighlightedValueDisplayMode): void

Parameters

v: HighlightedValueDisplayMode

Returns void

actualHighlightValueOpacity

Gets the actual opacity of the primary needle while highlighting

get actualHighlightValueOpacity(): number

Returns number

set actualHighlightValueOpacity(v: number): void

Parameters

v: number

Returns void

actualMaximumValue

Gets the resolved maximum value of the scale.

get actualMaximumValue(): number

Returns number

set actualMaximumValue(v: number): void

Parameters

v: number

Returns void

actualMaximumValueChange

get actualMaximumValueChange(): object

Returns object

set actualMaximumValueChange(ev: object): void

Parameters

ev: object

Returns void

actualMinimumValue

Gets the resolved minimum value of the scale.

get actualMinimumValue(): number

Returns number

set actualMinimumValue(v: number): void

Parameters

v: number

Returns void

actualMinimumValueChange

get actualMinimumValueChange(): object

Returns object

set actualMinimumValueChange(ev: object): void

Parameters

ev: object

Returns void

actualPixelScalingRatio

Gets the actual pixel scaling ratio used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

get actualPixelScalingRatio(): number

Returns number

set actualPixelScalingRatio(v: number): void

Parameters

v: number

Returns void

alignHighlightLabel

Event which is raised when a highlight label of the gauge is aligned and styled. Function takes first argument null and second argument ui. Use ui.owner to obtain reference to gauge widget. Use ui.actualMinimumValue to obtain the minimum value of gauge scale. Use ui.actualMaximumValue to obtain the maximum value of gauge scale. Use ui.startAngle to obtain the starting angle of gauge scale. Use ui.endAngle to obtain the ending angle of gauge scale. Use ui.angle to obtain the angle on the gauge scale at which the label will be located. Use ui.value to obtain the value on the gauge scale associated with the label. Use ui.label to obtain the string value of the label.

get alignHighlightLabel(): object

Returns object

set alignHighlightLabel(ev: object): void

Parameters

ev: object

Returns void

alignLabel

Event which is raised when a label of the gauge is aligned along the scale. Function takes first argument null and second argument ui. Use ui.owner to obtain reference to gauge widget. Use ui.actualMinimumValue to obtain the minimum value of gauge scale. Use ui.actualMaximumValue to obtain the maximum value of gauge scale. Use ui.startAngle to obtain the starting angle of gauge scale. Use ui.endAngle to obtain the ending angle of gauge scale. Use ui.angle to obtain the angle on the gauge scale at which the label will be located. Use ui.value to obtain the value on the gauge scale associated with the label. Use ui.label to obtain the string value of the label. Use ui.width to obtain the width of the label. Use ui.height to obtain the height of the label. Use ui.offsetX to obtain the X offset of the label on the gauge scale. Use ui.offsetY to obtain the Y offset of the label on the gauge scale.

get alignLabel(): object

Returns object

set alignLabel(ev: object): void

Parameters

ev: object

Returns void

alignSubtitle

Event which is raised when a subtitle of the gauge is aligned and styled. Function takes first argument null and second argument ui. Use ui.owner to obtain reference to gauge widget. Use ui.actualMinimumValue to obtain the minimum value of gauge scale. Use ui.actualMaximumValue to obtain the maximum value of gauge scale. Use ui.startAngle to obtain the starting angle of gauge scale. Use ui.endAngle to obtain the ending angle of gauge scale. Use ui.angle to obtain the angle on the gauge scale at which the label will be located. Use ui.value to obtain the value on the gauge scale associated with the label. Use ui.label to obtain the string value of the label.

get alignSubtitle(): object

Returns object

set alignSubtitle(ev: object): void

Parameters

ev: object

Returns void

alignTitle

Event which is raised when a title of the gauge is aligned and styled. Function takes first argument null and second argument ui. Use ui.owner to obtain reference to gauge widget. Use ui.actualMinimumValue to obtain the minimum value of gauge scale. Use ui.actualMaximumValue to obtain the maximum value of gauge scale. Use ui.startAngle to obtain the starting angle of gauge scale. Use ui.endAngle to obtain the ending angle of gauge scale. Use ui.angle to obtain the angle on the gauge scale at which the label will be located. Use ui.value to obtain the value on the gauge scale associated with the label. Use ui.label to obtain the string value of the label.

get alignTitle(): object

Returns object

set alignTitle(ev: object): void

Parameters

ev: object

Returns void

animating

Gets a value indicating whether the radial gauge is currently animating.

get animating(): boolean

Returns boolean

backingBrush

Gets or sets the brush to use to fill the backing of the gauge.

get backingBrush(): string

Returns string

set backingBrush(v: string): void

Parameters

v: string

Returns void

backingCornerRadius

Gets or sets the corner rounding radius to use for the fitted scale backings.

get backingCornerRadius(): number

Returns number

set backingCornerRadius(v: number): void

Parameters

v: number

Returns void

backingInnerExtent

Gets or sets the inner extent of the gauge backing.

get backingInnerExtent(): number

Returns number

set backingInnerExtent(v: number): void

Parameters

v: number

Returns void

backingOuterExtent

Gets or sets the outer extent of the gauge backing.

get backingOuterExtent(): number

Returns number

set backingOuterExtent(v: number): void

Parameters

v: number

Returns void

backingOutline

Gets or sets the brush to use for the outline of the backing.

get backingOutline(): string

Returns string

set backingOutline(v: string): void

Parameters

v: string

Returns void

backingOversweep

Gets or sets the over sweep angle to apply to the backing if it is displaying fitted (in degrees). Must be greater or equal to 0.

get backingOversweep(): number

Returns number

set backingOversweep(v: number): void

Parameters

v: number

Returns void

backingShape

Gets or sets the type of shape to use for the backing of the gauge.

get backingShape(): RadialGaugeBackingShape

Returns RadialGaugeBackingShape

set backingShape(v: RadialGaugeBackingShape): void

Parameters

v: RadialGaugeBackingShape

Returns void

backingStrokeThickness

Gets or sets the stroke thickness of the backing outline.

get backingStrokeThickness(): number

Returns number

set backingStrokeThickness(v: number): void

Parameters

v: number

Returns void

centerX

Gets or sets the x position of the center of the gauge with the value ranging from 0 to 1.

get centerX(): number

Returns number

set centerX(v: number): void

Parameters

v: number

Returns void

centerY

Gets or sets the y position of the center of the gauge with the value ranging from 0 to 1.

get centerY(): number

Returns number

set centerY(v: number): void

Parameters

v: number

Returns void

duplicateLabelOmissionStrategy

Gets or sets the strategy to use for omitting labels if the first and last label have the same value.

get duplicateLabelOmissionStrategy(): RadialGaugeDuplicateLabelOmissionStrategy

Returns RadialGaugeDuplicateLabelOmissionStrategy

set duplicateLabelOmissionStrategy(v: RadialGaugeDuplicateLabelOmissionStrategy): void

Parameters

v: RadialGaugeDuplicateLabelOmissionStrategy

Returns void

font

Gets or sets the font.

get font(): string

Returns string

set font(v: string): void

Parameters

v: string

Returns void

fontBrush

Gets or sets the brush to use for the label font.

get fontBrush(): string

Returns string

set fontBrush(v: string): void

Parameters

v: string

Returns void

formatHighlightLabel

Event which is raised when a highlight label of the gauge is formatted. Function takes first argument null and second argument ui. Use ui.owner to obtain reference to gauge widget. Use ui.actualMinimumValue to obtain the minimum value of gauge scale. Use ui.actualMaximumValue to obtain the maximum value of gauge scale. Use ui.startAngle to obtain the starting angle of gauge scale. Use ui.endAngle to obtain the ending angle of gauge scale. Use ui.angle to obtain the angle on the gauge scale at which the title will be located. Use ui.value to obtain the value on the gauge scale associated with the title. Use ui.label to obtain the string value of the title.

get formatHighlightLabel(): object

Returns object

set formatHighlightLabel(ev: object): void

Parameters

ev: object

Returns void

formatLabel

Event which is raised when a label of the gauge is formatted. Function takes first argument null and second argument ui. Use ui.owner to obtain reference to gauge widget. Use ui.actualMinimumValue to obtain the minimum value of gauge scale. Use ui.actualMaximumValue to obtain the maximum value of gauge scale. Use ui.startAngle to obtain the starting angle of gauge scale. Use ui.endAngle to obtain the ending angle of gauge scale. Use ui.angle to obtain the angle on the gauge scale at which the label will be located. Use ui.value to obtain the value on the gauge scale associated with the label. Use ui.label to obtain the string value of the label.

get formatLabel(): object

Returns object

set formatLabel(ev: object): void

Parameters

ev: object

Returns void

formatSubtitle

Event which is raised when a subtitle of the gauge is formatted. Function takes first argument null and second argument ui. Use ui.owner to obtain reference to gauge widget. Use ui.actualMinimumValue to obtain the minimum value of gauge scale. Use ui.actualMaximumValue to obtain the maximum value of gauge scale. Use ui.startAngle to obtain the starting angle of gauge scale. Use ui.endAngle to obtain the ending angle of gauge scale. Use ui.angle to obtain the angle on the gauge scale at which the subtitle will be located. Use ui.value to obtain the value on the gauge scale associated with the subtitle. Use ui.label to obtain the string value of the subtitle.

get formatSubtitle(): object

Returns object

set formatSubtitle(ev: object): void

Parameters

ev: object

Returns void

formatTitle

Event which is raised when a title of the gauge is formatted. Function takes first argument null and second argument ui. Use ui.owner to obtain reference to gauge widget. Use ui.actualMinimumValue to obtain the minimum value of gauge scale. Use ui.actualMaximumValue to obtain the maximum value of gauge scale. Use ui.startAngle to obtain the starting angle of gauge scale. Use ui.endAngle to obtain the ending angle of gauge scale. Use ui.angle to obtain the angle on the gauge scale at which the title will be located. Use ui.value to obtain the value on the gauge scale associated with the title. Use ui.label to obtain the string value of the title.

get formatTitle(): object

Returns object

set formatTitle(ev: object): void

Parameters

ev: object

Returns void

height

get height(): string

Returns string

set height(value: string): void

Parameters

value: string

Returns void

highlightLabelAngle

Gets or sets the angle for the highlight label in degrees.

get highlightLabelAngle(): number

Returns number

set highlightLabelAngle(v: number): void

Parameters

v: number

Returns void

highlightLabelBrush

Gets or sets the brush to use for rendering highlight text

get highlightLabelBrush(): string

Returns string

set highlightLabelBrush(v: string): void

Parameters

v: string

Returns void

highlightLabelDisplaysValue

Gets or sets the highlight label shows values of the gauge.

get highlightLabelDisplaysValue(): boolean

Returns boolean

set highlightLabelDisplaysValue(v: boolean): void

Parameters

v: boolean

Returns void

highlightLabelExtent

Gets or sets the angle for the highlight label in degrees.

get highlightLabelExtent(): number

Returns number

set highlightLabelExtent(v: number): void

Parameters

v: number

Returns void

highlightLabelFormat

Gets or sets the format used when creating highlight label.

get highlightLabelFormat(): string

Returns string

set highlightLabelFormat(v: string): void

Parameters

v: string

Returns void

highlightLabelFormatSpecifiers

Gets or sets the format specifiers to use with the HighlightLabelFormat string.

get highlightLabelFormatSpecifiers(): any[]

Returns any[]

set highlightLabelFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

highlightLabelSnapsToNeedlePivot

Gets or sets whether or not the highlight label should snap angle position to needle pivot (opposite of needle pointer).

get highlightLabelSnapsToNeedlePivot(): boolean

Returns boolean

set highlightLabelSnapsToNeedlePivot(v: boolean): void

Parameters

v: boolean

Returns void

highlightLabelText

Gets or sets the text displayed for the highlight label of the gauge.

get highlightLabelText(): string

Returns string

set highlightLabelText(v: string): void

Parameters

v: string

Returns void

highlightLabelTextStyle

Gets or Sets the style to use for the units text.

get highlightLabelTextStyle(): string

Returns string

set highlightLabelTextStyle(v: string): void

Parameters

v: string

Returns void

highlightValue

Gets or sets the highlight value at which to point the secondary needle of the gauge.

get highlightValue(): number

Returns number

set highlightValue(v: number): void

Parameters

v: number

Returns void

highlightValueChanged

Occurs when the Hightlight Value property changes.

get highlightValueChanged(): object

Returns object

set highlightValueChanged(ev: object): void

Parameters

ev: object

Returns void

highlightValueDisplayMode

Gets or sets whether and how to display the highlighted value.

get highlightValueDisplayMode(): HighlightedValueDisplayMode

Returns HighlightedValueDisplayMode

set highlightValueDisplayMode(v: HighlightedValueDisplayMode): void

Parameters

v: HighlightedValueDisplayMode

Returns void

highlightValueOpacity

Gets or sets the opacity of the primary needle while highlighting

get highlightValueOpacity(): number

Returns number

set highlightValueOpacity(v: number): void

Parameters

v: number

Returns void

interval

Gets or sets the interval to use for the scale.

get interval(): number

Returns number

set interval(v: number): void

Parameters

v: number

Returns void

isHighlightNeedleDraggingConstrained

Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging.

get isHighlightNeedleDraggingConstrained(): boolean

Returns boolean

set isHighlightNeedleDraggingConstrained(v: boolean): void

Parameters

v: boolean

Returns void

isHighlightNeedleDraggingEnabled

Gets or sets whether needle dragging is enabled or not.

get isHighlightNeedleDraggingEnabled(): boolean

Returns boolean

set isHighlightNeedleDraggingEnabled(v: boolean): void

Parameters

v: boolean

Returns void

isNeedleDraggingConstrained

Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging.

get isNeedleDraggingConstrained(): boolean

Returns boolean

set isNeedleDraggingConstrained(v: boolean): void

Parameters

v: boolean

Returns void

isNeedleDraggingEnabled

Gets or sets whether needle dragging is enabled or not.

get isNeedleDraggingEnabled(): boolean

Returns boolean

set isNeedleDraggingEnabled(v: boolean): void

Parameters

v: boolean

Returns void

labelExtent

Gets or sets the position at which to put the labels as a value from 0 to 1, measured form the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get labelExtent(): number

Returns number

set labelExtent(v: number): void

Parameters

v: number

Returns void

labelFormat

Gets or sets the label composite format used when creating label values.

get labelFormat(): string

Returns string

set labelFormat(v: string): void

Parameters

v: string

Returns void

labelFormatSpecifiers

Gets or sets the format specifiers to use with the LabelFormat string.

get labelFormatSpecifiers(): any[]

Returns any[]

set labelFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

labelInterval

Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale.

get labelInterval(): number

Returns number

set labelInterval(v: number): void

Parameters

v: number

Returns void

maximumValue

Gets or sets the maximum value of the scale.

get maximumValue(): number

Returns number

set maximumValue(v: number): void

Parameters

v: number

Returns void

minimumValue

Gets or sets the minimum value of the scale.

get minimumValue(): number

Returns number

set minimumValue(v: number): void

Parameters

v: number

Returns void

minorTickBrush

Gets or sets the brush to use for the minor tickmarks.

get minorTickBrush(): string

Returns string

set minorTickBrush(v: string): void

Parameters

v: string

Returns void

minorTickCount

Gets or sets the number of minor tickmarks to place between major tickmarks.

get minorTickCount(): number

Returns number

set minorTickCount(v: number): void

Parameters

v: number

Returns void

minorTickEndExtent

Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get minorTickEndExtent(): number

Returns number

set minorTickEndExtent(v: number): void

Parameters

v: number

Returns void

minorTickStartExtent

Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get minorTickStartExtent(): number

Returns number

set minorTickStartExtent(v: number): void

Parameters

v: number

Returns void

minorTickStrokeThickness

Gets or sets the stroke thickness to use when rendering minor ticks.

get minorTickStrokeThickness(): number

Returns number

set minorTickStrokeThickness(v: number): void

Parameters

v: number

Returns void

nativeElement

get nativeElement(): HTMLElement

Returns HTMLElement

needleBaseFeatureExtent

Gets or sets the extent of the feature which is closest to the base (e.g. a bulb) with a value from -1 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get needleBaseFeatureExtent(): number

Returns number

set needleBaseFeatureExtent(v: number): void

Parameters

v: number

Returns void

needleBaseFeatureWidthRatio

Gets or sets the width of the needle at its feature which is closest to the base (e.g. a bulb) with a value from 0 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get needleBaseFeatureWidthRatio(): number

Returns number

set needleBaseFeatureWidthRatio(v: number): void

Parameters

v: number

Returns void

needleBrush

Gets or sets the brush to use when rendering the fill of the needle.

get needleBrush(): string

Returns string

set needleBrush(v: string): void

Parameters

v: string

Returns void

needleEndExtent

Gets or sets the extent (from -1 to 1) at which to end rendering the needle, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get needleEndExtent(): number

Returns number

set needleEndExtent(v: number): void

Parameters

v: number

Returns void

needleEndWidthRatio

Gets or sets the width of the needle at its point using a value from (0 to 1). Note: Only some needle shapes respect this property. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get needleEndWidthRatio(): number

Returns number

set needleEndWidthRatio(v: number): void

Parameters

v: number

Returns void

needleOutline

Gets or sets the brush to use when rendering the outline of the needle.

get needleOutline(): string

Returns string

set needleOutline(v: string): void

Parameters

v: string

Returns void

needlePivotBrush

Gets or sets the brush to use for filling the needle cap. Note: this only applies to certain cap shapes.

get needlePivotBrush(): string

Returns string

set needlePivotBrush(v: string): void

Parameters

v: string

Returns void

needlePivotInnerWidthRatio

Gets or sets the width of the inner cutout section of the needle cap with a value from 0 to 1. Note: Will only take effect if you have a cap set on the needle that has a cutout section.

get needlePivotInnerWidthRatio(): number

Returns number

set needlePivotInnerWidthRatio(v: number): void

Parameters

v: number

Returns void

needlePivotOutline

Gets or sets the brush to use for the outlines of the needle cap.

get needlePivotOutline(): string

Returns string

set needlePivotOutline(v: string): void

Parameters

v: string

Returns void

needlePivotShape

Gets or sets the shape to use for the needle cap.

get needlePivotShape(): RadialGaugePivotShape

Returns RadialGaugePivotShape

set needlePivotShape(v: RadialGaugePivotShape): void

Parameters

v: RadialGaugePivotShape

Returns void

needlePivotStrokeThickness

Gets or sets the stroke thickness to use for the outline of the needle cap.

get needlePivotStrokeThickness(): number

Returns number

set needlePivotStrokeThickness(v: number): void

Parameters

v: number

Returns void

needlePivotWidthRatio

Gets or sets the width of the cap of the needle with a value from 0 to 1. Note: Will only take effect if you have a cap set on the needle. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get needlePivotWidthRatio(): number

Returns number

set needlePivotWidthRatio(v: number): void

Parameters

v: number

Returns void

needlePointFeatureExtent

Gets or sets the extent of the feature which is closest to the point (e.g. the tapering point of a needle) with a value from -1 to 1. Note: Only some needle shapes respect this property. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get needlePointFeatureExtent(): number

Returns number

set needlePointFeatureExtent(v: number): void

Parameters

v: number

Returns void

needlePointFeatureWidthRatio

Gets or sets the width of the needle at its feature which is closest to the point (e.g. the tapering point of a needle) with a value from 0 to 1. Note: Only some needle shapes respect this property. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get needlePointFeatureWidthRatio(): number

Returns number

set needlePointFeatureWidthRatio(v: number): void

Parameters

v: number

Returns void

needleShape

Gets or sets the shape to use when rendering the needle from a number of options.

get needleShape(): RadialGaugeNeedleShape

Returns RadialGaugeNeedleShape

set needleShape(v: RadialGaugeNeedleShape): void

Parameters

v: RadialGaugeNeedleShape

Returns void

needleStartExtent

Gets or sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get needleStartExtent(): number

Returns number

set needleStartExtent(v: number): void

Parameters

v: number

Returns void

needleStartWidthRatio

get needleStartWidthRatio(): number

Returns number

set needleStartWidthRatio(v: number): void

Parameters

v: number

Returns void

needleStrokeThickness

Gets or sets the stroke thickness of the needle outline.

get needleStrokeThickness(): number

Returns number

set needleStrokeThickness(v: number): void

Parameters

v: number

Returns void

opticalScalingEnabled

Gets or sets the title uses optical scaling when the gauge is resized.

get opticalScalingEnabled(): boolean

Returns boolean

set opticalScalingEnabled(v: boolean): void

Parameters

v: boolean

Returns void

opticalScalingRatio

Gets the optical scaling ratio calculated by dividing minimum gauge size by value of OpticalScalingSize property.

get opticalScalingRatio(): number

Returns number

set opticalScalingRatio(v: number): void

Parameters

v: number

Returns void

opticalScalingSize

Gets or sets the size at which labels have 100% optical scaling, e.g. labels will have larger fonts when gauge's size is larger

labels will have 200% larger fonts when gauge's size is 1000 and this property is set to 500
labels will have 50% smaller fonts when gauge's size is 250 and this property is set to 500

get opticalScalingSize(): number

Returns number

set opticalScalingSize(v: number): void

Parameters

v: number

Returns void

pixelScalingRatio

Gets or sets the scaling value used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

get pixelScalingRatio(): number

Returns number

set pixelScalingRatio(v: number): void

Parameters

v: number

Returns void

radiusMultiplier

Gets or sets the multiplying factor to apply to the normal radius of the gauge. The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. This introduces a multiplicative factor to that value.

get radiusMultiplier(): number

Returns number

set radiusMultiplier(v: number): void

Parameters

v: number

Returns void

rangeBrushes

Gets or sets a collection of brushes to be used as the palette for gauge ranges.

get rangeBrushes(): string[]

Returns string[]

set rangeBrushes(v: string[]): void

Parameters

v: string[]

Returns void

rangeOutlines

Gets or sets a collection of brushes to be used as the palette for gauge outlines.

get rangeOutlines(): string[]

Returns string[]

set rangeOutlines(v: string[]): void

Parameters

v: string[]

Returns void

ranges

A collection or manually added axes for the chart.

get ranges(): IgrRadialGaugeRangeCollection

Returns IgrRadialGaugeRangeCollection

scaleBrush

Gets or sets the brush to use to fill the background of the scale.

get scaleBrush(): string

Returns string

set scaleBrush(v: string): void

Parameters

v: string

Returns void

scaleEndAngle

Gets or sets the end angle for the scale in degrees.

get scaleEndAngle(): number

Returns number

set scaleEndAngle(v: number): void

Parameters

v: number

Returns void

scaleEndExtent

Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get scaleEndExtent(): number

Returns number

set scaleEndExtent(v: number): void

Parameters

v: number

Returns void

scaleOversweep

Gets or sets the extra degrees of sweep to apply to the scale background. Must be greater or equal to 0.

get scaleOversweep(): number

Returns number

set scaleOversweep(v: number): void

Parameters

v: number

Returns void

scaleOversweepShape

Gets or sets the oversweep shape to use for the excess fill area for the scale.

get scaleOversweepShape(): RadialGaugeScaleOversweepShape

Returns RadialGaugeScaleOversweepShape

set scaleOversweepShape(v: RadialGaugeScaleOversweepShape): void

Parameters

v: RadialGaugeScaleOversweepShape

Returns void

scaleStartAngle

Gets or sets the start angle for the scale in degrees.

get scaleStartAngle(): number

Returns number

set scaleStartAngle(v: number): void

Parameters

v: number

Returns void

scaleStartExtent

Gets or sets the position at which to start rendering the scale, measured from the center of the gauge as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get scaleStartExtent(): number

Returns number

set scaleStartExtent(v: number): void

Parameters

v: number

Returns void

scaleSweepDirection

Gets or sets the direction in which the scale sweeps around the center from the start angle to end angle.

get scaleSweepDirection(): SweepDirection

Returns SweepDirection

set scaleSweepDirection(v: SweepDirection): void

Parameters

v: SweepDirection

Returns void

subtitleAngle

Gets or sets the angle for the inner label in degrees.

get subtitleAngle(): number

Returns number

set subtitleAngle(v: number): void

Parameters

v: number

Returns void

subtitleBrush

Gets or sets the brush to use for rendering inner unit text

get subtitleBrush(): string

Returns string

set subtitleBrush(v: string): void

Parameters

v: string

Returns void

subtitleDisplaysValue

Gets or sets the subtitle show values of the gauge.

get subtitleDisplaysValue(): boolean

Returns boolean

set subtitleDisplaysValue(v: boolean): void

Parameters

v: boolean

Returns void

subtitleExtent

Gets or sets the angle for the inner label in degrees.

get subtitleExtent(): number

Returns number

set subtitleExtent(v: number): void

Parameters

v: number

Returns void

subtitleFormat

Gets or sets the subtitle format used when creating subtitle label.

get subtitleFormat(): string

Returns string

set subtitleFormat(v: string): void

Parameters

v: string

Returns void

subtitleFormatSpecifiers

Gets or sets the format specifiers to use with the SubtitleFormat string.

get subtitleFormatSpecifiers(): any[]

Returns any[]

set subtitleFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

subtitleSnapsToNeedlePivot

Gets or sets whether or not the subtitle should snap angle position to needle pivot (opposite of needle pointer).

get subtitleSnapsToNeedlePivot(): boolean

Returns boolean

set subtitleSnapsToNeedlePivot(v: boolean): void

Parameters

v: boolean

Returns void

subtitleText

Gets or sets the text displayed in the subtitle of the gauge.

get subtitleText(): string

Returns string

set subtitleText(v: string): void

Parameters

v: string

Returns void

subtitleTextStyle

Gets or Sets the style to use for the units text.

get subtitleTextStyle(): string

Returns string

set subtitleTextStyle(v: string): void

Parameters

v: string

Returns void

tickBrush

Gets or sets the brush to use for the major tickmarks.

get tickBrush(): string

Returns string

set tickBrush(v: string): void

Parameters

v: string

Returns void

tickEndExtent

Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get tickEndExtent(): number

Returns number

set tickEndExtent(v: number): void

Parameters

v: number

Returns void

tickStartExtent

Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

get tickStartExtent(): number

Returns number

set tickStartExtent(v: number): void

Parameters

v: number

Returns void

tickStrokeThickness

Gets or sets the stroke thickness to use when rendering ticks.

get tickStrokeThickness(): number

Returns number

set tickStrokeThickness(v: number): void

Parameters

v: number

Returns void

titleAngle

Gets or sets the angle for the inner label in degrees.

get titleAngle(): number

Returns number

set titleAngle(v: number): void

Parameters

v: number

Returns void

titleBrush

Gets or sets the brush to use for rendering inner unit text

get titleBrush(): string

Returns string

set titleBrush(v: string): void

Parameters

v: string

Returns void

titleDisplaysValue

Gets or sets the title show values of the gauge.

get titleDisplaysValue(): boolean

Returns boolean

set titleDisplaysValue(v: boolean): void

Parameters

v: boolean

Returns void

titleExtent

Gets or sets the angle for the inner label in degrees.

get titleExtent(): number

Returns number

set titleExtent(v: number): void

Parameters

v: number

Returns void

titleFormat

Gets or sets the title format used when creating title label.

get titleFormat(): string

Returns string

set titleFormat(v: string): void

Parameters

v: string

Returns void

titleFormatSpecifiers

Gets or sets the format specifiers to use with the TitleFormat string.

get titleFormatSpecifiers(): any[]

Returns any[]

set titleFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

titleSnapsToNeedlePivot

Gets or sets whether or not the title should snap angle position to needle pivot (opposite of needle pointer).

get titleSnapsToNeedlePivot(): boolean

Returns boolean

set titleSnapsToNeedlePivot(v: boolean): void

Parameters

v: boolean

Returns void

titleText

Gets or sets the text displayed in the title of the gauge.

get titleText(): string

Returns string

set titleText(v: string): void

Parameters

v: string

Returns void

titleTextStyle

Gets or Sets the style to use for the units text.

get titleTextStyle(): string

Returns string

set titleTextStyle(v: string): void

Parameters

v: string

Returns void

transitionDuration

Gets or sets the number of milliseconds over which changes to the gauge should be animated.

get transitionDuration(): number

Returns number

set transitionDuration(v: number): void

Parameters

v: number

Returns void

transitionProgress

Gets the transition progress of the animation when the control is animating.

get transitionProgress(): number

Returns number

set transitionProgress(v: number): void

Parameters

v: number

Returns void

value

Gets or sets the value at which to point the needle of the gauge.

get value(): number

Returns number

set value(v: number): void

Parameters

v: number

Returns void

valueChanged

Occurs when the Value property changes.

get valueChanged(): object

Returns object

set valueChanged(ev: object): void

Parameters

ev: object

Returns void

width

get width(): string

Returns string

set width(value: string): void

Parameters

value: string

Returns void

Methods

componentDidMount

componentDidMount(): void

Returns void

componentWillUnmount

componentWillUnmount(): void

Returns void

containerResized

containerResized(): void

Returns void

destroy

destroy(): void

Returns void

exportSerializedVisualData

Returns visuals as a serialized string.

exportSerializedVisualData(): string

Returns string

findByName

findByName(name: string): any

Parameters

name: string

Returns any

flush

Use to force the radial gauge to finish any deferred work before printing or evaluating its visual. This should only be called if the visual of the radial gauge needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the radial gauge.

flush(): void

Returns void

getPointForValue

getPointForValue(value: number, extent: number): IgPoint

Parameters

value: number
extent: number

Returns IgPoint

getValueForPoint

Gets the value for the main scale of the gauge for a given point within the bounds of the gauge.

getValueForPoint(point: IgPoint): number

Parameters

point: IgPoint
- The point for which to retrieve the associated value.

Returns number

highlightNeedleContainsPoint

highlightNeedleContainsPoint(point: IgPoint, isFinger: boolean): boolean

Parameters

point: IgPoint
isFinger: boolean

Returns boolean

initializeContent

initializeContent(): void

Returns void

needleContainsPoint

needleContainsPoint(point: IgPoint, isFinger: boolean): boolean

Parameters

point: IgPoint
isFinger: boolean

Returns boolean

provideContainer

Called by the UI framework to provide a UI container for rendering this control.

provideContainer(container: any): void

Parameters

container: any
- The UI container element.

Returns void

render

render(): DetailedReactHTMLElement<object, HTMLDivElement>

Returns DetailedReactHTMLElement<object, HTMLDivElement>

scaleValue

Scales a value on the gauge's main scale to an angle around the center point of the gauge, in radians.

scaleValue(value: number): number

Parameters

value: number
- The value to scale.

Returns number

shouldComponentUpdate

shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

nextProps: any
nextState: any

Returns boolean

styleUpdated

styleUpdated(): void

Returns void

unscaleValue

Unscales a value from an angle in radians to the represented value along the main scale of the gauge.

unscaleValue(angle: number): number

Parameters

angle: number
- The angle in radians to unscale to a value.

Returns number

_createFromInternal

_createFromInternal(internal: any): IgrRadialGauge

Parameters

internal: any