Represents an category-based horizontal X axis that uses a DateTime scale.

Represents horizontal axis that uses a DateTime scale.

``

``

Constructors

Section titled "Constructors"

IgrTimeAxisBase

new IgrTimeAxisBase(props: P): IgrTimeAxisBase

Returns IgrTimeAxisBase

Properties

Section titled "Properties"

actualMajorStroke

Section titled "actualMajorStroke"

Inherited from: IgrCategoryAxisBase 

actualMajorStroke: string

actualMaximumValue

Section titled "actualMaximumValue" 
actualMaximumValue: Date

actualMaximumValueChange

Section titled "actualMaximumValueChange" 
actualMaximumValueChange: object

actualMinimumValue

Section titled "actualMinimumValue" 
actualMinimumValue: Date

actualMinimumValueChange

Section titled "actualMinimumValueChange" 
actualMinimumValueChange: object

actualMinorStroke

Section titled "actualMinorStroke"

Inherited from: IgrCategoryAxisBase 

actualMinorStroke: string

actualStroke

Section titled "actualStroke"

Inherited from: IgrCategoryAxisBase 

actualStroke: string

annotations

Section titled "annotations"

Inherited from: IgrCategoryAxisBase 

annotations: IgrAxisAnnotationCollection

coercionMethods

Section titled "coercionMethods"

Inherited from: IgrCategoryAxisBase 

coercionMethods: any

companionAxisCrossingAxis

Section titled "companionAxisCrossingAxis"

Inherited from: IgrCategoryAxisBase 

companionAxisCrossingAxis: IgrAxis

companionAxisCrossingAxisName

Section titled "companionAxisCrossingAxisName"

Inherited from: IgrCategoryAxisBase 

companionAxisCrossingAxisName: string

companionAxisCrossingValue

Section titled "companionAxisCrossingValue"

Inherited from: IgrCategoryAxisBase 

companionAxisCrossingValue: number

companionAxisEnabled

Section titled "companionAxisEnabled"

Inherited from: IgrCategoryAxisBase 

companionAxisEnabled: boolean

companionAxisIsInverted

Section titled "companionAxisIsInverted"

Inherited from: IgrCategoryAxisBase 

companionAxisIsInverted: FeatureState

companionAxisLabelAngle

Section titled "companionAxisLabelAngle"

Inherited from: IgrCategoryAxisBase 

companionAxisLabelAngle: number

companionAxisLabelColor

Section titled "companionAxisLabelColor"

Inherited from: IgrCategoryAxisBase 

companionAxisLabelColor: string

companionAxisLabelExtent

Section titled "companionAxisLabelExtent"

Inherited from: IgrCategoryAxisBase 

companionAxisLabelExtent: number

companionAxisLabelHorizontalAlignment

Section titled "companionAxisLabelHorizontalAlignment"

Inherited from: IgrCategoryAxisBase 

companionAxisLabelHorizontalAlignment: HorizontalAlignment

companionAxisLabelLocation

Section titled "companionAxisLabelLocation"

Inherited from: IgrCategoryAxisBase 

companionAxisLabelLocation: AxisLabelsLocation

companionAxisLabelOpposite

Section titled "companionAxisLabelOpposite"

Inherited from: IgrCategoryAxisBase 

companionAxisLabelOpposite: boolean

companionAxisLabelVerticalAlignment

Section titled "companionAxisLabelVerticalAlignment"

Inherited from: IgrCategoryAxisBase 

companionAxisLabelVerticalAlignment: VerticalAlignment

companionAxisLabelVisible

Section titled "companionAxisLabelVisible"

Inherited from: IgrCategoryAxisBase 

companionAxisLabelVisible: FeatureState

companionAxisMajorStroke

Section titled "companionAxisMajorStroke"

Inherited from: IgrCategoryAxisBase 

companionAxisMajorStroke: string

companionAxisMajorStrokeThickness

Section titled "companionAxisMajorStrokeThickness"

Inherited from: IgrCategoryAxisBase 

companionAxisMajorStrokeThickness: number

companionAxisMinExtent

Section titled "companionAxisMinExtent"

Inherited from: IgrCategoryAxisBase 

companionAxisMinExtent: number

companionAxisMinorStroke

Section titled "companionAxisMinorStroke"

Inherited from: IgrCategoryAxisBase 

companionAxisMinorStroke: string

companionAxisMinorStrokeThickness

Section titled "companionAxisMinorStrokeThickness"

Inherited from: IgrCategoryAxisBase 

companionAxisMinorStrokeThickness: number

