Represents a DataChartComponent category X axis.

CategoryXAxis class represents a DataChartComponent category X axis.

``

``

IgrCategoryXAxis

new IgrCategoryXAxis(props: P): IgrCategoryXAxis

Returns IgrCategoryXAxis

actualInterval: number
actualIntervalChange: object

Inherited from: IgrCategoryAxisBase

actualMajorStroke: string
actualMinorInterval: number
actualMinorIntervalChange: object

Inherited from: IgrCategoryAxisBase

actualMinorStroke: string

Inherited from: IgrCategoryAxisBase

actualStroke: string

Inherited from: IgrCategoryAxisBase

annotations: IgrAxisAnnotationCollection

Inherited from: IgrCategoryAxisBase

coercionMethods: any

Inherited from: IgrCategoryAxisBase

companionAxisCrossingAxis: IgrAxis

Inherited from: IgrCategoryAxisBase

companionAxisCrossingAxisName: string

Inherited from: IgrCategoryAxisBase

companionAxisCrossingValue: number

Inherited from: IgrCategoryAxisBase

companionAxisEnabled: boolean
companionAxisInterval: number

Inherited from: IgrCategoryAxisBase

companionAxisIsInverted: FeatureState

Inherited from: IgrCategoryAxisBase

companionAxisLabelAngle: number

Inherited from: IgrCategoryAxisBase

companionAxisLabelColor: string

Inherited from: IgrCategoryAxisBase

companionAxisLabelExtent: number

companionAxisLabelHorizontalAlignment

Section titled "companionAxisLabelHorizontalAlignment"

Inherited from: IgrCategoryAxisBase

companionAxisLabelHorizontalAlignment: HorizontalAlignment

Inherited from: IgrCategoryAxisBase

companionAxisLabelLocation: AxisLabelsLocation

Inherited from: IgrCategoryAxisBase

companionAxisLabelOpposite: boolean

companionAxisLabelVerticalAlignment

Section titled "companionAxisLabelVerticalAlignment"

Inherited from: IgrCategoryAxisBase

companionAxisLabelVerticalAlignment: VerticalAlignment

Inherited from: IgrCategoryAxisBase

companionAxisLabelVisible: FeatureState

Inherited from: IgrCategoryAxisBase

companionAxisMajorStroke: string

Inherited from: IgrCategoryAxisBase

companionAxisMajorStrokeThickness: number

Inherited from: IgrCategoryAxisBase

companionAxisMinExtent: number
companionAxisMinorInterval: number

Inherited from: IgrCategoryAxisBase

companionAxisMinorStroke: string

Inherited from: IgrCategoryAxisBase

companionAxisMinorStrokeThickness: number

companionAxisShouldAutoTruncateAnnotations

Section titled "companionAxisShouldAutoTruncateAnnotations"

Inherited from: IgrCategoryAxisBase

companionAxisShouldAutoTruncateAnnotations: FeatureState

companionAxisShouldAvoidAnnotationCollisions

Section titled "companionAxisShouldAvoidAnnotationCollisions"

Inherited from: IgrCategoryAxisBase

companionAxisShouldAvoidAnnotationCollisions: FeatureState

companionAxisShouldKeepAnnotationsInView

Section titled "companionAxisShouldKeepAnnotationsInView"

Inherited from: IgrCategoryAxisBase

companionAxisShouldKeepAnnotationsInView: FeatureState

Inherited from: IgrCategoryAxisBase

companionAxisStrip: string

Inherited from: IgrCategoryAxisBase

companionAxisStroke: string

Inherited from: IgrCategoryAxisBase

companionAxisStrokeThickness: number

companionAxisSyncronizedWithPrimaryAxis

Section titled "companionAxisSyncronizedWithPrimaryAxis"

Inherited from: IgrCategoryAxisBase

companionAxisSyncronizedWithPrimaryAxis: boolean

Inherited from: IgrCategoryAxisBase

companionAxisTickLength: number

Inherited from: IgrCategoryAxisBase

companionAxisTickStroke: string

Inherited from: IgrCategoryAxisBase

companionAxisTickStrokeThickness: number

Inherited from: IgrCategoryAxisBase

companionAxisTitle: string

Inherited from: IgrCategoryAxisBase

crossingAxis: IgrAxis

Inherited from: IgrCategoryAxisBase

crossingAxisName: string

Inherited from: IgrCategoryAxisBase

crossingValue: any

Inherited from: IgrCategoryAxisBase

dataSource: any

Inherited from: IgrCategoryAxisBase

enhancedIntervalMinimumCharacters: number

enhancedIntervalPreferMoreCategoryLabels

Section titled "enhancedIntervalPreferMoreCategoryLabels"

Inherited from: IgrCategoryAxisBase

enhancedIntervalPreferMoreCategoryLabels: boolean

Inherited from: IgrCategoryAxisBase

