IgxTimeXAxisComponent

A horizontal axis that uses a DateTime scale.

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

<igx-data-chart
    [dataSource]="data">
    <igx-time-x-axis
		dateTimeMemberPath="date"
		#xAxis>
    </igx-time-x-axis>
</igx-data-chart>

let xAxis = new IgxTimeXAxisComponent();
xAxis.dataTimeMemberPath="date";
this.chart.axes.add(xAxis);

Constructors

new IgxTimeXAxisComponent(): IgxTimeXAxisComponent

Returns IgxTimeXAxisComponent

Properties

ngAcceptInputType_annotations

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_annotations: string | IgxAxisAnnotationCollection

ngAcceptInputType_breaks

ngAcceptInputType_breaks: string | IgxTimeAxisBreakCollection

ngAcceptInputType_companionAxisCrossingValue

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisCrossingValue: string | number

ngAcceptInputType_companionAxisEnabled

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisEnabled: string | boolean

ngAcceptInputType_companionAxisIsInverted

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisIsInverted: any

ngAcceptInputType_companionAxisLabelAngle

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisLabelAngle: string | number

ngAcceptInputType_companionAxisLabelExtent

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisLabelExtent: string | number

ngAcceptInputType_companionAxisLabelHorizontalAlignment

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisLabelHorizontalAlignment: any

ngAcceptInputType_companionAxisLabelLocation

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisLabelLocation: string | AxisLabelsLocation

ngAcceptInputType_companionAxisLabelOpposite

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisLabelOpposite: string | boolean

ngAcceptInputType_companionAxisLabelVerticalAlignment

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisLabelVerticalAlignment: any

ngAcceptInputType_companionAxisLabelVisible

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisLabelVisible: any

ngAcceptInputType_companionAxisMajorStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisMajorStrokeThickness: string | number

ngAcceptInputType_companionAxisMinExtent

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisMinExtent: string | number

ngAcceptInputType_companionAxisMinorStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisMinorStrokeThickness: string | number

ngAcceptInputType_companionAxisShouldAutoTruncateAnnotations

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisShouldAutoTruncateAnnotations: any

ngAcceptInputType_companionAxisShouldAvoidAnnotationCollisions

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisShouldAvoidAnnotationCollisions: any

ngAcceptInputType_companionAxisShouldKeepAnnotationsInView

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisShouldKeepAnnotationsInView: any

ngAcceptInputType_companionAxisStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisStrokeThickness: string | number

ngAcceptInputType_companionAxisSyncronizedWithPrimaryAxis

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisSyncronizedWithPrimaryAxis: string | boolean

ngAcceptInputType_companionAxisTickLength

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisTickLength: string | number

ngAcceptInputType_companionAxisTickStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_companionAxisTickStrokeThickness: string | number

ngAcceptInputType_enhancedIntervalMinimumCharacters

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_enhancedIntervalMinimumCharacters: string | number

ngAcceptInputType_enhancedIntervalPreferMoreCategoryLabels

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_enhancedIntervalPreferMoreCategoryLabels: string | boolean

ngAcceptInputType_expectFunctions

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_expectFunctions: string | boolean

ngAcceptInputType_gap

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_gap: string | number

ngAcceptInputType_intervals

ngAcceptInputType_intervals: string | IgxTimeAxisIntervalCollection

ngAcceptInputType_isAngular

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isAngular: string | boolean

ngAcceptInputType_isCategory

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isCategory: string | boolean

ngAcceptInputType_isCategoryDateTime

ngAcceptInputType_isCategoryDateTime: string | boolean

ngAcceptInputType_isCompanionAxis

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isCompanionAxis: string | boolean

ngAcceptInputType_isContinuous

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isContinuous: string | boolean

ngAcceptInputType_isDataPreSorted

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isDataPreSorted: string | boolean

ngAcceptInputType_isDateTime

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isDateTime: string | boolean

ngAcceptInputType_isDisabled

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isDisabled: string | boolean

ngAcceptInputType_isHorizontal

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isHorizontal: string | boolean

ngAcceptInputType_isInverted

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isInverted: string | boolean

ngAcceptInputType_isLastLabelMandatory

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isLastLabelMandatory: string | boolean

ngAcceptInputType_isNumeric

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isNumeric: string | boolean

ngAcceptInputType_isOrdinal

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isOrdinal: string | boolean

ngAcceptInputType_isPiecewise

ngAcceptInputType_isPiecewise: string | boolean

ngAcceptInputType_isPrimaryAxis

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isPrimaryAxis: string | boolean

ngAcceptInputType_isRadial

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isRadial: string | boolean

ngAcceptInputType_isSorting

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isSorting: string | boolean

ngAcceptInputType_isVertical

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_isVertical: string | boolean

ngAcceptInputType_itemsCount

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_itemsCount: string | number

ngAcceptInputType_labelAngle

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelAngle: string | number

ngAcceptInputType_labelBottomMargin

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelBottomMargin: string | number

ngAcceptInputType_labelExtent

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelExtent: string | number

ngAcceptInputType_labelFormats

ngAcceptInputType_labelFormats: string | IgxTimeAxisLabelFormatCollection

ngAcceptInputType_labelFormatSpecifiers

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelFormatSpecifiers: string | any[]

ngAcceptInputType_labelHorizontalAlignment

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelHorizontalAlignment: any

ngAcceptInputType_labelLeftMargin

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelLeftMargin: string | number

ngAcceptInputType_labellingMode

ngAcceptInputType_labellingMode: string | TimeAxisLabellingMode

ngAcceptInputType_labelLocation

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelLocation: string | AxisLabelsLocation

ngAcceptInputType_labelMaximumExtent

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelMaximumExtent: string | number

ngAcceptInputType_labelMaximumExtentPercentage

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelMaximumExtentPercentage: string | number

ngAcceptInputType_labelRightMargin

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelRightMargin: string | number

ngAcceptInputType_labelShowFirstLabel

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelShowFirstLabel: string | boolean

ngAcceptInputType_labelTopMargin

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelTopMargin: string | number

ngAcceptInputType_labelVerticalAlignment

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelVerticalAlignment: any

