IgxAxisComponent

Represents the base class from which all axis types are derived.

The Axis is an array of axis objects.

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

Constructors

new IgxAxisComponent(): IgxAxisComponent

Returns IgxAxisComponent

Properties

ngAcceptInputType_annotations

ngAcceptInputType_annotations: string | IgxAxisAnnotationCollection

ngAcceptInputType_companionAxisCrossingValue

ngAcceptInputType_companionAxisCrossingValue: string | number

ngAcceptInputType_companionAxisEnabled

ngAcceptInputType_companionAxisEnabled: string | boolean

ngAcceptInputType_companionAxisIsInverted

ngAcceptInputType_companionAxisIsInverted: any

ngAcceptInputType_companionAxisLabelAngle

ngAcceptInputType_companionAxisLabelAngle: string | number

ngAcceptInputType_companionAxisLabelExtent

ngAcceptInputType_companionAxisLabelExtent: string | number

ngAcceptInputType_companionAxisLabelHorizontalAlignment

ngAcceptInputType_companionAxisLabelHorizontalAlignment: any

ngAcceptInputType_companionAxisLabelLocation

ngAcceptInputType_companionAxisLabelLocation: string | AxisLabelsLocation

ngAcceptInputType_companionAxisLabelOpposite

ngAcceptInputType_companionAxisLabelOpposite: string | boolean

ngAcceptInputType_companionAxisLabelVerticalAlignment

ngAcceptInputType_companionAxisLabelVerticalAlignment: any

ngAcceptInputType_companionAxisLabelVisible

ngAcceptInputType_companionAxisLabelVisible: any

ngAcceptInputType_companionAxisMajorStrokeThickness

ngAcceptInputType_companionAxisMajorStrokeThickness: string | number

ngAcceptInputType_companionAxisMinExtent

ngAcceptInputType_companionAxisMinExtent: string | number

ngAcceptInputType_companionAxisMinorStrokeThickness

ngAcceptInputType_companionAxisMinorStrokeThickness: string | number

ngAcceptInputType_companionAxisShouldAutoTruncateAnnotations

ngAcceptInputType_companionAxisShouldAutoTruncateAnnotations: any

ngAcceptInputType_companionAxisShouldAvoidAnnotationCollisions

ngAcceptInputType_companionAxisShouldAvoidAnnotationCollisions: any

ngAcceptInputType_companionAxisShouldKeepAnnotationsInView

ngAcceptInputType_companionAxisShouldKeepAnnotationsInView: any

ngAcceptInputType_companionAxisStrokeThickness

ngAcceptInputType_companionAxisStrokeThickness: string | number

ngAcceptInputType_companionAxisSyncronizedWithPrimaryAxis

ngAcceptInputType_companionAxisSyncronizedWithPrimaryAxis: string | boolean

ngAcceptInputType_companionAxisTickLength

ngAcceptInputType_companionAxisTickLength: string | number

ngAcceptInputType_companionAxisTickStrokeThickness

ngAcceptInputType_companionAxisTickStrokeThickness: string | number

ngAcceptInputType_enhancedIntervalMinimumCharacters

ngAcceptInputType_enhancedIntervalMinimumCharacters: string | number

ngAcceptInputType_enhancedIntervalPreferMoreCategoryLabels

ngAcceptInputType_enhancedIntervalPreferMoreCategoryLabels: string | boolean

ngAcceptInputType_expectFunctions

ngAcceptInputType_expectFunctions: string | boolean

ngAcceptInputType_isAngular

ngAcceptInputType_isAngular: string | boolean

ngAcceptInputType_isCategory

ngAcceptInputType_isCategory: string | boolean

ngAcceptInputType_isCategoryDateTime

ngAcceptInputType_isCategoryDateTime: string | boolean

ngAcceptInputType_isCompanionAxis

ngAcceptInputType_isCompanionAxis: string | boolean

ngAcceptInputType_isContinuous

ngAcceptInputType_isContinuous: string | boolean

ngAcceptInputType_isDateTime

ngAcceptInputType_isDateTime: string | boolean

ngAcceptInputType_isDisabled

ngAcceptInputType_isDisabled: string | boolean

ngAcceptInputType_isHorizontal

ngAcceptInputType_isHorizontal: string | boolean

ngAcceptInputType_isInverted

ngAcceptInputType_isInverted: string | boolean

ngAcceptInputType_isNumeric

ngAcceptInputType_isNumeric: string | boolean

ngAcceptInputType_isOrdinal

ngAcceptInputType_isOrdinal: string | boolean

ngAcceptInputType_isPiecewise

ngAcceptInputType_isPiecewise: string | boolean

ngAcceptInputType_isPrimaryAxis

