Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrLinearGaugeProps

Hierarchy

Hierarchy

  • IIgrLinearGaugeProps

Properties

Properties

Optional actualHighlightValueDisplayMode

actualHighlightValueDisplayMode?: string | HighlightedValueDisplayMode

Gets whether and how to display the highlighted value.

Optional actualHighlightValueOpacity

actualHighlightValueOpacity?: string | number

Gets the actual opacity of the primary needle while highlighting

Optional actualMaximumValue

actualMaximumValue?: string | number

Gets the resolved maximum value of the scale.

Optional actualMinimumValue

actualMinimumValue?: string | number

Gets the resolved minimum value of the scale.

Optional actualPixelScalingRatio

actualPixelScalingRatio?: string | 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.

Optional alignLabel

alignLabel?: ((s, e) => void)

Type declaration

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

Optional backingBrush

backingBrush?: string

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

Optional backingInnerExtent

backingInnerExtent?: string | number

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

Optional backingOuterExtent

backingOuterExtent?: string | number

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

Optional backingOutline

backingOutline?: string

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

Optional backingStrokeThickness

backingStrokeThickness?: string | number

Gets or sets the stroke thickness of the backing outline.

Optional children

children?: ReactNode

Optional font

font?: string

Gets or sets the font.

Optional fontBrush

fontBrush?: string

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

Optional formatLabel

formatLabel?: ((s, e) => void)

Type declaration

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

Optional height

height?: string

Optional highlightValue

highlightValue?: string | number

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

Optional highlightValueChanged

highlightValueChanged?: ((s, e) => void)

Type declaration

    • (s, e): void

    • Occurs when the Hightlight Value property changes.

      Parameters

      Returns void

Optional highlightValueDisplayMode

highlightValueDisplayMode?: string | HighlightedValueDisplayMode

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

Optional highlightValueOpacity

highlightValueOpacity?: string | number

Gets or sets the opacity of the primary needle while highlighting

Optional interval

interval?: string | number

Gets or sets the interval to use for the scale.

Optional isHighlightNeedleDraggingEnabled

isHighlightNeedleDraggingEnabled?: string | boolean

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

Optional isNeedleDraggingEnabled

isNeedleDraggingEnabled?: string | boolean

Gets or sets whether needle dragging is enabled or not.

Optional isScaleInverted

isScaleInverted?: string | 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.

Optional labelExtent

labelExtent?: string | 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.

Optional labelFormat

labelFormat?: string

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

Optional labelFormatSpecifiers

labelFormatSpecifiers?: any[]

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

Optional labelInterval

labelInterval?: string | number

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

Optional labelsPostInitial

labelsPostInitial?: string | number

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

Optional labelsPreTerminal

labelsPreTerminal?: string | number

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

Optional labelsVisible

labelsVisible?: string | boolean

Gets or sets whether the labels are visible in the gauge.

Optional maximumValue

maximumValue?: string | number

Gets or sets the maximum value of the scale.

Optional mergeViewports

mergeViewports?: string | boolean

Gets or sets whether the scale viewport will be merged with backing viewport.

Optional minimumValue

minimumValue?: string | number

Gets or sets the minimum value of the scale.

Optional minorTickBrush

minorTickBrush?: string

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

Optional minorTickCount

minorTickCount?: string | number

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

Optional minorTickEndExtent

minorTickEndExtent?: string | 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.

Optional minorTickStartExtent

minorTickStartExtent?: string | 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.

Optional minorTickStrokeThickness

minorTickStrokeThickness?: string | number

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

Optional needleBreadth

needleBreadth?: string | number

Gets or sets the needle breadth.

Optional needleBrush

needleBrush?: string

Gets or sets the brush to use for needle element.

Optional needleInnerBaseWidth

needleInnerBaseWidth?: string | number

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

Optional needleInnerExtent

needleInnerExtent?: string | 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.

Optional needleInnerPointExtent

needleInnerPointExtent?: string | number

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

Optional needleInnerPointWidth

needleInnerPointWidth?: string | number

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

Optional needleName

needleName?: string

Gets or sets the name used for needle.

Optional needleOuterBaseWidth

needleOuterBaseWidth?: string | number

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

Optional needleOuterExtent

needleOuterExtent?: string | 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.

Optional needleOuterPointExtent

needleOuterPointExtent?: string | number

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

Optional needleOuterPointWidth

needleOuterPointWidth?: string | number

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

Optional needleOutline

needleOutline?: string

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

Optional needleShape

needleShape?: string | LinearGraphNeedleShape

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

Optional needleStrokeThickness

needleStrokeThickness?: string | number

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

Optional orientation

orientation?: string | LinearScaleOrientation

Gets or sets the orientation of the scale.

Optional pixelScalingRatio

pixelScalingRatio?: string | 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.

Optional rangeBrushes

rangeBrushes?: string | string[]

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

Optional rangeInnerExtent

rangeInnerExtent?: string | 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.

Optional rangeOuterExtent

rangeOuterExtent?: string | 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.

Optional rangeOutlines

rangeOutlines?: string | string[]

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

Optional scaleBrush

scaleBrush?: string

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

Optional scaleEndExtent

scaleEndExtent?: string | 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.

Optional scaleInnerExtent

scaleInnerExtent?: string | 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.

Optional scaleOuterExtent

scaleOuterExtent?: string | 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.

Optional scaleOutline

scaleOutline?: string

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

Optional scaleStartExtent

scaleStartExtent?: string | 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.

Optional scaleStrokeThickness

scaleStrokeThickness?: string | number

Gets or sets the stroke thickness of the scale outline.

Optional showToolTip

showToolTip?: string | boolean

Gets or sets a value indicating whether tooltips are enabled.

Optional showToolTipTimeout

showToolTipTimeout?: string | number

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

Optional tickBrush

tickBrush?: string

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

Optional tickEndExtent

tickEndExtent?: string | 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.

Optional tickStartExtent

tickStartExtent?: string | 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.

Optional tickStrokeThickness

tickStrokeThickness?: string | number

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

Optional ticksPostInitial

ticksPostInitial?: string | number

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

Optional ticksPreTerminal

ticksPreTerminal?: string | number

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

Optional transitionDuration

transitionDuration?: string | number

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

Optional transitionProgress

transitionProgress?: string | number

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

Optional value

value?: string | number

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

Optional valueChanged

valueChanged?: ((s, e) => void)

Type declaration

    • (s, e): void

    • Occurs when the Value property changes.

      Parameters

      Returns void

Optional width

width?: string