ngAcceptInputType_labelVisibility

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_labelVisibility: any

ngAcceptInputType_majorStrokeDashArray

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_majorStrokeDashArray: string | number[]

ngAcceptInputType_majorStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_majorStrokeThickness: string | number

ngAcceptInputType_maximumGap

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_maximumGap: string | number

ngAcceptInputType_minimumGapSize

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_minimumGapSize: string | number

ngAcceptInputType_minorStrokeDashArray

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_minorStrokeDashArray: string | number[]

ngAcceptInputType_minorStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_minorStrokeThickness: string | number

ngAcceptInputType_overlap

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_overlap: string | number

ngAcceptInputType_shouldAutoTruncateAnnotations

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_shouldAutoTruncateAnnotations: string | boolean

ngAcceptInputType_shouldAvoidAnnotationCollisions

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_shouldAvoidAnnotationCollisions: string | boolean

ngAcceptInputType_shouldKeepAnnotationsInView

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_shouldKeepAnnotationsInView: string | boolean

ngAcceptInputType_strokeDashArray

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_strokeDashArray: string | number[]

ngAcceptInputType_strokeThickness

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_strokeThickness: string | number

ngAcceptInputType_tickLength

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_tickLength: string | number

ngAcceptInputType_tickStrokeDashArray

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_tickStrokeDashArray: string | number[]

ngAcceptInputType_tickStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_tickStrokeThickness: string | number

ngAcceptInputType_titleAngle

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleAngle: string | number

ngAcceptInputType_titleBottomMargin

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleBottomMargin: string | number

ngAcceptInputType_titleExtent

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleExtent: string | number

ngAcceptInputType_titleHorizontalAlignment

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleHorizontalAlignment: any

ngAcceptInputType_titleLeftMargin

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleLeftMargin: string | number

ngAcceptInputType_titleLocation

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleLocation: string | AxisLabelsLocation

ngAcceptInputType_titleMaximumExtent

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleMaximumExtent: string | number

ngAcceptInputType_titleMaximumExtentPercentage

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleMaximumExtentPercentage: string | number

ngAcceptInputType_titlePosition

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titlePosition: string | AxisTitlePosition

ngAcceptInputType_titleRightMargin

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleRightMargin: string | number

ngAcceptInputType_titleShowFirstLabel

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleShowFirstLabel: string | boolean

ngAcceptInputType_titleTopMargin

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleTopMargin: string | number

ngAcceptInputType_titleVerticalAlignment

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleVerticalAlignment: any

ngAcceptInputType_titleVisibility

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_titleVisibility: any

ngAcceptInputType_useClusteringMode

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_useClusteringMode: string | boolean

ngAcceptInputType_useEnhancedIntervalManagement

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_useEnhancedIntervalManagement: string | boolean

ngAcceptInputType_usePerLabelHeightMeasurement

Inherited from: IgxTimeAxisBaseComponent

ngAcceptInputType_usePerLabelHeightMeasurement: string | boolean

ɵcmp

ɵcmp: ɵɵComponentDeclaration<IgxTimeXAxisComponent, "igx-time-x-axis", never, object, object, never, never, true, never>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxTimeXAxisComponent, never>

Accessors

actualMajorStroke

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the ActualMajorStroke property.

The ActualMajorStroke property is used for ActualMajorStroke of the axis.

get actualMajorStroke(): string

Returns string

set actualMajorStroke(v: string): void

Parameters

v: string

Returns void

actualMaximumValue

Inherited from: IgxTimeAxisBaseComponent

Gets the coerced maximum value.

Use ActualMaximumValue to get the coerced maximum value

get actualMaximumValue(): Date

Returns Date

set actualMaximumValue(v: Date): void

Parameters

v: Date

Returns void

actualMaximumValueChange

Inherited from: IgxTimeAxisBaseComponent

get actualMaximumValueChange(): EventEmitter<Date>

Returns EventEmitter<Date>

actualMinimumValue

Inherited from: IgxTimeAxisBaseComponent

Gets the coerced minimum value.

Use ActualMinimumValue to get the coerced maximum value.

get actualMinimumValue(): Date

Returns Date

set actualMinimumValue(v: Date): void

Parameters

v: Date

Returns void

actualMinimumValueChange

Inherited from: IgxTimeAxisBaseComponent

get actualMinimumValueChange(): EventEmitter<Date>

Returns EventEmitter<Date>

actualMinorStroke

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the ActualMinorStroke property.

The ActualMinorStroke property is used for ActualMinorStroke of the axis.

get actualMinorStroke(): string

Returns string

set actualMinorStroke(v: string): void

Parameters

v: string

Returns void

actualStroke

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the effective stroke used for the axis.

get actualStroke(): string

Returns string

set actualStroke(v: string): void

Parameters

v: string

Returns void

annotations

Inherited from: IgxTimeAxisBaseComponent

Gets the current annotations for the axis.

get annotations(): IgxAxisAnnotationCollection

Returns IgxAxisAnnotationCollection

set annotations(v: IgxAxisAnnotationCollection): void

Parameters

v: IgxAxisAnnotationCollection

Returns void

axisInternal

Inherited from: IgxTimeAxisBaseComponent

get axisInternal(): Axis

Returns Axis

breaks

TimeAxisBreaks to apply to this axis, representing spans of time to omit, such as weekends.

The Breaks to apply to this axis, representing spans of time to omit, such as weekends.

<igx-data-chart
    [dataSource]="data">
    <igx-time-x-axis
		dateTimeMemberPath="date"
		#xAxis>
    </igx-time-x-axis>
</igx-data-chart>

let xAxis = new IgxTimeXAxisComponent();
xAxis.dataTimeMemberPath="date";
this.chart.axes.add(xAxis);

get breaks(): IgxTimeAxisBreakCollection

Returns IgxTimeAxisBreakCollection

set breaks(v: IgxTimeAxisBreakCollection): void

Parameters

v: IgxTimeAxisBreakCollection

Returns void

coercionMethods

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the coercion methods to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be re-imported into the chart.

The coercionMethods methods is to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be reimported into the chart.

