IgrNumericAxisBase

Represents the base class for all DataChartComponent numeric axes.

Constructors

new IgrNumericAxisBase(props: P): IgrNumericAxisBase

Returns IgrNumericAxisBase

Properties

abbreviatedLabelFormat

abbreviatedLabelFormat: string

abbreviatedLabelFormatSpecifiers

abbreviatedLabelFormatSpecifiers: any[]

abbreviateLargeNumbers

abbreviateLargeNumbers: boolean

actualInterval

actualInterval: number

actualIntervalChange

actualIntervalChange: object

actualIsLogarithmic

actualIsLogarithmic: boolean

actualMajorStroke

Inherited from: IgrAxis

actualMajorStroke: string

actualMaximumValue

actualMaximumValue: number

actualMaximumValueChange

actualMaximumValueChange: object

actualMaxPrecision

actualMaxPrecision: number

actualMinimumValue

actualMinimumValue: number

actualMinimumValueChange

actualMinimumValueChange: object

actualMinorInterval

actualMinorInterval: number

actualMinorIntervalChange

actualMinorIntervalChange: object

actualMinorStroke

Inherited from: IgrAxis

actualMinorStroke: string

actualStroke

Inherited from: IgrAxis

actualStroke: string

actualVisibleMaximumValue

actualVisibleMaximumValue: number

actualVisibleMinimumValue

actualVisibleMinimumValue: number

annotations

Inherited from: IgrAxis

annotations: IgrAxisAnnotationCollection

autoRangeBufferMode

autoRangeBufferMode: AxisRangeBufferMode

coercionMethods

Inherited from: IgrAxis

coercionMethods: any

companionAxisCrossingAxis

Inherited from: IgrAxis

companionAxisCrossingAxis: IgrAxis

companionAxisCrossingAxisName

Inherited from: IgrAxis

companionAxisCrossingAxisName: string

companionAxisCrossingValue

Inherited from: IgrAxis

companionAxisCrossingValue: number

companionAxisEnabled

Inherited from: IgrAxis

companionAxisEnabled: boolean

companionAxisInterval

companionAxisInterval: number

companionAxisIsInverted

Inherited from: IgrAxis

companionAxisIsInverted: FeatureState

companionAxisIsLogarithmic

companionAxisIsLogarithmic: FeatureState

companionAxisLabelAngle

Inherited from: IgrAxis

companionAxisLabelAngle: number

companionAxisLabelColor

Inherited from: IgrAxis

companionAxisLabelColor: string

companionAxisLabelExtent

Inherited from: IgrAxis

companionAxisLabelExtent: number

companionAxisLabelHorizontalAlignment

Inherited from: IgrAxis

companionAxisLabelHorizontalAlignment: HorizontalAlignment

companionAxisLabelLocation

Inherited from: IgrAxis

companionAxisLabelLocation: AxisLabelsLocation

companionAxisLabelOpposite

Inherited from: IgrAxis

companionAxisLabelOpposite: boolean

companionAxisLabelVerticalAlignment

Inherited from: IgrAxis

companionAxisLabelVerticalAlignment: VerticalAlignment

companionAxisLabelVisible

Inherited from: IgrAxis

companionAxisLabelVisible: FeatureState

companionAxisLogarithmBase

companionAxisLogarithmBase: number

companionAxisMajorStroke

Inherited from: IgrAxis

companionAxisMajorStroke: string

companionAxisMajorStrokeThickness

Inherited from: IgrAxis

companionAxisMajorStrokeThickness: number

companionAxisMaximumValue

companionAxisMaximumValue: number

companionAxisMinExtent

Inherited from: IgrAxis

companionAxisMinExtent: number

companionAxisMinimumValue

companionAxisMinimumValue: number

companionAxisMinorInterval

companionAxisMinorInterval: number

companionAxisMinorStroke

Inherited from: IgrAxis

companionAxisMinorStroke: string

companionAxisMinorStrokeThickness

Inherited from: IgrAxis

companionAxisMinorStrokeThickness: number

companionAxisShouldAutoTruncateAnnotations

Inherited from: IgrAxis

companionAxisShouldAutoTruncateAnnotations: FeatureState

companionAxisShouldAvoidAnnotationCollisions

Inherited from: IgrAxis

companionAxisShouldAvoidAnnotationCollisions: FeatureState

companionAxisShouldKeepAnnotationsInView

Inherited from: IgrAxis

companionAxisShouldKeepAnnotationsInView: FeatureState

companionAxisStrip

Inherited from: IgrAxis

companionAxisStrip: string

companionAxisStroke

Inherited from: IgrAxis

companionAxisStroke: string

companionAxisStrokeThickness

Inherited from: IgrAxis

companionAxisStrokeThickness: number

companionAxisSyncronizedWithPrimaryAxis

Inherited from: IgrAxis