expectFunctions: boolean

Inherited from: IgrCategoryAxisBase

formatLabel: object

Inherited from: IgrCategoryAxisBase

gap: number
interval: number

Inherited from: IgrCategoryAxisBase

isCompanionAxis: boolean

Inherited from: IgrCategoryAxisBase

isDisabled: boolean

Inherited from: IgrCategoryAxisBase

isInverted: boolean

Inherited from: IgrCategoryAxisBase

itemsCount: number

Inherited from: IgrCategoryAxisBase

label: any

Inherited from: IgrCategoryAxisBase

labelAngle: number

Inherited from: IgrCategoryAxisBase

labelBottomMargin: number

Inherited from: IgrCategoryAxisBase

labelExtent: number

Inherited from: IgrCategoryAxisBase

labelFormat: string

Inherited from: IgrCategoryAxisBase

labelFormatSpecifiers: any[]

Inherited from: IgrCategoryAxisBase

labelHorizontalAlignment: HorizontalAlignment

Inherited from: IgrCategoryAxisBase

labelLeftMargin: number

Inherited from: IgrCategoryAxisBase

labelLocation: AxisLabelsLocation

Inherited from: IgrCategoryAxisBase

labelMaximumExtent: number

Inherited from: IgrCategoryAxisBase

labelMaximumExtentPercentage: number

Inherited from: IgrCategoryAxisBase

labelRightMargin: number

Inherited from: IgrCategoryAxisBase

labelShowFirstLabel: boolean

Inherited from: IgrCategoryAxisBase

labelTextColor: string

Inherited from: IgrCategoryAxisBase

labelTextStyle: string

Inherited from: IgrCategoryAxisBase

labelTopMargin: number

Inherited from: IgrCategoryAxisBase

labelVerticalAlignment: VerticalAlignment

Inherited from: IgrCategoryAxisBase

labelVisibility: Visibility

Inherited from: IgrCategoryAxisBase

majorStroke: string

Inherited from: IgrCategoryAxisBase

majorStrokeDashArray: number[]

Inherited from: IgrCategoryAxisBase

majorStrokeThickness: number

Inherited from: IgrCategoryAxisBase

maximumGap: number

Inherited from: IgrCategoryAxisBase

minimumGapSize: number
minorInterval: number

Inherited from: IgrCategoryAxisBase

minorStroke: string

Inherited from: IgrCategoryAxisBase

minorStrokeDashArray: number[]

Inherited from: IgrCategoryAxisBase

minorStrokeThickness: number

Inherited from: IgrCategoryAxisBase

name: string

Inherited from: IgrCategoryAxisBase

overlap: number

Inherited from: IgrCategoryAxisBase

rangeChanged: object

Inherited from: IgrCategoryAxisBase

renderRequested: object

Inherited from: IgrCategoryAxisBase

shouldAutoTruncateAnnotations: boolean

Inherited from: IgrCategoryAxisBase

shouldAvoidAnnotationCollisions: boolean

Inherited from: IgrCategoryAxisBase

shouldKeepAnnotationsInView: boolean

Inherited from: IgrCategoryAxisBase

strip: string

Inherited from: IgrCategoryAxisBase

stroke: string

Inherited from: IgrCategoryAxisBase

strokeDashArray: number[]

Inherited from: IgrCategoryAxisBase

strokeThickness: number

Inherited from: IgrCategoryAxisBase

tickLength: number

Inherited from: IgrCategoryAxisBase

tickStroke: string

Inherited from: IgrCategoryAxisBase

tickStrokeDashArray: number[]

Inherited from: IgrCategoryAxisBase

tickStrokeThickness: number

Inherited from: IgrCategoryAxisBase

title: string

Inherited from: IgrCategoryAxisBase

titleAngle: number

Inherited from: IgrCategoryAxisBase

titleBottomMargin: number

Inherited from: IgrCategoryAxisBase

titleExtent: number

Inherited from: IgrCategoryAxisBase

titleHorizontalAlignment: HorizontalAlignment

Inherited from: IgrCategoryAxisBase

titleLeftMargin: number

Inherited from: IgrCategoryAxisBase

titleLocation: AxisLabelsLocation

Inherited from: IgrCategoryAxisBase

titleMaximumExtent: number

Inherited from: IgrCategoryAxisBase

titleMaximumExtentPercentage: number

Inherited from: IgrCategoryAxisBase

titlePosition: AxisTitlePosition

Inherited from: IgrCategoryAxisBase

titleRightMargin: number

Inherited from: IgrCategoryAxisBase

titleShowFirstLabel: boolean

Inherited from: IgrCategoryAxisBase

titleTextColor: string

Inherited from: IgrCategoryAxisBase

titleTextStyle: string

Inherited from: IgrCategoryAxisBase

titleTopMargin: number

Inherited from: IgrCategoryAxisBase

