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>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxAxisComponent, never>

actualMajorStroke

actualMajorStroke: string

actualMinorStroke

actualMinorStroke: string

actualStroke

actualStroke: string

annotations

annotations: IgxAxisAnnotationCollection

coercionMethods

coercionMethods: any

companionAxisCrossingAxis

companionAxisCrossingAxis: IgxAxisComponent

companionAxisCrossingValue

companionAxisCrossingValue: number

companionAxisEnabled

companionAxisEnabled: boolean

companionAxisIsInverted

companionAxisIsInverted: FeatureState

companionAxisLabelAngle

companionAxisLabelAngle: number

companionAxisLabelColor

companionAxisLabelColor: string

companionAxisLabelExtent

companionAxisLabelExtent: number

companionAxisLabelHorizontalAlignment

companionAxisLabelHorizontalAlignment: HorizontalAlignment

companionAxisLabelLocation

companionAxisLabelLocation: AxisLabelsLocation

companionAxisLabelOpposite

companionAxisLabelOpposite: boolean

companionAxisLabelVerticalAlignment

companionAxisLabelVerticalAlignment: VerticalAlignment

companionAxisLabelVisible

companionAxisLabelVisible: FeatureState

companionAxisMajorStroke

companionAxisMajorStroke: string

companionAxisMajorStrokeThickness

companionAxisMajorStrokeThickness: number

companionAxisMinExtent

companionAxisMinExtent: number

companionAxisMinorStroke

companionAxisMinorStroke: string

companionAxisMinorStrokeThickness

companionAxisMinorStrokeThickness: number

companionAxisShouldAutoTruncateAnnotations

companionAxisShouldAutoTruncateAnnotations: FeatureState

companionAxisShouldAvoidAnnotationCollisions

companionAxisShouldAvoidAnnotationCollisions: FeatureState

companionAxisShouldKeepAnnotationsInView

companionAxisShouldKeepAnnotationsInView: FeatureState

companionAxisStrip

companionAxisStrip: string

companionAxisStroke

companionAxisStroke: string

companionAxisStrokeThickness

companionAxisStrokeThickness: number

companionAxisSyncronizedWithPrimaryAxis

companionAxisSyncronizedWithPrimaryAxis: boolean

companionAxisTickLength

companionAxisTickLength: number

companionAxisTickStroke

companionAxisTickStroke: string

companionAxisTickStrokeThickness

companionAxisTickStrokeThickness: number

companionAxisTitle

companionAxisTitle: string

crossingAxis

crossingAxis: IgxAxisComponent

crossingValue

crossingValue: any

enhancedIntervalMinimumCharacters

enhancedIntervalMinimumCharacters: number

enhancedIntervalPreferMoreCategoryLabels

enhancedIntervalPreferMoreCategoryLabels: boolean

expectFunctions

expectFunctions: boolean

formatLabel

formatLabel: object

isCompanionAxis

isCompanionAxis: boolean

isDisabled

isDisabled: boolean

isInverted

isInverted: boolean

label

label: any

labelAngle

labelAngle: number

labelBottomMargin

labelBottomMargin: number

labelExtent

labelExtent: number

labelFormat

labelFormat: string

labelFormatSpecifiers

labelFormatSpecifiers: any[]

labelHorizontalAlignment

labelHorizontalAlignment: HorizontalAlignment

labelLeftMargin

labelLeftMargin: number

labelLocation

labelLocation: AxisLabelsLocation

labelMaximumExtent

labelMaximumExtent: number

labelMaximumExtentPercentage

labelMaximumExtentPercentage: number

labelRightMargin

labelRightMargin: number

labelShowFirstLabel

labelShowFirstLabel: boolean

labelTextColor

labelTextColor: string

labelTextStyle

labelTextStyle: string

labelTopMargin

labelTopMargin: number

labelVerticalAlignment

labelVerticalAlignment: VerticalAlignment

labelVisibility

labelVisibility: Visibility

majorStroke

majorStroke: string

majorStrokeDashArray

majorStrokeDashArray: number[]

majorStrokeThickness

majorStrokeThickness: number

minorStroke

minorStroke: string

minorStrokeDashArray

minorStrokeDashArray: number[]

minorStrokeThickness

minorStrokeThickness: number

name

name: string

shouldAutoTruncateAnnotations

shouldAutoTruncateAnnotations: boolean

shouldAvoidAnnotationCollisions

shouldAvoidAnnotationCollisions: boolean

shouldKeepAnnotationsInView

shouldKeepAnnotationsInView: boolean

strip

strip: string

stroke

stroke: string

strokeDashArray

strokeDashArray: number[]

strokeThickness

strokeThickness: number

tickLength

tickLength: number

tickStroke

tickStroke: string

tickStrokeDashArray

tickStrokeDashArray: number[]

tickStrokeThickness

tickStrokeThickness: number

title

title: string

titleAngle

titleAngle: number

titleBottomMargin

titleBottomMargin: number

titleExtent

titleExtent: number

titleHorizontalAlignment

titleHorizontalAlignment: HorizontalAlignment

titleLeftMargin

titleLeftMargin: number

titleLocation

titleLocation: AxisLabelsLocation

titleMaximumExtent

titleMaximumExtent: number

titleMaximumExtentPercentage

titleMaximumExtentPercentage: number

titlePosition

titlePosition: AxisTitlePosition

titleRightMargin

titleRightMargin: number

titleShowFirstLabel

titleShowFirstLabel: boolean

titleTextColor

titleTextColor: string

titleTextStyle

titleTextStyle: string

titleTopMargin

titleTopMargin: number

titleVerticalAlignment

titleVerticalAlignment: VerticalAlignment

titleVisibility

titleVisibility: Visibility

useEnhancedIntervalManagement

useEnhancedIntervalManagement: boolean

usePerLabelHeightMeasurement

usePerLabelHeightMeasurement: boolean

Accessors

axisInternal

get axisInternal(): Axis

Returns Axis

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

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

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

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

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>

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