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

Represents horizontal axis that uses a DateTime scale.

IgcTimeAxisBaseComponent

new IgcTimeAxisBaseComponent(): IgcTimeAxisBaseComponent

Returns IgcTimeAxisBaseComponent

Inherited from: IgcCategoryAxisBaseComponent

actualMajorStroke: string
actualMaximumValue: Date
actualMaximumValueChange: object
actualMinimumValue: Date
actualMinimumValueChange: object

Inherited from: IgcCategoryAxisBaseComponent

actualMinorStroke: string

Inherited from: IgcCategoryAxisBaseComponent

actualStroke: string

Inherited from: IgcCategoryAxisBaseComponent

annotations: IgcAxisAnnotationCollection

Inherited from: IgcCategoryAxisBaseComponent

coercionMethods: any

Inherited from: IgcCategoryAxisBaseComponent

companionAxisCrossingAxis: IgcAxisComponent

Inherited from: IgcCategoryAxisBaseComponent

companionAxisCrossingAxisName: string

Inherited from: IgcCategoryAxisBaseComponent

companionAxisCrossingValue: number

Inherited from: IgcCategoryAxisBaseComponent

companionAxisEnabled: boolean

Inherited from: IgcCategoryAxisBaseComponent

companionAxisIsInverted: FeatureState

Inherited from: IgcCategoryAxisBaseComponent

companionAxisLabelAngle: number

Inherited from: IgcCategoryAxisBaseComponent

companionAxisLabelColor: string

Inherited from: IgcCategoryAxisBaseComponent

companionAxisLabelExtent: number

companionAxisLabelHorizontalAlignment

Section titled "companionAxisLabelHorizontalAlignment"

Inherited from: IgcCategoryAxisBaseComponent

companionAxisLabelHorizontalAlignment: HorizontalAlignment

Inherited from: IgcCategoryAxisBaseComponent

companionAxisLabelLocation: AxisLabelsLocation

Inherited from: IgcCategoryAxisBaseComponent

companionAxisLabelOpposite: boolean

companionAxisLabelVerticalAlignment

Section titled "companionAxisLabelVerticalAlignment"

Inherited from: IgcCategoryAxisBaseComponent

companionAxisLabelVerticalAlignment: VerticalAlignment

Inherited from: IgcCategoryAxisBaseComponent

companionAxisLabelVisible: FeatureState

Inherited from: IgcCategoryAxisBaseComponent

companionAxisMajorStroke: string

Inherited from: IgcCategoryAxisBaseComponent

companionAxisMajorStrokeThickness: number

Inherited from: IgcCategoryAxisBaseComponent

companionAxisMinExtent: number

Inherited from: IgcCategoryAxisBaseComponent

companionAxisMinorStroke: string

Inherited from: IgcCategoryAxisBaseComponent

companionAxisMinorStrokeThickness: number

companionAxisShouldAutoTruncateAnnotations

Section titled "companionAxisShouldAutoTruncateAnnotations"

Inherited from: IgcCategoryAxisBaseComponent

companionAxisShouldAutoTruncateAnnotations: FeatureState

companionAxisShouldAvoidAnnotationCollisions

Section titled "companionAxisShouldAvoidAnnotationCollisions"

Inherited from: IgcCategoryAxisBaseComponent

companionAxisShouldAvoidAnnotationCollisions: FeatureState

companionAxisShouldKeepAnnotationsInView

Section titled "companionAxisShouldKeepAnnotationsInView"

Inherited from: IgcCategoryAxisBaseComponent

companionAxisShouldKeepAnnotationsInView: FeatureState

Inherited from: IgcCategoryAxisBaseComponent

companionAxisStrip: string

Inherited from: IgcCategoryAxisBaseComponent

companionAxisStroke: string

Inherited from: IgcCategoryAxisBaseComponent

companionAxisStrokeThickness: number

companionAxisSyncronizedWithPrimaryAxis

Section titled "companionAxisSyncronizedWithPrimaryAxis"

Inherited from: IgcCategoryAxisBaseComponent

companionAxisSyncronizedWithPrimaryAxis: boolean

Inherited from: IgcCategoryAxisBaseComponent

companionAxisTickLength: number

Inherited from: IgcCategoryAxisBaseComponent

companionAxisTickStroke: string

Inherited from: IgcCategoryAxisBaseComponent

companionAxisTickStrokeThickness: number

Inherited from: IgcCategoryAxisBaseComponent

companionAxisTitle: string

Inherited from: IgcCategoryAxisBaseComponent

crossingAxis: IgcAxisComponent

Inherited from: IgcCategoryAxisBaseComponent

crossingAxisName: string

Inherited from: IgcCategoryAxisBaseComponent

crossingValue: any

Inherited from: IgcCategoryAxisBaseComponent

dataSource: any
dateTimeMemberPath: string

Inherited from: IgcCategoryAxisBaseComponent

enhancedIntervalMinimumCharacters: number

enhancedIntervalPreferMoreCategoryLabels

Section titled "enhancedIntervalPreferMoreCategoryLabels"

Inherited from: IgcCategoryAxisBaseComponent