get coercionMethods(): any

Returns any

set coercionMethods(v: any): void

Parameters

v: any

Returns void

companionAxisCrossingAxis

Inherited from: IgxTimeAxisBaseComponent

Gets or sets crossing axis for the companion axis.

get companionAxisCrossingAxis(): IgxAxisComponent

Returns IgxAxisComponent

set companionAxisCrossingAxis(v: IgxAxisComponent): void

Parameters

v: IgxAxisComponent

Returns void

companionAxisCrossingValue

Inherited from: IgxTimeAxisBaseComponent

Gets or sets crossing value for the companion axis.

get companionAxisCrossingValue(): number

Returns number

set companionAxisCrossingValue(v: number): void

Parameters

v: number

Returns void

companionAxisEnabled

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether or not the companion axis is enabled for this axis.

get companionAxisEnabled(): boolean

Returns boolean

set companionAxisEnabled(v: boolean): void

Parameters

v: boolean

Returns void

companionAxisIsInverted

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether or not the companion axis is inverted.

get companionAxisIsInverted(): FeatureState

Returns FeatureState

set companionAxisIsInverted(v: FeatureState): void

Parameters

v: FeatureState

Returns void

companionAxisLabelAngle

Inherited from: IgxTimeAxisBaseComponent

Gets or sets label angle on the companion axis.

get companionAxisLabelAngle(): number

Returns number

set companionAxisLabelAngle(v: number): void

Parameters

v: number

Returns void

companionAxisLabelColor

Inherited from: IgxTimeAxisBaseComponent

Gets or sets color of labels on the companion axis.

get companionAxisLabelColor(): string

Returns string

set companionAxisLabelColor(v: string): void

Parameters

v: string

Returns void

companionAxisLabelExtent

Inherited from: IgxTimeAxisBaseComponent

Gets or sets extent of labels on the companion axis.

get companionAxisLabelExtent(): number

Returns number

set companionAxisLabelExtent(v: number): void

Parameters

v: number

Returns void

companionAxisLabelHorizontalAlignment

Inherited from: IgxTimeAxisBaseComponent

Gets or sets horizontal alignment of labels on the companion axis.

get companionAxisLabelHorizontalAlignment(): HorizontalAlignment

Returns HorizontalAlignment

set companionAxisLabelHorizontalAlignment(v: HorizontalAlignment): void

Parameters

v: HorizontalAlignment

Returns void

companionAxisLabelLocation

Inherited from: IgxTimeAxisBaseComponent

Gets or sets location of labels on the companion axis.

get companionAxisLabelLocation(): AxisLabelsLocation

Returns AxisLabelsLocation

set companionAxisLabelLocation(v: AxisLabelsLocation): void

Parameters

v: AxisLabelsLocation

Returns void

companionAxisLabelOpposite

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether or not the companion axis has opposite location of this axis.

get companionAxisLabelOpposite(): boolean

Returns boolean

set companionAxisLabelOpposite(v: boolean): void

Parameters

v: boolean

Returns void

companionAxisLabelVerticalAlignment

Inherited from: IgxTimeAxisBaseComponent

Gets or sets vertical alignment of the companion axis.

get companionAxisLabelVerticalAlignment(): VerticalAlignment

Returns VerticalAlignment

set companionAxisLabelVerticalAlignment(v: VerticalAlignment): void

Parameters

v: VerticalAlignment

Returns void

companionAxisLabelVisible

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether or not the companion axis has visible labels.

get companionAxisLabelVisible(): FeatureState

Returns FeatureState

set companionAxisLabelVisible(v: FeatureState): void

Parameters

v: FeatureState

Returns void

companionAxisMajorStroke

Inherited from: IgxTimeAxisBaseComponent

Gets or sets stroke of major gridlines on the companion axis.

get companionAxisMajorStroke(): string

Returns string

set companionAxisMajorStroke(v: string): void

Parameters

v: string

Returns void

companionAxisMajorStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

Gets or sets thickness of major gridlines on the companion axis.

get companionAxisMajorStrokeThickness(): number

Returns number

set companionAxisMajorStrokeThickness(v: number): void

Parameters

v: number

Returns void

companionAxisMinExtent

Inherited from: IgxTimeAxisBaseComponent

Gets or sets label angle on the companion axis.

get companionAxisMinExtent(): number

Returns number

set companionAxisMinExtent(v: number): void

Parameters

v: number

Returns void

companionAxisMinorStroke

Inherited from: IgxTimeAxisBaseComponent

Gets or sets stroke of minior gridlines on the companion axis.

get companionAxisMinorStroke(): string

Returns string

set companionAxisMinorStroke(v: string): void

Parameters

v: string

Returns void

companionAxisMinorStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

Gets or sets thickness of minior gridlines on the companion axis.

get companionAxisMinorStrokeThickness(): number

Returns number

set companionAxisMinorStrokeThickness(v: number): void

Parameters

v: number

Returns void

companionAxisShouldAutoTruncateAnnotations

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether or not the companion axis should auto truncate annotations.

get companionAxisShouldAutoTruncateAnnotations(): FeatureState

Returns FeatureState

set companionAxisShouldAutoTruncateAnnotations(v: FeatureState): void

Parameters

v: FeatureState

Returns void

companionAxisShouldAvoidAnnotationCollisions

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether or not the companion axis should avoid annotation collisions.

get companionAxisShouldAvoidAnnotationCollisions(): FeatureState

Returns FeatureState

set companionAxisShouldAvoidAnnotationCollisions(v: FeatureState): void

Parameters

v: FeatureState

Returns void

companionAxisShouldKeepAnnotationsInView

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether or not the companion axis should keep annotations in view.

get companionAxisShouldKeepAnnotationsInView(): FeatureState

Returns FeatureState

set companionAxisShouldKeepAnnotationsInView(v: FeatureState): void

Parameters

v: FeatureState

Returns void

companionAxisStrip

Inherited from: IgxTimeAxisBaseComponent

Gets or sets color of strips on the companion axis.

get companionAxisStrip(): string

Returns string

set companionAxisStrip(v: string): void

Parameters

v: string

Returns void

