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

Constructors

Section titled "Constructors"

IgrLinearGauge

new IgrLinearGauge(props: IIgrLinearGaugeProps): IgrLinearGauge

Returns IgrLinearGauge

Properties

Section titled "Properties"

actualRanges

Section titled "actualRanges"

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.

 
actualRanges: IgrLinearGraphRange[]

contentRanges

Section titled "contentRanges" 
contentRanges: IgrLinearGraphRange[]

actualHighlightValueDisplayMode

Section titled "actualHighlightValueDisplayMode" 
actualHighlightValueDisplayMode: HighlightedValueDisplayMode

actualHighlightValueOpacity

Section titled "actualHighlightValueOpacity" 
actualHighlightValueOpacity: number

actualMaximumValue

Section titled "actualMaximumValue" 
actualMaximumValue: number

actualMaximumValueChange

Section titled "actualMaximumValueChange" 
actualMaximumValueChange: object

actualMinimumValue

Section titled "actualMinimumValue" 
actualMinimumValue: number

actualMinimumValueChange

Section titled "actualMinimumValueChange" 
actualMinimumValueChange: object

actualPixelScalingRatio

Section titled "actualPixelScalingRatio" 
actualPixelScalingRatio: number

alignLabel

Section titled "alignLabel" 
alignLabel: object

backingBrush

Section titled "backingBrush" 
backingBrush: string

backingInnerExtent

Section titled "backingInnerExtent" 
backingInnerExtent: number

backingOuterExtent

Section titled "backingOuterExtent" 
backingOuterExtent: number

backingOutline

Section titled "backingOutline" 
backingOutline: string

backingStrokeThickness

Section titled "backingStrokeThickness" 
backingStrokeThickness: number

font

Section titled "font" 
font: string

fontBrush

Section titled "fontBrush" 
fontBrush: string

formatLabel

Section titled "formatLabel" 
formatLabel: object

height

Section titled "height" 
height: string

highlightValue

Section titled "highlightValue" 
highlightValue: number

highlightValueChanged

Section titled "highlightValueChanged" 
highlightValueChanged: object

highlightValueDisplayMode

Section titled "highlightValueDisplayMode" 
highlightValueDisplayMode: HighlightedValueDisplayMode

highlightValueOpacity

Section titled "highlightValueOpacity" 
highlightValueOpacity: number

interval

Section titled "interval" 
interval: number

isHighlightNeedleDraggingEnabled

Section titled "isHighlightNeedleDraggingEnabled" 
isHighlightNeedleDraggingEnabled: boolean

isNeedleDraggingEnabled

Section titled "isNeedleDraggingEnabled" 
isNeedleDraggingEnabled: boolean

isScaleInverted

Section titled "isScaleInverted" 
isScaleInverted: boolean

labelExtent

Section titled "labelExtent" 
labelExtent: number

labelFormat

Section titled "labelFormat" 
labelFormat: string

labelFormatSpecifiers

Section titled "labelFormatSpecifiers" 
labelFormatSpecifiers: any[]

labelInterval

Section titled "labelInterval" 
labelInterval: number

labelsPostInitial

Section titled "labelsPostInitial" 
labelsPostInitial: number

labelsPreTerminal

Section titled "labelsPreTerminal" 
labelsPreTerminal: number

labelsVisible

Section titled "labelsVisible" 
labelsVisible: boolean

maximumValue

Section titled "maximumValue" 
maximumValue: number

mergeViewports

Section titled "mergeViewports" 
mergeViewports: boolean

minimumValue

Section titled "minimumValue" 
minimumValue: number

minorTickBrush

Section titled "minorTickBrush" 
minorTickBrush: string

minorTickCount

Section titled "minorTickCount" 
minorTickCount: number

minorTickEndExtent

Section titled "minorTickEndExtent" 
minorTickEndExtent: number

minorTickStartExtent

Section titled "minorTickStartExtent" 
minorTickStartExtent: number

minorTickStrokeThickness

Section titled "minorTickStrokeThickness" 
minorTickStrokeThickness: number

needleBreadth

Section titled "needleBreadth" 
needleBreadth: number

needleBrush

Section titled "needleBrush" 
needleBrush: string

needleInnerBaseWidth

Section titled "needleInnerBaseWidth" 
needleInnerBaseWidth: number

needleInnerExtent

Section titled "needleInnerExtent" 
needleInnerExtent: number

needleInnerPointExtent

Section titled "needleInnerPointExtent" 
needleInnerPointExtent: number

needleInnerPointWidth

Section titled "needleInnerPointWidth" 
needleInnerPointWidth: number

needleName

Section titled "needleName" 
needleName: string

needleOuterBaseWidth

Section titled "needleOuterBaseWidth" 
needleOuterBaseWidth: number

needleOuterExtent

Section titled "needleOuterExtent" 
needleOuterExtent: number

needleOuterPointExtent

Section titled "needleOuterPointExtent" 
needleOuterPointExtent: number

needleOuterPointWidth

Section titled "needleOuterPointWidth" 
needleOuterPointWidth: number