companionAxisShouldAutoTruncateAnnotations

Section titled "companionAxisShouldAutoTruncateAnnotations"

Inherited from: IgrCategoryAxisBase 

companionAxisShouldAutoTruncateAnnotations: FeatureState

companionAxisShouldAvoidAnnotationCollisions

Section titled "companionAxisShouldAvoidAnnotationCollisions"

Inherited from: IgrCategoryAxisBase 

companionAxisShouldAvoidAnnotationCollisions: FeatureState

companionAxisShouldKeepAnnotationsInView

Section titled "companionAxisShouldKeepAnnotationsInView"

Inherited from: IgrCategoryAxisBase 

companionAxisShouldKeepAnnotationsInView: FeatureState

companionAxisStrip

Section titled "companionAxisStrip"

Inherited from: IgrCategoryAxisBase 

companionAxisStrip: string

companionAxisStroke

Section titled "companionAxisStroke"

Inherited from: IgrCategoryAxisBase 

companionAxisStroke: string

companionAxisStrokeThickness

Section titled "companionAxisStrokeThickness"

Inherited from: IgrCategoryAxisBase 

companionAxisStrokeThickness: number

companionAxisSyncronizedWithPrimaryAxis

Section titled "companionAxisSyncronizedWithPrimaryAxis"

Inherited from: IgrCategoryAxisBase 

companionAxisSyncronizedWithPrimaryAxis: boolean

companionAxisTickLength

Section titled "companionAxisTickLength"

Inherited from: IgrCategoryAxisBase 

companionAxisTickLength: number

companionAxisTickStroke

Section titled "companionAxisTickStroke"

Inherited from: IgrCategoryAxisBase 

companionAxisTickStroke: string

companionAxisTickStrokeThickness

Section titled "companionAxisTickStrokeThickness"

Inherited from: IgrCategoryAxisBase 

companionAxisTickStrokeThickness: number

companionAxisTitle

Section titled "companionAxisTitle"

Inherited from: IgrCategoryAxisBase 

companionAxisTitle: string

crossingAxis

Section titled "crossingAxis"

Inherited from: IgrCategoryAxisBase 

crossingAxis: IgrAxis

crossingAxisName

Section titled "crossingAxisName"

Inherited from: IgrCategoryAxisBase 

crossingAxisName: string

crossingValue

Section titled "crossingValue"

Inherited from: IgrCategoryAxisBase 

crossingValue: any

dataSource

Section titled "dataSource"

Inherited from: IgrCategoryAxisBase 

dataSource: any

dateTimeMemberPath

Section titled "dateTimeMemberPath" 
dateTimeMemberPath: string

enhancedIntervalMinimumCharacters

Section titled "enhancedIntervalMinimumCharacters"

Inherited from: IgrCategoryAxisBase 

enhancedIntervalMinimumCharacters: number

enhancedIntervalPreferMoreCategoryLabels

Section titled "enhancedIntervalPreferMoreCategoryLabels"

Inherited from: IgrCategoryAxisBase 

enhancedIntervalPreferMoreCategoryLabels: boolean

expectFunctions

Section titled "expectFunctions"

Inherited from: IgrCategoryAxisBase 

expectFunctions: boolean

formatLabel

Section titled "formatLabel"

Inherited from: IgrCategoryAxisBase 

formatLabel: object

gap

Section titled "gap"

Inherited from: IgrCategoryAxisBase 

gap: number

isCompanionAxis

Section titled "isCompanionAxis"

Inherited from: IgrCategoryAxisBase 

isCompanionAxis: boolean

isDataPreSorted

Section titled "isDataPreSorted" 
isDataPreSorted: boolean

isDisabled

Section titled "isDisabled"

Inherited from: IgrCategoryAxisBase 

isDisabled: boolean

isInverted

Section titled "isInverted"

Inherited from: IgrCategoryAxisBase 

isInverted: boolean

itemsCount

Section titled "itemsCount"

Inherited from: IgrCategoryAxisBase 

itemsCount: number

label

Section titled "label"

Inherited from: IgrCategoryAxisBase 

label: any

labelAngle

Section titled "labelAngle"

Inherited from: IgrCategoryAxisBase 

labelAngle: number

labelBottomMargin

Section titled "labelBottomMargin"

Inherited from: IgrCategoryAxisBase 

labelBottomMargin: number

labelExtent

Section titled "labelExtent"

Inherited from: IgrCategoryAxisBase 

labelExtent: number

labelFormat

Section titled "labelFormat"

Inherited from: IgrCategoryAxisBase 

