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

Hierarchy

Hierarchy

  • IgxRadialGaugeComponent

Implements

  • AfterContentInit
  • OnDestroy

Constructors

Properties

Accessors

Methods

Constructors

  • Parameters

    • _renderer: Renderer2
    • _elRef: ViewContainerRef
    • _ngZone: NgZone
    • _componentFactoryResolver: ComponentFactoryResolver
    • _injector: Injector

    Returns IgxRadialGaugeComponent

Properties

_dynamicContent: ViewContainerRef

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: QueryList<IgxRadialGaugeRangeComponent>
ngAcceptInputType_actualMaximumValue: string | number
ngAcceptInputType_actualMinimumValue: string | number
ngAcceptInputType_actualPixelScalingRatio: string | number
ngAcceptInputType_animating: string | boolean
ngAcceptInputType_backingCornerRadius: string | number
ngAcceptInputType_backingInnerExtent: string | number
ngAcceptInputType_backingOuterExtent: string | number
ngAcceptInputType_backingOversweep: string | number
ngAcceptInputType_backingShape: string | RadialGaugeBackingShape
ngAcceptInputType_backingStrokeThickness: string | number
ngAcceptInputType_centerX: string | number
ngAcceptInputType_centerY: string | number
ngAcceptInputType_duplicateLabelOmissionStrategy: string | RadialGaugeDuplicateLabelOmissionStrategy
ngAcceptInputType_interval: string | number
ngAcceptInputType_isNeedleDraggingConstrained: string | boolean
ngAcceptInputType_isNeedleDraggingEnabled: string | boolean
ngAcceptInputType_labelExtent: string | number
ngAcceptInputType_labelFormatSpecifiers: string | any[]
ngAcceptInputType_labelInterval: string | number
ngAcceptInputType_maximumValue: string | number
ngAcceptInputType_minimumValue: string | number
ngAcceptInputType_minorTickCount: string | number
ngAcceptInputType_minorTickEndExtent: string | number
ngAcceptInputType_minorTickStartExtent: string | number
ngAcceptInputType_minorTickStrokeThickness: string | number
ngAcceptInputType_needleBaseFeatureExtent: string | number
ngAcceptInputType_needleBaseFeatureWidthRatio: string | number
ngAcceptInputType_needleEndExtent: string | number
ngAcceptInputType_needleEndWidthRatio: string | number
ngAcceptInputType_needlePivotInnerWidthRatio: string | number
ngAcceptInputType_needlePivotShape: string | RadialGaugePivotShape
ngAcceptInputType_needlePivotStrokeThickness: string | number
ngAcceptInputType_needlePivotWidthRatio: string | number
ngAcceptInputType_needlePointFeatureExtent: string | number
ngAcceptInputType_needlePointFeatureWidthRatio: string | number
ngAcceptInputType_needleShape: string | RadialGaugeNeedleShape
ngAcceptInputType_needleStartExtent: string | number
ngAcceptInputType_needleStartWidthRatio: string | number
ngAcceptInputType_needleStrokeThickness: string | number
ngAcceptInputType_pixelScalingRatio: string | number
ngAcceptInputType_radiusMultiplier: string | number
ngAcceptInputType_rangeBrushes: string | string[]
ngAcceptInputType_rangeOutlines: string | string[]
ngAcceptInputType_scaleEndAngle: string | number
ngAcceptInputType_scaleEndExtent: string | number
ngAcceptInputType_scaleOversweep: string | number
ngAcceptInputType_scaleOversweepShape: string | RadialGaugeScaleOversweepShape
ngAcceptInputType_scaleStartAngle: string | number
ngAcceptInputType_scaleStartExtent: string | number
ngAcceptInputType_scaleSweepDirection: string | SweepDirection
ngAcceptInputType_tickEndExtent: string | number
ngAcceptInputType_tickStartExtent: string | number
ngAcceptInputType_tickStrokeThickness: string | number
ngAcceptInputType_transitionDuration: string | number
ngAcceptInputType_transitionProgress: string | number
ngAcceptInputType_value: string | number
ɵcmp: unknown
ɵfac: unknown