needleOutline

Section titled "needleOutline" 
needleOutline: string

needleShape

Section titled "needleShape" 
needleShape: LinearGraphNeedleShape

needleStrokeThickness

Section titled "needleStrokeThickness" 
needleStrokeThickness: number

orientation

Section titled "orientation" 
orientation: LinearScaleOrientation

pixelScalingRatio

Section titled "pixelScalingRatio" 
pixelScalingRatio: number

rangeBrushes

Section titled "rangeBrushes" 
rangeBrushes: string[]

rangeInnerExtent

Section titled "rangeInnerExtent" 
rangeInnerExtent: number

rangeOuterExtent

Section titled "rangeOuterExtent" 
rangeOuterExtent: number

rangeOutlines

Section titled "rangeOutlines" 
rangeOutlines: string[]

scaleBrush

Section titled "scaleBrush" 
scaleBrush: string

scaleEndExtent

Section titled "scaleEndExtent" 
scaleEndExtent: number

scaleInnerExtent

Section titled "scaleInnerExtent" 
scaleInnerExtent: number

scaleOuterExtent

Section titled "scaleOuterExtent" 
scaleOuterExtent: number

scaleOutline

Section titled "scaleOutline" 
scaleOutline: string

scaleStartExtent

Section titled "scaleStartExtent" 
scaleStartExtent: number

scaleStrokeThickness

Section titled "scaleStrokeThickness" 
scaleStrokeThickness: number

showToolTip

Section titled "showToolTip" 
showToolTip: boolean

showToolTipTimeout

Section titled "showToolTipTimeout" 
showToolTipTimeout: number

tickBrush

Section titled "tickBrush" 
tickBrush: string

tickEndExtent

Section titled "tickEndExtent" 
tickEndExtent: number

ticksPostInitial

Section titled "ticksPostInitial" 
ticksPostInitial: number

ticksPreTerminal

Section titled "ticksPreTerminal" 
ticksPreTerminal: number

tickStartExtent

Section titled "tickStartExtent" 
tickStartExtent: number

tickStrokeThickness

Section titled "tickStrokeThickness" 
tickStrokeThickness: number

tooltipTemplate

Section titled "tooltipTemplate" 
tooltipTemplate: any

transitionDuration

Section titled "transitionDuration" 
transitionDuration: number

transitionProgress

Section titled "transitionProgress" 
transitionProgress: number

value

Section titled "value" 
value: number

valueChanged

Section titled "valueChanged" 
valueChanged: object

width

Section titled "width" 
width: string

Accessors

Section titled "Accessors"

animating

Section titled "animating"

Gets a value indicating whether the bullet graph is currently animating.

get animating(): boolean

Returns boolean

nativeElement

Section titled "nativeElement" 
get nativeElement(): HTMLElement

Returns HTMLElement

ranges

Section titled "ranges"

A collection or manually added axes for the chart.

get ranges(): IgrLinearGraphRangeCollection

Returns IgrLinearGraphRangeCollection

Methods

Section titled "Methods"

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): void

Returns void

componentWillUnmount

Section titled "componentWillUnmount" 
componentWillUnmount(): void

Returns void

containerResized

Section titled "containerResized" 
containerResized(): void

Returns void

destroy

Section titled "destroy" 
destroy(): void

Returns void

exportSerializedVisualData

Section titled "exportSerializedVisualData"

Returns visuals as a serialized string.

exportSerializedVisualData(): string

Returns string

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

flush

Section titled "flush"

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.

flush(): void

Returns void

getValueForPoint

Section titled "getValueForPoint"

Gets the value for the main scale of the gauge for a given point within the bounds of the gauge.

getValueForPoint(point: IgPoint): number

Parameters

  • point: IgPoint
    • The point for which to retrieve the associated value.

Returns number

highlightNeedleContainsPoint

Section titled "highlightNeedleContainsPoint" 
highlightNeedleContainsPoint(point: IgPoint, isFinger: boolean): boolean

Parameters

  • point: IgPoint
  • isFinger: boolean

Returns boolean

initializeContent

Section titled "initializeContent" 
initializeContent(): void

Returns void

needleContainsPoint

Section titled "needleContainsPoint" 
needleContainsPoint(point: IgPoint, isFinger: boolean): boolean

Parameters

  • point: IgPoint
  • isFinger: boolean

Returns boolean

provideContainer

Section titled "provideContainer"

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

provideContainer(container: any): void

Parameters

  • container: any
    • The UI container element.

Returns void

render

Section titled "render" 
render(): DetailedReactHTMLElement<object, HTMLDivElement>

Returns DetailedReactHTMLElement<object, HTMLDivElement>

shouldComponentUpdate

Section titled "shouldComponentUpdate" 
shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

styleUpdated

Section titled "styleUpdated" 
styleUpdated(): void

Returns void

_createFromInternal

Section titled "_createFromInternal" 
_createFromInternal(internal: any): IgrLinearGauge

Parameters

  • internal: any

Returns IgrLinearGauge