IgcNumericAxisBaseComponent

Represents the base class for all DataChartComponent numeric axes.

Constructors

new IgcNumericAxisBaseComponent(): IgcNumericAxisBaseComponent

Returns IgcNumericAxisBaseComponent

Properties

abbreviatedLabelFormat

abbreviatedLabelFormat: string

abbreviatedLabelFormatSpecifiers

abbreviatedLabelFormatSpecifiers: any[]

abbreviateLargeNumbers

abbreviateLargeNumbers: boolean

actualInterval

actualInterval: number

actualIntervalChange

actualIntervalChange: object

actualIsLogarithmic

actualIsLogarithmic: boolean

actualMajorStroke

Inherited from: IgcAxisComponent

actualMajorStroke: string

actualMaximumValue

actualMaximumValue: number

actualMaximumValueChange

actualMaximumValueChange: object

actualMaxPrecision

actualMaxPrecision: number

actualMinimumValue

actualMinimumValue: number

actualMinimumValueChange

actualMinimumValueChange: object

actualMinorInterval

actualMinorInterval: number

actualMinorIntervalChange

actualMinorIntervalChange: object

actualMinorStroke

Inherited from: IgcAxisComponent

actualMinorStroke: string

actualStroke

Inherited from: IgcAxisComponent

actualStroke: string

actualVisibleMaximumValue

actualVisibleMaximumValue: number

actualVisibleMinimumValue

actualVisibleMinimumValue: number

annotations

Inherited from: IgcAxisComponent

annotations: IgcAxisAnnotationCollection

autoRangeBufferMode

autoRangeBufferMode: AxisRangeBufferMode

coercionMethods

Inherited from: IgcAxisComponent

coercionMethods: any

companionAxisCrossingAxis

Inherited from: IgcAxisComponent

companionAxisCrossingAxis: IgcAxisComponent

companionAxisCrossingAxisName

Inherited from: IgcAxisComponent

companionAxisCrossingAxisName: string

companionAxisCrossingValue

Inherited from: IgcAxisComponent

companionAxisCrossingValue: number

companionAxisEnabled

Inherited from: IgcAxisComponent

companionAxisEnabled: boolean

companionAxisInterval

companionAxisInterval: number

companionAxisIsInverted

Inherited from: IgcAxisComponent

companionAxisIsInverted: FeatureState

companionAxisIsLogarithmic

companionAxisIsLogarithmic: FeatureState

companionAxisLabelAngle

Inherited from: IgcAxisComponent

companionAxisLabelAngle: number

companionAxisLabelColor

Inherited from: IgcAxisComponent

companionAxisLabelColor: string

companionAxisLabelExtent

Inherited from: IgcAxisComponent

companionAxisLabelExtent: number

companionAxisLabelHorizontalAlignment

Inherited from: IgcAxisComponent

companionAxisLabelHorizontalAlignment: HorizontalAlignment

companionAxisLabelLocation

Inherited from: IgcAxisComponent

companionAxisLabelLocation: AxisLabelsLocation

companionAxisLabelOpposite

Inherited from: IgcAxisComponent

companionAxisLabelOpposite: boolean

companionAxisLabelVerticalAlignment

Inherited from: IgcAxisComponent

companionAxisLabelVerticalAlignment: VerticalAlignment

companionAxisLabelVisible

Inherited from: IgcAxisComponent

companionAxisLabelVisible: FeatureState

companionAxisLogarithmBase

companionAxisLogarithmBase: number

companionAxisMajorStroke

Inherited from: IgcAxisComponent

companionAxisMajorStroke: string

companionAxisMajorStrokeThickness

Inherited from: IgcAxisComponent

companionAxisMajorStrokeThickness: number

companionAxisMaximumValue

companionAxisMaximumValue: number

companionAxisMinExtent

Inherited from: IgcAxisComponent

companionAxisMinExtent: number

companionAxisMinimumValue

companionAxisMinimumValue: number

companionAxisMinorInterval

companionAxisMinorInterval: number

companionAxisMinorStroke

Inherited from: IgcAxisComponent

