IgcTimeXAxisComponent

A horizontal axis that uses a DateTime scale.

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

Constructors

new IgcTimeXAxisComponent(): IgcTimeXAxisComponent

Returns IgcTimeXAxisComponent

Properties

htmlTagName

htmlTagName: string

actualMajorStroke

Inherited from: IgcTimeAxisBaseComponent

actualMajorStroke: string

actualMaximumValue

Inherited from: IgcTimeAxisBaseComponent

actualMaximumValue: Date

actualMaximumValueChange

Inherited from: IgcTimeAxisBaseComponent

actualMaximumValueChange: object

actualMinimumValue

Inherited from: IgcTimeAxisBaseComponent

actualMinimumValue: Date

actualMinimumValueChange

Inherited from: IgcTimeAxisBaseComponent

actualMinimumValueChange: object

actualMinorStroke

Inherited from: IgcTimeAxisBaseComponent

actualMinorStroke: string

actualStroke

Inherited from: IgcTimeAxisBaseComponent

actualStroke: string

annotations

Inherited from: IgcTimeAxisBaseComponent

annotations: IgcAxisAnnotationCollection

breaks

breaks: IgcTimeAxisBreakCollection

coercionMethods

Inherited from: IgcTimeAxisBaseComponent

coercionMethods: any

companionAxisCrossingAxis

Inherited from: IgcTimeAxisBaseComponent

companionAxisCrossingAxis: IgcAxisComponent

companionAxisCrossingAxisName

Inherited from: IgcTimeAxisBaseComponent

companionAxisCrossingAxisName: string

companionAxisCrossingValue

Inherited from: IgcTimeAxisBaseComponent

companionAxisCrossingValue: number

companionAxisEnabled

Inherited from: IgcTimeAxisBaseComponent

companionAxisEnabled: boolean

companionAxisIsInverted

Inherited from: IgcTimeAxisBaseComponent

companionAxisIsInverted: FeatureState

companionAxisLabelAngle

Inherited from: IgcTimeAxisBaseComponent

companionAxisLabelAngle: number

companionAxisLabelColor

Inherited from: IgcTimeAxisBaseComponent

companionAxisLabelColor: string

companionAxisLabelExtent

Inherited from: IgcTimeAxisBaseComponent

companionAxisLabelExtent: number

companionAxisLabelHorizontalAlignment

Inherited from: IgcTimeAxisBaseComponent

companionAxisLabelHorizontalAlignment: HorizontalAlignment

companionAxisLabelLocation

Inherited from: IgcTimeAxisBaseComponent

companionAxisLabelLocation: AxisLabelsLocation

companionAxisLabelOpposite

Inherited from: IgcTimeAxisBaseComponent

companionAxisLabelOpposite: boolean

companionAxisLabelVerticalAlignment

Inherited from: IgcTimeAxisBaseComponent

companionAxisLabelVerticalAlignment: VerticalAlignment

companionAxisLabelVisible

Inherited from: IgcTimeAxisBaseComponent

companionAxisLabelVisible: FeatureState

companionAxisMajorStroke

Inherited from: IgcTimeAxisBaseComponent

companionAxisMajorStroke: string

companionAxisMajorStrokeThickness

Inherited from: IgcTimeAxisBaseComponent

companionAxisMajorStrokeThickness: number

companionAxisMinExtent

Inherited from: IgcTimeAxisBaseComponent

companionAxisMinExtent: number

companionAxisMinorStroke

Inherited from: IgcTimeAxisBaseComponent

companionAxisMinorStroke: string

companionAxisMinorStrokeThickness

Inherited from: IgcTimeAxisBaseComponent

companionAxisMinorStrokeThickness: number

companionAxisShouldAutoTruncateAnnotations

Inherited from: IgcTimeAxisBaseComponent

companionAxisShouldAutoTruncateAnnotations: FeatureState

companionAxisShouldAvoidAnnotationCollisions

Inherited from: IgcTimeAxisBaseComponent

companionAxisShouldAvoidAnnotationCollisions: FeatureState

companionAxisShouldKeepAnnotationsInView

Inherited from: IgcTimeAxisBaseComponent

companionAxisShouldKeepAnnotationsInView: FeatureState

companionAxisStrip

Inherited from: IgcTimeAxisBaseComponent

companionAxisStrip: string

companionAxisStroke

