IgrAxis

Represents the base class from which all axis types are derived.

The Axis is an array of axis objects.

Constructors

new IgrAxis(props: P): IgrAxis

Returns IgrAxis

Properties

actualMajorStroke

actualMajorStroke: string

actualMinorStroke

actualMinorStroke: string

actualStroke

actualStroke: string

annotations

annotations: IgrAxisAnnotationCollection

coercionMethods

coercionMethods: any

companionAxisCrossingAxis

companionAxisCrossingAxis: IgrAxis

companionAxisCrossingAxisName

companionAxisCrossingAxisName: string

companionAxisCrossingValue

companionAxisCrossingValue: number

companionAxisEnabled

companionAxisEnabled: boolean

companionAxisIsInverted

companionAxisIsInverted: FeatureState

companionAxisLabelAngle

companionAxisLabelAngle: number

companionAxisLabelColor

companionAxisLabelColor: string

companionAxisLabelExtent

companionAxisLabelExtent: number

companionAxisLabelHorizontalAlignment

companionAxisLabelHorizontalAlignment: HorizontalAlignment

companionAxisLabelLocation

companionAxisLabelLocation: AxisLabelsLocation

companionAxisLabelOpposite

companionAxisLabelOpposite: boolean

companionAxisLabelVerticalAlignment

companionAxisLabelVerticalAlignment: VerticalAlignment

companionAxisLabelVisible

companionAxisLabelVisible: FeatureState

companionAxisMajorStroke

companionAxisMajorStroke: string

companionAxisMajorStrokeThickness

companionAxisMajorStrokeThickness: number

companionAxisMinExtent

companionAxisMinExtent: number

companionAxisMinorStroke

companionAxisMinorStroke: string

companionAxisMinorStrokeThickness

companionAxisMinorStrokeThickness: number

companionAxisShouldAutoTruncateAnnotations

companionAxisShouldAutoTruncateAnnotations: FeatureState

companionAxisShouldAvoidAnnotationCollisions

companionAxisShouldAvoidAnnotationCollisions: FeatureState

companionAxisShouldKeepAnnotationsInView

companionAxisShouldKeepAnnotationsInView: FeatureState

companionAxisStrip

companionAxisStrip: string

companionAxisStroke

companionAxisStroke: string

companionAxisStrokeThickness

companionAxisStrokeThickness: number

companionAxisSyncronizedWithPrimaryAxis

companionAxisSyncronizedWithPrimaryAxis: boolean

companionAxisTickLength

companionAxisTickLength: number

companionAxisTickStroke

companionAxisTickStroke: string

companionAxisTickStrokeThickness

companionAxisTickStrokeThickness: number

companionAxisTitle

companionAxisTitle: string

crossingAxis

crossingAxis: IgrAxis

crossingAxisName

crossingAxisName: string

crossingValue

crossingValue: any

enhancedIntervalMinimumCharacters

enhancedIntervalMinimumCharacters: number

enhancedIntervalPreferMoreCategoryLabels

enhancedIntervalPreferMoreCategoryLabels: boolean

expectFunctions

expectFunctions: boolean

formatLabel

formatLabel: object

isCompanionAxis

isCompanionAxis: boolean

isDisabled

isDisabled: boolean

isInverted

isInverted: boolean

label

label: any

labelAngle

labelAngle: number

labelBottomMargin

labelBottomMargin: number

labelExtent

labelExtent: number

labelFormat

labelFormat: string

labelFormatSpecifiers

labelFormatSpecifiers: any[]

labelHorizontalAlignment

labelHorizontalAlignment: HorizontalAlignment

labelLeftMargin

labelLeftMargin: number

labelLocation

labelLocation: AxisLabelsLocation

labelMaximumExtent

labelMaximumExtent: number

labelMaximumExtentPercentage

labelMaximumExtentPercentage: number

labelRightMargin

labelRightMargin: number

labelShowFirstLabel

labelShowFirstLabel: boolean

labelTextColor

labelTextColor: string

labelTextStyle

labelTextStyle: string

labelTopMargin

labelTopMargin: number

labelVerticalAlignment

