Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrRadialGaugeProps

Hierarchy

Hierarchy

  • IIgrRadialGaugeProps

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 alignHighlightLabel

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

Type declaration

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

Optional alignLabel

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

Type declaration

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

Optional alignSubtitle

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

Type declaration

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

Optional alignTitle

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

Type declaration

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

Optional backingBrush

backingBrush?: string

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

Optional backingCornerRadius

backingCornerRadius?: string | number

Gets or sets the corner rounding radius to use for the fitted scale backings.

Optional backingInnerExtent

backingInnerExtent?: string | number

Gets or sets the inner extent of the gauge backing.

Optional backingOuterExtent

backingOuterExtent?: string | number

Gets or sets the outer extent of the gauge backing.

Optional backingOutline

backingOutline?: string

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

Optional backingOversweep

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

Optional backingShape

backingShape?: string | RadialGaugeBackingShape

Gets or sets the type of shape to use for the backing of the gauge.

Optional backingStrokeThickness

backingStrokeThickness?: string | number

Gets or sets the stroke thickness of the backing outline.

Optional centerX

centerX?: string | number

Gets or sets the x position of the center of the gauge with the value ranging from 0 to 1.

Optional centerY

centerY?: string | number

Gets or sets the y position of the center of the gauge with the value ranging from 0 to 1.

Optional children

children?: ReactNode

Optional duplicateLabelOmissionStrategy

duplicateLabelOmissionStrategy?: string | RadialGaugeDuplicateLabelOmissionStrategy

Gets or sets the strategy to use for omitting labels if the first and last label have the same value.

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 formatHighlightLabel

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

Type declaration

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

Optional formatLabel

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

Type declaration

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

Optional formatSubtitle

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

Type declaration

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

Optional formatTitle

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

Type declaration

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

Optional height

height?: string

Optional highlightLabelAngle

highlightLabelAngle?: string | number

Gets or sets the angle for the highlight label in degrees.

Optional highlightLabelBrush

highlightLabelBrush?: string

Gets or sets the brush to use for rendering highlight text

Optional highlightLabelDisplaysValue

highlightLabelDisplaysValue?: string | boolean

Gets or sets the highlight label shows values of the gauge.

Optional highlightLabelExtent

highlightLabelExtent?: string | number

Gets or sets the angle for the highlight label in degrees.

Optional highlightLabelFormat

highlightLabelFormat?: string

Gets or sets the format used when creating highlight label.

Optional highlightLabelFormatSpecifiers

highlightLabelFormatSpecifiers?: any[]

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

Optional highlightLabelSnapsToNeedlePivot

highlightLabelSnapsToNeedlePivot?: string | boolean

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

Optional highlightLabelText

highlightLabelText?: string

Gets or sets the text displayed for the highlight label of the gauge.

Optional highlightLabelTextStyle

highlightLabelTextStyle?: string

Gets or Sets the style to use for the units text.

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 isHighlightNeedleDraggingConstrained

isHighlightNeedleDraggingConstrained?: string | boolean

Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging.

Optional isHighlightNeedleDraggingEnabled

isHighlightNeedleDraggingEnabled?: string | boolean

Gets or sets whether needle dragging is enabled or not.

Optional isNeedleDraggingConstrained

isNeedleDraggingConstrained?: string | boolean

Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging.

Optional isNeedleDraggingEnabled

isNeedleDraggingEnabled?: string | boolean

Gets or sets whether needle dragging is enabled or not.

Optional labelExtent

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

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 maximumValue

maximumValue?: string | number

Gets or sets the maximum value of the scale.

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

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

Optional minorTickStrokeThickness

minorTickStrokeThickness?: string | number

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

Optional needleBaseFeatureExtent

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

Optional needleBaseFeatureWidthRatio

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

Optional needleBrush

needleBrush?: string

Gets or sets the brush to use when rendering the fill of the needle.

Optional needleEndExtent

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

Optional needleEndWidthRatio

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

Optional needleOutline

needleOutline?: string

Gets or sets the brush to use when rendering the outline of the needle.

Optional needlePivotBrush

needlePivotBrush?: string

Gets or sets the brush to use for filling the needle cap. Note: this only applies to certain cap shapes.

Optional needlePivotInnerWidthRatio

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

Optional needlePivotOutline

needlePivotOutline?: string

Gets or sets the brush to use for the outlines of the needle cap.

Optional needlePivotShape