companionAxisMinorStroke: string

companionAxisMinorStrokeThickness

Inherited from: IgcAxisComponent

companionAxisMinorStrokeThickness: number

companionAxisShouldAutoTruncateAnnotations

Inherited from: IgcAxisComponent

companionAxisShouldAutoTruncateAnnotations: FeatureState

companionAxisShouldAvoidAnnotationCollisions

Inherited from: IgcAxisComponent

companionAxisShouldAvoidAnnotationCollisions: FeatureState

companionAxisShouldKeepAnnotationsInView

Inherited from: IgcAxisComponent

companionAxisShouldKeepAnnotationsInView: FeatureState

companionAxisStrip

Inherited from: IgcAxisComponent

companionAxisStrip: string

companionAxisStroke

Inherited from: IgcAxisComponent

companionAxisStroke: string

companionAxisStrokeThickness

Inherited from: IgcAxisComponent

companionAxisStrokeThickness: number

companionAxisSyncronizedWithPrimaryAxis

Inherited from: IgcAxisComponent

companionAxisSyncronizedWithPrimaryAxis: boolean

companionAxisTickLength

Inherited from: IgcAxisComponent

companionAxisTickLength: number

companionAxisTickStroke

Inherited from: IgcAxisComponent

companionAxisTickStroke: string

companionAxisTickStrokeThickness

Inherited from: IgcAxisComponent

companionAxisTickStrokeThickness: number

companionAxisTitle

Inherited from: IgcAxisComponent

companionAxisTitle: string

crossingAxis

Inherited from: IgcAxisComponent

crossingAxis: IgcAxisComponent

crossingAxisName

Inherited from: IgcAxisComponent

crossingAxisName: string

crossingValue

Inherited from: IgcAxisComponent

crossingValue: any

enhancedIntervalMinimumCharacters

Inherited from: IgcAxisComponent

enhancedIntervalMinimumCharacters: number

enhancedIntervalPreferMoreCategoryLabels

Inherited from: IgcAxisComponent

enhancedIntervalPreferMoreCategoryLabels: boolean

expectFunctions

Inherited from: IgcAxisComponent

expectFunctions: boolean

favorLabellingScaleEnd

favorLabellingScaleEnd: boolean

formatAbbreviatedLabel

formatAbbreviatedLabel: object

formatLabel

Inherited from: IgcAxisComponent

formatLabel: object

interval

interval: number

isCompanionAxis

Inherited from: IgcAxisComponent

isCompanionAxis: boolean

isDisabled

Inherited from: IgcAxisComponent

isDisabled: boolean

isFormattingAbbreviatedLargeNumber

isFormattingAbbreviatedLargeNumber: boolean

isInverted

Inherited from: IgcAxisComponent

isInverted: boolean

isLogarithmic

isLogarithmic: boolean

label

Inherited from: IgcAxisComponent

label: any

labelAngle

Inherited from: IgcAxisComponent

labelAngle: number

labelBottomMargin

Inherited from: IgcAxisComponent

labelBottomMargin: number

labelExtent

Inherited from: IgcAxisComponent

labelExtent: number

labelFormat

Inherited from: IgcAxisComponent

labelFormat: string

labelFormatSpecifiers

Inherited from: IgcAxisComponent

labelFormatSpecifiers: any[]

labelHorizontalAlignment

Inherited from: IgcAxisComponent

labelHorizontalAlignment: HorizontalAlignment

labelLeftMargin

Inherited from: IgcAxisComponent

labelLeftMargin: number

labelLocation

Inherited from: IgcAxisComponent

labelLocation: AxisLabelsLocation

labelMaximumExtent

Inherited from: IgcAxisComponent

labelMaximumExtent: number

labelMaximumExtentPercentage

Inherited from: IgcAxisComponent

labelMaximumExtentPercentage: number

labelRightMargin

Inherited from: IgcAxisComponent

labelRightMargin: number

labelShowFirstLabel

Inherited from: IgcAxisComponent

labelShowFirstLabel: boolean

labelTextColor

