Represents the base class for all DataChartComponent category-based axes.

``

``

Constructors

Section titled "Constructors"

IgrCategoryAxisBase

new IgrCategoryAxisBase(props: P): IgrCategoryAxisBase

Returns IgrCategoryAxisBase

Properties

Section titled "Properties"

actualMajorStroke

Section titled "actualMajorStroke"

Inherited from: IgrAxis 

actualMajorStroke: string

actualMinorStroke

Section titled "actualMinorStroke"

Inherited from: IgrAxis 

actualMinorStroke: string

actualStroke

Section titled "actualStroke"

Inherited from: IgrAxis 

actualStroke: string

annotations

Section titled "annotations"

Inherited from: IgrAxis 

annotations: IgrAxisAnnotationCollection

coercionMethods

Section titled "coercionMethods"

Inherited from: IgrAxis 

coercionMethods: any

companionAxisCrossingAxis

Section titled "companionAxisCrossingAxis"

Inherited from: IgrAxis 

companionAxisCrossingAxis: IgrAxis

companionAxisCrossingAxisName

Section titled "companionAxisCrossingAxisName"

Inherited from: IgrAxis 

companionAxisCrossingAxisName: string

companionAxisCrossingValue

Section titled "companionAxisCrossingValue"

Inherited from: IgrAxis 

companionAxisCrossingValue: number

companionAxisEnabled

Section titled "companionAxisEnabled"

Inherited from: IgrAxis 

companionAxisEnabled: boolean

companionAxisIsInverted

Section titled "companionAxisIsInverted"

Inherited from: IgrAxis 

companionAxisIsInverted: FeatureState

companionAxisLabelAngle

Section titled "companionAxisLabelAngle"

Inherited from: IgrAxis 

companionAxisLabelAngle: number

companionAxisLabelColor

Section titled "companionAxisLabelColor"

Inherited from: IgrAxis 

companionAxisLabelColor: string

companionAxisLabelExtent

Section titled "companionAxisLabelExtent"

Inherited from: IgrAxis 

companionAxisLabelExtent: number

companionAxisLabelHorizontalAlignment

Section titled "companionAxisLabelHorizontalAlignment"

Inherited from: IgrAxis 

companionAxisLabelHorizontalAlignment: HorizontalAlignment

companionAxisLabelLocation

Section titled "companionAxisLabelLocation"

Inherited from: IgrAxis 

companionAxisLabelLocation: AxisLabelsLocation

companionAxisLabelOpposite

Section titled "companionAxisLabelOpposite"

Inherited from: IgrAxis 

companionAxisLabelOpposite: boolean

companionAxisLabelVerticalAlignment

Section titled "companionAxisLabelVerticalAlignment"

Inherited from: IgrAxis 

companionAxisLabelVerticalAlignment: VerticalAlignment

companionAxisLabelVisible

Section titled "companionAxisLabelVisible"

Inherited from: IgrAxis 

companionAxisLabelVisible: FeatureState

companionAxisMajorStroke

Section titled "companionAxisMajorStroke"

Inherited from: IgrAxis 

companionAxisMajorStroke: string

companionAxisMajorStrokeThickness

Section titled "companionAxisMajorStrokeThickness"

Inherited from: IgrAxis 

companionAxisMajorStrokeThickness: number

companionAxisMinExtent

Section titled "companionAxisMinExtent"

Inherited from: IgrAxis 

companionAxisMinExtent: number

companionAxisMinorStroke

Section titled "companionAxisMinorStroke"

Inherited from: IgrAxis 

companionAxisMinorStroke: string

companionAxisMinorStrokeThickness

Section titled "companionAxisMinorStrokeThickness"

Inherited from: IgrAxis 

companionAxisMinorStrokeThickness: number

companionAxisShouldAutoTruncateAnnotations

Section titled "companionAxisShouldAutoTruncateAnnotations"

Inherited from: IgrAxis 

