IgrNumericXAxis

Represents a DataChartComponent numeric X axis.

The NumericXAxis treats the data as continuously varying numerical data items. Labels on this axis are placed along the X-axis. The location of labels varies according to the value in a data column that is mapped using the XMemberPath property of Scatter Series or ValueMemberPath property of Bar Series.

Constructors

new IgrNumericXAxis(props: IIgrNumericXAxisProps): IgrNumericXAxis

Returns IgrNumericXAxis

Properties

abbreviatedLabelFormat

Inherited from: IgrStraightNumericAxisBase

abbreviatedLabelFormat: string

abbreviatedLabelFormatSpecifiers

Inherited from: IgrStraightNumericAxisBase

abbreviatedLabelFormatSpecifiers: any[]

abbreviateLargeNumbers

Inherited from: IgrStraightNumericAxisBase

abbreviateLargeNumbers: boolean

actualInterval

Inherited from: IgrStraightNumericAxisBase

actualInterval: number

actualIntervalChange

Inherited from: IgrStraightNumericAxisBase

actualIntervalChange: object

actualIsLogarithmic

Inherited from: IgrStraightNumericAxisBase

actualIsLogarithmic: boolean

actualMajorStroke

Inherited from: IgrStraightNumericAxisBase

actualMajorStroke: string

actualMaximumValue

Inherited from: IgrStraightNumericAxisBase

actualMaximumValue: number

actualMaximumValueChange

Inherited from: IgrStraightNumericAxisBase

actualMaximumValueChange: object

actualMaxPrecision

Inherited from: IgrStraightNumericAxisBase

actualMaxPrecision: number

actualMinimumValue

Inherited from: IgrStraightNumericAxisBase

actualMinimumValue: number

actualMinimumValueChange

Inherited from: IgrStraightNumericAxisBase

actualMinimumValueChange: object

actualMinorInterval

Inherited from: IgrStraightNumericAxisBase

actualMinorInterval: number

actualMinorIntervalChange

Inherited from: IgrStraightNumericAxisBase

actualMinorIntervalChange: object

actualMinorStroke

Inherited from: IgrStraightNumericAxisBase

actualMinorStroke: string

actualStroke

Inherited from: IgrStraightNumericAxisBase

actualStroke: string

actualVisibleMaximumValue

Inherited from: IgrStraightNumericAxisBase

actualVisibleMaximumValue: number

actualVisibleMinimumValue

Inherited from: IgrStraightNumericAxisBase

actualVisibleMinimumValue: number

annotations

Inherited from: IgrStraightNumericAxisBase

annotations: IgrAxisAnnotationCollection

autoRangeBufferMode

Inherited from: IgrStraightNumericAxisBase

autoRangeBufferMode: AxisRangeBufferMode

coercionMethods

Inherited from: IgrStraightNumericAxisBase

coercionMethods: any

companionAxisCrossingAxis

Inherited from: IgrStraightNumericAxisBase

companionAxisCrossingAxis: IgrAxis

companionAxisCrossingAxisName

Inherited from: IgrStraightNumericAxisBase

companionAxisCrossingAxisName: string

companionAxisCrossingValue

Inherited from: IgrStraightNumericAxisBase

companionAxisCrossingValue: number

companionAxisEnabled

Inherited from: IgrStraightNumericAxisBase

companionAxisEnabled: boolean

companionAxisInterval

Inherited from: IgrStraightNumericAxisBase

companionAxisInterval: number

companionAxisIsInverted

Inherited from: IgrStraightNumericAxisBase

companionAxisIsInverted: FeatureState

companionAxisIsLogarithmic

Inherited from: IgrStraightNumericAxisBase

companionAxisIsLogarithmic: FeatureState

companionAxisLabelAngle

Inherited from: IgrStraightNumericAxisBase

companionAxisLabelAngle: number

companionAxisLabelColor

Inherited from: IgrStraightNumericAxisBase

companionAxisLabelColor: string

companionAxisLabelExtent

Inherited from: IgrStraightNumericAxisBase

companionAxisLabelExtent: number

companionAxisLabelHorizontalAlignment

Inherited from: IgrStraightNumericAxisBase

companionAxisLabelHorizontalAlignment: HorizontalAlignment

companionAxisLabelLocation

Inherited from: IgrStraightNumericAxisBase

companionAxisLabelLocation: AxisLabelsLocation