enhancedIntervalPreferMoreCategoryLabels: boolean

Inherited from: IgcCategoryAxisBaseComponent

expectFunctions: boolean

Inherited from: IgcCategoryAxisBaseComponent

formatLabel: object

Inherited from: IgcCategoryAxisBaseComponent

gap: number

Inherited from: IgcCategoryAxisBaseComponent

isCompanionAxis: boolean
isDataPreSorted: boolean

Inherited from: IgcCategoryAxisBaseComponent

isDisabled: boolean

Inherited from: IgcCategoryAxisBaseComponent

isInverted: boolean

Inherited from: IgcCategoryAxisBaseComponent

isLastLabelMandatory: boolean

Inherited from: IgcCategoryAxisBaseComponent

itemsCount: number

Inherited from: IgcCategoryAxisBaseComponent

label: any

Inherited from: IgcCategoryAxisBaseComponent

labelAngle: number

Inherited from: IgcCategoryAxisBaseComponent

labelBottomMargin: number

Inherited from: IgcCategoryAxisBaseComponent

labelExtent: number

Inherited from: IgcCategoryAxisBaseComponent

labelFormat: string

Inherited from: IgcCategoryAxisBaseComponent

labelFormatSpecifiers: any[]

Inherited from: IgcCategoryAxisBaseComponent

labelHorizontalAlignment: HorizontalAlignment

Inherited from: IgcCategoryAxisBaseComponent

labelLeftMargin: number

Inherited from: IgcCategoryAxisBaseComponent

labelLocation: AxisLabelsLocation

Inherited from: IgcCategoryAxisBaseComponent

labelMaximumExtent: number

Inherited from: IgcCategoryAxisBaseComponent

labelMaximumExtentPercentage: number

Inherited from: IgcCategoryAxisBaseComponent

labelRightMargin: number

Inherited from: IgcCategoryAxisBaseComponent

labelShowFirstLabel: boolean

Inherited from: IgcCategoryAxisBaseComponent

labelTextColor: string

Inherited from: IgcCategoryAxisBaseComponent

labelTextStyle: string

Inherited from: IgcCategoryAxisBaseComponent

labelTopMargin: number

Inherited from: IgcCategoryAxisBaseComponent

labelVerticalAlignment: VerticalAlignment

Inherited from: IgcCategoryAxisBaseComponent

labelVisibility: Visibility

Inherited from: IgcCategoryAxisBaseComponent

majorStroke: string

Inherited from: IgcCategoryAxisBaseComponent

majorStrokeDashArray: number[]

Inherited from: IgcCategoryAxisBaseComponent

majorStrokeThickness: number

Inherited from: IgcCategoryAxisBaseComponent

maximumGap: number
maximumValue: Date

Inherited from: IgcCategoryAxisBaseComponent

minimumGapSize: number
minimumValue: Date

Inherited from: IgcCategoryAxisBaseComponent

minorStroke: string

Inherited from: IgcCategoryAxisBaseComponent

minorStrokeDashArray: number[]

Inherited from: IgcCategoryAxisBaseComponent

minorStrokeThickness: number

Inherited from: IgcCategoryAxisBaseComponent

name: string

Inherited from: IgcCategoryAxisBaseComponent

overlap: number

Inherited from: IgcCategoryAxisBaseComponent

rangeChanged: object

Inherited from: IgcCategoryAxisBaseComponent

renderRequested: object

Inherited from: IgcCategoryAxisBaseComponent

shouldAutoTruncateAnnotations: boolean

Inherited from: IgcCategoryAxisBaseComponent

shouldAvoidAnnotationCollisions: boolean

Inherited from: IgcCategoryAxisBaseComponent

shouldKeepAnnotationsInView: boolean

Inherited from: IgcCategoryAxisBaseComponent

strip: string

Inherited from: IgcCategoryAxisBaseComponent

stroke: string

Inherited from: IgcCategoryAxisBaseComponent

strokeDashArray: number[]

Inherited from: IgcCategoryAxisBaseComponent

strokeThickness: number

Inherited from: IgcCategoryAxisBaseComponent

tickLength: number

Inherited from: IgcCategoryAxisBaseComponent

tickStroke: string

Inherited from: IgcCategoryAxisBaseComponent

tickStrokeDashArray: number[]

Inherited from: IgcCategoryAxisBaseComponent

tickStrokeThickness: number

Inherited from: IgcCategoryAxisBaseComponent

title: string

Inherited from: IgcCategoryAxisBaseComponent

titleAngle: number

Inherited from: IgcCategoryAxisBaseComponent

titleBottomMargin: number

Inherited from: IgcCategoryAxisBaseComponent

titleExtent: number

Inherited from: IgcCategoryAxisBaseComponent

titleHorizontalAlignment: HorizontalAlignment

Inherited from: IgcCategoryAxisBaseComponent

titleLeftMargin: number

Inherited from: IgcCategoryAxisBaseComponent

titleLocation: AxisLabelsLocation

Inherited from: IgcCategoryAxisBaseComponent

titleMaximumExtent: number

Inherited from: IgcCategoryAxisBaseComponent