companionAxisShouldAutoTruncateAnnotations: FeatureState

companionAxisShouldAvoidAnnotationCollisions

Section titled "companionAxisShouldAvoidAnnotationCollisions"

Inherited from: IgrAxis 

companionAxisShouldAvoidAnnotationCollisions: FeatureState

companionAxisShouldKeepAnnotationsInView

Section titled "companionAxisShouldKeepAnnotationsInView"

Inherited from: IgrAxis 

companionAxisShouldKeepAnnotationsInView: FeatureState

companionAxisStrip

Section titled "companionAxisStrip"

Inherited from: IgrAxis 

companionAxisStrip: string

companionAxisStroke

Section titled "companionAxisStroke"

Inherited from: IgrAxis 

companionAxisStroke: string

companionAxisStrokeThickness

Section titled "companionAxisStrokeThickness"

Inherited from: IgrAxis 

companionAxisStrokeThickness: number

companionAxisSyncronizedWithPrimaryAxis

Section titled "companionAxisSyncronizedWithPrimaryAxis"

Inherited from: IgrAxis 

companionAxisSyncronizedWithPrimaryAxis: boolean

companionAxisTickLength

Section titled "companionAxisTickLength"

Inherited from: IgrAxis 

companionAxisTickLength: number

companionAxisTickStroke

Section titled "companionAxisTickStroke"

Inherited from: IgrAxis 

companionAxisTickStroke: string

companionAxisTickStrokeThickness

Section titled "companionAxisTickStrokeThickness"

Inherited from: IgrAxis 

companionAxisTickStrokeThickness: number

companionAxisTitle

Section titled "companionAxisTitle"

Inherited from: IgrAxis 

companionAxisTitle: string

crossingAxis

Section titled "crossingAxis"

Inherited from: IgrAxis 

crossingAxis: IgrAxis

crossingAxisName

Section titled "crossingAxisName"

Inherited from: IgrAxis 

crossingAxisName: string

crossingValue

Section titled "crossingValue"

Inherited from: IgrAxis 

crossingValue: any

dataSource

Section titled "dataSource" 
dataSource: any

enhancedIntervalMinimumCharacters

Section titled "enhancedIntervalMinimumCharacters"

Inherited from: IgrAxis 

enhancedIntervalMinimumCharacters: number

enhancedIntervalPreferMoreCategoryLabels

Section titled "enhancedIntervalPreferMoreCategoryLabels"

Inherited from: IgrAxis 

enhancedIntervalPreferMoreCategoryLabels: boolean

expectFunctions

Section titled "expectFunctions"

Inherited from: IgrAxis 

expectFunctions: boolean

formatLabel

Section titled "formatLabel"

Inherited from: IgrAxis 

formatLabel: object

gap

Section titled "gap" 
gap: number

isCompanionAxis

Section titled "isCompanionAxis"

Inherited from: IgrAxis 

isCompanionAxis: boolean

isDisabled

Section titled "isDisabled"

Inherited from: IgrAxis 

isDisabled: boolean

isInverted

Section titled "isInverted"

Inherited from: IgrAxis 

isInverted: boolean

itemsCount

Section titled "itemsCount" 
itemsCount: number

label

Section titled "label"

Inherited from: IgrAxis 

label: any

labelAngle

Section titled "labelAngle"

Inherited from: IgrAxis 

labelAngle: number

labelBottomMargin

Section titled "labelBottomMargin"

Inherited from: IgrAxis 

labelBottomMargin: number

labelExtent

Section titled "labelExtent"

Inherited from: IgrAxis 

labelExtent: number

labelFormat

Section titled "labelFormat"

Inherited from: IgrAxis 

labelFormat: string

labelFormatSpecifiers

Section titled "labelFormatSpecifiers"

Inherited from: IgrAxis 

labelFormatSpecifiers: any[]

labelHorizontalAlignment

Section titled "labelHorizontalAlignment"

Inherited from: IgrAxis 

