IgrTimeXAxis

A horizontal axis that uses a DateTime scale.

The TimeXAxis is a horizontal axis that uses a DateTime scale.

Constructors

new IgrTimeXAxis(props: IIgrTimeXAxisProps): IgrTimeXAxis

Returns IgrTimeXAxis

Properties

actualMajorStroke

Inherited from: IgrTimeAxisBase

actualMajorStroke: string

actualMaximumValue

Inherited from: IgrTimeAxisBase

actualMaximumValue: Date

actualMaximumValueChange

Inherited from: IgrTimeAxisBase

actualMaximumValueChange: object

actualMinimumValue

Inherited from: IgrTimeAxisBase

actualMinimumValue: Date

actualMinimumValueChange

Inherited from: IgrTimeAxisBase

actualMinimumValueChange: object

actualMinorStroke

Inherited from: IgrTimeAxisBase

actualMinorStroke: string

actualStroke

Inherited from: IgrTimeAxisBase

actualStroke: string

annotations

Inherited from: IgrTimeAxisBase

annotations: IgrAxisAnnotationCollection

breaks

breaks: IgrTimeAxisBreakCollection

coercionMethods

Inherited from: IgrTimeAxisBase

coercionMethods: any

companionAxisCrossingAxis

Inherited from: IgrTimeAxisBase

companionAxisCrossingAxis: IgrAxis

companionAxisCrossingAxisName

Inherited from: IgrTimeAxisBase

companionAxisCrossingAxisName: string

companionAxisCrossingValue

Inherited from: IgrTimeAxisBase

companionAxisCrossingValue: number

companionAxisEnabled

Inherited from: IgrTimeAxisBase

companionAxisEnabled: boolean

companionAxisIsInverted

Inherited from: IgrTimeAxisBase

companionAxisIsInverted: FeatureState

companionAxisLabelAngle

Inherited from: IgrTimeAxisBase

companionAxisLabelAngle: number

companionAxisLabelColor

Inherited from: IgrTimeAxisBase

companionAxisLabelColor: string

companionAxisLabelExtent

Inherited from: IgrTimeAxisBase

companionAxisLabelExtent: number

companionAxisLabelHorizontalAlignment

Inherited from: IgrTimeAxisBase

companionAxisLabelHorizontalAlignment: HorizontalAlignment

companionAxisLabelLocation

Inherited from: IgrTimeAxisBase

companionAxisLabelLocation: AxisLabelsLocation

companionAxisLabelOpposite

Inherited from: IgrTimeAxisBase

companionAxisLabelOpposite: boolean

companionAxisLabelVerticalAlignment

Inherited from: IgrTimeAxisBase

companionAxisLabelVerticalAlignment: VerticalAlignment

companionAxisLabelVisible

Inherited from: IgrTimeAxisBase

companionAxisLabelVisible: FeatureState

companionAxisMajorStroke

Inherited from: IgrTimeAxisBase

companionAxisMajorStroke: string

companionAxisMajorStrokeThickness

Inherited from: IgrTimeAxisBase

companionAxisMajorStrokeThickness: number

companionAxisMinExtent

Inherited from: IgrTimeAxisBase

companionAxisMinExtent: number

companionAxisMinorStroke

Inherited from: IgrTimeAxisBase

companionAxisMinorStroke: string

companionAxisMinorStrokeThickness

Inherited from: IgrTimeAxisBase

companionAxisMinorStrokeThickness: number

companionAxisShouldAutoTruncateAnnotations

Inherited from: IgrTimeAxisBase

companionAxisShouldAutoTruncateAnnotations: FeatureState

companionAxisShouldAvoidAnnotationCollisions

Inherited from: IgrTimeAxisBase

companionAxisShouldAvoidAnnotationCollisions: FeatureState

companionAxisShouldKeepAnnotationsInView

Inherited from: IgrTimeAxisBase

companionAxisShouldKeepAnnotationsInView: FeatureState

companionAxisStrip

Inherited from: IgrTimeAxisBase

companionAxisStrip: string

companionAxisStroke

Inherited from: IgrTimeAxisBase

companionAxisStroke: string

companionAxisStrokeThickness

Inherited from: IgrTimeAxisBase

companionAxisStrokeThickness: number

companionAxisSyncronizedWithPrimaryAxis