labelFormat: string

labelFormatSpecifiers

Section titled "labelFormatSpecifiers"

Inherited from: IgrCategoryAxisBase 

labelFormatSpecifiers: any[]

labelHorizontalAlignment

Section titled "labelHorizontalAlignment"

Inherited from: IgrCategoryAxisBase 

labelHorizontalAlignment: HorizontalAlignment

labelLeftMargin

Section titled "labelLeftMargin"

Inherited from: IgrCategoryAxisBase 

labelLeftMargin: number

labelLocation

Section titled "labelLocation"

Inherited from: IgrCategoryAxisBase 

labelLocation: AxisLabelsLocation

labelMaximumExtent

Section titled "labelMaximumExtent"

Inherited from: IgrCategoryAxisBase 

labelMaximumExtent: number

labelMaximumExtentPercentage

Section titled "labelMaximumExtentPercentage"

Inherited from: IgrCategoryAxisBase 

labelMaximumExtentPercentage: number

labelRightMargin

Section titled "labelRightMargin"

Inherited from: IgrCategoryAxisBase 

labelRightMargin: number

labelShowFirstLabel

Section titled "labelShowFirstLabel"

Inherited from: IgrCategoryAxisBase 

labelShowFirstLabel: boolean

labelTextColor

Section titled "labelTextColor"

Inherited from: IgrCategoryAxisBase 

labelTextColor: string

labelTextStyle

Section titled "labelTextStyle"

Inherited from: IgrCategoryAxisBase 

labelTextStyle: string

labelTopMargin

Section titled "labelTopMargin"

Inherited from: IgrCategoryAxisBase 

labelTopMargin: number

labelVerticalAlignment

Section titled "labelVerticalAlignment"

Inherited from: IgrCategoryAxisBase 

labelVerticalAlignment: VerticalAlignment

labelVisibility

Section titled "labelVisibility"

Inherited from: IgrCategoryAxisBase 

labelVisibility: Visibility

majorStroke

Section titled "majorStroke"

Inherited from: IgrCategoryAxisBase 

majorStroke: string

majorStrokeDashArray

Section titled "majorStrokeDashArray"

Inherited from: IgrCategoryAxisBase 

majorStrokeDashArray: number[]

majorStrokeThickness

Section titled "majorStrokeThickness"

Inherited from: IgrCategoryAxisBase 

majorStrokeThickness: number

maximumGap

Section titled "maximumGap"

Inherited from: IgrCategoryAxisBase 

maximumGap: number

maximumValue

Section titled "maximumValue" 
maximumValue: Date

minimumGapSize

Section titled "minimumGapSize"

Inherited from: IgrCategoryAxisBase 

minimumGapSize: number

minimumValue

Section titled "minimumValue" 
minimumValue: Date

minorStroke

Section titled "minorStroke"

Inherited from: IgrCategoryAxisBase 

minorStroke: string

minorStrokeDashArray

Section titled "minorStrokeDashArray"

Inherited from: IgrCategoryAxisBase 

minorStrokeDashArray: number[]

minorStrokeThickness

Section titled "minorStrokeThickness"

Inherited from: IgrCategoryAxisBase 

minorStrokeThickness: number

name

Section titled "name"

Inherited from: IgrCategoryAxisBase 

name: string

overlap

Section titled "overlap"

Inherited from: IgrCategoryAxisBase 

overlap: number

rangeChanged

Section titled "rangeChanged"

Inherited from: IgrCategoryAxisBase 

rangeChanged: object

renderRequested

Section titled "renderRequested"

Inherited from: IgrCategoryAxisBase 

renderRequested: object

shouldAutoTruncateAnnotations

Section titled "shouldAutoTruncateAnnotations"

Inherited from: IgrCategoryAxisBase 

shouldAutoTruncateAnnotations: boolean

shouldAvoidAnnotationCollisions

Section titled "shouldAvoidAnnotationCollisions"

Inherited from: IgrCategoryAxisBase 

shouldAvoidAnnotationCollisions: boolean

shouldKeepAnnotationsInView

Section titled "shouldKeepAnnotationsInView"

Inherited from: IgrCategoryAxisBase 

shouldKeepAnnotationsInView: boolean

strip

Section titled "strip"

Inherited from: IgrCategoryAxisBase 

strip: string

stroke

Section titled "stroke"

Inherited from: IgrCategoryAxisBase 

stroke: string

strokeDashArray

Section titled "strokeDashArray"

Inherited from: IgrCategoryAxisBase 

strokeDashArray: number[]

strokeThickness