labelHorizontalAlignment: HorizontalAlignment

labelLeftMargin

Section titled "labelLeftMargin"

Inherited from: IgrAxis 

labelLeftMargin: number

labelLocation

Section titled "labelLocation"

Inherited from: IgrAxis 

labelLocation: AxisLabelsLocation

labelMaximumExtent

Section titled "labelMaximumExtent"

Inherited from: IgrAxis 

labelMaximumExtent: number

labelMaximumExtentPercentage

Section titled "labelMaximumExtentPercentage"

Inherited from: IgrAxis 

labelMaximumExtentPercentage: number

labelRightMargin

Section titled "labelRightMargin"

Inherited from: IgrAxis 

labelRightMargin: number

labelShowFirstLabel

Section titled "labelShowFirstLabel"

Inherited from: IgrAxis 

labelShowFirstLabel: boolean

labelTextColor

Section titled "labelTextColor"

Inherited from: IgrAxis 

labelTextColor: string

labelTextStyle

Section titled "labelTextStyle"

Inherited from: IgrAxis 

labelTextStyle: string

labelTopMargin

Section titled "labelTopMargin"

Inherited from: IgrAxis 

labelTopMargin: number

labelVerticalAlignment

Section titled "labelVerticalAlignment"

Inherited from: IgrAxis 

labelVerticalAlignment: VerticalAlignment

labelVisibility

Section titled "labelVisibility"

Inherited from: IgrAxis 

labelVisibility: Visibility

majorStroke

Section titled "majorStroke"

Inherited from: IgrAxis 

majorStroke: string

majorStrokeDashArray

Section titled "majorStrokeDashArray"

Inherited from: IgrAxis 

majorStrokeDashArray: number[]

majorStrokeThickness

Section titled "majorStrokeThickness"

Inherited from: IgrAxis 

majorStrokeThickness: number

maximumGap

Section titled "maximumGap" 
maximumGap: number

minimumGapSize

Section titled "minimumGapSize" 
minimumGapSize: number

minorStroke

Section titled "minorStroke"

Inherited from: IgrAxis 

minorStroke: string

minorStrokeDashArray

Section titled "minorStrokeDashArray"

Inherited from: IgrAxis 

minorStrokeDashArray: number[]

minorStrokeThickness

Section titled "minorStrokeThickness"

Inherited from: IgrAxis 

minorStrokeThickness: number

name

Section titled "name"

Inherited from: IgrAxis 

name: string

overlap

Section titled "overlap" 
overlap: number

rangeChanged

Section titled "rangeChanged"

Inherited from: IgrAxis 

rangeChanged: object

renderRequested

Section titled "renderRequested"

Inherited from: IgrAxis 

renderRequested: object

shouldAutoTruncateAnnotations

Section titled "shouldAutoTruncateAnnotations"

Inherited from: IgrAxis 

shouldAutoTruncateAnnotations: boolean

shouldAvoidAnnotationCollisions

Section titled "shouldAvoidAnnotationCollisions"

Inherited from: IgrAxis 

shouldAvoidAnnotationCollisions: boolean

shouldKeepAnnotationsInView

Section titled "shouldKeepAnnotationsInView"

Inherited from: IgrAxis 

shouldKeepAnnotationsInView: boolean

strip

Section titled "strip"

Inherited from: IgrAxis 

strip: string

stroke

Section titled "stroke"

Inherited from: IgrAxis 

stroke: string

strokeDashArray

Section titled "strokeDashArray"

Inherited from: IgrAxis 

strokeDashArray: number[]

strokeThickness

Section titled "strokeThickness"

Inherited from: IgrAxis 

strokeThickness: number

tickLength

Section titled "tickLength"

Inherited from: IgrAxis 

tickLength: number

tickStroke

Section titled "tickStroke"

Inherited from: IgrAxis 

tickStroke: string

tickStrokeDashArray

Section titled "tickStrokeDashArray"

Inherited from: IgrAxis 