Inherited from: IgrTimeAxisBase

companionAxisSyncronizedWithPrimaryAxis: boolean

companionAxisTickLength

Inherited from: IgrTimeAxisBase

companionAxisTickLength: number

companionAxisTickStroke

Inherited from: IgrTimeAxisBase

companionAxisTickStroke: string

companionAxisTickStrokeThickness

Inherited from: IgrTimeAxisBase

companionAxisTickStrokeThickness: number

companionAxisTitle

Inherited from: IgrTimeAxisBase

companionAxisTitle: string

crossingAxis

Inherited from: IgrTimeAxisBase

crossingAxis: IgrAxis

crossingAxisName

Inherited from: IgrTimeAxisBase

crossingAxisName: string

crossingValue

Inherited from: IgrTimeAxisBase

crossingValue: any

dataSource

Inherited from: IgrTimeAxisBase

dataSource: any

dateTimeMemberPath

Inherited from: IgrTimeAxisBase

dateTimeMemberPath: string

enhancedIntervalMinimumCharacters

Inherited from: IgrTimeAxisBase

enhancedIntervalMinimumCharacters: number

enhancedIntervalPreferMoreCategoryLabels

Inherited from: IgrTimeAxisBase

enhancedIntervalPreferMoreCategoryLabels: boolean

expectFunctions

Inherited from: IgrTimeAxisBase

expectFunctions: boolean

formatLabel

Inherited from: IgrTimeAxisBase

formatLabel: object

gap

Inherited from: IgrTimeAxisBase

gap: number

intervals

intervals: IgrTimeAxisIntervalCollection

isCompanionAxis

Inherited from: IgrTimeAxisBase

isCompanionAxis: boolean

isDataPreSorted

Inherited from: IgrTimeAxisBase

isDataPreSorted: boolean

isDisabled

Inherited from: IgrTimeAxisBase

isDisabled: boolean

isInverted

Inherited from: IgrTimeAxisBase

isInverted: boolean

itemsCount

Inherited from: IgrTimeAxisBase

itemsCount: number

label

Inherited from: IgrTimeAxisBase

label: any

labelAngle

Inherited from: IgrTimeAxisBase

labelAngle: number

labelBottomMargin

Inherited from: IgrTimeAxisBase

labelBottomMargin: number

labelExtent

Inherited from: IgrTimeAxisBase

labelExtent: number

labelFormat

Inherited from: IgrTimeAxisBase

labelFormat: string

labelFormats

labelFormats: IgrTimeAxisLabelFormatCollection

labelFormatSpecifiers

Inherited from: IgrTimeAxisBase

labelFormatSpecifiers: any[]

labelHorizontalAlignment

Inherited from: IgrTimeAxisBase

labelHorizontalAlignment: HorizontalAlignment

labelLeftMargin

Inherited from: IgrTimeAxisBase

labelLeftMargin: number

labellingMode

labellingMode: TimeAxisLabellingMode

labelLocation

Inherited from: IgrTimeAxisBase

labelLocation: AxisLabelsLocation

labelMaximumExtent

Inherited from: IgrTimeAxisBase

labelMaximumExtent: number

labelMaximumExtentPercentage

Inherited from: IgrTimeAxisBase

labelMaximumExtentPercentage: number

labelRightMargin

Inherited from: IgrTimeAxisBase

labelRightMargin: number

labelShowFirstLabel

Inherited from: IgrTimeAxisBase

labelShowFirstLabel: boolean

labelTextColor

Inherited from: IgrTimeAxisBase

labelTextColor: string

labelTextStyle

Inherited from: IgrTimeAxisBase

labelTextStyle: string

labelTopMargin

Inherited from: IgrTimeAxisBase

labelTopMargin: number

labelVerticalAlignment

Inherited from: IgrTimeAxisBase

labelVerticalAlignment: VerticalAlignment

labelVisibility

Inherited from: IgrTimeAxisBase

labelVisibility: Visibility

majorStroke

Inherited from: IgrTimeAxisBase

majorStroke: string

majorStrokeDashArray

Inherited from: IgrTimeAxisBase

majorStrokeDashArray: number[]

majorStrokeThickness

Inherited from: IgrTimeAxisBase

majorStrokeThickness: number

maximumGap

Inherited from: IgrTimeAxisBase

maximumGap: number