Inherited from: IgcTimeAxisBaseComponent

companionAxisStroke: string

companionAxisStrokeThickness

Inherited from: IgcTimeAxisBaseComponent

companionAxisStrokeThickness: number

companionAxisSyncronizedWithPrimaryAxis

Inherited from: IgcTimeAxisBaseComponent

companionAxisSyncronizedWithPrimaryAxis: boolean

companionAxisTickLength

Inherited from: IgcTimeAxisBaseComponent

companionAxisTickLength: number

companionAxisTickStroke

Inherited from: IgcTimeAxisBaseComponent

companionAxisTickStroke: string

companionAxisTickStrokeThickness

Inherited from: IgcTimeAxisBaseComponent

companionAxisTickStrokeThickness: number

companionAxisTitle

Inherited from: IgcTimeAxisBaseComponent

companionAxisTitle: string

crossingAxis

Inherited from: IgcTimeAxisBaseComponent

crossingAxis: IgcAxisComponent

crossingAxisName

Inherited from: IgcTimeAxisBaseComponent

crossingAxisName: string

crossingValue

Inherited from: IgcTimeAxisBaseComponent

crossingValue: any

dataSource

Inherited from: IgcTimeAxisBaseComponent

dataSource: any

dateTimeMemberPath

Inherited from: IgcTimeAxisBaseComponent

dateTimeMemberPath: string

enhancedIntervalMinimumCharacters

Inherited from: IgcTimeAxisBaseComponent

enhancedIntervalMinimumCharacters: number

enhancedIntervalPreferMoreCategoryLabels

Inherited from: IgcTimeAxisBaseComponent

enhancedIntervalPreferMoreCategoryLabels: boolean

expectFunctions

Inherited from: IgcTimeAxisBaseComponent

expectFunctions: boolean

formatLabel

Inherited from: IgcTimeAxisBaseComponent

formatLabel: object

gap

Inherited from: IgcTimeAxisBaseComponent

gap: number

intervals

intervals: IgcTimeAxisIntervalCollection

isCompanionAxis

Inherited from: IgcTimeAxisBaseComponent

isCompanionAxis: boolean

isDataPreSorted

Inherited from: IgcTimeAxisBaseComponent

isDataPreSorted: boolean

isDisabled

Inherited from: IgcTimeAxisBaseComponent

isDisabled: boolean

isInverted

Inherited from: IgcTimeAxisBaseComponent

isInverted: boolean

isLastLabelMandatory

Inherited from: IgcTimeAxisBaseComponent

isLastLabelMandatory: boolean

itemsCount

Inherited from: IgcTimeAxisBaseComponent

itemsCount: number

label

Inherited from: IgcTimeAxisBaseComponent

label: any

labelAngle

Inherited from: IgcTimeAxisBaseComponent

labelAngle: number

labelBottomMargin

Inherited from: IgcTimeAxisBaseComponent

labelBottomMargin: number

labelExtent

Inherited from: IgcTimeAxisBaseComponent

labelExtent: number

labelFormat

Inherited from: IgcTimeAxisBaseComponent

labelFormat: string

labelFormats

labelFormats: IgcTimeAxisLabelFormatCollection

labelFormatSpecifiers

Inherited from: IgcTimeAxisBaseComponent

labelFormatSpecifiers: any[]

labelHorizontalAlignment

Inherited from: IgcTimeAxisBaseComponent

labelHorizontalAlignment: HorizontalAlignment

labelLeftMargin

Inherited from: IgcTimeAxisBaseComponent

labelLeftMargin: number

labellingMode

labellingMode: TimeAxisLabellingMode

labelLocation

Inherited from: IgcTimeAxisBaseComponent

labelLocation: AxisLabelsLocation

labelMaximumExtent

Inherited from: IgcTimeAxisBaseComponent

labelMaximumExtent: number

labelMaximumExtentPercentage

Inherited from: IgcTimeAxisBaseComponent

labelMaximumExtentPercentage: number

labelRightMargin

Inherited from: IgcTimeAxisBaseComponent

labelRightMargin: number

labelShowFirstLabel

Inherited from: IgcTimeAxisBaseComponent

labelShowFirstLabel: boolean

labelTextColor

Inherited from: IgcTimeAxisBaseComponent

labelTextColor: string

labelTextStyle

Inherited from: IgcTimeAxisBaseComponent

labelTextStyle: string