Inherited from: IgcAxisComponent

labelTextColor: string

labelTextStyle

Inherited from: IgcAxisComponent

labelTextStyle: string

labelTopMargin

Inherited from: IgcAxisComponent

labelTopMargin: number

labelVerticalAlignment

Inherited from: IgcAxisComponent

labelVerticalAlignment: VerticalAlignment

labelVisibility

Inherited from: IgcAxisComponent

labelVisibility: Visibility

logarithmBase

logarithmBase: number

majorStroke

Inherited from: IgcAxisComponent

majorStroke: string

majorStrokeDashArray

Inherited from: IgcAxisComponent

majorStrokeDashArray: number[]

majorStrokeThickness

Inherited from: IgcAxisComponent

majorStrokeThickness: number

maximumValue

maximumValue: number

maxPrecision

maxPrecision: number

minimumValue

minimumValue: number

minorInterval

minorInterval: number

minorStroke

Inherited from: IgcAxisComponent

minorStroke: string

minorStrokeDashArray

Inherited from: IgcAxisComponent

minorStrokeDashArray: number[]

minorStrokeThickness

Inherited from: IgcAxisComponent

minorStrokeThickness: number

name

Inherited from: IgcAxisComponent

name: string

rangeChanged

Inherited from: IgcAxisComponent

rangeChanged: object

referenceValue

referenceValue: number

renderRequested

Inherited from: IgcAxisComponent

renderRequested: object

shouldApplyMaxPrecisionWhenZoomed

shouldApplyMaxPrecisionWhenZoomed: boolean

shouldAutoTruncateAnnotations

Inherited from: IgcAxisComponent

shouldAutoTruncateAnnotations: boolean

shouldAvoidAnnotationCollisions

Inherited from: IgcAxisComponent

shouldAvoidAnnotationCollisions: boolean

shouldKeepAnnotationsInView

Inherited from: IgcAxisComponent

shouldKeepAnnotationsInView: boolean

strip

Inherited from: IgcAxisComponent

strip: string

stroke

Inherited from: IgcAxisComponent

stroke: string

strokeDashArray

Inherited from: IgcAxisComponent

strokeDashArray: number[]

strokeThickness

Inherited from: IgcAxisComponent

strokeThickness: number

tickLength

Inherited from: IgcAxisComponent

tickLength: number

tickStroke

Inherited from: IgcAxisComponent

tickStroke: string

tickStrokeDashArray

Inherited from: IgcAxisComponent

tickStrokeDashArray: number[]

tickStrokeThickness

Inherited from: IgcAxisComponent

tickStrokeThickness: number

title

Inherited from: IgcAxisComponent

title: string

titleAngle

Inherited from: IgcAxisComponent

titleAngle: number

titleBottomMargin

Inherited from: IgcAxisComponent

titleBottomMargin: number

titleExtent

Inherited from: IgcAxisComponent

titleExtent: number

titleHorizontalAlignment

Inherited from: IgcAxisComponent

titleHorizontalAlignment: HorizontalAlignment

titleLeftMargin

Inherited from: IgcAxisComponent

titleLeftMargin: number

titleLocation

Inherited from: IgcAxisComponent

titleLocation: AxisLabelsLocation

titleMaximumExtent

Inherited from: IgcAxisComponent

titleMaximumExtent: number

titleMaximumExtentPercentage

Inherited from: IgcAxisComponent

titleMaximumExtentPercentage: number

titlePosition

Inherited from: IgcAxisComponent

titlePosition: AxisTitlePosition

titleRightMargin

Inherited from: IgcAxisComponent

titleRightMargin: number

titleShowFirstLabel

Inherited from: IgcAxisComponent

titleShowFirstLabel: boolean

titleTextColor

Inherited from: IgcAxisComponent

titleTextColor: string

titleTextStyle

Inherited from: IgcAxisComponent

titleTextStyle: string

titleTopMargin

Inherited from: IgcAxisComponent

titleTopMargin: number

titleVerticalAlignment

Inherited from: IgcAxisComponent

titleVerticalAlignment: VerticalAlignment