Section titled "strokeThickness"

Inherited from: IgrCategoryAxisBase 

strokeThickness: number

tickLength

Section titled "tickLength"

Inherited from: IgrCategoryAxisBase 

tickLength: number

tickStroke

Section titled "tickStroke"

Inherited from: IgrCategoryAxisBase 

tickStroke: string

tickStrokeDashArray

Section titled "tickStrokeDashArray"

Inherited from: IgrCategoryAxisBase 

tickStrokeDashArray: number[]

tickStrokeThickness

Section titled "tickStrokeThickness"

Inherited from: IgrCategoryAxisBase 

tickStrokeThickness: number

title

Section titled "title"

Inherited from: IgrCategoryAxisBase 

title: string

titleAngle

Section titled "titleAngle"

Inherited from: IgrCategoryAxisBase 

titleAngle: number

titleBottomMargin

Section titled "titleBottomMargin"

Inherited from: IgrCategoryAxisBase 

titleBottomMargin: number

titleExtent

Section titled "titleExtent"

Inherited from: IgrCategoryAxisBase 

titleExtent: number

titleHorizontalAlignment

Section titled "titleHorizontalAlignment"

Inherited from: IgrCategoryAxisBase 

titleHorizontalAlignment: HorizontalAlignment

titleLeftMargin

Section titled "titleLeftMargin"

Inherited from: IgrCategoryAxisBase 

titleLeftMargin: number

titleLocation

Section titled "titleLocation"

Inherited from: IgrCategoryAxisBase 

titleLocation: AxisLabelsLocation

titleMaximumExtent

Section titled "titleMaximumExtent"

Inherited from: IgrCategoryAxisBase 

titleMaximumExtent: number

titleMaximumExtentPercentage

Section titled "titleMaximumExtentPercentage"

Inherited from: IgrCategoryAxisBase 

titleMaximumExtentPercentage: number

titlePosition

Section titled "titlePosition"

Inherited from: IgrCategoryAxisBase 

titlePosition: AxisTitlePosition

titleRightMargin

Section titled "titleRightMargin"

Inherited from: IgrCategoryAxisBase 

titleRightMargin: number

titleShowFirstLabel

Section titled "titleShowFirstLabel"

Inherited from: IgrCategoryAxisBase 

titleShowFirstLabel: boolean

titleTextColor

Section titled "titleTextColor"

Inherited from: IgrCategoryAxisBase 

titleTextColor: string

titleTextStyle

Section titled "titleTextStyle"

Inherited from: IgrCategoryAxisBase 

titleTextStyle: string

titleTopMargin

Section titled "titleTopMargin"

Inherited from: IgrCategoryAxisBase 

titleTopMargin: number

titleVerticalAlignment

Section titled "titleVerticalAlignment"

Inherited from: IgrCategoryAxisBase 

titleVerticalAlignment: VerticalAlignment

titleVisibility

Section titled "titleVisibility"

Inherited from: IgrCategoryAxisBase 

titleVisibility: Visibility

useClusteringMode

Section titled "useClusteringMode"

Inherited from: IgrCategoryAxisBase 

useClusteringMode: boolean

useEnhancedIntervalManagement

Section titled "useEnhancedIntervalManagement"

Inherited from: IgrCategoryAxisBase 

useEnhancedIntervalManagement: boolean

usePerLabelHeightMeasurement

Section titled "usePerLabelHeightMeasurement"

Inherited from: IgrCategoryAxisBase 

usePerLabelHeightMeasurement: boolean

Accessors

Section titled "Accessors"

axisInternal

Section titled "axisInternal"

Inherited from: IgrCategoryAxisBase 

get axisInternal(): Axis

Returns Axis

isAngular

Section titled "isAngular"

Inherited from: IgrCategoryAxisBase

Gets if the current axis is of angular axis type

get isAngular(): boolean

Returns boolean

isCategory

Section titled "isCategory"

Inherited from: IgrCategoryAxisBase

Checks if the axis is of category axis type

get isCategory(): boolean

Returns boolean

isCategoryDateTime

Section titled "isCategoryDateTime"

Inherited from: IgrCategoryAxisBase

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

get isCategoryDateTime(): boolean

Returns boolean

isContinuous

Section titled "isContinuous"

Inherited from: IgrCategoryAxisBase

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

get isContinuous(): boolean

Returns boolean

isDateTime

Section titled "isDateTime"

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

Section titled "isHorizontal"

Inherited from: IgrCategoryAxisBase

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

Section titled "isNumeric"