companionAxisStroke

Inherited from: IgxTimeAxisBaseComponent

Gets or sets color of line stroke on the companion axis.

get companionAxisStroke(): string

Returns string

set companionAxisStroke(v: string): void

Parameters

v: string

Returns void

companionAxisStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

Gets or sets label angle on the companion axis.

get companionAxisStrokeThickness(): number

Returns number

set companionAxisStrokeThickness(v: number): void

Parameters

v: number

Returns void

companionAxisSyncronizedWithPrimaryAxis

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether or not the companion axis is syncronized with properties of primary axis unless CompanionAxis* properties are set In other words, companion axis' LabelExtent will syncronize with primary axis' LabelExtent unless CompanionAxisLabelExtent is set

get companionAxisSyncronizedWithPrimaryAxis(): boolean

Returns boolean

set companionAxisSyncronizedWithPrimaryAxis(v: boolean): void

Parameters

v: boolean

Returns void

companionAxisTickLength

Inherited from: IgxTimeAxisBaseComponent

Gets or sets length of ticks on the companion axis.

get companionAxisTickLength(): number

Returns number

set companionAxisTickLength(v: number): void

Parameters

v: number

Returns void

companionAxisTickStroke

Inherited from: IgxTimeAxisBaseComponent

Gets or sets color of ticks on the companion axis.

get companionAxisTickStroke(): string

Returns string

set companionAxisTickStroke(v: string): void

Parameters

v: string

Returns void

companionAxisTickStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

Gets or sets label angle on the companion axis.

get companionAxisTickStrokeThickness(): number

Returns number

set companionAxisTickStrokeThickness(v: number): void

Parameters

v: number

Returns void

companionAxisTitle

Inherited from: IgxTimeAxisBaseComponent

Gets or sets title on the companion axis.

get companionAxisTitle(): string

Returns string

set companionAxisTitle(v: string): void

Parameters

v: string

Returns void

crossingAxis

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the CrossingAxis property.

The CrossingAxis property is used for CrossingAxis .

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
		crossingAxis= "xAxis"
		crossingValue= 700
		#yAxis>
    </igx-numeric-y-axis>
</igx-data-chart>

get crossingAxis(): IgxAxisComponent

Returns IgxAxisComponent

set crossingAxis(v: IgxAxisComponent): void

Parameters

v: IgxAxisComponent

Returns void

crossingValue

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the CrossingValue property.

The CrossingValue property is used for CrossingValue of the axis.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
		crossingAxis= "xAxis"
		crossingValue= 700
		#yAxis>
    </igx-numeric-y-axis>
</igx-data-chart>

get crossingValue(): any

Returns any

set crossingValue(v: any): void

Parameters

v: any

Returns void

dataSource

Inherited from: IgxTimeAxisBaseComponent

get dataSource(): any

Returns any

set dataSource(value: any): void

Parameters

value: any

Returns void

dateTimeMemberPath

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the DateTime mapping property for the axis.

Use DateTimeMemberPath property for DateTime mapping with the axis.

<igx-data-chart
    [dataSource]="data">
    <igx-time-x-axis
		dateTimeMemberPath="date"
		#xAxis>
    </igx-time-x-axis>
</igx-data-chart>

let xAxis = new IgxTimeXAxisComponent();
xAxis.dataTimeMemberPath="date";
this.chart.axes.add(xAxis);

get dateTimeMemberPath(): string

Returns string

set dateTimeMemberPath(v: string): void

Parameters

v: string

Returns void

enhancedIntervalMinimumCharacters

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the minimum desired characters to be displayed for horizontal axes when using advanced label heuristics. -1 will attempt to adjust the interval to precisely fit the horizontal labels.

The EnhancedIntervalMinimumCharacters property is used to set the mininum desired characters to be displayed for horizontal axes when using advanced label heuristics.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
		enhancedIntervalMinimumCharacters=5
		#yAxis>
    </igx-numeric-y-axis>

</igx-data-chart>

get enhancedIntervalMinimumCharacters(): number

Returns number

set enhancedIntervalMinimumCharacters(v: number): void

Parameters

v: number

Returns void

enhancedIntervalPreferMoreCategoryLabels

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether the enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval.

get enhancedIntervalPreferMoreCategoryLabels(): boolean

Returns boolean

set enhancedIntervalPreferMoreCategoryLabels(v: boolean): void

Parameters

v: boolean

Returns void

expectFunctions

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether the series should expect that properties in its items source may be functions that need to be evaluated to yield their value. This defaults to false, as there will be a subtle performance impact to using this feature. This value must be set before assigning an item's source to take effect.

get expectFunctions(): boolean

Returns boolean

set expectFunctions(v: boolean): void

Parameters

v: boolean

Returns void

formatLabel

Inherited from: IgxTimeAxisBaseComponent

Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.

The FormatLabel function takes an object that produces a formatted label for displaying in the chart.

<igx-data-chart [dataSource]="data" >
    <igx-category-x-axis
		name="xAxis"
		FormatLabel="xAxis_FormatLabel" />
</igx-data-chart>

get formatLabel(): object

Returns object

set formatLabel(v: object): void

Parameters

v: object

Returns void

gap

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the amount of space between adjacent categories for the current axis object. The gap is silently clamped to the range [0, 1] when used.

Use the Gap property to configure the spacing between items on a category axis with item spacing.

A Gap of 0 allocates no space between items. A Gap of 1 allocates a space between items equal to the width of one item.

To set the item spacing to 75% the width of one item, set the Gap to 0.75, as in this code:

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        gap="0.75"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value">
    </igx-column-series>
</igx-data-chart>

get gap(): number

Returns number

set gap(v: number): void

Parameters

v: number

Returns void

intervals

A list of axis label intervals to apply, which are selected according to the visible axis range. The interval selected will be the one with the largest range smaller than the visible range of the axis.

get intervals(): IgxTimeAxisIntervalCollection

Returns IgxTimeAxisIntervalCollection

set intervals(v: IgxTimeAxisIntervalCollection): void

Parameters

v: IgxTimeAxisIntervalCollection

Returns void

isAngular