companionAxisSyncronizedWithPrimaryAxis: boolean

companionAxisTickLength

Inherited from: IgrAxis

companionAxisTickLength: number

companionAxisTickStroke

Inherited from: IgrAxis

companionAxisTickStroke: string

companionAxisTickStrokeThickness

Inherited from: IgrAxis

companionAxisTickStrokeThickness: number

companionAxisTitle

Inherited from: IgrAxis

companionAxisTitle: string

crossingAxis

Inherited from: IgrAxis

crossingAxis: IgrAxis

crossingAxisName

Inherited from: IgrAxis

crossingAxisName: string

crossingValue

Inherited from: IgrAxis

crossingValue: any

enhancedIntervalMinimumCharacters

Inherited from: IgrAxis

enhancedIntervalMinimumCharacters: number

enhancedIntervalPreferMoreCategoryLabels

Inherited from: IgrAxis

enhancedIntervalPreferMoreCategoryLabels: boolean

expectFunctions

Inherited from: IgrAxis

expectFunctions: boolean

favorLabellingScaleEnd

favorLabellingScaleEnd: boolean

formatAbbreviatedLabel

formatAbbreviatedLabel: object

formatLabel

Inherited from: IgrAxis

formatLabel: object

interval

interval: number

isCompanionAxis

Inherited from: IgrAxis

isCompanionAxis: boolean

isDisabled

Inherited from: IgrAxis

isDisabled: boolean

isFormattingAbbreviatedLargeNumber

isFormattingAbbreviatedLargeNumber: boolean

isInverted

Inherited from: IgrAxis

isInverted: boolean

isLogarithmic

isLogarithmic: boolean

label

Inherited from: IgrAxis

label: any

labelAngle

Inherited from: IgrAxis

labelAngle: number

labelBottomMargin

Inherited from: IgrAxis

labelBottomMargin: number

labelExtent

Inherited from: IgrAxis

labelExtent: number

labelFormat

Inherited from: IgrAxis

labelFormat: string

labelFormatSpecifiers

Inherited from: IgrAxis

labelFormatSpecifiers: any[]

labelHorizontalAlignment

Inherited from: IgrAxis

labelHorizontalAlignment: HorizontalAlignment

labelLeftMargin

Inherited from: IgrAxis

labelLeftMargin: number

labelLocation

Inherited from: IgrAxis

labelLocation: AxisLabelsLocation

labelMaximumExtent

Inherited from: IgrAxis

labelMaximumExtent: number

labelMaximumExtentPercentage

Inherited from: IgrAxis

labelMaximumExtentPercentage: number

labelRightMargin

Inherited from: IgrAxis

labelRightMargin: number

labelShowFirstLabel

Inherited from: IgrAxis

labelShowFirstLabel: boolean

labelTextColor

Inherited from: IgrAxis

labelTextColor: string

labelTextStyle

Inherited from: IgrAxis

labelTextStyle: string

labelTopMargin

Inherited from: IgrAxis

labelTopMargin: number

labelVerticalAlignment

Inherited from: IgrAxis

labelVerticalAlignment: VerticalAlignment

labelVisibility

Inherited from: IgrAxis

labelVisibility: Visibility

logarithmBase

logarithmBase: number

majorStroke

Inherited from: IgrAxis

majorStroke: string

majorStrokeDashArray

Inherited from: IgrAxis

majorStrokeDashArray: number[]

majorStrokeThickness

Inherited from: IgrAxis

majorStrokeThickness: number

maximumValue

maximumValue: number

maxPrecision

maxPrecision: number

minimumValue

minimumValue: number

minorInterval

minorInterval: number

minorStroke

Inherited from: IgrAxis

minorStroke: string

minorStrokeDashArray

Inherited from: IgrAxis

minorStrokeDashArray: number[]

minorStrokeThickness

Inherited from: IgrAxis

minorStrokeThickness: number

name

Inherited from: IgrAxis

name: string

rangeChanged

Inherited from: IgrAxis

rangeChanged: object

referenceValue

referenceValue: number

renderRequested

Inherited from: IgrAxis

renderRequested: object

shouldApplyMaxPrecisionWhenZoomed

shouldApplyMaxPrecisionWhenZoomed: boolean

shouldAutoTruncateAnnotations

Inherited from: IgrAxis

shouldAutoTruncateAnnotations: boolean

shouldAvoidAnnotationCollisions

Inherited from: IgrAxis

shouldAvoidAnnotationCollisions: boolean

shouldKeepAnnotationsInView

Inherited from: IgrAxis

shouldKeepAnnotationsInView: boolean

strip

Inherited from: IgrAxis

strip: string

stroke

Inherited from: IgrAxis

stroke: string

strokeDashArray

Inherited from: IgrAxis

strokeDashArray: number[]

strokeThickness

Inherited from: IgrAxis

strokeThickness: number

tickLength