labelVerticalAlignment: VerticalAlignment

labelVisibility

labelVisibility: Visibility

majorStroke

majorStroke: string

majorStrokeDashArray

majorStrokeDashArray: number[]

majorStrokeThickness

majorStrokeThickness: number

minorStroke

minorStroke: string

minorStrokeDashArray

minorStrokeDashArray: number[]

minorStrokeThickness

minorStrokeThickness: number

name

name: string

rangeChanged

rangeChanged: object

renderRequested

renderRequested: object

shouldAutoTruncateAnnotations

shouldAutoTruncateAnnotations: boolean

shouldAvoidAnnotationCollisions

shouldAvoidAnnotationCollisions: boolean

shouldKeepAnnotationsInView

shouldKeepAnnotationsInView: boolean

strip

strip: string

stroke

stroke: string

strokeDashArray

strokeDashArray: number[]

strokeThickness

strokeThickness: number

tickLength

tickLength: number

tickStroke

tickStroke: string

tickStrokeDashArray

tickStrokeDashArray: number[]

tickStrokeThickness

tickStrokeThickness: number

title

title: string

titleAngle

titleAngle: number

titleBottomMargin

titleBottomMargin: number

titleExtent

titleExtent: number

titleHorizontalAlignment

titleHorizontalAlignment: HorizontalAlignment

titleLeftMargin

titleLeftMargin: number

titleLocation

titleLocation: AxisLabelsLocation

titleMaximumExtent

titleMaximumExtent: number

titleMaximumExtentPercentage

titleMaximumExtentPercentage: number

titlePosition

titlePosition: AxisTitlePosition

titleRightMargin

titleRightMargin: number

titleShowFirstLabel

titleShowFirstLabel: boolean

titleTextColor

titleTextColor: string

titleTextStyle

titleTextStyle: string

titleTopMargin

titleTopMargin: number

titleVerticalAlignment

titleVerticalAlignment: VerticalAlignment

titleVisibility

titleVisibility: Visibility

useEnhancedIntervalManagement

useEnhancedIntervalManagement: boolean

usePerLabelHeightMeasurement

usePerLabelHeightMeasurement: boolean

Accessors

axisInternal

get axisInternal(): Axis

Returns Axis

i

get i(): Axis

Returns Axis

isAngular

Gets if the current axis is of angular axis type

get isAngular(): boolean

Returns boolean

isCategory

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

get isCategory(): boolean

Returns boolean

isCategoryDateTime

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

get isCategoryDateTime(): boolean

Returns boolean

isContinuous

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

get isContinuous(): boolean

Returns boolean

isDateTime

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

get isDateTime(): boolean

Returns boolean

isHorizontal

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

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

get isNumeric(): boolean

Returns boolean

isOrdinal

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

get isOrdinal(): boolean

Returns boolean

isPiecewise

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

get isPiecewise(): boolean

Returns boolean

isPrimaryAxis

Gets whether this is primary axis created by an user

get isPrimaryAxis(): boolean

Returns boolean

isRadial

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

get isRadial(): boolean

Returns boolean

isSorting

Gets or sets if the current axis is sorting data items

get isSorting(): boolean

Returns boolean

isVertical

Gets if the current axis is a vertical axis.

get isVertical(): boolean

Returns boolean

Methods

bindAxes

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

Parameters

axes: IgrAxis<IIgrAxisProps>[]

Returns void

componentDidMount

componentDidMount(): void

Returns void

ensureLabelSettings

ensureLabelSettings(): void

Returns void

ensureTitleSettings

ensureTitleSettings(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

getFullRange

getFullRange(): number[]

Returns number[]

getItemValue

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

Parameters

item: any
memberPathName: string

Returns any

getMemberPathValue

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

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

provideData(data: any): void

Parameters

data: any

Returns void

render

render(): any

Returns any

renderAxis

Renders the axis with no animation.

renderAxis(): void

Returns void

resetCachedEnhancedInterval

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

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

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

Parameters

nextProps: any
nextState: any

Returns boolean

_createFromInternal

_createFromInternal(internal: any): IgrAxis

Parameters

internal: any