Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

actualRanges: IgrRadialGaugeRange[]

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.

contentRanges: IgrRadialGaugeRange[]
context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<IIgrRadialGaugeProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get actualHighlightValueDisplayMode(): HighlightedValueDisplayMode
  • Gets whether and how to display the highlighted value.

    Returns HighlightedValueDisplayMode

  • set actualHighlightValueDisplayMode(v): void
  • Parameters

    • v: HighlightedValueDisplayMode

    Returns void

  • get actualHighlightValueOpacity(): number
  • Gets the actual opacity of the primary needle while highlighting

    Returns number

  • set actualHighlightValueOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualMaximumValue(): number
  • Gets the resolved maximum value of the scale.

    Returns number

  • set actualMaximumValue(v): void
  • Parameters

    • v: number

    Returns void

  • get actualMaximumValueChange(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set actualMaximumValueChange(ev): void
  • Parameters

    • ev: ((s, e) => void)

    Returns void

  • get actualMinimumValue(): number
  • Gets the resolved minimum value of the scale.

    Returns number

  • set actualMinimumValue(v): void
  • Parameters

    • v: number

    Returns void

  • get actualMinimumValueChange(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set actualMinimumValueChange(ev): void
  • Parameters

    • ev: ((s, e) => void)

    Returns void

  • get actualPixelScalingRatio(): number
  • 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.

    Returns number

  • set actualPixelScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get alignHighlightLabel(): ((s, e) => void)
  • 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.

    Returns ((s, e) => void)

      • (s, e): void
      • 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.

        Parameters

        Returns void

  • set alignHighlightLabel(ev): void
  • Parameters

    Returns void

  • get alignLabel(): ((s, e) => void)
  • 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.

    Returns ((s, e) => void)

      • (s, e): void
      • 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.

        Parameters

        Returns void

  • set alignLabel(ev): void
  • Parameters

    Returns void

  • get alignSubtitle(): ((s, e) => void)
  • 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.

    Returns ((s, e) => void)

      • (s, e): void
      • 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.

        Parameters

        Returns void

  • set alignSubtitle(ev): void
  • Parameters

    Returns void

  • get alignTitle(): ((s, e) => void)
  • 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.

    Returns ((s, e) => void)

      • (s, e): void
      • 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.

        Parameters

        Returns void

  • set alignTitle(ev): void
  • Parameters

    Returns void

  • get animating(): boolean
  • Gets a value indicating whether the radial gauge is currently animating.

    Returns boolean

  • get backingBrush(): string
  • Gets or sets the brush to use to fill the backing of the gauge.

    Returns string

  • set backingBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get backingCornerRadius(): number
  • Gets or sets the corner rounding radius to use for the fitted scale backings.

    Returns number

  • set backingCornerRadius(v): void
  • Parameters

    • v: number

    Returns void

  • get backingInnerExtent(): number
  • Gets or sets the inner extent of the gauge backing.

    Returns number

  • set backingInnerExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get backingOuterExtent(): number
  • Gets or sets the outer extent of the gauge backing.

    Returns number

  • set backingOuterExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get backingOutline(): string
  • Gets or sets the brush to use for the outline of the backing.

    Returns string

  • set backingOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get backingOversweep(): number
  • 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.

    Returns number

  • set backingOversweep(v): void
  • Parameters

    • v: number

    Returns void

  • get backingShape(): RadialGaugeBackingShape
  • Gets or sets the type of shape to use for the backing of the gauge.

    Returns RadialGaugeBackingShape

  • set backingShape(v): void
  • Parameters

    Returns void

  • get backingStrokeThickness(): number
  • Gets or sets the stroke thickness of the backing outline.

    Returns number

  • set backingStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get centerX(): number
  • Gets or sets the x position of the center of the gauge with the value ranging from 0 to 1.

    Returns number

  • set centerX(v): void
  • Parameters

    • v: number

    Returns void

  • get centerY(): number
  • Gets or sets the y position of the center of the gauge with the value ranging from 0 to 1.

    Returns number

  • set centerY(v): void
  • Parameters

    • v: number

    Returns void

  • get font(): string
  • Gets or sets the font.

    Returns string

  • set font(v): void
  • Parameters

    • v: string

    Returns void

  • get fontBrush(): string
  • Gets or sets the brush to use for the label font.

    Returns string

  • set fontBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get formatHighlightLabel(): ((s, e) => void)
  • 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.

    Returns ((s, e) => void)

      • (s, e): void
      • 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.

        Parameters

        Returns void

  • set formatHighlightLabel(ev): void
  • Parameters

    Returns void

  • get formatLabel(): ((s, e) => void)
  • 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.

    Returns ((s, e) => void)

      • (s, e): void
      • 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.

        Parameters

        Returns void

  • set formatLabel(ev): void
  • Parameters

    Returns void

  • get formatSubtitle(): ((s, e) => void)
  • 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.

    Returns ((s, e) => void)

      • (s, e): void
      • 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.

        Parameters

        Returns void

  • set formatSubtitle(ev): void
  • Parameters

    Returns void

  • get formatTitle(): ((s, e) => void)
  • 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.

    Returns ((s, e) => void)

      • (s, e): void
      • 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.

        Parameters

        Returns void

  • set formatTitle(ev): void
  • Parameters

    Returns void

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get highlightLabelAngle(): number
  • Gets or sets the angle for the highlight label in degrees.

    Returns number

  • set highlightLabelAngle(v): void
  • Parameters

    • v: number

    Returns void

  • get highlightLabelBrush(): string
  • Gets or sets the brush to use for rendering highlight text

    Returns string

  • set highlightLabelBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get highlightLabelDisplaysValue(): boolean
  • Gets or sets the highlight label shows values of the gauge.

    Returns boolean

  • set highlightLabelDisplaysValue(v): void
  • Parameters

    • v: boolean

    Returns void

  • get highlightLabelExtent(): number
  • Gets or sets the angle for the highlight label in degrees.

    Returns number

  • set highlightLabelExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get highlightLabelFormat(): string
  • Gets or sets the format used when creating highlight label.

    Returns string

  • set highlightLabelFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get highlightLabelFormatSpecifiers(): any[]
  • Gets or sets the format specifiers to use with the HighlightLabelFormat string.

    Returns any[]

  • set highlightLabelFormatSpecifiers(v): void
  • Parameters

    • v: any[]

    Returns void

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

    Returns boolean

  • set highlightLabelSnapsToNeedlePivot(v): void
  • Parameters

    • v: boolean

    Returns void

  • get highlightLabelText(): string
  • Gets or sets the text displayed for the highlight label of the gauge.

    Returns string

  • set highlightLabelText(v): void
  • Parameters

    • v: string

    Returns void

  • get highlightLabelTextStyle(): string
  • Gets or Sets the style to use for the units text.

    Returns string

  • set highlightLabelTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get highlightValue(): number
  • Gets or sets the highlight value at which to point the secondary needle of the gauge.

    Returns number

  • set highlightValue(v): void
  • Parameters

    • v: number

    Returns void

  • get highlightValueChanged(): ((s, e) => void)
  • Occurs when the Hightlight Value property changes.

    Returns ((s, e) => void)

      • (s, e): void
      • Occurs when the Hightlight Value property changes.

        Parameters

        Returns void

  • set highlightValueChanged(ev): void
  • Parameters

    • ev: ((s, e) => void)
        • (s, e): void
        • Parameters

          Returns void

    Returns void

  • get highlightValueDisplayMode(): HighlightedValueDisplayMode
  • Gets or sets whether and how to display the highlighted value.

    Returns HighlightedValueDisplayMode

  • set highlightValueDisplayMode(v): void
  • Parameters

    • v: HighlightedValueDisplayMode

    Returns void

  • get highlightValueOpacity(): number
  • Gets or sets the opacity of the primary needle while highlighting

    Returns number

  • set highlightValueOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get interval(): number
  • Gets or sets the interval to use for the scale.

    Returns number

  • set interval(v): void
  • Parameters

    • v: number

    Returns void

  • get isHighlightNeedleDraggingConstrained(): boolean
  • Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging.

    Returns boolean

  • set isHighlightNeedleDraggingConstrained(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isHighlightNeedleDraggingEnabled(): boolean
  • Gets or sets whether needle dragging is enabled or not.

    Returns boolean

  • set isHighlightNeedleDraggingEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isNeedleDraggingConstrained(): boolean
  • Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging.

    Returns boolean

  • set isNeedleDraggingConstrained(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isNeedleDraggingEnabled(): boolean
  • Gets or sets whether needle dragging is enabled or not.

    Returns boolean

  • set isNeedleDraggingEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get labelExtent(): number
  • 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.

    Returns number

  • set labelExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get labelFormat(): string
  • Gets or sets the label composite format used when creating label values.

    Returns string

  • set labelFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get labelFormatSpecifiers(): any[]
  • Gets or sets the format specifiers to use with the LabelFormat string.

    Returns any[]

  • set labelFormatSpecifiers(v): void
  • Parameters

    • v: any[]

    Returns void

  • get labelInterval(): number
  • Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale.

    Returns number

  • set labelInterval(v): void
  • Parameters

    • v: number

    Returns void

  • get maximumValue(): number
  • Gets or sets the maximum value of the scale.

    Returns number

  • set maximumValue(v): void
  • Parameters

    • v: number

    Returns void

  • get minimumValue(): number
  • Gets or sets the minimum value of the scale.

    Returns number

  • set minimumValue(v): void
  • Parameters

    • v: number

    Returns void

  • get minorTickBrush(): string
  • Gets or sets the brush to use for the minor tickmarks.

    Returns string

  • set minorTickBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get minorTickCount(): number
  • Gets or sets the number of minor tickmarks to place between major tickmarks.

    Returns number

  • set minorTickCount(v): void
  • Parameters

    • v: number

    Returns void

  • get minorTickEndExtent(): number
  • 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.

    Returns number

  • set minorTickEndExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get minorTickStartExtent(): number
  • 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.

    Returns number

  • set minorTickStartExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get minorTickStrokeThickness(): number
  • Gets or sets the stroke thickness to use when rendering minor ticks.

    Returns number

  • set minorTickStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get needleBaseFeatureExtent(): number
  • 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.

    Returns number

  • set needleBaseFeatureExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get needleBaseFeatureWidthRatio(): number
  • 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.

    Returns number

  • set needleBaseFeatureWidthRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get needleBrush(): string
  • Gets or sets the brush to use when rendering the fill of the needle.

    Returns string

  • set needleBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get needleEndExtent(): number
  • 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.

    Returns number

  • set needleEndExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get needleEndWidthRatio(): number
  • 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.

    Returns number

  • set needleEndWidthRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get needleOutline(): string
  • Gets or sets the brush to use when rendering the outline of the needle.

    Returns string

  • set needleOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get needlePivotBrush(): string
  • Gets or sets the brush to use for filling the needle cap. Note: this only applies to certain cap shapes.

    Returns string

  • set needlePivotBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get needlePivotInnerWidthRatio(): number
  • 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.

    Returns number

  • set needlePivotInnerWidthRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get needlePivotOutline(): string
  • Gets or sets the brush to use for the outlines of the needle cap.

    Returns string

  • set needlePivotOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get needlePivotShape(): RadialGaugePivotShape
  • Gets or sets the shape to use for the needle cap.

    Returns RadialGaugePivotShape

  • set needlePivotShape(v): void
  • Parameters

    Returns void

  • get needlePivotStrokeThickness(): number
  • Gets or sets the stroke thickness to use for the outline of the needle cap.

    Returns number

  • set needlePivotStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get needlePivotWidthRatio(): number
  • 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.

    Returns number

  • set needlePivotWidthRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get needlePointFeatureExtent(): number
  • 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.

    Returns number

  • set needlePointFeatureExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get needlePointFeatureWidthRatio(): number
  • 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.

    Returns number

  • set needlePointFeatureWidthRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get needleShape(): RadialGaugeNeedleShape
  • Gets or sets the shape to use when rendering the needle from a number of options.

    Returns RadialGaugeNeedleShape

  • set needleShape(v): void
  • Parameters

    Returns void

  • get needleStartExtent(): number
  • 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.

    Returns number

  • set needleStartExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get needleStartWidthRatio(): number
  • 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.

    Returns number

  • set needleStartWidthRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get needleStrokeThickness(): number
  • Gets or sets the stroke thickness of the needle outline.

    Returns number

  • set needleStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get opticalScalingEnabled(): boolean
  • Gets or sets the title uses optical scaling when the gauge is resized.

    Returns boolean

  • set opticalScalingEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get opticalScalingRatio(): number
  • Gets the optical scaling ratio calculated by dividing minimum gauge size by value of OpticalScalingSize property.

    Returns number

  • set opticalScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get opticalScalingSize(): number
  • 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

    Returns number

  • set opticalScalingSize(v): void
  • Parameters

    • v: number

    Returns void

  • get pixelScalingRatio(): number
  • 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.

    Returns number

  • set pixelScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get radiusMultiplier(): number
  • 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.

    Returns number

  • set radiusMultiplier(v): void
  • Parameters

    • v: number

    Returns void

  • get rangeBrushes(): string[]
  • Gets or sets a collection of brushes to be used as the palette for gauge ranges.

    Returns string[]

  • set rangeBrushes(v): void
  • Parameters

    • v: string[]

    Returns void

  • get rangeOutlines(): string[]
  • Gets or sets a collection of brushes to be used as the palette for gauge outlines.

    Returns string[]

  • set rangeOutlines(v): void
  • Parameters

    • v: string[]

    Returns void

  • get scaleBrush(): string
  • Gets or sets the brush to use to fill the background of the scale.

    Returns string

  • set scaleBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get scaleEndAngle(): number
  • Gets or sets the end angle for the scale in degrees.

    Returns number

  • set scaleEndAngle(v): void
  • Parameters

    • v: number

    Returns void

  • get scaleEndExtent(): number
  • 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.

    Returns number

  • set scaleEndExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get scaleOversweep(): number
  • Gets or sets the extra degrees of sweep to apply to the scale background. Must be greater or equal to 0.

    Returns number

  • set scaleOversweep(v): void
  • Parameters

    • v: number

    Returns void

  • get scaleStartAngle(): number
  • Gets or sets the start angle for the scale in degrees.

    Returns number

  • set scaleStartAngle(v): void
  • Parameters

    • v: number

    Returns void

  • get scaleStartExtent(): number
  • 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.

    Returns number

  • set scaleStartExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get scaleSweepDirection(): SweepDirection
  • Gets or sets the direction in which the scale sweeps around the center from the start angle to end angle.

    Returns SweepDirection

  • set scaleSweepDirection(v): void
  • Parameters

    • v: SweepDirection

    Returns void

  • get subtitleAngle(): number
  • Gets or sets the angle for the inner label in degrees.

    Returns number

  • set subtitleAngle(v): void
  • Parameters

    • v: number

    Returns void

  • get subtitleBrush(): string
  • Gets or sets the brush to use for rendering inner unit text

    Returns string

  • set subtitleBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get subtitleDisplaysValue(): boolean
  • Gets or sets the subtitle show values of the gauge.

    Returns boolean

  • set subtitleDisplaysValue(v): void
  • Parameters

    • v: boolean

    Returns void

  • get subtitleExtent(): number
  • Gets or sets the angle for the inner label in degrees.

    Returns number

  • set subtitleExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get subtitleFormat(): string
  • Gets or sets the subtitle format used when creating subtitle label.

    Returns string

  • set subtitleFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get subtitleFormatSpecifiers(): any[]
  • Gets or sets the format specifiers to use with the SubtitleFormat string.

    Returns any[]

  • set subtitleFormatSpecifiers(v): void
  • Parameters

    • v: any[]

    Returns void

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

    Returns boolean

  • set subtitleSnapsToNeedlePivot(v): void
  • Parameters

    • v: boolean

    Returns void

  • get subtitleText(): string
  • Gets or sets the text displayed in the subtitle of the gauge.

    Returns string

  • set subtitleText(v): void
  • Parameters

    • v: string

    Returns void

  • get subtitleTextStyle(): string
  • Gets or Sets the style to use for the units text.

    Returns string

  • set subtitleTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get tickBrush(): string
  • Gets or sets the brush to use for the major tickmarks.

    Returns string

  • set tickBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get tickEndExtent(): number
  • 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.

    Returns number

  • set tickEndExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get tickStartExtent(): number
  • 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.

    Returns number

  • set tickStartExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get tickStrokeThickness(): number
  • Gets or sets the stroke thickness to use when rendering ticks.

    Returns number

  • set tickStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get titleAngle(): number
  • Gets or sets the angle for the inner label in degrees.

    Returns number

  • set titleAngle(v): void
  • Parameters

    • v: number

    Returns void

  • get titleBrush(): string
  • Gets or sets the brush to use for rendering inner unit text

    Returns string

  • set titleBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get titleDisplaysValue(): boolean
  • Gets or sets the title show values of the gauge.

    Returns boolean

  • set titleDisplaysValue(v): void
  • Parameters

    • v: boolean

    Returns void

  • get titleExtent(): number
  • Gets or sets the angle for the inner label in degrees.

    Returns number

  • set titleExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get titleFormat(): string
  • Gets or sets the title format used when creating title label.

    Returns string

  • set titleFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get titleFormatSpecifiers(): any[]
  • Gets or sets the format specifiers to use with the TitleFormat string.

    Returns any[]

  • set titleFormatSpecifiers(v): void
  • Parameters

    • v: any[]

    Returns void

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

    Returns boolean

  • set titleSnapsToNeedlePivot(v): void
  • Parameters

    • v: boolean

    Returns void

  • get titleText(): string
  • Gets or sets the text displayed in the title of the gauge.

    Returns string

  • set titleText(v): void
  • Parameters

    • v: string

    Returns void

  • get titleTextStyle(): string
  • Gets or Sets the style to use for the units text.

    Returns string

  • set titleTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get transitionDuration(): number
  • Gets or sets the number of milliseconds over which changes to the gauge should be animated.

    Returns number

  • set transitionDuration(v): void
  • Parameters

    • v: number

    Returns void

  • get transitionEasingFunction(): ((time) => number)
  • Gets or sets the easing function used to morph the current series.

    Returns ((time) => number)

      • (time): number
      • Gets or sets the easing function used to morph the current series.

        Parameters

        • time: number

        Returns number

  • set transitionEasingFunction(v): void
  • Parameters

    • v: ((time) => number)
        • (time): number
        • Parameters

          • time: number

          Returns number

    Returns void

  • get transitionProgress(): number
  • Gets the transition progress of the animation when the control is animating.

    Returns number

  • set transitionProgress(v): void
  • Parameters

    • v: number

    Returns void

  • get value(): number
  • Gets or sets the value at which to point the needle of the gauge.

    Returns number

  • set value(v): void
  • Parameters

    • v: number

    Returns void

  • get valueChanged(): ((s, e) => void)
  • Occurs when the Value property changes.

    Returns ((s, e) => void)

      • (s, e): void
      • Occurs when the Value property changes.

        Parameters

        Returns void

  • set valueChanged(ev): void
  • Parameters

    • ev: ((s, e) => void)
        • (s, e): void
        • Parameters

          Returns void

    Returns void

  • get width(): string
  • Returns string

  • set width(value): void
  • Parameters

    • value: string

    Returns void

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns visuals as a serialized string.

    Returns string

  • Parameters

    • name: string

    Returns any

  • 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.

    Returns void

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • value: number
    • extent: number

    Returns IgPoint

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

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

    Parameters

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

    Returns number

  • Parameters

    • point: IgPoint
    • isFinger: boolean

    Returns boolean

  • Returns void

  • Parameters

    • point: IgPoint
    • isFinger: boolean

    Returns boolean

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

    Parameters

    • container: any
      • The UI container element.

    Returns void

  • Returns DetailedReactHTMLElement<{
        children: any[];
        className: string;
        ref: ((div) => void);
    }, HTMLDivElement>

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

    Parameters

    • value: number
      • The value to scale.

    Returns number

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Returns void

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

    Parameters

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

    Returns number

  • Parameters

    • internal: any

    Returns IgrRadialGauge