needlePivotShape?: string | RadialGaugePivotShape

Gets or sets the shape to use for the needle cap.

Optional needlePivotStrokeThickness

needlePivotStrokeThickness?: string | number

Gets or sets the stroke thickness to use for the outline of the needle cap.

Optional needlePivotWidthRatio

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

Optional needlePointFeatureExtent

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

Optional needlePointFeatureWidthRatio

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

Optional needleShape

needleShape?: string | RadialGaugeNeedleShape

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

Optional needleStartExtent

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

Optional needleStartWidthRatio

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

Optional needleStrokeThickness

needleStrokeThickness?: string | number

Gets or sets the stroke thickness of the needle outline.

Optional opticalScalingEnabled

opticalScalingEnabled?: string | boolean

Gets or sets the title uses optical scaling when the gauge is resized.

Optional opticalScalingRatio

opticalScalingRatio?: string | number

Gets the optical scaling ratio calculated by dividing minimum gauge size by value of OpticalScalingSize property.

Optional opticalScalingSize

opticalScalingSize?: string | 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

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 radiusMultiplier

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

Optional rangeBrushes

rangeBrushes?: string | string[]

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

Optional rangeOutlines

rangeOutlines?: string | string[]

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

Optional scaleBrush

scaleBrush?: string

Gets or sets the brush to use to fill the background of the scale.

Optional scaleEndAngle

scaleEndAngle?: string | number

Gets or sets the end angle for the scale in degrees.

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

Optional scaleOversweep

scaleOversweep?: string | number

Gets or sets the extra degrees of sweep to apply to the scale background. Must be greater or equal to 0.

Optional scaleOversweepShape

scaleOversweepShape?: string | RadialGaugeScaleOversweepShape

Gets or sets the oversweep shape to use for the excess fill area for the scale.

Optional scaleStartAngle

scaleStartAngle?: string | number

Gets or sets the start angle for the scale in degrees.

Optional scaleStartExtent

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

Optional scaleSweepDirection

scaleSweepDirection?: string | SweepDirection

Gets or sets the direction in which the scale sweeps around the center from the start angle to end angle.

Optional subtitleAngle

subtitleAngle?: string | number

Gets or sets the angle for the inner label in degrees.

Optional subtitleBrush

subtitleBrush?: string

Gets or sets the brush to use for rendering inner unit text

Optional subtitleDisplaysValue

subtitleDisplaysValue?: string | boolean

Gets or sets the subtitle show values of the gauge.

Optional subtitleExtent

subtitleExtent?: string | number

Gets or sets the angle for the inner label in degrees.

Optional subtitleFormat

subtitleFormat?: string

Gets or sets the subtitle format used when creating subtitle label.

Optional subtitleFormatSpecifiers

subtitleFormatSpecifiers?: any[]

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

Optional subtitleSnapsToNeedlePivot

subtitleSnapsToNeedlePivot?: string | boolean

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

Optional subtitleText

subtitleText?: string

Gets or sets the text displayed in the subtitle of the gauge.

Optional subtitleTextStyle

subtitleTextStyle?: string

Gets or Sets the style to use for the units text.

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

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

Optional tickStrokeThickness

tickStrokeThickness?: string | number

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

Optional titleAngle

titleAngle?: string | number

Gets or sets the angle for the inner label in degrees.

Optional titleBrush

titleBrush?: string

Gets or sets the brush to use for rendering inner unit text

Optional titleDisplaysValue

titleDisplaysValue?: string | boolean

Gets or sets the title show values of the gauge.

Optional titleExtent

titleExtent?: string | number

Gets or sets the angle for the inner label in degrees.

Optional titleFormat

titleFormat?: string

Gets or sets the title format used when creating title label.

Optional titleFormatSpecifiers

titleFormatSpecifiers?: any[]

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

Optional titleSnapsToNeedlePivot

titleSnapsToNeedlePivot?: string | boolean

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

Optional titleText

titleText?: string

Gets or sets the text displayed in the title of the gauge.

Optional titleTextStyle

titleTextStyle?: string

Gets or Sets the style to use for the units text.

Optional transitionDuration

transitionDuration?: string | number

Gets or sets the number of milliseconds over which changes to the 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 to point the needle of the gauge.

Optional valueChanged

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

Type declaration

    • (s, e): void

    • Occurs when the Value property changes.

      Parameters

      Returns void

Optional width

width?: string