labelTopMargin

Inherited from: IgcTimeAxisBaseComponent

labelTopMargin: number

labelVerticalAlignment

Inherited from: IgcTimeAxisBaseComponent

labelVerticalAlignment: VerticalAlignment

labelVisibility

Inherited from: IgcTimeAxisBaseComponent

labelVisibility: Visibility

majorStroke

Inherited from: IgcTimeAxisBaseComponent

majorStroke: string

majorStrokeDashArray

Inherited from: IgcTimeAxisBaseComponent

majorStrokeDashArray: number[]

majorStrokeThickness

Inherited from: IgcTimeAxisBaseComponent

majorStrokeThickness: number

maximumGap

Inherited from: IgcTimeAxisBaseComponent

maximumGap: number

maximumValue

Inherited from: IgcTimeAxisBaseComponent

maximumValue: Date

minimumGapSize

Inherited from: IgcTimeAxisBaseComponent

minimumGapSize: number

minimumValue

Inherited from: IgcTimeAxisBaseComponent

minimumValue: Date

minorStroke

Inherited from: IgcTimeAxisBaseComponent

minorStroke: string

minorStrokeDashArray

Inherited from: IgcTimeAxisBaseComponent

minorStrokeDashArray: number[]

minorStrokeThickness

Inherited from: IgcTimeAxisBaseComponent

minorStrokeThickness: number

name

Inherited from: IgcTimeAxisBaseComponent

name: string

overlap

Inherited from: IgcTimeAxisBaseComponent

overlap: number

rangeChanged

Inherited from: IgcTimeAxisBaseComponent

rangeChanged: object

renderRequested

Inherited from: IgcTimeAxisBaseComponent

renderRequested: object

shouldAutoTruncateAnnotations

Inherited from: IgcTimeAxisBaseComponent

shouldAutoTruncateAnnotations: boolean

shouldAvoidAnnotationCollisions

Inherited from: IgcTimeAxisBaseComponent

shouldAvoidAnnotationCollisions: boolean

shouldKeepAnnotationsInView

Inherited from: IgcTimeAxisBaseComponent

shouldKeepAnnotationsInView: boolean

strip

Inherited from: IgcTimeAxisBaseComponent

strip: string

stroke

Inherited from: IgcTimeAxisBaseComponent

stroke: string

strokeDashArray

Inherited from: IgcTimeAxisBaseComponent

strokeDashArray: number[]

strokeThickness

Inherited from: IgcTimeAxisBaseComponent

strokeThickness: number

tickLength

Inherited from: IgcTimeAxisBaseComponent

tickLength: number

tickStroke

Inherited from: IgcTimeAxisBaseComponent

tickStroke: string

tickStrokeDashArray

Inherited from: IgcTimeAxisBaseComponent

tickStrokeDashArray: number[]

tickStrokeThickness

Inherited from: IgcTimeAxisBaseComponent

tickStrokeThickness: number

title

Inherited from: IgcTimeAxisBaseComponent

title: string

titleAngle

Inherited from: IgcTimeAxisBaseComponent

titleAngle: number

titleBottomMargin

Inherited from: IgcTimeAxisBaseComponent

titleBottomMargin: number

titleExtent

Inherited from: IgcTimeAxisBaseComponent

titleExtent: number

titleHorizontalAlignment

Inherited from: IgcTimeAxisBaseComponent

titleHorizontalAlignment: HorizontalAlignment

titleLeftMargin

Inherited from: IgcTimeAxisBaseComponent

titleLeftMargin: number

titleLocation

Inherited from: IgcTimeAxisBaseComponent

titleLocation: AxisLabelsLocation

titleMaximumExtent

Inherited from: IgcTimeAxisBaseComponent

titleMaximumExtent: number

titleMaximumExtentPercentage

Inherited from: IgcTimeAxisBaseComponent

titleMaximumExtentPercentage: number

titlePosition

Inherited from: IgcTimeAxisBaseComponent

titlePosition: AxisTitlePosition

titleRightMargin

Inherited from: IgcTimeAxisBaseComponent

titleRightMargin: number

titleShowFirstLabel

Inherited from: IgcTimeAxisBaseComponent

titleShowFirstLabel: boolean

titleTextColor

Inherited from: IgcTimeAxisBaseComponent

titleTextColor: string

titleTextStyle

Inherited from: IgcTimeAxisBaseComponent