Inherited from: IgxTimeAxisBaseComponent

Gets if the current axis is of angular axis type

get isAngular(): boolean

Returns boolean

isCategory

Inherited from: IgxTimeAxisBaseComponent

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

isCompanionAxis

Inherited from: IgxTimeAxisBaseComponent

Gets whether this is companion axis automatically created for a primary axis

get isCompanionAxis(): boolean

Returns boolean

set isCompanionAxis(v: boolean): void

Parameters

v: boolean

Returns void

isContinuous

Inherited from: IgxTimeAxisBaseComponent

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

get isContinuous(): boolean

Returns boolean

isDataPreSorted

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether the data assigned to the date time axis should be considered pre-sorted by date/time.

Use IsDataPreSorted property to decide if the data assigned to the date time axis should be considered pre-sorted by date/time.

get isDataPreSorted(): boolean

Returns boolean

set isDataPreSorted(v: boolean): void

Parameters

v: boolean

Returns void

isDateTime

Inherited from: IgxTimeAxisBaseComponent

Checks if the axis is of date time axis type

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

const isDT = this.timeXAxis.isDateTime;

get isDateTime(): boolean

Returns boolean

isDisabled

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the IsDisabled property. If true, the axis will not be rendered.

The IsDisabled property is used to decide if the axis will not be rendered.

get isDisabled(): boolean

Returns boolean

set isDisabled(v: boolean): void

Parameters

v: boolean

Returns void

isHorizontal

Inherited from: IgxTimeAxisBaseComponent

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

isInverted

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the IsInverted property.

Gets or sets the IsInverted property.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		isInverted= true
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
		#yAxis>
    </igx-numeric-y-axis>

</igx-data-chart>

get isInverted(): boolean

Returns boolean

set isInverted(v: boolean): void

Parameters

v: boolean

Returns void

isLastLabelMandatory

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether the last label on the axis is mandatory. When true, the axis will ensure the last data item's label is always displayed, even if it does not fall on a regular interval step. This may cause labels to be unevenly spaced, triggering the more expensive anti-collision path.

get isLastLabelMandatory(): boolean

Returns boolean

set isLastLabelMandatory(v: boolean): void

Parameters

v: boolean

Returns void

isNumeric

Inherited from: IgxTimeAxisBaseComponent

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

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

Gets whether this is primary axis created by an user

get isPrimaryAxis(): boolean

Returns boolean

isRadial

Inherited from: IgxTimeAxisBaseComponent

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

get isRadial(): boolean

Returns boolean

isSorting

Inherited from: IgxTimeAxisBaseComponent

Checks if axis requires sorting of items

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

const isDT = this.timeXAxis.isDateTime;

get isSorting(): boolean

Returns boolean

isVertical

Inherited from: IgxTimeAxisBaseComponent

Gets if the current axis is a vertical axis.

get isVertical(): boolean

Returns boolean

itemsCount

Inherited from: IgxTimeAxisBaseComponent

Gets the number of items in the current category axis items source.

get itemsCount(): number

Returns number

set itemsCount(v: number): void

Parameters

v: number

Returns void

label

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the axis label format string.

The Label property is used for label mapping of the axis labels.

get label(): any

Returns any

set label(v: any): void

Parameters

v: any

Returns void

labelAngle

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the angle of the {0}.

The Angle property is used to set the angle of the axis.

get labelAngle(): number

Returns number

set labelAngle(v: number): void

Parameters

v: number

Returns void

labelBottomMargin

Inherited from: IgxTimeAxisBaseComponent

Margin applied below the {0}.

The labelBottomMargin is used to set the bottom margin of the labels.

get labelBottomMargin(): number

Returns number

set labelBottomMargin(v: number): void

Parameters

v: number

Returns void

labelExtent

Inherited from: IgxTimeAxisBaseComponent

Distance between the axis and the edge of the control.

The Extent property is used for the extent.

get labelExtent(): number

Returns number

set labelExtent(v: number): void

Parameters

v: number

Returns void

labelFormat

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the label format string to use for the label.

get labelFormat(): string

Returns string

set labelFormat(v: string): void

Parameters

v: string

Returns void

labelFormats

A list of axis label formats to apply, which are selected according to the visible axis range. The label format selected will be the one with the largest range smaller than the visible range of the axis.

get labelFormats(): IgxTimeAxisLabelFormatCollection

Returns IgxTimeAxisLabelFormatCollection

set labelFormats(v: IgxTimeAxisLabelFormatCollection): void

Parameters

v: IgxTimeAxisLabelFormatCollection

Returns void

labelFormatSpecifiers

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the format specifiers to use with the LabelFormat string.

get labelFormatSpecifiers(): any[]

Returns any[]

set labelFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

labelHorizontalAlignment

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the horizontal alignment of the {0}.

The HorizontalAlignment property is used for the horizontal alignment.

get labelHorizontalAlignment(): HorizontalAlignment

Returns HorizontalAlignment

set labelHorizontalAlignment(v: HorizontalAlignment): void

Parameters

v: HorizontalAlignment

Returns void

labelLeftMargin

Inherited from: IgxTimeAxisBaseComponent

Margin applied to the left of the {0}.

The labelLeftMargin property is used for the left margin of the labels.

get labelLeftMargin(): number

Returns number

set labelLeftMargin(v: number): void

Parameters

v: number

Returns void

labellingMode

Gets or sets the labelling mode to use when the automatic label formats are applied.

get labellingMode(): TimeAxisLabellingMode

Returns TimeAxisLabellingMode

set labellingMode(v: TimeAxisLabellingMode): void

Parameters

v: TimeAxisLabellingMode

Returns void

labelLocation

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the location of the {0}.

The Location property is used for the location.

get labelLocation(): AxisLabelsLocation

Returns AxisLabelsLocation

set labelLocation(v: AxisLabelsLocation): void

Parameters

v: AxisLabelsLocation

Returns void

labelMaximumExtent

Inherited from: IgxTimeAxisBaseComponent

Maximum distance between the axis and the edge of the control.

get labelMaximumExtent(): number

Returns number

set labelMaximumExtent(v: number): void

Parameters

