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

Hierarchy

Hierarchy

  • IgxLinearGaugeComponent

Implements

  • AfterContentInit
  • OnDestroy

Constructors

Properties

Accessors

Methods

Constructors

  • Parameters

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

    Returns IgxLinearGaugeComponent

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<IgxLinearGraphRangeComponent>
ngAcceptInputType_actualMaximumValue: string | number
ngAcceptInputType_actualMinimumValue: string | number
ngAcceptInputType_actualPixelScalingRatio: string | number
ngAcceptInputType_animating: string | boolean
ngAcceptInputType_backingInnerExtent: string | number
ngAcceptInputType_backingOuterExtent: string | number
ngAcceptInputType_backingStrokeThickness: string | number
ngAcceptInputType_interval: string | number
ngAcceptInputType_isNeedleDraggingEnabled: string | boolean
ngAcceptInputType_isScaleInverted: string | boolean
ngAcceptInputType_labelExtent: string | number
ngAcceptInputType_labelFormatSpecifiers: string | any[]
ngAcceptInputType_labelInterval: string | number
ngAcceptInputType_labelsPostInitial: string | number
ngAcceptInputType_labelsPreTerminal: 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_needleBreadth: string | number
ngAcceptInputType_needleInnerBaseWidth: string | number
ngAcceptInputType_needleInnerExtent: string | number
ngAcceptInputType_needleInnerPointExtent: string | number
ngAcceptInputType_needleInnerPointWidth: string | number
ngAcceptInputType_needleOuterBaseWidth: string | number
ngAcceptInputType_needleOuterExtent: string | number
ngAcceptInputType_needleOuterPointExtent: string | number
ngAcceptInputType_needleOuterPointWidth: string | number
ngAcceptInputType_needleShape: string | LinearGraphNeedleShape
ngAcceptInputType_needleStrokeThickness: string | number
ngAcceptInputType_orientation: string | LinearScaleOrientation
ngAcceptInputType_pixelScalingRatio: string | number
ngAcceptInputType_rangeBrushes: string | string[]
ngAcceptInputType_rangeInnerExtent: string | number
ngAcceptInputType_rangeOuterExtent: string | number
ngAcceptInputType_rangeOutlines: string | string[]
ngAcceptInputType_scaleEndExtent: string | number
ngAcceptInputType_scaleInnerExtent: string | number
ngAcceptInputType_scaleOuterExtent: string | number
ngAcceptInputType_scaleStartExtent: string | number
ngAcceptInputType_scaleStrokeThickness: string | number
ngAcceptInputType_showToolTip: string | boolean
ngAcceptInputType_showToolTipTimeout: string | number
ngAcceptInputType_tickEndExtent: string | number
ngAcceptInputType_tickStartExtent: string | number
ngAcceptInputType_tickStrokeThickness: string | number
ngAcceptInputType_ticksPostInitial: string | number
ngAcceptInputType_ticksPreTerminal: 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: IgxAlignLinearGraphLabelEventArgs;
        sender: any;
    }>
  • 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.

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

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

    Returns boolean

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

    Returns string

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

    • v: string

    Returns void

  • get backingInnerExtent(): number
  • Gets or sets the inner extent of the linear 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 linear 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 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 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: IgxFormatLinearGraphLabelEventArgs;
        sender: any;
    }>
  • 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.

    Returns EventEmitter<{
        args: IgxFormatLinearGraphLabelEventArgs;
        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 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 isScaleInverted(): boolean
  • Gets or sets a value indicating whether the scale is inverted. When the scale is inverted the direction in which the scale values increase is right to left.

    Returns boolean

  • set isScaleInverted(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 from the bottom of the scale. Values further from zero than 1 can be used to hide the labels of the linear 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 labelsPostInitial(): number
  • A value to start adding labels, added to the scale's MinimumValue.

    Returns number

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

    • v: number

    Returns void

  • get labelsPreTerminal(): number
  • A value to stop adding labels, subtracted from the scale's MaximumValue.

    Returns number

  • set labelsPreTerminal(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 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.

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

    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 needleBreadth(): number
  • Gets or sets the needle breadth.

    Returns number

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

    • v: number

    Returns void

  • get needleBrush(): string
  • Gets or sets the brush to use for needle element.

    Returns string

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

    • v: string

    Returns void

  • get needleInnerBaseWidth(): number
  • Gets or sets the width of the needle's inner base.

    Returns number

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

    • v: number

    Returns void

  • get needleInnerExtent(): number
  • Gets or sets the position at which to start rendering the needle geometry, measured from the front/bottom of the linear gauge as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

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

    • v: number

    Returns void

  • get needleInnerPointExtent(): number
  • Gets or sets the extent of the needle's inner point.

    Returns number

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

    • v: number

    Returns void

  • get needleInnerPointWidth(): number
  • Gets or sets the width of the needle's inner point.

    Returns number

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

    • v: number

    Returns void

  • get needleName(): string
  • Gets or sets the name used for needle.

    Returns string

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

    • v: string

    Returns void

  • get needleOuterBaseWidth(): number
  • Gets or sets the width of the needle's outer base.

    Returns number

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

    • v: number

    Returns void

  • get needleOuterExtent(): number
  • Gets or sets the position at which to stop rendering the needle geometry as a value from 0 to 1 measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

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

    • v: number

    Returns void

  • get needleOuterPointExtent(): number
  • Gets or sets the extent of the needle's outer point.

    Returns number

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

    • v: number

    Returns void

  • get needleOuterPointWidth(): number
  • Gets or sets the width of the needle's outer point.

    Returns number

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

    • v: number

    Returns void

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

    Returns string

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

    • v: string

    Returns void

  • get needleStrokeThickness(): number
  • Gets or sets the stroke thickness to use when rendering single actual value element.

    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 rangeBrushes(): string[]
  • Gets or sets a collection of brushes to be used as the palette for linear gauge ranges.

    Returns string[]

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

    • v: string[]

    Returns void

  • get rangeInnerExtent(): number
  • Gets or sets the position at which to start rendering the ranges, measured from the front/bottom of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

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

    • v: number

    Returns void

  • get rangeOuterExtent(): number
  • Gets or sets the position at which to stop rendering the range as a value from 0 to 1 measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

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

    • v: number

    Returns void

  • get rangeOutlines(): string[]
  • Gets or sets a collection of brushes to be used as the palette for linear 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 scale of the linear gauge.

    Returns string

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

    • v: string

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

    Returns number

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

    • v: number

    Returns void

  • get scaleInnerExtent(): number
  • Gets or sets the position at which to start rendering the scale, measured from the bottom/front (when orientation is horizontal/vertical) of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

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

    • v: number

    Returns void

  • get scaleOuterExtent(): number
  • Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the bottom/front (when orientation is horizontal/vertical) of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

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

    • v: number

    Returns void

  • get scaleOutline(): string
  • Gets or sets the brush to use for the outline of the scale.

    Returns string

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

    • v: string

    Returns void

  • get scaleStartExtent(): number
  • Gets or sets the position at which to start rendering the scale, measured from the front/bottom of the linear gauge as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

    Returns number

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

    • v: number

    Returns void

  • get scaleStrokeThickness(): number
  • Gets or sets the stroke thickness of the scale outline.

    Returns number

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

    • v: number

    Returns void

  • get showToolTip(): boolean
  • Gets or sets a value indicating whether tooltips are enabled.

    Returns boolean

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

    • v: boolean

    Returns void

  • get showToolTipTimeout(): number
  • Gets or sets the time in milliseconds that tooltip appearance is delayed with.

    Returns number

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

    • v: number

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

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

    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 ticksPostInitial(): number
  • A value to start adding tickmarks, added to the scale's MinimumValue.

    Returns number

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

    • v: number

    Returns void

  • get ticksPreTerminal(): number
  • A value to stop adding tickmarks, subtracted from the scale's MaximumValue.

    Returns number

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

    • v: number

    Returns void

  • get tooltipTemplate(): TemplateRef<any>
  • Returns TemplateRef<any>

  • set tooltipTemplate(value: TemplateRef<any>): void
  • Parameters

    • value: TemplateRef<any>

    Returns void

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

    Returns number

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

    • v: 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 the needle is positioned.

    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 linear gauge to finish any deferred work before printing or evaluating its visual. This should only be called if the visual of the linear gauge needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the linear gauge.

    Returns void

  • 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

  • Returns void