titleTextStyle: string

titleTopMargin

Inherited from: IgcTimeAxisBaseComponent

titleTopMargin: number

titleVerticalAlignment

Inherited from: IgcTimeAxisBaseComponent

titleVerticalAlignment: VerticalAlignment

titleVisibility

Inherited from: IgcTimeAxisBaseComponent

titleVisibility: Visibility

useClusteringMode

Inherited from: IgcTimeAxisBaseComponent

useClusteringMode: boolean

useEnhancedIntervalManagement

Inherited from: IgcTimeAxisBaseComponent

useEnhancedIntervalManagement: boolean

usePerLabelHeightMeasurement

Inherited from: IgcTimeAxisBaseComponent

usePerLabelHeightMeasurement: boolean

Accessors

axisInternal

Inherited from: IgcTimeAxisBaseComponent

get axisInternal(): Axis

Returns Axis

isAngular

Inherited from: IgcTimeAxisBaseComponent

Gets if the current axis is of angular axis type

get isAngular(): boolean

Returns boolean

isCategory

Inherited from: IgcTimeAxisBaseComponent

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

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

get isContinuous(): boolean

Returns boolean

isDateTime

Inherited from: IgcTimeAxisBaseComponent

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

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

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

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

Gets whether this is primary axis created by an user

get isPrimaryAxis(): boolean

Returns boolean

isRadial

Inherited from: IgcTimeAxisBaseComponent

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

get isRadial(): boolean

Returns boolean

isSorting

Inherited from: IgcTimeAxisBaseComponent

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

Gets if the current axis is a vertical axis.

get isVertical(): boolean

Returns boolean

observedAttributes

get observedAttributes(): string[]

Returns string[]

Methods

attributeChangedCallback

Inherited from: IgcTimeAxisBaseComponent

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

Parameters

name: string
oldValue: string
newValue: string

Returns void

bindAxes

Inherited from: IgcTimeAxisBaseComponent

bindAxes(axes: IgcAxisComponent[]): void

Parameters

axes: IgcAxisComponent[]

Returns void

connectedCallback

connectedCallback(): void

Returns void

disconnectedCallback

disconnectedCallback(): void

Returns void

ensureLabelSettings

Inherited from: IgcTimeAxisBaseComponent

ensureLabelSettings(): void

Returns void

ensureTitleSettings

Inherited from: IgcTimeAxisBaseComponent

ensureTitleSettings(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

getCategoryBoundingBox

Inherited from: IgcTimeAxisBaseComponent

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

Parameters

point: IgPoint
useInterpolation: boolean
singularWidth: number

Returns IgRect

getCategoryBoundingBoxHelper

Inherited from: IgcTimeAxisBaseComponent

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

Parameters

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

Returns IgRect

getFullRange

Inherited from: IgcTimeAxisBaseComponent

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

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

Parameters

item: any
memberPathName: string

Returns any

getMemberPathValue

Inherited from: IgcTimeAxisBaseComponent

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

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

notifyClearItems(): void

Returns void

notifyDataChanged

Inherited from: IgcTimeAxisBaseComponent

Updates the axis when the data has been changed.

notifyDataChanged(): void

Returns void

notifyInsertItem

Inherited from: IgcTimeAxisBaseComponent

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

Parameters

index: number
newItem: any

Returns void

notifyRemoveItem

Inherited from: IgcTimeAxisBaseComponent

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

Parameters

index: number
oldItem: any

Returns void

notifySetItem

Inherited from: IgcTimeAxisBaseComponent

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

Parameters

index: number
oldItem: any
newItem: any

Returns void

provideData

Inherited from: IgcTimeAxisBaseComponent

provideData(data: any[]): void

Parameters

data: any[]

Returns void

renderAxis

Inherited from: IgcTimeAxisBaseComponent

Renders the axis with no animation.

renderAxis(): void

Returns void

resetCachedEnhancedInterval

Inherited from: IgcTimeAxisBaseComponent

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

Scales a value from axis space into screen space.

scaleValue(unscaledValue: number): number

Parameters

unscaledValue: number
- The unscaled axis value to scale.

Returns number

unscaleValue

Inherited from: IgcTimeAxisBaseComponent

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

_createFromInternal(internal: any): IgcAxisComponent

Parameters

internal: any

Returns IgcAxisComponent

register

register(): void