v: number

Returns void

labelMaximumExtentPercentage

Inherited from: IgxTimeAxisBaseComponent

Maximum distance between the axis and the edge of the control, relative to Chart size.

get labelMaximumExtentPercentage(): number

Returns number

set labelMaximumExtentPercentage(v: number): void

Parameters

v: number

Returns void

labelRightMargin

Inherited from: IgxTimeAxisBaseComponent

Margin applied to the right of the {0}.

The labelRightMargin property is used for the right margin of the labels.

get labelRightMargin(): number

Returns number

set labelRightMargin(v: number): void

Parameters

v: number

Returns void

labelShowFirstLabel

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether the first label is displayed when the zoom level is set to 1.

The ShowFirstLabel is used to check whether the first label is displayed when the zoom level is set to 1.

get labelShowFirstLabel(): boolean

Returns boolean

set labelShowFirstLabel(v: boolean): void

Parameters

v: boolean

Returns void

labelTextColor

Inherited from: IgxTimeAxisBaseComponent

The color of the {0}.

The labelTextColor property Overrides the color of the text used for the axis labels.

get labelTextColor(): string

Returns string

set labelTextColor(v: string): void

Parameters

v: string

Returns void

labelTextStyle

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the text style to use for axis labels.

The labelTextStyle property Overrides the style of the text used for the axis labels.

get labelTextStyle(): string

Returns string

set labelTextStyle(v: string): void

Parameters

v: string

Returns void

labelTopMargin

Inherited from: IgxTimeAxisBaseComponent

Margin applied above the {0}.

The labelTopMargin property is used for the top margin of the labels.

get labelTopMargin(): number

Returns number

set labelTopMargin(v: number): void

Parameters

v: number

Returns void

labelVerticalAlignment

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the vertical alignment of the {0}.

The VerticalAlignment property is used for the vertical alignment of the axis.

get labelVerticalAlignment(): VerticalAlignment

Returns VerticalAlignment

set labelVerticalAlignment(v: VerticalAlignment): void

Parameters

v: VerticalAlignment

Returns void

labelVisibility

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the visibility of the {0}.

The Visibility property is used for the visibility of the axis.

get labelVisibility(): Visibility

Returns Visibility

set labelVisibility(v: Visibility): void

Parameters

v: Visibility

Returns void

majorStroke

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the MajorStroke property. Null is treated as auto. Major lines will be displayed or not based on the axis type and series used with it.

Gets or sets the MajorStroke using this property.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
	   majorStroke="black"
		#yAxis>
    </igx-numeric-y-axis>
</igx-data-chart>

get majorStroke(): string

Returns string

set majorStroke(v: string): void

Parameters

v: string

Returns void

majorStrokeDashArray

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the MajorStrokeDashArray property.

get majorStrokeDashArray(): number[]

Returns number[]

set majorStrokeDashArray(v: number[]): void

Parameters

v: number[]

Returns void

majorStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the MajorStrokeThickness property.

Gets or sets the MajorStrokeThickness using this property.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
	  majorStrokeThickness="1"
		#yAxis>
    </igx-numeric-y-axis>
</igx-data-chart>

get majorStrokeThickness(): number

Returns number

set majorStrokeThickness(v: number): void

Parameters

v: number

Returns void

maximumGap

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the maximum gap value to allow. This defaults to 1.0.

get maximumGap(): number

Returns number

set maximumGap(v: number): void

Parameters

v: number

Returns void

maximumValue

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the axis MaximumValue.

Use MaximumValue property for axis maximum value.

this.timeXAxis.maximumValue="2019-12-26";

get maximumValue(): Date

Returns Date

set maximumValue(v: Date): void

Parameters

v: Date

Returns void

minimumGapSize

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the minimum amount of pixels to use for the gap between categories, if possible.

get minimumGapSize(): number

Returns number

set minimumGapSize(v: number): void

Parameters

v: number

Returns void

minimumValue

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the axis MinimumValue.

Use MinimumValue property for axis minimum value.

this.timeXAxis.maximumValue="2019-12-26";

get minimumValue(): Date

Returns Date

set minimumValue(v: Date): void

Parameters

v: Date

Returns void

minorStroke

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the MinorStroke property.

Gets or sets the minorStroke thickness using MinorStrokeThickness property.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
	 minorStrokeThickness="1"
		#yAxis>
    </igx-numeric-y-axis>
</igx-data-chart>

get minorStroke(): string

Returns string

set minorStroke(v: string): void

Parameters

v: string

Returns void

minorStrokeDashArray

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the MinorStrokeDashArray property.

get minorStrokeDashArray(): number[]

Returns number[]

set minorStrokeDashArray(v: number[]): void

Parameters

v: number[]

Returns void

minorStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the MinorStrokeThickness property.

get minorStrokeThickness(): number

Returns number

set minorStrokeThickness(v: number): void

Parameters

v: number

Returns void

name

Inherited from: IgxTimeAxisBaseComponent

get name(): string

Returns string

set name(value: string): void

Parameters

value: string

Returns void

overlap

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the amount of overlap between adjacent categories for the current axis object. The overlap is silently clamped to the range [-1, 1] when used.

Use the Overlap property to configure the spacing between items on a category axis with item spacing and more than one series.

An Overlap of 0 places grouped items adjacent to each other. An Overlap of 1 places grouped items in the same axis space, completely overlapping. An Overlap of -1 places a space between grouped items equal to the width of one item.

To place grouped items with 75% overlap, set the Overlap to 0.75, as in this code:

<igx-data-chart
    [dataSource]="data">

    <igx-category-x-axis
        label="label"
        overlap="0.75"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>

    <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value">
    </igx-column-series>
    <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value">
      </igx-column-series>
</igx-data-chart>

get overlap(): number

Returns number

set overlap(v: number): void

Parameters

v: number

Returns void

rangeChanged

Inherited from: IgxTimeAxisBaseComponent

Occurs when the axis range changes.

get rangeChanged(): EventEmitter<object>

Returns EventEmitter<object>

renderRequested

Inherited from: IgxTimeAxisBaseComponent

This event is raised every time a render has been requested from a series.