companionAxisLabelOpposite

Inherited from: IgrStraightNumericAxisBase

companionAxisLabelOpposite: boolean

companionAxisLabelVerticalAlignment

Inherited from: IgrStraightNumericAxisBase

companionAxisLabelVerticalAlignment: VerticalAlignment

companionAxisLabelVisible

Inherited from: IgrStraightNumericAxisBase

companionAxisLabelVisible: FeatureState

companionAxisLogarithmBase

Inherited from: IgrStraightNumericAxisBase

companionAxisLogarithmBase: number

companionAxisMajorStroke

Inherited from: IgrStraightNumericAxisBase

companionAxisMajorStroke: string

companionAxisMajorStrokeThickness

Inherited from: IgrStraightNumericAxisBase

companionAxisMajorStrokeThickness: number

companionAxisMaximumValue

Inherited from: IgrStraightNumericAxisBase

companionAxisMaximumValue: number

companionAxisMinExtent

Inherited from: IgrStraightNumericAxisBase

companionAxisMinExtent: number

companionAxisMinimumValue

Inherited from: IgrStraightNumericAxisBase

companionAxisMinimumValue: number

companionAxisMinorInterval

Inherited from: IgrStraightNumericAxisBase

companionAxisMinorInterval: number

companionAxisMinorStroke

Inherited from: IgrStraightNumericAxisBase

companionAxisMinorStroke: string

companionAxisMinorStrokeThickness

Inherited from: IgrStraightNumericAxisBase

companionAxisMinorStrokeThickness: number

companionAxisShouldAutoTruncateAnnotations

Inherited from: IgrStraightNumericAxisBase

companionAxisShouldAutoTruncateAnnotations: FeatureState

companionAxisShouldAvoidAnnotationCollisions

Inherited from: IgrStraightNumericAxisBase

companionAxisShouldAvoidAnnotationCollisions: FeatureState

companionAxisShouldKeepAnnotationsInView

Inherited from: IgrStraightNumericAxisBase

companionAxisShouldKeepAnnotationsInView: FeatureState

companionAxisStrip

Inherited from: IgrStraightNumericAxisBase

companionAxisStrip: string

companionAxisStroke

Inherited from: IgrStraightNumericAxisBase

companionAxisStroke: string

companionAxisStrokeThickness

Inherited from: IgrStraightNumericAxisBase

companionAxisStrokeThickness: number

companionAxisSyncronizedWithPrimaryAxis

Inherited from: IgrStraightNumericAxisBase

companionAxisSyncronizedWithPrimaryAxis: boolean

companionAxisTickLength

Inherited from: IgrStraightNumericAxisBase

companionAxisTickLength: number

companionAxisTickStroke

Inherited from: IgrStraightNumericAxisBase

companionAxisTickStroke: string

companionAxisTickStrokeThickness

Inherited from: IgrStraightNumericAxisBase

companionAxisTickStrokeThickness: number

companionAxisTitle

Inherited from: IgrStraightNumericAxisBase

companionAxisTitle: string

crossingAxis

Inherited from: IgrStraightNumericAxisBase

crossingAxis: IgrAxis

crossingAxisName

Inherited from: IgrStraightNumericAxisBase

crossingAxisName: string

crossingValue

Inherited from: IgrStraightNumericAxisBase

crossingValue: any

enhancedIntervalMinimumCharacters

Inherited from: IgrStraightNumericAxisBase

enhancedIntervalMinimumCharacters: number

enhancedIntervalPreferMoreCategoryLabels

Inherited from: IgrStraightNumericAxisBase

enhancedIntervalPreferMoreCategoryLabels: boolean

expectFunctions

Inherited from: IgrStraightNumericAxisBase

expectFunctions: boolean

favorLabellingScaleEnd

Inherited from: IgrStraightNumericAxisBase

favorLabellingScaleEnd: boolean

formatAbbreviatedLabel

Inherited from: IgrStraightNumericAxisBase

formatAbbreviatedLabel: object

formatLabel

Inherited from: IgrStraightNumericAxisBase

formatLabel: object

interval

Inherited from: IgrStraightNumericAxisBase

interval: number

isCompanionAxis

Inherited from: IgrStraightNumericAxisBase

isCompanionAxis: boolean

isDisabled

Inherited from: IgrStraightNumericAxisBase

isDisabled: boolean

isFormattingAbbreviatedLargeNumber

