Class IgxRadialGaugeComponent

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

Hierarchy

  • IgxRadialGaugeComponent

Implements

  • AfterContentInit
  • OnDestroy

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new IgxRadialGaugeComponent(_renderer: Renderer2, _elRef: ViewContainerRef, _ngZone: NgZone, _componentFactoryResolver: ComponentFactoryResolver, _injector: Injector): IgxRadialGaugeComponent
  • Parameters

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

    Returns IgxRadialGaugeComponent

Properties

_dynamicContent

_dynamicContent: ViewContainerRef

actualRanges

actualRanges: IgxRadialGaugeRangeComponent[] = []

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: QueryList<IgxRadialGaugeRangeComponent>

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(): EventEmitter<object>
  • 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<object>

animating

  • get animating(): boolean
  • Gets a value indicating whether the radial gauge 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 gauge.

    Returns string

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

    Parameters

    • v: string

    Returns void

backingCornerRadius

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

    Returns number

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

    Parameters

    • v: number

    Returns void

backingInnerExtent

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

    Returns number

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

    Parameters

    • v: number

    Returns void

backingOuterExtent

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

    Returns number

  • Gets or sets the outer extent of the 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

backingOversweep

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

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

    Parameters

    • v: number

    Returns void

backingShape

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

    Returns RadialGaugeBackingShape

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

    Parameters

    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

centerX

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

    Returns number

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

    Parameters

    • v: number

    Returns void

centerY

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

    Returns number

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

    Parameters

    • v: number

    Returns void

duplicateLabelOmissionStrategy

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

    Returns RadialGaugeDuplicateLabelOmissionStrategy

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

    Parameters

    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(): EventEmitter<object>
  • 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<object>

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

isNeedleDraggingConstrained

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

    Returns boolean

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

    Parameters

    • v: boolean

    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

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

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

    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

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

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

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

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

    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

needleBaseFeatureExtent

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

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

    Parameters

    • v: number

    Returns void

needleBaseFeatureWidthRatio

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

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

    Parameters

    • v: number

    Returns void

needleBrush

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

    Returns string

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

    Parameters

    • v: string

    Returns void

needleEndExtent

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

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

    Parameters

    • v: number

    Returns void

needleEndWidthRatio

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

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

    Parameters

    • v: number

    Returns void

needleOutline

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

    Returns string

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

    Parameters

    • v: string

    Returns void

needlePivotBrush

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

    Returns string

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

    Parameters

    • v: string

    Returns void

needlePivotInnerWidthRatio

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

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

    Parameters

    • v: number

    Returns void

needlePivotOutline

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

    Returns string

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

    Parameters

    • v: string

    Returns void

needlePivotShape

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

    Returns RadialGaugePivotShape

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

    Parameters

    Returns void

needlePivotStrokeThickness

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

    Returns number

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

    Parameters

    • v: number

    Returns void

needlePivotWidthRatio

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

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

    Parameters

    • v: number

    Returns void

needlePointFeatureExtent

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

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

    Parameters

    • v: number

    Returns void

needlePointFeatureWidthRatio

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

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

    Parameters

    • v: number

    Returns void

needleShape

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

    Returns RadialGaugeNeedleShape

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

    Parameters

    Returns void

needleStartExtent

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

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

    Parameters

    • v: number

    Returns void

needleStartWidthRatio

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

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

    Parameters

    • v: number

    Returns void

needleStrokeThickness

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

    Returns number

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

    Parameters

    • v: number

    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

radiusMultiplier

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

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

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

    Returns string[]

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

    Parameters

    • v: string[]

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

    Returns string[]

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

    Parameters

    • v: string[]

    Returns void

ranges

  • get ranges(): RadialGaugeRangeCollection
  • A collection or manually added axes for the chart.

    Returns RadialGaugeRangeCollection

scaleBrush

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

    Returns string

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

    Parameters

    • v: string

    Returns void

scaleEndAngle

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

    Returns number

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

    Parameters

    • v: number

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

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

    Parameters

    • v: number

    Returns void

scaleOversweep

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

    Returns number

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

    Parameters

    • v: number

    Returns void

scaleOversweepShape

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

    Returns RadialGaugeScaleOversweepShape

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

    Parameters

    Returns void

scaleStartAngle

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

    Returns number

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

    Parameters

    • v: number

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

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

    Parameters

    • v: number

    Returns void

scaleSweepDirection

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

    Returns SweepDirection

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

    Parameters

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

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

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

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

    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

transitionDuration

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

    Returns number

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

    Parameters

    • v: number

    Returns void

transitionEasingFunction

  • get transitionEasingFunction(): function
  • set transitionEasingFunction(v: function): void
  • Gets or sets the easing function used to morph the current series.

    Returns function

      • (time: number): number
      • Parameters

        • time: number

        Returns number

  • Gets or sets the easing function used to morph the current series.

    Parameters

    • v: function
        • (time: number): number
        • Parameters

          • time: number

          Returns 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 to point the needle of the gauge.

    Returns number

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

    Parameters

    • v: number

    Returns void

width

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

  • Parameters

    • value: string

    Returns void

Methods

containerResized

  • containerResized(): void
  • Returns void

exportSerializedVisualData

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

    Returns string

flush

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

getPointForValue

  • getPointForValue(value: number, extent: number): IgPoint
  • Parameters

    • value: number
    • extent: number

    Returns IgPoint

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

needleContainsPoint

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

    Returns boolean

ngAfterContentInit

  • ngAfterContentInit(): void
  • Returns void

ngOnDestroy

  • ngOnDestroy(): void
  • Returns void

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

scaleValue

  • scaleValue(value: number): number
  • 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

styleUpdated

  • styleUpdated(): void
  • Returns void

unscaleValue

  • unscaleValue(angle: number): number
  • 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

Static _createFromInternal

  • Parameters

    • internal: any

    Returns IgxRadialGaugeComponent