get renderRequested(): EventEmitter<object>

Returns EventEmitter<object>

shouldAutoTruncateAnnotations

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether annotations on this axis will automatically truncate themselves to avoid colliding with each other. This only works if the ShouldAvoidAnnotationCollisions property is enabled.

get shouldAutoTruncateAnnotations(): boolean

Returns boolean

set shouldAutoTruncateAnnotations(v: boolean): void

Parameters

v: boolean

Returns void

shouldAvoidAnnotationCollisions

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether annotations should be shifted to avoid collision, even if this would result in them appearing where they shouldn't be along the scale.

get shouldAvoidAnnotationCollisions(): boolean

Returns boolean

set shouldAvoidAnnotationCollisions(v: boolean): void

Parameters

v: boolean

Returns void

shouldKeepAnnotationsInView

Inherited from: IgxTimeAxisBaseComponent

ets or sets whether annotations should be kept in view, even if they aren't positioned where they should appear on the scale.

get shouldKeepAnnotationsInView(): boolean

Returns boolean

set shouldKeepAnnotationsInView(v: boolean): void

Parameters

v: boolean

Returns void

strip

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the Strip property.

Use Strip property to set the strip of the chart.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		 strip= "grey"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
		#yAxis>
    </igx-numeric-y-axis>

</igx-data-chart>

get strip(): string

Returns string

set strip(v: string): void

Parameters

v: string

Returns void

stroke

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the Stroke property. Null is treated as auto. The axis stroke will be displayed or not based on the axis type and series used with it.

Use Stroke property to set the stroke of the chart.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		stroke="blue"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
		#yAxis>
    </igx-numeric-y-axis>
</igx-data-chart>

get stroke(): string

Returns string

set stroke(v: string): void

Parameters

v: string

Returns void

strokeDashArray

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the StrokeDashArray property.

get strokeDashArray(): number[]

Returns number[]

set strokeDashArray(v: number[]): void

Parameters

v: number[]

Returns void

strokeThickness

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the StrokeThickness property.

Use StrokeThickness property for the thickness of the stroke.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		strokeThickness= 5
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
		#yAxis>
    </igx-numeric-y-axis>

</igx-data-chart>

get strokeThickness(): number

Returns number

set strokeThickness(v: number): void

Parameters

v: number

Returns void

tickLength

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the TickLength property.

Use TickLength property for The length of the tickmarks to display for this axis.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		tickLength="5"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
		#yAxis>
    </igx-numeric-y-axis>

</igx-data-chart>

get tickLength(): number

Returns number

set tickLength(v: number): void

Parameters

v: number

Returns void

tickStroke

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the TickStroke property.

Use TickStroke property for the color of the tickmarks.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		tickStroke="black"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
		#yAxis>
    </igx-numeric-y-axis>
</igx-data-chart>

get tickStroke(): string

Returns string

set tickStroke(v: string): void

Parameters

v: string

Returns void

tickStrokeDashArray

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the TickStrokeDashArray property.

get tickStrokeDashArray(): number[]

Returns number[]

set tickStrokeDashArray(v: number[]): void

Parameters

v: number[]

Returns void

tickStrokeThickness

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the TickStrokeThickness property.

Use TickStrokeThickness property for thickness of the stroke tickmarks.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		tickStrokeThicknes="2"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
		#yAxis>
    </igx-numeric-y-axis>

</igx-data-chart>

get tickStrokeThickness(): number

Returns number

set tickStrokeThickness(v: number): void

Parameters

v: number

Returns void

title

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the Title property.

Use Title property to display the title of the component.

<igx-data-chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
		#yAxis>
    </igx-numeric-y-axis>

</igx-data-chart>

get title(): string

Returns string

set title(v: string): void

Parameters

v: string

Returns void

titleAngle

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the angle of the {0}.

The Angle property is used to set the angle of the axis.

get titleAngle(): number

Returns number

set titleAngle(v: number): void

Parameters

v: number

Returns void

titleBottomMargin

Inherited from: IgxTimeAxisBaseComponent

Margin applied below the {0}.

The labelBottomMargin is used to set the bottom margin of the labels.

get titleBottomMargin(): number

Returns number

set titleBottomMargin(v: number): void

Parameters

v: number

Returns void

titleExtent

Inherited from: IgxTimeAxisBaseComponent

Distance between the axis and the edge of the control.

The Extent property is used for the extent.

get titleExtent(): number

Returns number

set titleExtent(v: number): void

Parameters

v: number

Returns void

titleHorizontalAlignment

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the horizontal alignment of the {0}.

The HorizontalAlignment property is used for the horizontal alignment.

get titleHorizontalAlignment(): HorizontalAlignment

Returns HorizontalAlignment

set titleHorizontalAlignment(v: HorizontalAlignment): void

Parameters

v: HorizontalAlignment

Returns void

titleLeftMargin

Inherited from: IgxTimeAxisBaseComponent

Margin applied to the left of the {0}.

The labelLeftMargin property is used for the left margin of the labels.

get titleLeftMargin(): number

Returns number

set titleLeftMargin(v: number): void

Parameters

v: number

Returns void

titleLocation

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the location of the {0}.

The Location property is used for the location.

get titleLocation(): AxisLabelsLocation

Returns AxisLabelsLocation

set titleLocation(v: AxisLabelsLocation): void

Parameters

v: AxisLabelsLocation

Returns void

titleMaximumExtent

Inherited from: IgxTimeAxisBaseComponent

Maximum distance between the axis and the edge of the control.

get titleMaximumExtent(): number

Returns number

set titleMaximumExtent(v: number): void

Parameters

v: number

Returns void

titleMaximumExtentPercentage

Inherited from: IgxTimeAxisBaseComponent

Maximum distance between the axis and the edge of the control, relative to Chart size.

get titleMaximumExtentPercentage(): number

Returns number

set titleMaximumExtentPercentage(v: number): void

Parameters

v: number

Returns void

titlePosition

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the title position relative to the axis labels.

get titlePosition(): AxisTitlePosition

Returns AxisTitlePosition

set titlePosition(v: AxisTitlePosition): void