maximumValue

Inherited from: IgrTimeAxisBase

maximumValue: Date

minimumGapSize

Inherited from: IgrTimeAxisBase

minimumGapSize: number

minimumValue

Inherited from: IgrTimeAxisBase

minimumValue: Date

minorStroke

Inherited from: IgrTimeAxisBase

minorStroke: string

minorStrokeDashArray

Inherited from: IgrTimeAxisBase

minorStrokeDashArray: number[]

minorStrokeThickness

Inherited from: IgrTimeAxisBase

minorStrokeThickness: number

name

Inherited from: IgrTimeAxisBase

name: string

overlap

Inherited from: IgrTimeAxisBase

overlap: number

rangeChanged

Inherited from: IgrTimeAxisBase

rangeChanged: object

renderRequested

Inherited from: IgrTimeAxisBase

renderRequested: object

shouldAutoTruncateAnnotations

Inherited from: IgrTimeAxisBase

shouldAutoTruncateAnnotations: boolean

shouldAvoidAnnotationCollisions

Inherited from: IgrTimeAxisBase

shouldAvoidAnnotationCollisions: boolean

shouldKeepAnnotationsInView

Inherited from: IgrTimeAxisBase

shouldKeepAnnotationsInView: boolean

strip

Inherited from: IgrTimeAxisBase

strip: string

stroke

Inherited from: IgrTimeAxisBase

stroke: string

strokeDashArray

Inherited from: IgrTimeAxisBase

strokeDashArray: number[]

strokeThickness

Inherited from: IgrTimeAxisBase

strokeThickness: number

tickLength

Inherited from: IgrTimeAxisBase

tickLength: number

tickStroke

Inherited from: IgrTimeAxisBase

tickStroke: string

tickStrokeDashArray

Inherited from: IgrTimeAxisBase

tickStrokeDashArray: number[]

tickStrokeThickness

Inherited from: IgrTimeAxisBase

tickStrokeThickness: number

title

Inherited from: IgrTimeAxisBase

title: string

titleAngle

Inherited from: IgrTimeAxisBase

titleAngle: number

titleBottomMargin

Inherited from: IgrTimeAxisBase

titleBottomMargin: number

titleExtent

Inherited from: IgrTimeAxisBase

titleExtent: number

titleHorizontalAlignment

Inherited from: IgrTimeAxisBase

titleHorizontalAlignment: HorizontalAlignment

titleLeftMargin

Inherited from: IgrTimeAxisBase

titleLeftMargin: number

titleLocation

Inherited from: IgrTimeAxisBase

titleLocation: AxisLabelsLocation

titleMaximumExtent

Inherited from: IgrTimeAxisBase

titleMaximumExtent: number

titleMaximumExtentPercentage

Inherited from: IgrTimeAxisBase

titleMaximumExtentPercentage: number

titlePosition

Inherited from: IgrTimeAxisBase

titlePosition: AxisTitlePosition

titleRightMargin

Inherited from: IgrTimeAxisBase

titleRightMargin: number

titleShowFirstLabel

Inherited from: IgrTimeAxisBase

titleShowFirstLabel: boolean

titleTextColor

Inherited from: IgrTimeAxisBase

titleTextColor: string

titleTextStyle

Inherited from: IgrTimeAxisBase

titleTextStyle: string

titleTopMargin

Inherited from: IgrTimeAxisBase

titleTopMargin: number

titleVerticalAlignment

Inherited from: IgrTimeAxisBase

titleVerticalAlignment: VerticalAlignment

titleVisibility

Inherited from: IgrTimeAxisBase

titleVisibility: Visibility

useClusteringMode

Inherited from: IgrTimeAxisBase

useClusteringMode: boolean

useEnhancedIntervalManagement

Inherited from: IgrTimeAxisBase

useEnhancedIntervalManagement: boolean

usePerLabelHeightMeasurement

Inherited from: IgrTimeAxisBase

usePerLabelHeightMeasurement: boolean

Accessors

axisInternal

Inherited from: IgrTimeAxisBase

get axisInternal(): Axis

Returns Axis

isAngular

Inherited from: IgrTimeAxisBase

Gets if the current axis is of angular axis type

get isAngular(): boolean

Returns boolean

isCategory

Inherited from: IgrTimeAxisBase

Checks if the 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