Inherited from: IgrCategoryAxisBase

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

Section titled "isOrdinal"

Inherited from: IgrCategoryAxisBase

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

get isOrdinal(): boolean

Returns boolean

isPiecewise

Section titled "isPiecewise"

Inherited from: IgrCategoryAxisBase

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

get isPiecewise(): boolean

Returns boolean

isPrimaryAxis

Section titled "isPrimaryAxis"

Inherited from: IgrCategoryAxisBase

Gets whether this is primary axis created by an user

get isPrimaryAxis(): boolean

Returns boolean

isRadial

Section titled "isRadial"

Inherited from: IgrCategoryAxisBase

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

get isRadial(): boolean

Returns boolean

isSorting

Section titled "isSorting"

Checks if axis requires sorting of items

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

``

get isSorting(): boolean

Returns boolean

isVertical

Section titled "isVertical"

Inherited from: IgrCategoryAxisBase

Gets if the current axis is a vertical axis.

get isVertical(): boolean

Returns boolean

i

Section titled "i" 
get i(): Axis

Returns Axis

Methods

Section titled "Methods"

bindAxes

Section titled "bindAxes"

Inherited from: IgrCategoryAxisBase 

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

Parameters

Returns void

componentDidMount

Section titled "componentDidMount"

Inherited from: IgrCategoryAxisBase 

componentDidMount(): void

Returns void

ensureLabelSettings

Section titled "ensureLabelSettings"

Inherited from: IgrCategoryAxisBase 

ensureLabelSettings(): void

Returns void

ensureTitleSettings

Section titled "ensureTitleSettings"

Inherited from: IgrCategoryAxisBase 

ensureTitleSettings(): void

Returns void

findByName

Section titled "findByName"

Inherited from: IgrCategoryAxisBase 

findByName(name: string): any

Parameters

  • name: string

Returns any

getCategoryBoundingBox

Section titled "getCategoryBoundingBox"

Inherited from: IgrCategoryAxisBase 

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

Parameters

  • point: IgPoint
  • useInterpolation: boolean
  • singularWidth: number

Returns IgRect

getCategoryBoundingBoxHelper

Section titled "getCategoryBoundingBoxHelper"

Inherited from: IgrCategoryAxisBase 

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

Parameters

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

Returns IgRect

getFullRange

Section titled "getFullRange" 
getFullRange(): number[]

Returns number[]

getIndexClosestToUnscaledValue

Section titled "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

Section titled "getItemValue" 
getItemValue(item: any, memberPathName: string): any

Parameters

  • item: any
  • memberPathName: string

Returns any

getMemberPathValue

Section titled "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

Section titled "getValueLabel"

Inherited from: IgrCategoryAxisBase

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

Section titled "notifyClearItems"

Inherited from: IgrCategoryAxisBase

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

notifyClearItems(): void

Returns void

notifyDataChanged

Section titled "notifyDataChanged"

Updates the axis when the data has been changed.

notifyDataChanged(): void

Returns void

notifyInsertItem

Section titled "notifyInsertItem"

Inherited from: IgrCategoryAxisBase 

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

Parameters

  • index: number
  • newItem: any

Returns void

notifyRemoveItem

Section titled "notifyRemoveItem"

Inherited from: IgrCategoryAxisBase 

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

Parameters

  • index: number
  • oldItem: any

Returns void

notifySetItem

Section titled "notifySetItem"

Inherited from: IgrCategoryAxisBase 

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

Parameters

  • index: number
  • oldItem: any
  • newItem: any

Returns void

provideData

Section titled "provideData"

Inherited from: IgrCategoryAxisBase 

provideData(data: any[]): void

Parameters

  • data: any[]

Returns void

render

Section titled "render"

Inherited from: IgrCategoryAxisBase 

render(): any

Returns any

renderAxis

Section titled "renderAxis"

Inherited from: IgrCategoryAxisBase

Renders the axis with no animation.

renderAxis(): void

Returns void

resetCachedEnhancedInterval

Section titled "resetCachedEnhancedInterval"

Inherited from: IgrCategoryAxisBase

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

Section titled "scaleValue"

Inherited from: IgrCategoryAxisBase

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

Section titled "shouldComponentUpdate"

Inherited from: IgrCategoryAxisBase 

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

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

unscaleValue

Section titled "unscaleValue"

Inherited from: IgrCategoryAxisBase

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

Section titled "_createFromInternal"

Inherited from: IgrCategoryAxisBase 

_createFromInternal(internal: any): IgrAxis

Parameters

  • internal: any

Returns IgrAxis