ngAcceptInputType_isPrimaryAxis: string | boolean

ngAcceptInputType_isRadial

ngAcceptInputType_isRadial: string | boolean

ngAcceptInputType_isSorting

ngAcceptInputType_isSorting: string | boolean

ngAcceptInputType_isVertical

ngAcceptInputType_isVertical: string | boolean

ngAcceptInputType_labelAngle

ngAcceptInputType_labelAngle: string | number

ngAcceptInputType_labelBottomMargin

ngAcceptInputType_labelBottomMargin: string | number

ngAcceptInputType_labelExtent

ngAcceptInputType_labelExtent: string | number

ngAcceptInputType_labelFormatSpecifiers

ngAcceptInputType_labelFormatSpecifiers: string | any[]

ngAcceptInputType_labelHorizontalAlignment

ngAcceptInputType_labelHorizontalAlignment: any

ngAcceptInputType_labelLeftMargin

ngAcceptInputType_labelLeftMargin: string | number

ngAcceptInputType_labelLocation

ngAcceptInputType_labelLocation: string | AxisLabelsLocation

ngAcceptInputType_labelMaximumExtent

ngAcceptInputType_labelMaximumExtent: string | number

ngAcceptInputType_labelMaximumExtentPercentage

ngAcceptInputType_labelMaximumExtentPercentage: string | number

ngAcceptInputType_labelRightMargin

ngAcceptInputType_labelRightMargin: string | number

ngAcceptInputType_labelShowFirstLabel

ngAcceptInputType_labelShowFirstLabel: string | boolean

ngAcceptInputType_labelTopMargin

ngAcceptInputType_labelTopMargin: string | number

ngAcceptInputType_labelVerticalAlignment

ngAcceptInputType_labelVerticalAlignment: any

ngAcceptInputType_labelVisibility

ngAcceptInputType_labelVisibility: any

ngAcceptInputType_majorStrokeDashArray

ngAcceptInputType_majorStrokeDashArray: string | number[]

ngAcceptInputType_majorStrokeThickness

ngAcceptInputType_majorStrokeThickness: string | number

ngAcceptInputType_minorStrokeDashArray

ngAcceptInputType_minorStrokeDashArray: string | number[]

ngAcceptInputType_minorStrokeThickness

ngAcceptInputType_minorStrokeThickness: string | number

ngAcceptInputType_shouldAutoTruncateAnnotations

ngAcceptInputType_shouldAutoTruncateAnnotations: string | boolean

ngAcceptInputType_shouldAvoidAnnotationCollisions

ngAcceptInputType_shouldAvoidAnnotationCollisions: string | boolean

ngAcceptInputType_shouldKeepAnnotationsInView

ngAcceptInputType_shouldKeepAnnotationsInView: string | boolean

ngAcceptInputType_strokeDashArray

ngAcceptInputType_strokeDashArray: string | number[]

ngAcceptInputType_strokeThickness

ngAcceptInputType_strokeThickness: string | number

ngAcceptInputType_tickLength

ngAcceptInputType_tickLength: string | number

ngAcceptInputType_tickStrokeDashArray

ngAcceptInputType_tickStrokeDashArray: string | number[]

ngAcceptInputType_tickStrokeThickness

ngAcceptInputType_tickStrokeThickness: string | number

ngAcceptInputType_titleAngle

ngAcceptInputType_titleAngle: string | number

ngAcceptInputType_titleBottomMargin

ngAcceptInputType_titleBottomMargin: string | number

ngAcceptInputType_titleExtent

ngAcceptInputType_titleExtent: string | number

ngAcceptInputType_titleHorizontalAlignment

ngAcceptInputType_titleHorizontalAlignment: any

ngAcceptInputType_titleLeftMargin

ngAcceptInputType_titleLeftMargin: string | number

ngAcceptInputType_titleLocation

ngAcceptInputType_titleLocation: string | AxisLabelsLocation

ngAcceptInputType_titleMaximumExtent

ngAcceptInputType_titleMaximumExtent: string | number

ngAcceptInputType_titleMaximumExtentPercentage

ngAcceptInputType_titleMaximumExtentPercentage: string | number

ngAcceptInputType_titlePosition

ngAcceptInputType_titlePosition: string | AxisTitlePosition

ngAcceptInputType_titleRightMargin

ngAcceptInputType_titleRightMargin: string | number

ngAcceptInputType_titleShowFirstLabel

ngAcceptInputType_titleShowFirstLabel: string | boolean

ngAcceptInputType_titleTopMargin

ngAcceptInputType_titleTopMargin: string | number

ngAcceptInputType_titleVerticalAlignment

ngAcceptInputType_titleVerticalAlignment: any

ngAcceptInputType_titleVisibility