Inherited from: IgrTimeAxisBase

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

get isContinuous(): boolean

Returns boolean

isDateTime

Inherited from: IgrTimeAxisBase

Checks if the axis is of date time axis type

Use IsDateTime property to Checks if the axis is of date time axis type.

get isDateTime(): boolean

Returns boolean

isHorizontal

Inherited from: IgrTimeAxisBase

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

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

Inherited from: IgrTimeAxisBase

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

Inherited from: IgrTimeAxisBase

Gets whether this is primary axis created by an user

get isPrimaryAxis(): boolean

Returns boolean

isRadial

Inherited from: IgrTimeAxisBase

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

get isRadial(): boolean

Returns boolean

isSorting

Inherited from: IgrTimeAxisBase

Checks if axis requires sorting of items

Use IsSorting property to Checks if axis requires sorting of items.

get isSorting(): boolean

Returns boolean

isVertical

Inherited from: IgrTimeAxisBase

Gets if the current axis is a vertical axis.

get isVertical(): boolean

Returns boolean

i

get i(): Axis

Returns Axis

Methods

bindAxes

Inherited from: IgrTimeAxisBase

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

Parameters

axes: IgrAxis<IIgrAxisProps>[]

Returns void

componentDidMount

Inherited from: IgrTimeAxisBase

componentDidMount(): void

Returns void

ensureLabelSettings

Inherited from: IgrTimeAxisBase

ensureLabelSettings(): void

Returns void

ensureTitleSettings

Inherited from: IgrTimeAxisBase

ensureTitleSettings(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

getCategoryBoundingBox

Inherited from: IgrTimeAxisBase

getCategoryBoundingBox(point: IgPoint, useInterpolation: boolean, singularWidth: number): IgRect

Parameters

point: IgPoint
useInterpolation: boolean
singularWidth: number

Returns IgRect

getCategoryBoundingBoxHelper

Inherited from: IgrTimeAxisBase

getCategoryBoundingBoxHelper(point: IgPoint, useInterpolation: boolean, singularWidth: number, isVertical: boolean): IgRect

Parameters

point: IgPoint
useInterpolation: boolean
singularWidth: number
isVertical: boolean

Returns IgRect

getFullRange

Inherited from: IgrTimeAxisBase

getFullRange(): number[]

Returns number[]

getIndexClosestToUnscaledValue

Gets the index of the data item with the value nearest the given value.

getIndexClosestToUnscaledValue(unscaledValue: number): number

Parameters

unscaledValue: number
- The value to find a value close to.

Returns number

getItemValue

Inherited from: IgrTimeAxisBase

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

Parameters

item: any
memberPathName: string

Returns any

getMemberPathValue

Inherited from: IgrTimeAxisBase

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

notifyClearItems

Inherited from: IgrTimeAxisBase

Used to manually notify the axis that the data source has reset or cleared its items.

notifyClearItems(): void

Returns void

notifyDataChanged

Inherited from: IgrTimeAxisBase

Updates the axis when the data has been changed.

notifyDataChanged(): void

Returns void

notifyInsertItem

Inherited from: IgrTimeAxisBase

notifyInsertItem(index: number, newItem: any): void

Parameters

index: number
newItem: any

Returns void

notifyRemoveItem

Inherited from: IgrTimeAxisBase

notifyRemoveItem(index: number, oldItem: any): void

Parameters

index: number
oldItem: any

Returns void

notifySetItem

Inherited from: IgrTimeAxisBase

notifySetItem(index: number, oldItem: any, newItem: any): void

Parameters

index: number
oldItem: any
newItem: any

Returns void

provideData

Inherited from: IgrTimeAxisBase

provideData(data: any[]): void

Parameters

data: any[]

Returns void

render

Inherited from: IgrTimeAxisBase

render(): any

Returns any

renderAxis

Inherited from: IgrTimeAxisBase

Renders the axis with no animation.

renderAxis(): void

Returns void

resetCachedEnhancedInterval

Inherited from: IgrTimeAxisBase

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

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

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

Parameters

nextProps: any
nextState: any

Returns boolean

unscaleValue

Inherited from: IgrTimeAxisBase

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.

Returns number

_createFromInternal

Inherited from: IgrTimeAxisBase

_createFromInternal(internal: any): IgrAxis

Parameters

internal: any