titleVerticalAlignment: VerticalAlignment

Inherited from: IgrCategoryAxisBase

titleVisibility: Visibility

Inherited from: IgrCategoryAxisBase

useClusteringMode: boolean

Inherited from: IgrCategoryAxisBase

useEnhancedIntervalManagement: boolean

Inherited from: IgrCategoryAxisBase

usePerLabelHeightMeasurement: boolean
zoomMaximumCategoryRange: number
zoomMaximumItemSpan: number
zoomToCategoryRange: number
zoomToCategoryStart: number
zoomToItemSpan: number

Inherited from: IgrCategoryAxisBase

get axisInternal(): Axis

Returns Axis

Inherited from: IgrCategoryAxisBase

Gets if the current axis is of angular axis type

get isAngular(): boolean

Returns boolean

Inherited from: IgrCategoryAxisBase

Checks if the axis is of category axis type

get isCategory(): boolean

Returns boolean

Inherited from: IgrCategoryAxisBase

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

get isCategoryDateTime(): boolean

Returns boolean

Inherited from: IgrCategoryAxisBase

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

get isContinuous(): boolean

Returns boolean

Inherited from: IgrCategoryAxisBase

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

get isDateTime(): boolean

Returns boolean

Inherited from: IgrCategoryAxisBase

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

Inherited from: IgrCategoryAxisBase

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

Inherited from: IgrCategoryAxisBase

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

get isOrdinal(): boolean

Returns boolean

Inherited from: IgrCategoryAxisBase

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

get isPiecewise(): boolean

Returns boolean

Inherited from: IgrCategoryAxisBase

Gets whether this is primary axis created by an user

get isPrimaryAxis(): boolean

Returns boolean

Inherited from: IgrCategoryAxisBase

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

get isRadial(): boolean

Returns boolean

Inherited from: IgrCategoryAxisBase

Gets or sets if the current axis is sorting data items

get isSorting(): boolean

Returns boolean

Inherited from: IgrCategoryAxisBase

Gets if the current axis is a vertical axis.

get isVertical(): boolean

Returns boolean

get i(): Axis

Returns Axis

Inherited from: IgrCategoryAxisBase

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

Parameters

Returns void

Inherited from: IgrCategoryAxisBase

componentDidMount(): void

Returns void

Inherited from: IgrCategoryAxisBase

ensureLabelSettings(): void

Returns void

Inherited from: IgrCategoryAxisBase

ensureTitleSettings(): void

Returns void

Inherited from: IgrCategoryAxisBase

findByName(name: string): any

Parameters

  • name: string

Returns any

Inherited from: IgrCategoryAxisBase

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

Parameters

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

Returns IgRect

Inherited from: IgrCategoryAxisBase

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

Parameters

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

Returns IgRect

Inherited from: IgrCategoryAxisBase

getFullRange(): number[]

Returns number[]

Inherited from: IgrCategoryAxisBase

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

Parameters

  • item: any
  • memberPathName: string

Returns any

Inherited from: IgrCategoryAxisBase

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

Inherited from: IgrCategoryAxisBase

Gets the label for a data item.

getValueLabel(value: number): string

Parameters

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

Returns string

Gets window zoom scale required to zoom to specified number of categories

getWindowZoomFromCategories(categoriesCount: number): number

Parameters

  • categoriesCount: number

Returns number

Gets window zoom scale required to zoom to specified span of series item

getWindowZoomFromItemSpan(pixels: number): number

Parameters

  • pixels: number

Returns number

Inherited from: IgrCategoryAxisBase

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

notifyClearItems(): void

Returns void

Inherited from: IgrCategoryAxisBase

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

Parameters

  • index: number
  • newItem: any

Returns void

Inherited from: IgrCategoryAxisBase

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

Parameters

  • index: number
  • oldItem: any

Returns void

Inherited from: IgrCategoryAxisBase

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

Parameters

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

Returns void

Inherited from: IgrCategoryAxisBase

provideData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgrCategoryAxisBase

render(): any

Returns any

Inherited from: IgrCategoryAxisBase

Renders the axis with no animation.

renderAxis(): void

Returns void

Inherited from: IgrCategoryAxisBase

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

Inherited from: IgrCategoryAxisBase

Scales a value from axis space into screen space.

scaleValue(unscaledValue: number): number

Parameters

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

Returns number

Scrolls the specified item into view.

scrollIntoView(item: any): void

Parameters

  • item: any
    • Data item to scroll into view

Returns void

scrollRangeIntoView(minimum: number, maximum: number): void

Parameters

  • minimum: number
  • maximum: number

Returns void

Inherited from: IgrCategoryAxisBase

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

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

Inherited from: IgrCategoryAxisBase

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

Inherited from: IgrCategoryAxisBase

_createFromInternal(internal: any): IgrAxis

Parameters

  • internal: any

Returns IgrAxis