titleMaximumExtentPercentage: number

Inherited from: IgcCategoryAxisBaseComponent

titlePosition: AxisTitlePosition

Inherited from: IgcCategoryAxisBaseComponent

titleRightMargin: number

Inherited from: IgcCategoryAxisBaseComponent

titleShowFirstLabel: boolean

Inherited from: IgcCategoryAxisBaseComponent

titleTextColor: string

Inherited from: IgcCategoryAxisBaseComponent

titleTextStyle: string

Inherited from: IgcCategoryAxisBaseComponent

titleTopMargin: number

Inherited from: IgcCategoryAxisBaseComponent

titleVerticalAlignment: VerticalAlignment

Inherited from: IgcCategoryAxisBaseComponent

titleVisibility: Visibility

Inherited from: IgcCategoryAxisBaseComponent

useClusteringMode: boolean

Inherited from: IgcCategoryAxisBaseComponent

useEnhancedIntervalManagement: boolean

Inherited from: IgcCategoryAxisBaseComponent

usePerLabelHeightMeasurement: boolean

Inherited from: IgcCategoryAxisBaseComponent

get axisInternal(): Axis

Returns Axis

Inherited from: IgcCategoryAxisBaseComponent

Gets if the current axis is of angular axis type

get isAngular(): boolean

Returns boolean

Inherited from: IgcCategoryAxisBaseComponent

Checks if the axis is of category axis type

get isCategory(): boolean

Returns boolean

Inherited from: IgcCategoryAxisBaseComponent

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

get isCategoryDateTime(): boolean

Returns boolean

Inherited from: IgcCategoryAxisBaseComponent

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

get isContinuous(): boolean

Returns boolean

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

Inherited from: IgcCategoryAxisBaseComponent

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

Inherited from: IgcCategoryAxisBaseComponent

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

Inherited from: IgcCategoryAxisBaseComponent

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

get isOrdinal(): boolean

Returns boolean

Inherited from: IgcCategoryAxisBaseComponent

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

get isPiecewise(): boolean

Returns boolean

Inherited from: IgcCategoryAxisBaseComponent

Gets whether this is primary axis created by an user

get isPrimaryAxis(): boolean

Returns boolean

Inherited from: IgcCategoryAxisBaseComponent

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

get isRadial(): boolean

Returns boolean

Checks if axis requires sorting of items

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

``

get isSorting(): boolean

Returns boolean

Inherited from: IgcCategoryAxisBaseComponent

Gets if the current axis is a vertical axis.

get isVertical(): boolean

Returns boolean

get observedAttributes(): string[]

Returns string[]

Inherited from: IgcCategoryAxisBaseComponent

attributeChangedCallback(name: string, oldValue: string, newValue: string): void

Parameters

  • name: string
  • oldValue: string
  • newValue: string

Returns void

Inherited from: IgcCategoryAxisBaseComponent

bindAxes(axes: IgcAxisComponent[]): void

Parameters

Returns void

connectedCallback(): void

Returns void

disconnectedCallback(): void

Returns void

Inherited from: IgcCategoryAxisBaseComponent

ensureLabelSettings(): void

Returns void

Inherited from: IgcCategoryAxisBaseComponent

ensureTitleSettings(): void

Returns void

Inherited from: IgcCategoryAxisBaseComponent

findByName(name: string): any

Parameters

  • name: string

Returns any

Inherited from: IgcCategoryAxisBaseComponent

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

Parameters

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

Returns IgRect

Inherited from: IgcCategoryAxisBaseComponent

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

Parameters

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

Returns IgRect

getFullRange(): number[]

Returns number[]

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(item: any, memberPathName: string): any

Parameters

  • item: any
  • memberPathName: string

Returns any

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

Inherited from: IgcCategoryAxisBaseComponent

Gets the label for a data item.

getValueLabel(value: number): string

Parameters

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

Returns string

Inherited from: IgcCategoryAxisBaseComponent

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

notifyClearItems(): void

Returns void

Updates the axis when the data has been changed.

notifyDataChanged(): void

Returns void

Inherited from: IgcCategoryAxisBaseComponent

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

Parameters

  • index: number
  • newItem: any

Returns void

Inherited from: IgcCategoryAxisBaseComponent

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

Parameters

  • index: number
  • oldItem: any

Returns void

Inherited from: IgcCategoryAxisBaseComponent

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

Parameters

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

Returns void

Inherited from: IgcCategoryAxisBaseComponent

provideData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgcCategoryAxisBaseComponent

Renders the axis with no animation.

renderAxis(): void

Returns void

Inherited from: IgcCategoryAxisBaseComponent

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

Inherited from: IgcCategoryAxisBaseComponent

Scales a value from axis space into screen space.

scaleValue(unscaledValue: number): number

Parameters

  • unscaledValue: number
    • The unscaled axis value to scale.

Returns number

Inherited from: IgcCategoryAxisBaseComponent

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

Inherited from: IgcCategoryAxisBaseComponent

_createFromInternal(internal: any): IgcAxisComponent

Parameters

  • internal: any

Returns IgcAxisComponent