Inherited from: IgrStraightNumericAxisBase

isFormattingAbbreviatedLargeNumber: boolean

isInverted

Inherited from: IgrStraightNumericAxisBase

isInverted: boolean

isLogarithmic

Inherited from: IgrStraightNumericAxisBase

isLogarithmic: boolean

label

Inherited from: IgrStraightNumericAxisBase

label: any

labelAngle

Inherited from: IgrStraightNumericAxisBase

labelAngle: number

labelBottomMargin

Inherited from: IgrStraightNumericAxisBase

labelBottomMargin: number

labelExtent

Inherited from: IgrStraightNumericAxisBase

labelExtent: number

labelFormat

Inherited from: IgrStraightNumericAxisBase

labelFormat: string

labelFormatSpecifiers

Inherited from: IgrStraightNumericAxisBase

labelFormatSpecifiers: any[]

labelHorizontalAlignment

Inherited from: IgrStraightNumericAxisBase

labelHorizontalAlignment: HorizontalAlignment

labelLeftMargin

Inherited from: IgrStraightNumericAxisBase

labelLeftMargin: number

labelLocation

Inherited from: IgrStraightNumericAxisBase

labelLocation: AxisLabelsLocation

labelMaximumExtent

Inherited from: IgrStraightNumericAxisBase

labelMaximumExtent: number

labelMaximumExtentPercentage

Inherited from: IgrStraightNumericAxisBase

labelMaximumExtentPercentage: number

labelRightMargin

Inherited from: IgrStraightNumericAxisBase

labelRightMargin: number

labelShowFirstLabel

Inherited from: IgrStraightNumericAxisBase

labelShowFirstLabel: boolean

labelTextColor

Inherited from: IgrStraightNumericAxisBase

labelTextColor: string

labelTextStyle

Inherited from: IgrStraightNumericAxisBase

labelTextStyle: string

labelTopMargin

Inherited from: IgrStraightNumericAxisBase

labelTopMargin: number

labelVerticalAlignment

Inherited from: IgrStraightNumericAxisBase

labelVerticalAlignment: VerticalAlignment

labelVisibility

Inherited from: IgrStraightNumericAxisBase

labelVisibility: Visibility

logarithmBase

Inherited from: IgrStraightNumericAxisBase

logarithmBase: number

majorStroke

Inherited from: IgrStraightNumericAxisBase

majorStroke: string

majorStrokeDashArray

Inherited from: IgrStraightNumericAxisBase

majorStrokeDashArray: number[]

majorStrokeThickness

Inherited from: IgrStraightNumericAxisBase

majorStrokeThickness: number

maximumValue

Inherited from: IgrStraightNumericAxisBase

maximumValue: number

maxPrecision

Inherited from: IgrStraightNumericAxisBase

maxPrecision: number

minimumValue

Inherited from: IgrStraightNumericAxisBase

minimumValue: number

minorInterval

Inherited from: IgrStraightNumericAxisBase

minorInterval: number

minorStroke

Inherited from: IgrStraightNumericAxisBase

minorStroke: string

minorStrokeDashArray

Inherited from: IgrStraightNumericAxisBase

minorStrokeDashArray: number[]

minorStrokeThickness

Inherited from: IgrStraightNumericAxisBase

minorStrokeThickness: number

name

Inherited from: IgrStraightNumericAxisBase

name: string

rangeChanged

Inherited from: IgrStraightNumericAxisBase

rangeChanged: object

referenceValue

Inherited from: IgrStraightNumericAxisBase

referenceValue: number

renderRequested

Inherited from: IgrStraightNumericAxisBase

renderRequested: object

scaleMode

Inherited from: IgrStraightNumericAxisBase

scaleMode: NumericScaleMode

shouldApplyMaxPrecisionWhenZoomed

Inherited from: IgrStraightNumericAxisBase

shouldApplyMaxPrecisionWhenZoomed: boolean

shouldAutoTruncateAnnotations

Inherited from: IgrStraightNumericAxisBase

shouldAutoTruncateAnnotations: boolean

shouldAvoidAnnotationCollisions

Inherited from: IgrStraightNumericAxisBase

shouldAvoidAnnotationCollisions: boolean

shouldKeepAnnotationsInView

Inherited from: IgrStraightNumericAxisBase

shouldKeepAnnotationsInView: boolean

strip

Inherited from: IgrStraightNumericAxisBase