titleVisibility

Inherited from: IgcAxisComponent

titleVisibility: Visibility

useEnhancedIntervalManagement

Inherited from: IgcAxisComponent

useEnhancedIntervalManagement: boolean

usePerLabelHeightMeasurement

Inherited from: IgcAxisComponent

usePerLabelHeightMeasurement: boolean

Accessors

axisInternal

Inherited from: IgcAxisComponent

get axisInternal(): Axis

Returns Axis

hasUserMaximum

Determines if the axis has a user-defined maximum.

HasUserMinimum is used to determine if a numeric axis has a user definied minium value.

get hasUserMaximum(): boolean

Returns boolean

hasUserMinimum

Determines if the axis has a user-defined minimum.

HasUserMaximum is used to determine if a numeric axis has a user definied maximum value.

get hasUserMinimum(): boolean

Returns boolean

isAngular

Inherited from: IgcAxisComponent

Gets if the current axis is of angular axis type

get isAngular(): boolean

Returns boolean

isCategory

Inherited from: IgcAxisComponent

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

get isCategory(): boolean

Returns boolean

isCategoryDateTime

Inherited from: IgcAxisComponent

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

get isCategoryDateTime(): boolean

Returns boolean

isContinuous

Inherited from: IgcAxisComponent

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

get isContinuous(): boolean

Returns boolean

isDateTime

Inherited from: IgcAxisComponent

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

get isDateTime(): boolean

Returns boolean

isHorizontal

Inherited from: IgcAxisComponent

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

get isNumeric(): boolean

Returns boolean

isOrdinal

Inherited from: IgcAxisComponent

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

get isOrdinal(): boolean

Returns boolean

isPiecewise

Inherited from: IgcAxisComponent

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

get isPiecewise(): boolean

Returns boolean

isPrimaryAxis

Inherited from: IgcAxisComponent

Gets whether this is primary axis created by an user

get isPrimaryAxis(): boolean

Returns boolean

isRadial

Inherited from: IgcAxisComponent

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

get isRadial(): boolean

Returns boolean

isSorting

Inherited from: IgcAxisComponent

Gets or sets if the current axis is sorting data items

get isSorting(): boolean

Returns boolean

isVertical

Inherited from: IgcAxisComponent

Gets if the current axis is a vertical axis.

get isVertical(): boolean

Returns boolean

observedAttributes

get observedAttributes(): string[]

Returns string[]

Methods

attributeChangedCallback

Inherited from: IgcAxisComponent

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

Parameters

name: string
oldValue: string
newValue: string

Returns void

bindAxes

Inherited from: IgcAxisComponent

bindAxes(axes: IgcAxisComponent[]): void

Parameters

axes: IgcAxisComponent[]

Returns void

connectedCallback

connectedCallback(): void

Returns void

disconnectedCallback

disconnectedCallback(): void

Returns void

ensureLabelSettings

Inherited from: IgcAxisComponent

ensureLabelSettings(): void

Returns void

ensureTitleSettings

Inherited from: IgcAxisComponent

ensureTitleSettings(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

getFullRange

getFullRange(): number[]

Returns number[]

getItemValue

Inherited from: IgcAxisComponent

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

Parameters

item: any
memberPathName: string

Returns any

getMemberPathValue

Inherited from: IgcAxisComponent

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

Inherited from: IgcAxisComponent

Gets the label for a data item.

getValueLabel(value: number): string

Parameters

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

Returns string

provideData

Inherited from: IgcAxisComponent

provideData(data: any): void

Parameters

data: any

Returns void

renderAxis

Inherited from: IgcAxisComponent

Renders the axis with no animation.

renderAxis(): void

Returns void

resetCachedEnhancedInterval

Inherited from: IgcAxisComponent

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

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

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.
Unscales a value from screen space into axis space.
```
let dataValue: number = this.yAxis.unscaleValue(pixel);
```

Returns number

_createFromInternal

Inherited from: IgcAxisComponent

_createFromInternal(internal: any): IgcAxisComponent

Parameters

internal: any