IIgrLinearGaugeProps

Properties

Optional actualHighlightValueDisplayMode

Gets whether and how to display the highlighted value.

actualHighlightValueDisplayMode?: any

Optional actualHighlightValueOpacity

Gets the actual opacity of the primary needle while highlighting

actualHighlightValueOpacity?: string | number

Optional actualMaximumValue

Gets the resolved maximum value of the scale.

actualMaximumValue?: string | number

Optional actualMinimumValue

Gets the resolved minimum value of the scale.

actualMinimumValue?: string | number

Optional actualPixelScalingRatio

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

actualPixelScalingRatio?: string | number

Optional alignLabel

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.

alignLabel?: object

Optional backingBrush

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

backingBrush?: string

Optional backingInnerExtent

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

backingInnerExtent?: string | number

Optional backingOuterExtent

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

backingOuterExtent?: string | number

Optional backingOutline

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

backingOutline?: string

Optional backingStrokeThickness

Gets or sets the stroke thickness of the backing outline.

backingStrokeThickness?: string | number

Optional children

children?: ReactNode

Optional font

Gets or sets the font.

font?: string

Optional fontBrush

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

fontBrush?: string

Optional formatLabel

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.

formatLabel?: object

Optional height

height?: string

Optional highlightValue

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

highlightValue?: string | number

Optional highlightValueChanged

Occurs when the Hightlight Value property changes.

highlightValueChanged?: object

Optional highlightValueDisplayMode

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

highlightValueDisplayMode?: any

Optional highlightValueOpacity

Gets or sets the opacity of the primary needle while highlighting

highlightValueOpacity?: string | number

Optional interval

Gets or sets the interval to use for the scale.

interval?: string | number

Optional isHighlightNeedleDraggingEnabled

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

isHighlightNeedleDraggingEnabled?: string | boolean

Optional isNeedleDraggingEnabled

Gets or sets whether needle dragging is enabled or not.

isNeedleDraggingEnabled?: string | boolean

Optional isScaleInverted

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.

isScaleInverted?: string | boolean

Optional labelExtent

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.

labelExtent?: string | number

Optional labelFormat

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

labelFormat?: string

Optional labelFormatSpecifiers

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

labelFormatSpecifiers?: any[]

Optional labelInterval

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

labelInterval?: string | number

Optional labelsPostInitial

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

labelsPostInitial?: string | number

Optional labelsPreTerminal

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

labelsPreTerminal?: string | number

Optional labelsVisible

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

labelsVisible?: string | boolean

Optional maximumValue

Gets or sets the maximum value of the scale.

maximumValue?: string | number

Optional mergeViewports

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

mergeViewports?: string | boolean

Optional minimumValue

Gets or sets the minimum value of the scale.

minimumValue?: string | number

Optional minorTickBrush

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

minorTickBrush?: string

Optional minorTickCount

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

minorTickCount?: string | number

Optional minorTickEndExtent

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.

minorTickEndExtent?: string | number

Optional minorTickStartExtent

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.

minorTickStartExtent?: string | number

Optional minorTickStrokeThickness

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

minorTickStrokeThickness?: string | number

Optional needleBreadth

Gets or sets the needle breadth.

needleBreadth?: string | number

Optional needleBrush

Gets or sets the brush to use for needle element.

needleBrush?: string

Optional needleInnerBaseWidth

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

needleInnerBaseWidth?: string | number

Optional needleInnerExtent

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.

needleInnerExtent?: string | number

Optional needleInnerPointExtent

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

needleInnerPointExtent?: string | number

Optional needleInnerPointWidth

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

needleInnerPointWidth?: string | number

Optional needleName

Gets or sets the name used for needle.

needleName?: string

Optional needleOuterBaseWidth

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

needleOuterBaseWidth?: string | number

Optional needleOuterExtent

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.

needleOuterExtent?: string | number

Optional needleOuterPointExtent

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

needleOuterPointExtent?: string | number

Optional needleOuterPointWidth

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

needleOuterPointWidth?: string | number

Optional needleOutline

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

needleOutline?: string

Optional needleShape

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

needleShape?: string | LinearGraphNeedleShape

Optional needleStrokeThickness

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

needleStrokeThickness?: string | number

Optional orientation

Gets or sets the orientation of the scale.

orientation?: string | LinearScaleOrientation

Optional pixelScalingRatio

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

pixelScalingRatio?: string | number

Optional rangeBrushes

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

rangeBrushes?: string | string[]

Optional rangeInnerExtent

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.

rangeInnerExtent?: string | number

Optional rangeOuterExtent

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.

rangeOuterExtent?: string | number

Optional rangeOutlines

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

rangeOutlines?: string | string[]

Optional scaleBrush

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

scaleBrush?: string

Optional scaleEndExtent

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.

scaleEndExtent?: string | number

Optional scaleInnerExtent

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.

scaleInnerExtent?: string | number

Optional scaleOuterExtent

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.

scaleOuterExtent?: string | number

Optional scaleOutline

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

scaleOutline?: string

Optional scaleStartExtent

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.

scaleStartExtent?: string | number

Optional scaleStrokeThickness

Gets or sets the stroke thickness of the scale outline.

scaleStrokeThickness?: string | number

Optional showToolTip

Gets or sets a value indicating whether tooltips are enabled.

showToolTip?: string | boolean

Optional showToolTipTimeout

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

showToolTipTimeout?: string | number

Optional tickBrush

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

tickBrush?: string

Optional tickEndExtent

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.

tickEndExtent?: string | number

Optional ticksPostInitial

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

ticksPostInitial?: string | number

Optional ticksPreTerminal

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

ticksPreTerminal?: string | number

Optional tickStartExtent

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.

tickStartExtent?: string | number

Optional tickStrokeThickness

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

tickStrokeThickness?: string | number

Optional transitionDuration

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

transitionDuration?: string | number

Optional transitionProgress

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

transitionProgress?: string | number

Optional value

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

value?: string | number

Optional valueChanged

Occurs when the Value property changes.

valueChanged?: object

Optional width

width?: string