strip: string

stroke

Inherited from: IgrStraightNumericAxisBase

stroke: string

strokeDashArray

Inherited from: IgrStraightNumericAxisBase

strokeDashArray: number[]

strokeThickness

Inherited from: IgrStraightNumericAxisBase

strokeThickness: number

tickLength

Inherited from: IgrStraightNumericAxisBase

tickLength: number

tickStroke

Inherited from: IgrStraightNumericAxisBase

tickStroke: string

tickStrokeDashArray

Inherited from: IgrStraightNumericAxisBase

tickStrokeDashArray: number[]

tickStrokeThickness

Inherited from: IgrStraightNumericAxisBase

tickStrokeThickness: number

title

Inherited from: IgrStraightNumericAxisBase

title: string

titleAngle

Inherited from: IgrStraightNumericAxisBase

titleAngle: number

titleBottomMargin

Inherited from: IgrStraightNumericAxisBase

titleBottomMargin: number

titleExtent

Inherited from: IgrStraightNumericAxisBase

titleExtent: number

titleHorizontalAlignment

Inherited from: IgrStraightNumericAxisBase

titleHorizontalAlignment: HorizontalAlignment

titleLeftMargin

Inherited from: IgrStraightNumericAxisBase

titleLeftMargin: number

titleLocation

Inherited from: IgrStraightNumericAxisBase

titleLocation: AxisLabelsLocation

titleMaximumExtent

Inherited from: IgrStraightNumericAxisBase

titleMaximumExtent: number

titleMaximumExtentPercentage

Inherited from: IgrStraightNumericAxisBase

titleMaximumExtentPercentage: number

titlePosition

Inherited from: IgrStraightNumericAxisBase

titlePosition: AxisTitlePosition

titleRightMargin

Inherited from: IgrStraightNumericAxisBase

titleRightMargin: number

titleShowFirstLabel

Inherited from: IgrStraightNumericAxisBase

titleShowFirstLabel: boolean

titleTextColor

Inherited from: IgrStraightNumericAxisBase

titleTextColor: string

titleTextStyle

Inherited from: IgrStraightNumericAxisBase

titleTextStyle: string

titleTopMargin

Inherited from: IgrStraightNumericAxisBase

titleTopMargin: number

titleVerticalAlignment

Inherited from: IgrStraightNumericAxisBase

titleVerticalAlignment: VerticalAlignment

titleVisibility

Inherited from: IgrStraightNumericAxisBase

titleVisibility: Visibility

useEnhancedIntervalManagement

Inherited from: IgrStraightNumericAxisBase

useEnhancedIntervalManagement: boolean

usePerLabelHeightMeasurement

Inherited from: IgrStraightNumericAxisBase

usePerLabelHeightMeasurement: boolean

Accessors

axisInternal

Inherited from: IgrStraightNumericAxisBase

get axisInternal(): Axis

Returns Axis

hasUserMaximum

Inherited from: IgrStraightNumericAxisBase

Determines if the axis has a user-defined maximum.

HasUserMinimum is used to determine if a numeric axis has a user definied minium value.

get hasUserMaximum(): boolean

Returns boolean

hasUserMinimum

Inherited from: IgrStraightNumericAxisBase

Determines if the axis has a user-defined minimum.

HasUserMaximum is used to determine if a numeric axis has a user definied maximum value.

get hasUserMinimum(): boolean

Returns boolean

isAngular

Inherited from: IgrStraightNumericAxisBase

Gets if the current axis is of angular axis type

get isAngular(): boolean

Returns boolean

isCategory

Inherited from: IgrStraightNumericAxisBase

Gets or sets if the current axis is of category axis type

get isCategory(): boolean

Returns boolean

isCategoryDateTime

Inherited from: IgrStraightNumericAxisBase

Gets if the current axis is of category date time axis type

get isCategoryDateTime(): boolean

Returns boolean

isContinuous

Inherited from: IgrStraightNumericAxisBase

Gets if the current axis is a continuous rather than a discrete scale

get isContinuous(): boolean

Returns boolean

isDateTime

Inherited from: IgrStraightNumericAxisBase

Gets or sets if the current axis is of date time axis type

get isDateTime(): boolean

Returns boolean

isHorizontal

Inherited from: IgrStraightNumericAxisBase

Gets if the current axis is a horizontal axis, e.g. not vertical axis, not radial axis, and not angular axis.