Parameters

v: AxisTitlePosition

Returns void

titleRightMargin

Inherited from: IgxTimeAxisBaseComponent

Margin applied to the right of the {0}.

The labelRightMargin property is used for the right margin of the labels.

get titleRightMargin(): number

Returns number

set titleRightMargin(v: number): void

Parameters

v: number

Returns void

titleShowFirstLabel

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether the first label is displayed when the zoom level is set to 1.

The ShowFirstLabel is used to check whether the first label is displayed when the zoom level is set to 1.

get titleShowFirstLabel(): boolean

Returns boolean

set titleShowFirstLabel(v: boolean): void

Parameters

v: boolean

Returns void

titleTextColor

Inherited from: IgxTimeAxisBaseComponent

The color of the {0}.

The labelTextColor property Overrides the color of the text used for the axis labels.

get titleTextColor(): string

Returns string

set titleTextColor(v: string): void

Parameters

v: string

Returns void

titleTextStyle

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the text style to use for axis labels.

The labelTextStyle property Overrides the style of the text used for the axis labels.

get titleTextStyle(): string

Returns string

set titleTextStyle(v: string): void

Parameters

v: string

Returns void

titleTopMargin

Inherited from: IgxTimeAxisBaseComponent

Margin applied above the {0}.

The labelTopMargin property is used for the top margin of the labels.

get titleTopMargin(): number

Returns number

set titleTopMargin(v: number): void

Parameters

v: number

Returns void

titleVerticalAlignment

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the vertical alignment of the {0}.

The VerticalAlignment property is used for the vertical alignment of the axis.

get titleVerticalAlignment(): VerticalAlignment

Returns VerticalAlignment

set titleVerticalAlignment(v: VerticalAlignment): void

Parameters

v: VerticalAlignment

Returns void

titleVisibility

Inherited from: IgxTimeAxisBaseComponent

Gets or sets the visibility of the {0}.

The Visibility property is used for the visibility of the axis.

get titleVisibility(): Visibility

Returns Visibility

set titleVisibility(v: Visibility): void

Parameters

v: Visibility

Returns void

useClusteringMode

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether the category axis should use clustering display mode even if no series are present that would force clustering mode.

UseClusteringMode applies grouping and spacing to a category axis equivalent to the grouping that occurs when grouping series, such as ColumnSeries, are used.

Try setting it on an axis displaying financial series to adjust the spacing on the left and right sides of the axis:

<igx-data-chart
    [dataSource]="financialData">
    <igx-category-x-axis
    label="time"
    useClusteringMode="true"
    #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
    #yAxis>
    </igx-numeric-y-axis>

    <igx-column-series
    [xAxis]="xAxis"
    [yAxis]="yAxis"
    valueMemberPath="value">
    </igx-column-series>
    <igx-financial-price-series
    [xAxis]="xAxis"
    [yAxis]="yAxis"
    openMemberPath="open"
    highMemberPath="high"
    lowMemberPath="low"
    closeMemberPath="close"
    volumeMemberPath="volume">
    </igx-financial-price-series>
</igx-data-chart>

get useClusteringMode(): boolean

Returns boolean

set useClusteringMode(v: boolean): void

Parameters

v: boolean

Returns void

useEnhancedIntervalManagement

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.

Use UseEnhancedIntervalManagement property to gets/sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.

get useEnhancedIntervalManagement(): boolean

Returns boolean

set useEnhancedIntervalManagement(v: boolean): void

Parameters

v: boolean

Returns void

usePerLabelHeightMeasurement

Inherited from: IgxTimeAxisBaseComponent

Gets or sets whether to use label height measurement when determining the initial number of labels to render, before resolving collisions, etc.

get usePerLabelHeightMeasurement(): boolean

Returns boolean

set usePerLabelHeightMeasurement(v: boolean): void

Parameters

v: boolean

Returns void

Methods

bindAxes

Inherited from: IgxTimeAxisBaseComponent

bindAxes(axes: IgxAxisComponent[]): void

Parameters

axes: IgxAxisComponent[]

Returns void

ensureLabelSettings

Inherited from: IgxTimeAxisBaseComponent

ensureLabelSettings(): void

Returns void

ensureTitleSettings

Inherited from: IgxTimeAxisBaseComponent

ensureTitleSettings(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

getCategoryBoundingBox

Inherited from: IgxTimeAxisBaseComponent

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

Parameters

point: IgPoint
useInterpolation: boolean
singularWidth: number

Returns IgRect

getCategoryBoundingBoxHelper

Inherited from: IgxTimeAxisBaseComponent

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

Parameters

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

Returns IgRect

getFullRange

Inherited from: IgxTimeAxisBaseComponent

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

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

Parameters

item: any
memberPathName: string

Returns any

getMemberPathValue

Inherited from: IgxTimeAxisBaseComponent

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

ngOnInit

Inherited from: IgxTimeAxisBaseComponent

ngOnInit(): void

Returns void

notifyClearItems

Inherited from: IgxTimeAxisBaseComponent

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

notifyClearItems(): void

Returns void

notifyDataChanged

Inherited from: IgxTimeAxisBaseComponent

Updates the axis when the data has been changed.

notifyDataChanged(): void

Returns void

notifyInsertItem

Inherited from: IgxTimeAxisBaseComponent

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

Parameters

index: number
newItem: any

Returns void

notifyRemoveItem

Inherited from: IgxTimeAxisBaseComponent

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

Parameters

index: number
oldItem: any

Returns void

notifySetItem

Inherited from: IgxTimeAxisBaseComponent

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

Parameters

index: number
oldItem: any
newItem: any

Returns void

provideData

Inherited from: IgxTimeAxisBaseComponent

provideData(data: any[]): void

Parameters

data: any[]

Returns void

renderAxis

Inherited from: IgxTimeAxisBaseComponent

Renders the axis with no animation.

renderAxis(): void

Returns void

resetCachedEnhancedInterval

Inherited from: IgxTimeAxisBaseComponent

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

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

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

_createFromInternal(internal: any): IgxAxisComponent

Parameters

internal: any

Returns IgxAxisComponent

register

register(): void