tickStrokeDashArray: number[]

tickStrokeThickness

Section titled "tickStrokeThickness"

Inherited from: IgrAxis 

tickStrokeThickness: number

title

Section titled "title"

Inherited from: IgrAxis 

title: string

titleAngle

Section titled "titleAngle"

Inherited from: IgrAxis 

titleAngle: number

titleBottomMargin

Section titled "titleBottomMargin"

Inherited from: IgrAxis 

titleBottomMargin: number

titleExtent

Section titled "titleExtent"

Inherited from: IgrAxis 

titleExtent: number

titleHorizontalAlignment

Section titled "titleHorizontalAlignment"

Inherited from: IgrAxis 

titleHorizontalAlignment: HorizontalAlignment

titleLeftMargin

Section titled "titleLeftMargin"

Inherited from: IgrAxis 

titleLeftMargin: number

titleLocation

Section titled "titleLocation"

Inherited from: IgrAxis 

titleLocation: AxisLabelsLocation

titleMaximumExtent

Section titled "titleMaximumExtent"

Inherited from: IgrAxis 

titleMaximumExtent: number

titleMaximumExtentPercentage

Section titled "titleMaximumExtentPercentage"

Inherited from: IgrAxis 

titleMaximumExtentPercentage: number

titlePosition

Section titled "titlePosition"

Inherited from: IgrAxis 

titlePosition: AxisTitlePosition

titleRightMargin

Section titled "titleRightMargin"

Inherited from: IgrAxis 

titleRightMargin: number

titleShowFirstLabel

Section titled "titleShowFirstLabel"

Inherited from: IgrAxis 

titleShowFirstLabel: boolean

titleTextColor

Section titled "titleTextColor"

Inherited from: IgrAxis 

titleTextColor: string

titleTextStyle

Section titled "titleTextStyle"

Inherited from: IgrAxis 

titleTextStyle: string

titleTopMargin

Section titled "titleTopMargin"

Inherited from: IgrAxis 

titleTopMargin: number

titleVerticalAlignment

Section titled "titleVerticalAlignment"

Inherited from: IgrAxis 

titleVerticalAlignment: VerticalAlignment

titleVisibility

Section titled "titleVisibility"

Inherited from: IgrAxis 

titleVisibility: Visibility

useClusteringMode

Section titled "useClusteringMode" 
useClusteringMode: boolean

useEnhancedIntervalManagement

Section titled "useEnhancedIntervalManagement"

Inherited from: IgrAxis 

useEnhancedIntervalManagement: boolean

usePerLabelHeightMeasurement

Section titled "usePerLabelHeightMeasurement"

Inherited from: IgrAxis 

usePerLabelHeightMeasurement: boolean

Accessors

Section titled "Accessors"

axisInternal

Section titled "axisInternal"

Inherited from: IgrAxis 

get axisInternal(): Axis

Returns Axis

isAngular

Section titled "isAngular"

Inherited from: IgrAxis

Gets if the current axis is of angular axis type

get isAngular(): boolean

Returns boolean

isCategory

Section titled "isCategory"

Checks if the axis is of category axis type

get isCategory(): boolean

Returns boolean

isCategoryDateTime

Section titled "isCategoryDateTime"

Inherited from: IgrAxis

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

get isCategoryDateTime(): boolean

Returns boolean

isContinuous

Section titled "isContinuous"

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

get isContinuous(): boolean

Returns boolean

isDateTime

Section titled "isDateTime"

Inherited from: IgrAxis

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

get isDateTime(): boolean

Returns boolean

isHorizontal

Section titled "isHorizontal"

Inherited from: IgrAxis

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

Section titled "isNumeric"

Inherited from: IgrAxis

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

Section titled "isOrdinal"

Inherited from: IgrAxis

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

get isOrdinal(): boolean

Returns boolean

isPiecewise

Section titled "isPiecewise"

Inherited from: IgrAxis

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

get isPiecewise(): boolean