Inherited from: IgrAxis

tickLength: number

tickStroke

Inherited from: IgrAxis

tickStroke: string

tickStrokeDashArray

Inherited from: IgrAxis

tickStrokeDashArray: number[]

tickStrokeThickness

Inherited from: IgrAxis

tickStrokeThickness: number

title

Inherited from: IgrAxis

title: string

titleAngle

Inherited from: IgrAxis

titleAngle: number

titleBottomMargin

Inherited from: IgrAxis

titleBottomMargin: number

titleExtent

Inherited from: IgrAxis

titleExtent: number

titleHorizontalAlignment

Inherited from: IgrAxis

titleHorizontalAlignment: HorizontalAlignment

titleLeftMargin

Inherited from: IgrAxis

titleLeftMargin: number

titleLocation

Inherited from: IgrAxis

titleLocation: AxisLabelsLocation

titleMaximumExtent

Inherited from: IgrAxis

titleMaximumExtent: number

titleMaximumExtentPercentage

Inherited from: IgrAxis

titleMaximumExtentPercentage: number

titlePosition

Inherited from: IgrAxis

titlePosition: AxisTitlePosition

titleRightMargin

Inherited from: IgrAxis

titleRightMargin: number

titleShowFirstLabel

Inherited from: IgrAxis

titleShowFirstLabel: boolean

titleTextColor

Inherited from: IgrAxis

titleTextColor: string

titleTextStyle

Inherited from: IgrAxis

titleTextStyle: string

titleTopMargin

Inherited from: IgrAxis

titleTopMargin: number

titleVerticalAlignment

Inherited from: IgrAxis

titleVerticalAlignment: VerticalAlignment

titleVisibility

Inherited from: IgrAxis

titleVisibility: Visibility

useEnhancedIntervalManagement

Inherited from: IgrAxis

useEnhancedIntervalManagement: boolean

usePerLabelHeightMeasurement

Inherited from: IgrAxis

usePerLabelHeightMeasurement: boolean

Accessors

axisInternal

Inherited from: IgrAxis

get axisInternal(): Axis

Returns Axis

hasUserMaximum

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

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

Gets if the current axis is of angular axis type

get isAngular(): boolean

Returns boolean

isCategory

Inherited from: IgrAxis

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

get isCategory(): boolean

Returns boolean

isCategoryDateTime

Inherited from: IgrAxis

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

get isCategoryDateTime(): boolean

Returns boolean

isContinuous

Inherited from: IgrAxis

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

get isContinuous(): boolean

Returns boolean

isDateTime

Inherited from: IgrAxis

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

get isDateTime(): boolean

Returns boolean

isHorizontal

Inherited from: IgrAxis

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

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

get isNumeric(): boolean

Returns boolean

isOrdinal

Inherited from: IgrAxis

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

get isOrdinal(): boolean

Returns boolean

isPiecewise

Inherited from: IgrAxis

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

get isPiecewise(): boolean

Returns boolean

isPrimaryAxis

Inherited from: IgrAxis

Gets whether this is primary axis created by an user

get isPrimaryAxis(): boolean

Returns boolean

isRadial

Inherited from: IgrAxis

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

get isRadial(): boolean

Returns boolean

isSorting

Inherited from: IgrAxis

Gets or sets if the current axis is sorting data items

get isSorting(): boolean

Returns boolean

isVertical

Inherited from: IgrAxis

Gets if the current axis is a vertical axis.

get isVertical(): boolean

Returns boolean

i

get i(): Axis

Returns Axis

Methods

bindAxes

Inherited from: IgrAxis

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

Parameters

axes: IgrAxis<IIgrAxisProps>[]

Returns void

componentDidMount

Inherited from: IgrAxis

componentDidMount(): void

Returns void

ensureLabelSettings

Inherited from: IgrAxis

ensureLabelSettings(): void

Returns void

ensureTitleSettings

Inherited from: IgrAxis

ensureTitleSettings(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

getFullRange

getFullRange(): number[]

Returns number[]

getItemValue

Inherited from: IgrAxis

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

Parameters

item: any
memberPathName: string

Returns any

getMemberPathValue

Inherited from: IgrAxis

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

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

provideData(data: any): void

Parameters

data: any

Returns void

render

Inherited from: IgrAxis

render(): any

Returns any

renderAxis

Inherited from: IgrAxis

Renders the axis with no animation.

renderAxis(): void

Returns void

resetCachedEnhancedInterval

Inherited from: IgrAxis

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

Scales a value from axis space into screen space.

scaleValue(unscaledValue: number): number

Parameters

unscaledValue: number
- The unscaled axis value to scale.

Returns number

shouldComponentUpdate

Inherited from: IgrAxis

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

Parameters

nextProps: any
nextState: any

Returns boolean

unscaleValue

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

_createFromInternal(internal: any): IgrAxis

Parameters

internal: any