ngAcceptInputType_titleVisibility: any

ngAcceptInputType_useEnhancedIntervalManagement

ngAcceptInputType_useEnhancedIntervalManagement: string | boolean

ngAcceptInputType_usePerLabelHeightMeasurement

ngAcceptInputType_usePerLabelHeightMeasurement: string | boolean

ɵcmp

ɵcmp: ɵɵComponentDeclaration<IgxAxisComponent, "ng-component", never, object, object, never, never, true, never>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxAxisComponent, never>

Accessors

actualMajorStroke

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

actualMinorStroke

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

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

Gets the current annotations for the axis.

get annotations(): IgxAxisAnnotationCollection

Returns IgxAxisAnnotationCollection

set annotations(v: IgxAxisAnnotationCollection): void

Parameters

v: IgxAxisAnnotationCollection

Returns void

axisInternal

get axisInternal(): Axis

Returns Axis

coercionMethods

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Gets or sets title on the companion axis.

get companionAxisTitle(): string

Returns string

set companionAxisTitle(v: string): void

Parameters

v: string

Returns void

crossingAxis

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

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

enhancedIntervalMinimumCharacters

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

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

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

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

i

get i(): Axis

Returns Axis

isAngular

Gets if the current axis is of angular axis type

get isAngular(): boolean

Returns boolean

isCategory

Gets or sets if the current 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

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

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

get isContinuous(): boolean

Returns boolean

isDateTime

Gets or sets if the current axis is of date time axis type

get isDateTime(): boolean

Returns boolean

isDisabled

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

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

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

isNumeric

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

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

Gets whether this is primary axis created by an user

get isPrimaryAxis(): boolean

Returns boolean

isRadial

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

get isRadial(): boolean

Returns boolean

isSorting

Gets or sets if the current axis is sorting data items

get isSorting(): boolean

Returns boolean

isVertical

Gets if the current axis is a vertical axis.

get isVertical(): boolean

Returns boolean

label

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

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

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

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

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

labelFormatSpecifiers

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

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

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

labelLocation

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

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

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

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

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

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

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

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

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

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

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

Gets or sets the MajorStrokeDashArray property.

get majorStrokeDashArray(): number[]

Returns number[]

set majorStrokeDashArray(v: number[]): void

Parameters

v: number[]

Returns void

majorStrokeThickness

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

minorStroke

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

Gets or sets the MinorStrokeDashArray property.

get minorStrokeDashArray(): number[]

Returns number[]

set minorStrokeDashArray(v: number[]): void

Parameters

v: number[]

Returns void

minorStrokeThickness

Gets or sets the MinorStrokeThickness property.

get minorStrokeThickness(): number

Returns number

set minorStrokeThickness(v: number): void

Parameters

v: number

Returns void

name

get name(): string

Returns string

set name(value: string): void

Parameters

value: string

Returns void

rangeChanged

Occurs when the axis range changes.

get rangeChanged(): EventEmitter<object>

Returns EventEmitter<object>

renderRequested

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

get renderRequested(): EventEmitter<object>

Returns EventEmitter<object>

shouldAutoTruncateAnnotations

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

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

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

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

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

Gets or sets the StrokeDashArray property.

get strokeDashArray(): number[]

Returns number[]

set strokeDashArray(v: number[]): void

Parameters

v: number[]

Returns void

strokeThickness

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

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

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

Gets or sets the TickStrokeDashArray property.

get tickStrokeDashArray(): number[]

Returns number[]

set tickStrokeDashArray(v: number[]): void

Parameters

v: number[]

Returns void

tickStrokeThickness

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

useEnhancedIntervalManagement

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

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

bindAxes(axes: IgxAxisComponent[]): void

Parameters

axes: IgxAxisComponent[]

Returns void

ensureLabelSettings

ensureLabelSettings(): void

Returns void

ensureTitleSettings

ensureTitleSettings(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

getFullRange

getFullRange(): number[]

Returns number[]

getItemValue

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

Parameters

item: any
memberPathName: string

Returns any

getMemberPathValue

Gets the value of a requested member path from the series.

getMemberPathValue(memberPathName: string): string

Parameters

memberPathName: string
- The property name of a valid member path for the series

Returns string

getValueLabel

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

ngOnInit(): void

Returns void

provideData

provideData(data: any): void

Parameters

data: any

Returns void

renderAxis

Renders the axis with no animation.

renderAxis(): void

Returns void

resetCachedEnhancedInterval

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

Scales a value from axis space into screen space.

scaleValue(unscaledValue: number): number

Parameters

unscaledValue: number
- The unscaled axis value to scale.

Returns number

_createFromInternal

_createFromInternal(internal: any): IgxAxisComponent

Parameters

internal: any