A linear gauge for displaying a single value on a defined scale.

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

actualRanges: IgrLinearGraphRange[]

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: IgrLinearGraphRange[]
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<IIgrLinearGaugeProps> & 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 alignLabel(): ((s, e) => void)
  • Event which is raised when a label of the linear gauge is aligned along the scale. Function takes first argument evt and second argument ui. Use ui.owner to obtain reference to the gauge widget. Use ui.actualMinimumValue to obtain the minimum value of the gauge scale. Use ui.actualMaximumValue to obtain the maximum value of the gauge scale. 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 linear gauge is aligned along the scale. Function takes first argument evt and second argument ui. Use ui.owner to obtain reference to the gauge widget. Use ui.actualMinimumValue to obtain the minimum value of the gauge scale. Use ui.actualMaximumValue to obtain the maximum value of the gauge scale. 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 animating(): boolean
  • Gets a value indicating whether the bullet graph is currently animating.

    Returns boolean

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

    Returns string

  • set backingBrush(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set backingInnerExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get backingOuterExtent(): number
  • Gets or sets the outer extent of the linear 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 backingStrokeThickness(): number
  • Gets or sets the stroke thickness of the backing outline.

    Returns number

  • set backingStrokeThickness(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 formatLabel(): ((s, e) => void)
  • Event which is raised when a label of the the gauge is formatted. Function takes first argument evt and second argument ui. Use ui.owner to obtain reference to the gauge widget. Use ui.actualMinimumValue to obtain the minimum value of the gauge scale. Use ui.actualMaximumValue to obtain the maximum value of the gauge scale. Use ui.value to obtain the value on the 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 the gauge is formatted. Function takes first argument evt and second argument ui. Use ui.owner to obtain reference to the gauge widget. Use ui.actualMinimumValue to obtain the minimum value of the gauge scale. Use ui.actualMaximumValue to obtain the maximum value of the gauge scale. Use ui.value to obtain the value on the 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 height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: 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 isHighlightNeedleDraggingEnabled(): boolean
  • Gets or sets whether highlight needle dragging is enabled or not.

    Returns boolean

  • set isHighlightNeedleDraggingEnabled(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 isScaleInverted(): boolean
  • Gets or sets a value indicating whether the scale is inverted. When the scale is inverted the direction in which the scale values increase is right to left.

    Returns boolean

  • set isScaleInverted(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 from the bottom of the scale. Values further from zero than 1 can be used to hide the labels of the linear 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 labelsPostInitial(): number
  • A value to start adding labels, added to the scale's MinimumValue.

    Returns number

  • set labelsPostInitial(v): void
  • Parameters

    • v: number

    Returns void

  • get labelsPreTerminal(): number
  • A value to stop adding labels, subtracted from the scale's MaximumValue.

    Returns number

  • set labelsPreTerminal(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 mergeViewports(): boolean
  • Gets or sets whether the scale viewport will be merged with backing viewport.

    Returns boolean

  • set mergeViewports(v): void
  • Parameters

    • v: boolean

    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 front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear 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 front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear 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 needleBreadth(): number
  • Gets or sets the needle breadth.

    Returns number

  • set needleBreadth(v): void
  • Parameters

    • v: number

    Returns void

  • get needleBrush(): string
  • Gets or sets the brush to use for needle element.

    Returns string

  • set needleBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get needleInnerBaseWidth(): number
  • Gets or sets the width of the needle's inner base.

    Returns number

  • set needleInnerBaseWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get needleInnerExtent(): number
  • Gets or sets the position at which to start rendering the needle geometry, measured from the front/bottom of the linear 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 size of the linear gauge.

    Returns number

  • set needleInnerExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get needleInnerPointExtent(): number
  • Gets or sets the extent of the needle's inner point.

    Returns number

  • set needleInnerPointExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get needleInnerPointWidth(): number
  • Gets or sets the width of the needle's inner point.

    Returns number

  • set needleInnerPointWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get needleName(): string
  • Gets or sets the name used for needle.

    Returns string

  • set needleName(v): void
  • Parameters

    • v: string

    Returns void

  • get needleOuterBaseWidth(): number
  • Gets or sets the width of the needle's outer base.

    Returns number

  • set needleOuterBaseWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get needleOuterExtent(): number
  • Gets or sets the position at which to stop rendering the needle geometry as a value from 0 to 1 measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

  • set needleOuterExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get needleOuterPointExtent(): number
  • Gets or sets the extent of the needle's outer point.

    Returns number

  • set needleOuterPointExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get needleOuterPointWidth(): number
  • Gets or sets the width of the needle's outer point.

    Returns number

  • set needleOuterPointWidth(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set needleOutline(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns LinearGraphNeedleShape

  • set needleShape(v): void
  • Parameters

    Returns void

  • get needleStrokeThickness(): number
  • Gets or sets the stroke thickness to use when rendering single actual value element.

    Returns number

  • set needleStrokeThickness(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 rangeBrushes(): string[]
  • Gets or sets a collection of brushes to be used as the palette for linear gauge ranges.

    Returns string[]

  • set rangeBrushes(v): void
  • Parameters

    • v: string[]

    Returns void

  • get rangeInnerExtent(): number
  • Gets or sets the position at which to start rendering the ranges, measured from the front/bottom of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

  • set rangeInnerExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get rangeOuterExtent(): number
  • Gets or sets the position at which to stop rendering the range as a value from 0 to 1 measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

  • set rangeOuterExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get rangeOutlines(): string[]
  • Gets or sets a collection of brushes to be used as the palette for linear 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 scale of the linear gauge.

    Returns string

  • set scaleBrush(v): void
  • Parameters

    • v: string

    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 front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

  • set scaleEndExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get scaleInnerExtent(): number
  • Gets or sets the position at which to start rendering the scale, measured from the bottom/front (when orientation is horizontal/vertical) of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

  • set scaleInnerExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get scaleOuterExtent(): number
  • Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the bottom/front (when orientation is horizontal/vertical) of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

  • set scaleOuterExtent(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set scaleOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get scaleStartExtent(): number
  • Gets or sets the position at which to start rendering the scale, measured from the front/bottom of the linear 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 size of the linear gauge.

    Returns number

  • set scaleStartExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get scaleStrokeThickness(): number
  • Gets or sets the stroke thickness of the scale outline.

    Returns number

  • set scaleStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get showToolTip(): boolean
  • Gets or sets a value indicating whether tooltips are enabled.

    Returns boolean

  • set showToolTip(v): void
  • Parameters

    • v: boolean

    Returns void

  • get showToolTipTimeout(): number
  • Gets or sets the time in milliseconds that tooltip appearance is delayed with.

    Returns number

  • set showToolTipTimeout(v): void
  • Parameters

    • v: number

    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 front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear 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 front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear 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 ticksPostInitial(): number
  • A value to start adding tickmarks, added to the scale's MinimumValue.

    Returns number

  • set ticksPostInitial(v): void
  • Parameters

    • v: number

    Returns void

  • get ticksPreTerminal(): number
  • A value to stop adding tickmarks, subtracted from the scale's MaximumValue.

    Returns number

  • set ticksPreTerminal(v): void
  • Parameters

    • v: number

    Returns void

  • get tooltipTemplate(): FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>
  • Returns FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>

  • set tooltipTemplate(value): void
  • Parameters

    • value: FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>

    Returns void

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

    Returns number

  • set transitionDuration(v): void
  • Parameters

    • v: 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 the needle is positioned.

    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 linear gauge to finish any deferred work before printing or evaluating its visual. This should only be called if the visual of the linear gauge needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the linear gauge.

    Returns void

  • Parameters

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

    Returns void

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

  • 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

  • Parameters

    • internal: any

    Returns IgrLinearGauge