Returns boolean

isPrimaryAxis

Section titled "isPrimaryAxis"

Inherited from: IgrAxis

Gets whether this is primary axis created by an user

get isPrimaryAxis(): boolean

Returns boolean

isRadial

Section titled "isRadial"

Inherited from: IgrAxis

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

get isRadial(): boolean

Returns boolean

isSorting

Section titled "isSorting"

Inherited from: IgrAxis

Gets or sets if the current axis is sorting data items

get isSorting(): boolean

Returns boolean

isVertical

Section titled "isVertical"

Inherited from: IgrAxis

Gets if the current axis is a vertical axis.

get isVertical(): boolean

Returns boolean

i

Section titled "i" 
get i(): Axis

Returns Axis

Methods

Section titled "Methods"

bindAxes

Section titled "bindAxes"

Inherited from: IgrAxis 

bindAxes(axes: IgrAxis<IIgrAxisProps>[]): void

Parameters

Returns void

componentDidMount

Section titled "componentDidMount"

Inherited from: IgrAxis 

componentDidMount(): void

Returns void

ensureLabelSettings

Section titled "ensureLabelSettings"

Inherited from: IgrAxis 

ensureLabelSettings(): void

Returns void

ensureTitleSettings

Section titled "ensureTitleSettings"

Inherited from: IgrAxis 

ensureTitleSettings(): void

Returns void

findByName

Section titled "findByName"

Inherited from: IgrAxis 

findByName(name: string): any

Parameters

  • name: string

Returns any

getCategoryBoundingBox

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

Parameters

  • point: IgPoint
  • useInterpolation: boolean
  • singularWidth: number

Returns IgRect

getCategoryBoundingBoxHelper

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

Parameters

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

Returns IgRect

getFullRange

Section titled "getFullRange" 
getFullRange(): number[]

Returns number[]

getItemValue

Section titled "getItemValue"

Inherited from: IgrAxis 

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

Parameters

  • item: any
  • memberPathName: string

Returns any

getMemberPathValue

Section titled "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

Section titled "getValueLabel"

Inherited from: IgrAxis

Gets the label for a data item.

getValueLabel(value: number): string

Parameters

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

Returns string

notifyClearItems

Section titled "notifyClearItems"

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

notifyClearItems(): void

Returns void

notifyInsertItem

Section titled "notifyInsertItem" 
notifyInsertItem(index: number, newItem: any): void

Parameters

  • index: number
  • newItem: any

Returns void

notifyRemoveItem

Section titled "notifyRemoveItem" 
notifyRemoveItem(index: number, oldItem: any): void

Parameters

  • index: number
  • oldItem: any

Returns void

notifySetItem

Section titled "notifySetItem" 
notifySetItem(index: number, oldItem: any, newItem: any): void

Parameters

  • index: number
  • oldItem: any
  • newItem: any

Returns void

provideData

Section titled "provideData" 
provideData(data: any[]): void

Parameters

  • data: any[]

Returns void

render

Section titled "render"

Inherited from: IgrAxis 

render(): any

Returns any

renderAxis

Section titled "renderAxis"

Inherited from: IgrAxis

Renders the axis with no animation.

renderAxis(): void

Returns void

resetCachedEnhancedInterval

Section titled "resetCachedEnhancedInterval"

Inherited from: IgrAxis

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

Section titled "scaleValue"

Inherited from: IgrAxis

Scales a value from axis space into screen space.

scaleValue(unscaledValue: number): number

Parameters

  • unscaledValue: number
    • The unscaled axis value to scale.

Returns number

shouldComponentUpdate

Section titled "shouldComponentUpdate"

Inherited from: IgrAxis 

shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

unscaleValue

Section titled "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.

Returns number

_createFromInternal

Section titled "_createFromInternal"

Inherited from: IgrAxis 

_createFromInternal(internal: any): IgrAxis

Parameters

  • internal: any

Returns IgrAxis