get isHorizontal(): boolean

Returns boolean

isNumeric

Inherited from: IgrStraightNumericAxisBase

Gets or sets if the current axis is of numeric axis type

get isNumeric(): boolean

Returns boolean

isOrdinal

Inherited from: IgrStraightNumericAxisBase

Gets or sets if the current axis is of ordinal axis type

get isOrdinal(): boolean

Returns boolean

isPiecewise

Inherited from: IgrStraightNumericAxisBase

Gets or sets if the axis is a piecewise scaling function.

get isPiecewise(): boolean

Returns boolean

isPrimaryAxis

Inherited from: IgrStraightNumericAxisBase

Gets whether this is primary axis created by an user

get isPrimaryAxis(): boolean

Returns boolean

isRadial

Inherited from: IgrStraightNumericAxisBase

Gets or sets if the current axis is of radial axis type

get isRadial(): boolean

Returns boolean

isSorting

Inherited from: IgrStraightNumericAxisBase

Gets or sets if the current axis is sorting data items

get isSorting(): boolean

Returns boolean

isVertical

Inherited from: IgrStraightNumericAxisBase

Gets if the current axis is a vertical axis.

get isVertical(): boolean

Returns boolean

i

get i(): Axis

Returns Axis

Methods

bindAxes

Inherited from: IgrStraightNumericAxisBase

bindAxes(axes: IgrAxis<IIgrAxisProps>[]): void

Parameters

axes: IgrAxis<IIgrAxisProps>[]

Returns void

componentDidMount

Inherited from: IgrStraightNumericAxisBase

componentDidMount(): void

Returns void

ensureLabelSettings

Inherited from: IgrStraightNumericAxisBase

ensureLabelSettings(): void

Returns void

ensureTitleSettings

Inherited from: IgrStraightNumericAxisBase

ensureTitleSettings(): void

Returns void

findByName

Inherited from: IgrStraightNumericAxisBase

findByName(name: string): any

Parameters

name: string

Returns any

getFullRange

Inherited from: IgrStraightNumericAxisBase

getFullRange(): number[]

Returns number[]

getItemValue

Inherited from: IgrStraightNumericAxisBase

getItemValue(item: any, memberPathName: string): any

Parameters

item: any
memberPathName: string

Returns any

getMemberPathValue

Inherited from: IgrStraightNumericAxisBase

Gets the value of a requested member path from the series.

getMemberPathValue(memberPathName: string): string

Parameters

memberPathName: string
- The property name of a valid member path for the series

Returns string

getValueLabel

Inherited from: IgrStraightNumericAxisBase

Gets the label for a data item.

getValueLabel(value: number): string

Parameters

value: number
- The unscaled value to get a label for.

Returns string

provideData

Inherited from: IgrStraightNumericAxisBase

provideData(data: any): void

Parameters

data: any

Returns void

render

Inherited from: IgrStraightNumericAxisBase

render(): any

Returns any

renderAxis

Inherited from: IgrStraightNumericAxisBase

Renders the axis with no animation.

renderAxis(): void

Returns void

resetCachedEnhancedInterval

Inherited from: IgrStraightNumericAxisBase

If using enhanced interval management and precise interval fitting, this will reset the cached maximum label width, and recalculate using the current labels.

resetCachedEnhancedInterval(): void

Returns void

scaleValue

Inherited from: IgrStraightNumericAxisBase

Scales a value from axis space into screen space.

scaleValue(unscaledValue: number): number

Parameters

unscaledValue: number
- The unscaled axis value to scale.

Returns number

scrollRangeIntoView

scrollRangeIntoView(minimum: number, maximum: number): void

Parameters

minimum: number
maximum: number

Returns void

shouldComponentUpdate

Inherited from: IgrStraightNumericAxisBase

shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

nextProps: any
nextState: any

Returns boolean

unscaleValue

Inherited from: IgrStraightNumericAxisBase

Unscales a value from screen space into axis space.

unscaleValue(unscaledValue: number): number

Parameters

unscaledValue: number
- The scaled value in screen coordinates to unscale into axis space.
Unscales a value from screen space into axis space.
```
let dataValue: number = this.yAxis.unscaleValue(pixel);
```

Returns number

_createFromInternal

Inherited from: IgrStraightNumericAxisBase

_createFromInternal(internal: any): IgrAxis

Parameters

internal: any