Class IgrLinearGauge<S, SS, S>

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

Type parameters

  • S

  • SS

  • S

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

actualRanges

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

contentRanges: IgrLinearGraphRange[] = []

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

props

props: Readonly<IIgrLinearGaugeProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<S>

Static Optional contextType

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}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Accessors

actualMaximumValue

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

    Returns number

  • Gets the resolved maximum value of the scale.

    Parameters

    • v: number

    Returns void

actualMinimumValue

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

    Returns number

  • Gets the resolved minimum value of the scale.

    Parameters

    • v: number

    Returns void

actualPixelScalingRatio

  • get actualPixelScalingRatio(): number
  • set actualPixelScalingRatio(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

alignLabel

  • get alignLabel(): function
  • set alignLabel(ev: function): 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 function

  • 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

animating

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

    Returns boolean

backingBrush

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

    Returns string

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

    Parameters

    • v: string

    Returns void

backingInnerExtent

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

    Returns number

  • Gets or sets the inner extent of the linear gauge backing.

    Parameters

    • v: number

    Returns void

backingOuterExtent

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

    Returns number

  • Gets or sets the outer extent of the linear gauge backing.

    Parameters

    • v: number

    Returns void

backingOutline

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

    Returns string

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

    Parameters

    • v: string

    Returns void

backingStrokeThickness

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

    Returns number

  • Gets or sets the stroke thickness of the backing outline.

    Parameters

    • v: number

    Returns void

font

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

    Returns string

  • Gets or sets the font.

    Parameters

    • v: string

    Returns void

fontBrush

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

    Returns string

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

    Parameters

    • v: string

    Returns void

formatLabel

  • get formatLabel(): function
  • set formatLabel(ev: function): 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 function

  • 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

height

  • get height(): string
  • set height(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

interval

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

    Returns number

  • Gets or sets the interval to use for the scale.

    Parameters

    • v: number

    Returns void

isNeedleDraggingEnabled

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

    Returns boolean

  • Gets or sets whether needle dragging is enabled or not.

    Parameters

    • v: boolean

    Returns void

isScaleInverted

  • get isScaleInverted(): boolean
  • set isScaleInverted(v: boolean): void
  • 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

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

    Parameters

    • v: boolean

    Returns void

labelExtent

  • get labelExtent(): number
  • set labelExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

labelInterval

  • get labelInterval(): number
  • set labelInterval(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

labelsPostInitial

  • get labelsPostInitial(): number
  • set labelsPostInitial(v: number): void
  • A value to start adding labels, added to the scale's MinimumValue.

    Returns number

  • A value to start adding labels, added to the scale's MinimumValue.

    Parameters

    • v: number

    Returns void

labelsPreTerminal

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

    Returns number

  • A value to stop adding labels, subtracted from the scale's MaximumValue.

    Parameters

    • v: number

    Returns void

maximumValue

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

    Returns number

  • Gets or sets the maximum value of the scale.

    Parameters

    • v: number

    Returns void

minimumValue

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

    Returns number

  • Gets or sets the minimum value of the scale.

    Parameters

    • v: number

    Returns void

minorTickBrush

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

    Returns string

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

    Parameters

    • v: string

    Returns void

minorTickCount

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

    Returns number

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

    Parameters

    • v: number

    Returns void

minorTickEndExtent

  • get minorTickEndExtent(): number
  • set minorTickEndExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

minorTickStartExtent

  • get minorTickStartExtent(): number
  • set minorTickStartExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

minorTickStrokeThickness

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

    Returns number

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

    Parameters

    • v: number

    Returns void

needleBreadth

  • get needleBreadth(): number
  • set needleBreadth(v: number): void
  • Gets or sets the needle breadth.

    Returns number

  • Gets or sets the needle breadth.

    Parameters

    • v: number

    Returns void

needleBrush

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

    Returns string

  • Gets or sets the brush to use for needle element.

    Parameters

    • v: string

    Returns void

needleInnerBaseWidth

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

    Returns number

  • Gets or sets the width of the needle's inner base.

    Parameters

    • v: number

    Returns void

needleInnerExtent

  • get needleInnerExtent(): number
  • set needleInnerExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

needleInnerPointExtent

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

    Returns number

  • Gets or sets the extent of the needle's inner point.

    Parameters

    • v: number

    Returns void

needleInnerPointWidth

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

    Returns number

  • Gets or sets the width of the needle's inner point.

    Parameters

    • v: number

    Returns void

needleName

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

    Returns string

  • Gets or sets the name used for needle.

    Parameters

    • v: string

    Returns void

needleOuterBaseWidth

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

    Returns number

  • Gets or sets the width of the needle's outer base.

    Parameters

    • v: number

    Returns void

needleOuterExtent

  • get needleOuterExtent(): number
  • set needleOuterExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

needleOuterPointExtent

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

    Returns number

  • Gets or sets the extent of the needle's outer point.

    Parameters

    • v: number

    Returns void

needleOuterPointWidth

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

    Returns number

  • Gets or sets the width of the needle's outer point.

    Parameters

    • v: number

    Returns void

needleOutline

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

    Returns string

  • Gets or sets the brush to use for the outline of needle element.

    Parameters

    • v: string

    Returns void

needleShape

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

    Returns LinearGraphNeedleShape

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

    Parameters

    Returns void

needleStrokeThickness

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

    Returns number

  • Gets or sets the stroke thickness to use when rendering single actual value element.

    Parameters

    • v: number

    Returns void

orientation

  • Gets or sets the orientation of the scale.

    Returns LinearScaleOrientation

  • Gets or sets the orientation of the scale.

    Parameters

    Returns void

pixelScalingRatio

  • get pixelScalingRatio(): number
  • set pixelScalingRatio(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

rangeBrushes

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

    Returns string[]

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

    Parameters

    • v: string[]

    Returns void

rangeInnerExtent

  • get rangeInnerExtent(): number
  • set rangeInnerExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

rangeOuterExtent

  • get rangeOuterExtent(): number
  • set rangeOuterExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

rangeOutlines

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

    Returns string[]

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

    Parameters

    • v: string[]

    Returns void

ranges

  • A collection or manually added axes for the chart.

    Returns IgrLinearGraphRangeCollection

scaleBrush

  • get scaleBrush(): string
  • set scaleBrush(v: string): void
  • Gets or sets the brush to use to fill the scale of the linear gauge.

    Returns string

  • Gets or sets the brush to use to fill the scale of the linear gauge.

    Parameters

    • v: string

    Returns void

scaleEndExtent

  • get scaleEndExtent(): number
  • set scaleEndExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

scaleInnerExtent

  • get scaleInnerExtent(): number
  • set scaleInnerExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

scaleOuterExtent

  • get scaleOuterExtent(): number
  • set scaleOuterExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

scaleOutline

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

    Returns string

  • Gets or sets the brush to use for the outline of the scale.

    Parameters

    • v: string

    Returns void

scaleStartExtent

  • get scaleStartExtent(): number
  • set scaleStartExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

scaleStrokeThickness

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

    Returns number

  • Gets or sets the stroke thickness of the scale outline.

    Parameters

    • v: number

    Returns void

showToolTip

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

    Returns boolean

  • Gets or sets a value indicating whether tooltips are enabled.

    Parameters

    • v: boolean

    Returns void

showToolTipTimeout

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

    Returns number

  • Gets or sets the time in milliseconds that tooltip appearance is delayed with.

    Parameters

    • v: number

    Returns void

tickBrush

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

    Returns string

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

    Parameters

    • v: string

    Returns void

tickEndExtent

  • get tickEndExtent(): number
  • set tickEndExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

tickStartExtent

  • get tickStartExtent(): number
  • set tickStartExtent(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

tickStrokeThickness

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

    Returns number

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

    Parameters

    • v: number

    Returns void

ticksPostInitial

  • get ticksPostInitial(): number
  • set ticksPostInitial(v: number): void
  • A value to start adding tickmarks, added to the scale's MinimumValue.

    Returns number

  • A value to start adding tickmarks, added to the scale's MinimumValue.

    Parameters

    • v: number

    Returns void

ticksPreTerminal

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

    Returns number

  • A value to stop adding tickmarks, subtracted from the scale's MaximumValue.

    Parameters

    • v: number

    Returns void

tooltipTemplate

  • get tooltipTemplate(): React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>
  • set tooltipTemplate(value: React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>): void
  • Returns React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>

  • Parameters

    • value: React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>

    Returns void

transitionDuration

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

    Returns number

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

    Parameters

    • v: number

    Returns void

transitionProgress

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

    Returns number

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

    Parameters

    • v: number

    Returns void

value

  • get value(): number
  • set value(v: number): void
  • Gets or sets the value at which the needle is positioned.

    Returns number

  • Gets or sets the value at which the needle is positioned.

    Parameters

    • v: number

    Returns void

width

  • get width(): string
  • set width(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IIgrLinearGaugeProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IIgrLinearGaugeProps>, nextState: Readonly<S>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void
  • Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IIgrLinearGaugeProps>, prevState: Readonly<S>, snapshot?: SS): 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

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

componentWillUnmount

  • componentWillUnmount(): void
  • Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IIgrLinearGaugeProps>, nextState: Readonly<S>, nextContext: any): void

containerResized

  • containerResized(): void
  • Returns void

destroy

  • destroy(): void
  • Returns void

exportSerializedVisualData

  • exportSerializedVisualData(): string
  • Returns visuals as a serialized string.

    Returns string

flush

  • flush(): void
  • 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

forceUpdate

  • forceUpdate(callBack?: function): void
  • Parameters

    • Optional callBack: function
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IIgrLinearGaugeProps>, prevState: Readonly<S>): SS | null
  • 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 SS | null

getValueForPoint

  • getValueForPoint(point: IgPoint): number
  • 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

initializeContent

  • initializeContent(): void
  • Returns void

needleContainsPoint

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

    • point: IgPoint
    • isFinger: boolean

    Returns boolean

provideContainer

  • provideContainer(container: any): void
  • Called by the UI framework to provide a UI container for rendering this control.

    Parameters

    • container: any
      • The UI container element.

    Returns void

render

  • render(): DetailedReactHTMLElement<object, HTMLDivElement>
  • Returns DetailedReactHTMLElement<object, HTMLDivElement>

setState

  • setState<K>(state: function | S | object, callback?: function): void
  • Type parameters

    • K: keyof S

    Parameters

    • state: function | S | object
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

shouldComponentUpdate

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

    • nextProps: any
    • nextState: any

    Returns boolean

styleUpdated

  • styleUpdated(): void
  • Returns void

Static _createFromInternal

  • Parameters

    • internal: any

    Returns IgrLinearGauge