Accessors

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

    Returns number

  • set actualMaximumValue(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualMaximumValueChange(): EventEmitter<number>
  • Returns EventEmitter<number>

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

    Returns number

  • set actualMinimumValue(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualMinimumValueChange(): EventEmitter<number>
  • Returns EventEmitter<number>

  • 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: number): void
  • Parameters

    • v: number

    Returns void

  • get alignLabel(): EventEmitter<{
        args: IgxAlignRadialGaugeLabelEventArgs;
        sender: any;
    }>
  • 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.

    Returns EventEmitter<{
        args: IgxAlignRadialGaugeLabelEventArgs;
        sender: any;
    }>

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

    Returns boolean

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

    Returns string

  • set backingBrush(v: string): void
  • Parameters

    • v: string

    Returns void

  • get backingCornerRadius(): number
  • Gets or sets the corner rounding radius to use for the fitted scale backings.

    Returns number

  • set backingCornerRadius(v: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set backingInnerExtent(v: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set backingOuterExtent(v: number): 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: string): void
  • Parameters

    • v: string

    Returns void

  • get backingOversweep(): 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.

    Returns number

  • set backingOversweep(v: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set backingStrokeThickness(v: number): void
  • Parameters

    • v: number

    Returns void

  • get centerX(): number
  • Gets or sets the x position of the center of the gauge with the value ranging from 0 to 1.

    Returns number

  • set centerX(v: number): void
  • Parameters

    • v: number

    Returns void

  • get centerY(): number
  • Gets or sets the y position of the center of the gauge with the value ranging from 0 to 1.

    Returns number

  • set centerY(v: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set font(v: string): 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: string): void
  • Parameters

    • v: string

    Returns void

  • get formatLabel(): EventEmitter<{
        args: IgxFormatRadialGaugeLabelEventArgs;
        sender: any;
    }>
  • 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.

    Returns EventEmitter<{
        args: IgxFormatRadialGaugeLabelEventArgs;
        sender: any;
    }>

  • get height(): string
  • Returns string

  • set height(value: string): void
  • Parameters

    • value: string

    Returns void

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

    Returns number

  • set interval(v: number): void
  • Parameters

    • v: number

    Returns void

  • get isNeedleDraggingConstrained(): boolean
  • Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging.

    Returns boolean

  • set isNeedleDraggingConstrained(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

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

    Returns boolean

  • set isNeedleDraggingEnabled(v: boolean): 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 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.

    Returns number

  • set labelExtent(v: number): 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: string): 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: any[]): 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: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set maximumValue(v: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set minimumValue(v: number): 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: string): 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: number): 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 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.

    Returns number

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

    Returns number

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

    • v: number

    Returns void

  • get needleBaseFeatureExtent(): 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.

    Returns number

  • set needleBaseFeatureExtent(v: number): void
  • Parameters

    • v: number

    Returns void

  • get needleBaseFeatureWidthRatio(): 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.

    Returns number

  • set needleBaseFeatureWidthRatio(v: number): void
  • Parameters

    • v: number

    Returns void

  • get needleBrush(): string
  • Gets or sets the brush to use when rendering the fill of the needle.

    Returns string

  • set needleBrush(v: string): void
  • Parameters

    • v: string

    Returns void

  • get needleEndExtent(): 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.

    Returns number

  • set needleEndExtent(v: number): void
  • Parameters

    • v: number

    Returns void

  • get needleEndWidthRatio(): 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.

    Returns number

  • set needleEndWidthRatio(v: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set needleOutline(v: string): void
  • Parameters

    • v: string

    Returns void

  • get needlePivotBrush(): string
  • Gets or sets the brush to use for filling the needle cap. Note: this only applies to certain cap shapes.

    Returns string

  • set needlePivotBrush(v: string): void
  • Parameters

    • v: string

    Returns void

  • get needlePivotInnerWidthRatio(): 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.

    Returns number

  • set needlePivotInnerWidthRatio(v: number): void
  • Parameters

    • v: number

    Returns void

  • get needlePivotOutline(): string
  • Gets or sets the brush to use for the outlines of the needle cap.

    Returns string

  • set needlePivotOutline(v: string): void
  • Parameters

    • v: string

    Returns void

  • get needlePivotStrokeThickness(): number
  • Gets or sets the stroke thickness to use for the outline of the needle cap.

    Returns number

  • set needlePivotStrokeThickness(v: number): void
  • Parameters

    • v: number

    Returns void

  • get needlePivotWidthRatio(): 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.

    Returns number

  • set needlePivotWidthRatio(v: number): void
  • Parameters

    • v: number

    Returns void

  • get needlePointFeatureExtent(): 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.

    Returns number

  • set needlePointFeatureExtent(v: number): void
  • Parameters

    • v: number

    Returns void

  • get needlePointFeatureWidthRatio(): 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.

    Returns number

  • set needlePointFeatureWidthRatio(v: number): void
  • Parameters

    • v: number

    Returns void

  • get needleStartExtent(): 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.

    Returns number

  • set needleStartExtent(v: number): void
  • Parameters

    • v: number

    Returns void

  • get needleStartWidthRatio(): 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.

    Returns number

  • set needleStartWidthRatio(v: number): void
  • Parameters

    • v: number

    Returns void

  • get needleStrokeThickness(): number
  • Gets or sets the stroke thickness of the needle outline.

    Returns number

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

    • v: number

    Returns void

  • get radiusMultiplier(): 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.

    Returns number

  • set radiusMultiplier(v: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns string[]

  • set rangeBrushes(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

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

    Returns string[]

  • set rangeOutlines(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get scaleBrush(): string
  • Gets or sets the brush to use to fill the background of the scale.

    Returns string

  • set scaleBrush(v: string): void
  • Parameters

    • v: string

    Returns void

  • get scaleEndAngle(): number
  • Gets or sets the end angle for the scale in degrees.

    Returns number

  • set scaleEndAngle(v: number): void
  • Parameters

    • v: number

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

    Returns number

  • set scaleEndExtent(v: number): void
  • Parameters

    • v: number

    Returns void

  • get scaleOversweep(): number
  • Gets or sets the extra degrees of sweep to apply to the scale background. Must be greater or equal to 0.

    Returns number

  • set scaleOversweep(v: number): void
  • Parameters

    • v: number

    Returns void

  • get scaleStartAngle(): number
  • Gets or sets the start angle for the scale in degrees.

    Returns number

  • set scaleStartAngle(v: number): void
  • Parameters

    • v: number

    Returns void

  • get scaleStartExtent(): 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.

    Returns number

  • set scaleStartExtent(v: number): void
  • Parameters

    • v: number

    Returns void

  • get scaleSweepDirection(): SweepDirection
  • Gets or sets the direction in which the scale sweeps around the center from the start angle to end angle.

    Returns SweepDirection

  • set scaleSweepDirection(v: SweepDirection): void
  • Parameters

    Returns void

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

    Returns string

  • set tickBrush(v: string): 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 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.

    Returns number

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

    Returns number

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

    • v: number

    Returns void

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

    Returns number

  • set transitionDuration(v: number): void
  • Parameters

    • v: number

    Returns void

  • get transitionEasingFunction(): ((time: number) => number)
  • Gets or sets the easing function used to morph the current series.

    Returns ((time: number) => number)

      • (time: number): number
      • Gets or sets the easing function used to morph the current series.

        Parameters

        • time: number

        Returns number

  • set transitionEasingFunction(v: ((time: number) => number)): void
  • Parameters

    • v: ((time: number) => number)
        • (time: number): number
        • Parameters

          • time: number

          Returns number

    Returns void

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

    Returns number

  • set transitionProgress(v: number): void
  • Parameters

    • v: number

    Returns void

  • get value(): number
  • Gets or sets the value at which to point the needle of the gauge.

    Returns number

  • set value(v: number): void
  • Parameters

    • v: number

    Returns void

  • get valueChanged(): EventEmitter<{
        args: IgxDoubleValueChangedEventArgs;
        sender: any;
    }>
  • Occurs when the Value property changes.

    Returns EventEmitter<{
        args: IgxDoubleValueChangedEventArgs;
        sender: any;
    }>

  • get width(): string
  • Returns string

  • set width(value: string): void
  • Parameters

    • value: string

    Returns void

Methods

  • Returns void

  • Returns visuals as a serialized string.

    Returns string

  • Parameters

    • name: string

    Returns any

  • Use to force the radial gauge to finish any deferred work before printing or evaluating its visual. This should only be called if the visual of the radial gauge needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the radial gauge.

    Returns void

  • Parameters

    • value: number
    • extent: number

    Returns IgPoint

  • 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

    Returns boolean

  • Returns void

  • Returns void

  • Called by the UI framework to provide a UI container for rendering this control.

    Parameters

    • container: any
      • The UI container element.

    Returns void

  • Scales a value on the gauge's main scale to an angle around the center point of the gauge, in radians.

    Parameters

    • value: number
      • The value to scale.

    Returns number

  • Returns void

  • Unscales a value from an angle in radians to the represented value along the main scale of the gauge.

    Parameters

    • angle: number
      • The angle in radians to unscale to a value.

    Returns number