Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CategoryAxis

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github
summary

A 2D Chart Category Axis type

description

A category axis uses the X-index not the X-value to measure data-points on the XAxis. For example this can be used in stock chart applications to ensure weekend or overnight gaps are collapsed and each data-point is spaced equidistantly

remarks

Set a CategoryAxis on the SciChartSurface.xAxes property. This axis type is not valid for YAxis

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

  • Creates an instance of a CategoryAxis

    Parameters

    • webAssemblyContext: TSciChart

      The {@link TSciChart | SciChart 2D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

    • Optional options: ICategoryAxisOptions

      Optional parameters of type ICategoryAxisOptions used to configure the axis at instantiation time

    Returns CategoryAxis

Properties

Protected allowFastMathProperty

allowFastMathProperty: boolean = false

Protected autoRangeAnimationProperty

autoRangeAnimationProperty: IAutoRangeAnimationOptions

Protected autoRangeProperty

autoRangeProperty: EAutoRange = EAutoRange.Once

Internal backing property for AxisCore.autoRange. To fire AxisCore.invalidateParentCallback, set the public property

Protected autoTicksProperty

autoTicksProperty: boolean = true

Internal backing property for AxisCore.autoTicks. To fire AxisCore.invalidateParentCallback, set the public property

Protected axisBandsFillProperty

axisBandsFillProperty: string = SciChartSurfaceBase.DEFAULT_THEME.axisBandsFill

Internal backing property for AxisCore.axisBandsFill. To fire AxisCore.invalidateParentCallback, set the public property

Readonly axisLayoutState

axisLayoutState: AxisLayoutState = new AxisLayoutState()

Gets the AxisLayoutState class which manages layout

Protected axisRendererProperty

axisRendererProperty: AxisRenderer

Protected axisTitleProperty

axisTitleProperty: string | string[]

Internal backing property for AxisCore.axisTitle. To fire AxisCore.invalidateParentCallback, set the public property

Readonly axisTitleRenderer

axisTitleRenderer: AxisTitleRenderer

Gets the AxisTitleRenderer instance responsible for drawing the axis title

Protected coordCalcCache

coordCalcCache: CoordinateCalculatorBase

Internal backing property for AxisCore.getCurrentCoordinateCalculator, a method which returns the latest valid CoordinateCalculatorBase instance for calculating pixel coordinates from data-values and vice versa.

Protected cursorTextFormattingProperty

cursorTextFormattingProperty: string

Internal backing property for AxisCore.cursorTextFormatting. To fire AxisCore.invalidateParentCallback, set the public property

Protected Readonly defaultVisibleRange

defaultVisibleRange: NumberRange = new NumberRange(0, 10)

Protected deltaCalculatorProperty

deltaCalculatorProperty: DeltaCalculator

Internal backing property for AxisCore.deltaCalculator. To fire AxisCore.invalidateParentCallback, set the public property

Protected drawLabelsProperty

drawLabelsProperty: boolean = true

Internal backing property for AxisCore.drawLabels. To fire AxisCore.invalidateParentCallback, set the public property

Protected drawMajorBandsProperty

drawMajorBandsProperty: boolean = true

Internal backing property for AxisCore.drawMajorBands. To fire AxisCore.invalidateParentCallback, set the public property

Protected drawMajorGridLinesProperty

drawMajorGridLinesProperty: boolean = true

Internal backing property for AxisCore.drawMajorGridLines. To fire AxisCore.invalidateParentCallback, set the public property

Protected drawMajorTickLinesProperty

drawMajorTickLinesProperty: boolean = true

Internal backing property for AxisCore.drawMajorTickLines. To fire AxisCore.invalidateParentCallback, set the public property

Protected drawMinorGridLinesProperty

drawMinorGridLinesProperty: boolean = true

Internal backing property for AxisCore.drawMinorGridLines. To fire AxisCore.invalidateParentCallback, set the public property

Protected drawMinorTickLinesProperty

drawMinorTickLinesProperty: boolean = true

Internal backing property for AxisCore.drawMinorTickLines. To fire AxisCore.invalidateParentCallback, set the public property

Protected flippedCoordinatesProperty

flippedCoordinatesProperty: boolean = false

Internal backing property for AxisCore.flippedCoordinates. To fire AxisCore.invalidateParentCallback, set the public property

Protected growByProperty

growByProperty: NumberRange

Internal backing property for AxisCore.growBy. To fire AxisCore.invalidateParentCallback, set the public property

Protected idProperty

idProperty: string = AxisCore.DEFAULT_AXIS_ID

Internal backing property for AxisCore.id. To fire AxisCore.invalidateParentCallback, set the public property

invalidateParentCallback

invalidateParentCallback: () => void

Callback to invalidate the parent 2D SciChartSurface or 3D SciChart3DSurface

Type declaration

    • (): void

    • Returns void

isMeasured

isMeasured: boolean = false

A flag to indicate if measure has been called this frame. Properties updated after measure must trigger a redraw

Protected isVisibleProperty

isVisibleProperty: boolean = true

Internal backing property for AxisCore.isVisible. To fire AxisCore.invalidateParentCallback, set the public property

Protected isXAxisProperty

isXAxisProperty: boolean = true

Internal backing property for {@link AxisCore.isAxis}. To fire AxisCore.invalidateParentCallback, set the public property

Protected labelProviderProperty

labelProviderProperty: LabelProvider

Internal backing property for AxisCore.labelProvider. To fire AxisCore.invalidateParentCallback, set the public property

Protected majorDeltaProperty

majorDeltaProperty: number

Internal backing property for AxisCore.majorDelta. To fire AxisCore.invalidateParentCallback, set the public property

Protected maxAutoTicksProperty

maxAutoTicksProperty: number = 10

Internal backing property for AxisCore.maxAutoTicks. To fire AxisCore.invalidateParentCallback, set the public property

Protected minorDeltaProperty

minorDeltaProperty: number

Internal backing property for AxisCore.minorDelta. To fire AxisCore.invalidateParentCallback, set the public property

Protected minorsPerMajorProperty

minorsPerMajorProperty: number = 5

Internal backing property for AxisCore.minorsPerMajor. To fire AxisCore.invalidateParentCallback, set the public property

parentSurface

parentSurface: SciChartSurface

Gets the parent SciChartSurface that this axis is attached to

Protected textFormattingProperty

textFormattingProperty: string

Internal backing property for AxisCore.textFormatting. To fire AxisCore.invalidateParentCallback, set the public property

Protected tickCoordinatesProviderProperty

tickCoordinatesProviderProperty: TickCoordinatesProvider

Internal backing property for AxisCore.tickCoordinatesProvider. To fire AxisCore.invalidateParentCallback, set the public property

Protected tickProviderProperty

tickProviderProperty: TickProvider

Internal backing property for AxisCore.tickProvider. To fire AxisCore.invalidateParentCallback, set the public property

Protected tickTextBrushProperty

tickTextBrushProperty: string = SciChartSurfaceBase.DEFAULT_THEME.tickTextBrush

Internal backing property for {@link AxisCore.tickTextBrush}. To fire AxisCore.invalidateParentCallback, set the public property

Readonly type

type: CategoryAxis = EAxisType.CategoryAxis

viewRect

viewRect: Rect

Gets the ViewRect - a rectangle defining the location of the axis within the parent SciChartSurface

Protected visibleRangeAnimationToken

visibleRangeAnimationToken: IGenericAnimation

visibleRangeChanged

visibleRangeChanged: EventHandler<VisibleRangeChangedArgs> = new EventHandler<VisibleRangeChangedArgs>()

An EventHandler which fires a callback when the AxisCore.visibleRange property changes.

desc

Protected visibleRangeProperty

visibleRangeProperty: NumberRange

Internal backing property for AxisCore.visibleRange. To fire AxisCore.invalidateParentCallback, set the public property

Protected Readonly webAssemblyContext2D

webAssemblyContext2D: TSciChart

The {@link TSciChart | SciChart 2D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

Static Readonly DEFAULT_AXIS_ID

DEFAULT_AXIS_ID: "DefaultAxisId" = "DefaultAxisId"

The Default AxisCore.id

description

By default all axis in SciChart have Id=AxisCore.DEFAULT_AXIS_ID. Also, all RenderableSeries have an xAxisId and yAxisId property set to AxisCore.DEFAULT_AXIS_ID. Annotations also have an xAxisId and yAxisId also set to AxisCore.DEFAULT_AXIS_ID. Some Chart Modifiers have an x,yAxisId property to filter their operations to an axis.

In multi-axis scenarios you will need to set the xAxisId/yAxisId properties of series, annotations, modifiers to match that of the axis you want them to be registered on.

Accessors

allowFastMath

  • get allowFastMath(): boolean
  • set allowFastMath(allowFastMath: boolean): void

  • When true, 32-bit faster paths for coordinate calculation maths are used. This improves performance in edge-cases where every CPU cycle counts.

    Returns boolean

  • When true, 32-bit faster paths for coordinate calculation maths are used. This improves performance in edge-cases where every CPU cycle counts.

    Parameters

    • allowFastMath: boolean

    Returns void

animatedVisibleRange

autoRange

autoRangeAnimation

autoTicks

  • get autoTicks(): boolean
  • set autoTicks(value: boolean): void

  • A boolean flag, when true, the axis will automatically calculate its Major and Minor delta. When false, the user can specify or set these properties for overriding axis gridline spacing

    Returns boolean

  • A boolean flag, when true, the axis will automatically calculate its Major and Minor delta. When false, the user can specify or set these properties for overriding axis gridline spacing

    Parameters

    • value: boolean

    Returns void

axisAlignment

  • Gets or sets the Axis Alignment. See EAxisAlignment for a list of values

    remarks

    use this property to set whether the axis is on the Left, Right, Bottom Top of the chart. SciChart also supports XAxis on the left and YAxis on the top to rotate / create vertical charts.

    Returns EAxisAlignment

  • Gets or sets the Axis Alignment. See EAxisAlignment for a list of values

    remarks

    use this property to set whether the axis is on the Left, Right, Bottom Top of the chart. SciChart also supports XAxis on the left and YAxis on the top to rotate / create vertical charts.

    Parameters

    Returns void

axisBandsFill

  • get axisBandsFill(): string
  • set axisBandsFill(axisBandsFill: string): void

  • Gets or sets the Axis Bands fill as an HTML Color code

    remarks

    See AxisCore.drawMajorBands to switch band drawing on and off

    Returns string

  • Gets or sets the Axis Bands fill as an HTML Color code

    remarks

    See AxisCore.drawMajorBands to switch band drawing on and off

    Parameters

    • axisBandsFill: string

    Returns void

axisBorder

  • Gets or sets the Axis Border properties

    Returns TBorder

  • Gets or sets the Axis Border properties

    Parameters

    Returns void

axisLength

  • get axisLength(): number
  • set axisLength(value: number): void

  • Called internally - Gets or sets the length the current Axis. E.g. width of horizontal axis or height of vertical axis.

    Returns number

  • Called internally - Gets or sets the length the current Axis. E.g. width of horizontal axis or height of vertical axis.

    Parameters

    • value: number

    Returns void

axisRenderer

axisTitle

  • get axisTitle(): string | string[]
  • set axisTitle(axisTitle: string | string[]): void

  • Gets or sets the Axis title string Use an array to create a multiLine title

    Returns string | string[]

  • Gets or sets the Axis title string Use an array to create a multiLine title

    Parameters

    • axisTitle: string | string[]

    Returns void

axisTitleStyle

  • summary

    Gets or sets the Axis Title style

    remarks

    See TTextStyle for the type which contains style options

    Returns TTextStyle

  • summary

    Gets or sets the Axis Title style

    remarks

    See TTextStyle for the type which contains style options

    Parameters

    Returns void

backgroundColor

  • get backgroundColor(): string
  • set backgroundColor(value: string): void

  • Gets the background color of separate Axis

    Returns string

  • Sets the background color of separate Axis

    Parameters

    • value: string

    Returns void

cursorTextFormatting

  • get cursorTextFormatting(): string
  • set cursorTextFormatting(cursorTextFormatting: string): void

defaultXStart

  • get defaultXStart(): number
  • set defaultXStart(value: number): void

  • The starting value for default x values. See defaultXValues

    Returns number

  • The starting value for default x values. See defaultXValues

    Parameters

    • value: number

    Returns void

defaultXStep

  • get defaultXStep(): number
  • set defaultXStep(value: number): void

  • The step size for default x values. See defaultXValues

    Returns number

  • The step size for default x values. See defaultXValues

    Parameters

    • value: number

    Returns void

defaultXValues

  • get defaultXValues(): number[]
  • set defaultXValues(values: number[]): void

  • The default x values to use if no series or data is added to the chart. The tick values shown will depend on the visible range, which for category axis is by index, not by value. eg if you want default values [10, 20, 30, 40] you would need to set visibleRange: new NumberRange(0,3) By default it will start at 0 and increment by 1, up to the size of the visible range. To change the start and step set defaultXStart and defaultXStep

    Returns number[]

  • The default x values to use if no series or data is added to the chart. The tick values shown will depend on the visible range, which for category axis is by index, not by value. eg if you want default values [10, 20, 30, 40] you would need to set visibleRange: new NumberRange(0,3) By default it will start at 0 and increment by 1, up to the size of the visible range. To change the start and step set defaultXStart and defaultXStep

    Parameters

    • values: number[]

    Returns void

deltaCalculator

  • Gets or sets a DeltaCalculator - a class which is responsible for calculating the Major and Minor delta, which are used for gridline spacing

    Returns DeltaCalculator

  • Gets or sets a DeltaCalculator - a class which is responsible for calculating the Major and Minor delta, which are used for gridline spacing

    Parameters

    Returns void

dpiAdjustedAxisTitleStyle

dpiAdjustedLabelStyle

drawLabels

  • get drawLabels(): boolean
  • set drawLabels(drawLabels: boolean): void

  • When true, draws labels on the axis, else they are not drawn

    Returns boolean

  • When true, draws labels on the axis, else they are not drawn

    Parameters

    • drawLabels: boolean

    Returns void

drawMajorBands

  • get drawMajorBands(): boolean
  • set drawMajorBands(drawMajorBands: boolean): void

  • When true, draws bands, a solid color fill between alternative major gridlines, else they are not drawn

    remarks

    See also the AxisCore.axisBandsFill property to style this element

    Returns boolean

  • When true, draws bands, a solid color fill between alternative major gridlines, else they are not drawn

    remarks

    See also the AxisCore.axisBandsFill property to style this element

    Parameters

    • drawMajorBands: boolean

    Returns void

drawMajorGridLines

  • get drawMajorGridLines(): boolean
  • set drawMajorGridLines(drawMajorGridLines: boolean): void

  • When true, major gridlines (lines inside the chart viewport area) are drawn, else they are not drawn

    description

    SciChart makes a distinction between axis Gridlines (drawn inside the chart) and axis ticks (small marks drawn outside the chart).

    Also, an Axis draws its own gridlines, for example a YAxis, which is vertical in a 2D Chart, draws gridlines horizontally at y-spacings.

    Similarly, an XAxis, which is horizontal in a 2D chart, draws gridlines vertically at X-spacings.

    remarks

    See also AxisCore.majorGridLineStyle to style the major gridlines

    Returns boolean

  • When true, major gridlines (lines inside the chart viewport area) are drawn, else they are not drawn

    description

    SciChart makes a distinction between axis Gridlines (drawn inside the chart) and axis ticks (small marks drawn outside the chart).

    Also, an Axis draws its own gridlines, for example a YAxis, which is vertical in a 2D Chart, draws gridlines horizontally at y-spacings.

    Similarly, an XAxis, which is horizontal in a 2D chart, draws gridlines vertically at X-spacings.

    remarks

    See also AxisCore.majorGridLineStyle to style the major gridlines

    Parameters

    • drawMajorGridLines: boolean

    Returns void

drawMajorTickLines

  • get drawMajorTickLines(): boolean
  • set drawMajorTickLines(drawMajorTickLines: boolean): void

  • When true, major gridlines (small lines outside the chart viewport area) are drawn, else they are not drawn

    description

    SciChart makes a distinction between axis Gridlines (drawn inside the chart) and axis ticks (small marks drawn outside the chart).

    Also, an Axis draws its own ticklines, for example a YAxis, which is vertical in a 2D Chart, draws ticklines horizontally at y-spacings.

    Similarly, an XAxis, which is horizontal in a 2D chart, draws ticklines vertically at X-spacings.

    remarks

    See also AxisCore.majorTickLineStyle to style the major tick lines

    Returns boolean

  • When true, major gridlines (small lines outside the chart viewport area) are drawn, else they are not drawn

    description

    SciChart makes a distinction between axis Gridlines (drawn inside the chart) and axis ticks (small marks drawn outside the chart).

    Also, an Axis draws its own ticklines, for example a YAxis, which is vertical in a 2D Chart, draws ticklines horizontally at y-spacings.

    Similarly, an XAxis, which is horizontal in a 2D chart, draws ticklines vertically at X-spacings.

    remarks

    See also AxisCore.majorTickLineStyle to style the major tick lines

    Parameters

    • drawMajorTickLines: boolean

    Returns void

drawMinorGridLines

  • get drawMinorGridLines(): boolean
  • set drawMinorGridLines(drawMinorGridLines: boolean): void

  • When true, minor gridlines (lines inside the chart viewport area) are drawn, else they are not drawn

    description

    SciChart makes a distinction between axis Gridlines (drawn inside the chart) and axis ticks (small marks drawn outside the chart).

    Also, an Axis draws its own gridlines, for example a YAxis, which is vertical in a 2D Chart, draws gridlines horizontally at y-spacings.

    Similarly, an XAxis, which is horizontal in a 2D chart, draws gridlines vertically at X-spacings.

    remarks

    See also AxisCore.minorGridLineStyle to style the minor gridlines

    Returns boolean

  • When true, minor gridlines (lines inside the chart viewport area) are drawn, else they are not drawn

    description

    SciChart makes a distinction between axis Gridlines (drawn inside the chart) and axis ticks (small marks drawn outside the chart).

    Also, an Axis draws its own gridlines, for example a YAxis, which is vertical in a 2D Chart, draws gridlines horizontally at y-spacings.

    Similarly, an XAxis, which is horizontal in a 2D chart, draws gridlines vertically at X-spacings.

    remarks

    See also AxisCore.minorGridLineStyle to style the minor gridlines

    Parameters

    • drawMinorGridLines: boolean

    Returns void

drawMinorTickLines

  • get drawMinorTickLines(): boolean
  • set drawMinorTickLines(drawMinorTickLines: boolean): void

  • When true, minor gridlines (small lines outside the chart viewport area) are drawn, else they are not drawn

    description

    SciChart makes a distinction between axis Gridlines (drawn inside the chart) and axis ticks (small marks drawn outside the chart).

    Also, an Axis draws its own ticklines, for example a YAxis, which is vertical in a 2D Chart, draws ticklines horizontally at y-spacings.

    Similarly, an XAxis, which is horizontal in a 2D chart, draws ticklines vertically at X-spacings.

    remarks

    See also AxisCore.minorTickLineStyle to style the minor tick lines

    Returns boolean

  • When true, minor gridlines (small lines outside the chart viewport area) are drawn, else they are not drawn

    description

    SciChart makes a distinction between axis Gridlines (drawn inside the chart) and axis ticks (small marks drawn outside the chart).

    Also, an Axis draws its own ticklines, for example a YAxis, which is vertical in a 2D Chart, draws ticklines horizontally at y-spacings.

    Similarly, an XAxis, which is horizontal in a 2D chart, draws ticklines vertically at X-spacings.

    remarks

    See also AxisCore.minorTickLineStyle to style the minor tick lines

    Parameters

    • drawMinorTickLines: boolean

    Returns void

flippedCoordinates

  • get flippedCoordinates(): boolean
  • set flippedCoordinates(flippedCoordinates: boolean): void

  • When true, axis coordinates are flipped, e.g. a NumericAxis with @{link AxisCore.visibleRange | VisibleRange} 0..10 will render from 10 to 0

    Returns boolean

  • When true, axis coordinates are flipped, e.g. a NumericAxis with @{link AxisCore.visibleRange | VisibleRange} 0..10 will render from 10 to 0

    Parameters

    • flippedCoordinates: boolean

    Returns void

growBy

  • Gets or sets the GrowBy: a padding factor on the axis

    description

    Growby factor is a padding factor set on the axis. For example if you want to have a constant padding above and below the axis, the following code will result in a 10% (min) and 20% (max) padding outside of the datarange.

    axis.growBy = new NumberRange(0.1, 0.2);

    Returns NumberRange

  • Gets or sets the GrowBy: a padding factor on the axis

    description

    Growby factor is a padding factor set on the axis. For example if you want to have a constant padding above and below the axis, the following code will result in a 10% (min) and 20% (max) padding outside of the datarange.

    axis.growBy = new NumberRange(0.1, 0.2);

    Parameters

    Returns void

id

  • get id(): string
  • set id(id: string): void

  • Gets or sets the unique Axis Id

    description

    By default all axis in SciChart have Id=AxisCore.DEFAULT_AXIS_ID. Also, all RenderableSeries have an xAxisId and yAxisId property set to AxisCore.DEFAULT_AXIS_ID. Annotations also have an xAxisId and yAxisId also set to AxisCore.DEFAULT_AXIS_ID. Some Chart Modifiers have an x,yAxisId property to filter their operations to an axis.

    In multi-axis scenarios you will need to set the xAxisId/yAxisId properties of series, annotations, modifiers to match that of the axis you want them to be registered on.

    Returns string

  • Gets or sets the unique Axis Id

    description

    By default all axis in SciChart have Id=AxisCore.DEFAULT_AXIS_ID. Also, all RenderableSeries have an xAxisId and yAxisId property set to AxisCore.DEFAULT_AXIS_ID. Annotations also have an xAxisId and yAxisId also set to AxisCore.DEFAULT_AXIS_ID. Some Chart Modifiers have an x,yAxisId property to filter their operations to an axis.

    In multi-axis scenarios you will need to set the xAxisId/yAxisId properties of series, annotations, modifiers to match that of the axis you want them to be registered on.

    Parameters

    • id: string

    Returns void

isAxisFlipped

  • get isAxisFlipped(): boolean

  • Gets whether the axis is flipped or not

    Returns boolean

isCategoryAxis

  • get isCategoryAxis(): boolean

isHorizontalAxis

  • get isHorizontalAxis(): boolean

  • Gets whether the axis is currently horizontal or not

    Returns boolean

isInnerAxis

  • get isInnerAxis(): boolean
  • set isInnerAxis(value: boolean): void

  • Gets or sets whether this axis is placed inside the chart viewport

    remarks

    Center axis uses inner layout strategy

    Returns boolean

  • Gets or sets whether this axis is placed inside the chart viewport

    remarks

    Center axis uses inner layout strategy

    Parameters

    • value: boolean

    Returns void

isPrimaryAxis

  • get isPrimaryAxis(): boolean
  • set isPrimaryAxis(value: boolean): void

  • Gets or sets whether this axis is the Primary axis on the chart

    remarks

    In SciChart 2D Charts, multiple X,Y Axis are supported. The primary axis is the one which draws the gridlines. By default, this is the first axis in the collection

    Returns boolean

  • Gets or sets whether this axis is the Primary axis on the chart

    remarks

    In SciChart 2D Charts, multiple X,Y Axis are supported. The primary axis is the one which draws the gridlines. By default, this is the first axis in the collection

    Parameters

    • value: boolean

    Returns void

isStackedAxis

  • get isStackedAxis(): boolean
  • set isStackedAxis(value: boolean): void

  • Internal Use. Gets or Sets if this axis is stacked This is only used to allow multiple primary axes, so that all stacked axes can draw gridlines

    Returns boolean

  • Internal Use. Gets or Sets if this axis is stacked This is only used to allow multiple primary axes, so that all stacked axes can draw gridlines

    Parameters

    • value: boolean

    Returns void

isVerticalChart

  • get isVerticalChart(): boolean

  • Gets whether the parent SciChartSurface is a vertical chart, when the XAxis is on the Left or Right, and YAxis is on the Top or Bottom

    Returns boolean

isVisible

  • get isVisible(): boolean
  • set isVisible(isVisible: boolean): void

  • When true, the axis is visible. Default value is also true for the axis

    remarks

    An invisible axis can be used to scale series to the viewport. For example:

    • have a chart with two-YAxis

    • have one series on the first axis and another series on the second axis

    • set second AxisCore.isVisible = false, and AxisCore.autoRange = EAutoRange.Always

      This will scale the series on the second axis to the viewport, on an invisible, auto-ranged axis

    Returns boolean

  • When true, the axis is visible. Default value is also true for the axis

    remarks

    An invisible axis can be used to scale series to the viewport. For example:

    • have a chart with two-YAxis

    • have one series on the first axis and another series on the second axis

    • set second AxisCore.isVisible = false, and AxisCore.autoRange = EAutoRange.Always

      This will scale the series on the second axis to the viewport, on an invisible, auto-ranged axis

    Parameters

    • isVisible: boolean

    Returns void

isXAxis

  • get isXAxis(): boolean

  • SET INTERNALLY. Gets whether this axis is an XAxis or not

    remarks

    See AxisBase2D.axisAlignment if you want to set a 2D Axis alignment to the left, right, top or bottom

    Returns boolean

labelProvider

labelStyle

majorDelta

  • get majorDelta(): number
  • set majorDelta(majorDelta: number): void

  • The MajorDelta is the spacing between major gridlines and axis labels.

    remarks

    This is internally computed via the Delta Calculator, however it can be explicitly set here in which case you should also set AxisCore.minorDelta and AxisCore.autoTicks = false.

    It is also possible to override and create custom implementations of the DeltaCalculator for full control over axis gridline spacing.

    Returns number

  • The MajorDelta is the spacing between major gridlines and axis labels.

    remarks

    This is internally computed via the Delta Calculator, however it can be explicitly set here in which case you should also set AxisCore.minorDelta and AxisCore.autoTicks = false.

    It is also possible to override and create custom implementations of the DeltaCalculator for full control over axis gridline spacing.

    Parameters

    • majorDelta: number

    Returns void

majorGridLineStyle

majorTickLineStyle

maxAutoTicks

  • get maxAutoTicks(): number
  • set maxAutoTicks(value: number): void

  • Gets or sets the max-auto-ticks. A hint which limits the number of major gridlines and labels (aka major ticks) on the axis at any one time. This value is a hint, and actual value of ticks may be lower than this

    Returns number

  • Gets or sets the max-auto-ticks. A hint which limits the number of major gridlines and labels (aka major ticks) on the axis at any one time. This value is a hint, and actual value of ticks may be lower than this

    Parameters

    • value: number

    Returns void

minorDelta

  • get minorDelta(): number
  • set minorDelta(minorDelta: number): void

  • The MinorDelta is the spacing between minor gridlines.

    remarks

    This is internally computed via the Delta Calculator, however it can be explicitly set here in which case you should also set AxisCore.majorDelta and AxisCore.autoTicks = false.

    It is also possible to override and create custom implementations of the DeltaCalculator for full control over axis gridline spacing.

    Returns number

  • The MinorDelta is the spacing between minor gridlines.

    remarks

    This is internally computed via the Delta Calculator, however it can be explicitly set here in which case you should also set AxisCore.majorDelta and AxisCore.autoTicks = false.

    It is also possible to override and create custom implementations of the DeltaCalculator for full control over axis gridline spacing.

    Parameters

    • minorDelta: number

    Returns void

minorGridLineStyle

minorTickLineStyle

minorsPerMajor

  • get minorsPerMajor(): number
  • set minorsPerMajor(minorDelta: number): void

  • When AxisCore.autoTicks is true, minorsPerMajor is a hint of how many minor gridlines should be drawn between each major gridline

    Returns number

  • When AxisCore.autoTicks is true, minorsPerMajor is a hint of how many minor gridlines should be drawn between each major gridline

    Parameters

    • minorDelta: number

    Returns void

offset

  • get offset(): number
  • set offset(value: number): void

  • Gets or sets the offset of the axis position. Defines a position of the axis along the layout flow.

    Returns number

  • Gets or sets the offset of the axis position

    Parameters

    • value: number

    Returns void

stackedAxisLength

  • get stackedAxisLength(): string | number
  • set stackedAxisLength(value: string | number): void

  • Gets or sets the length of a stacked axis as an absolute number or percentage, e.g. 100, or "30%". A plain number will be interpreted as a number of pixels. A number with % will take that percentage of the total length. Stacked axes without a defined length will have the remaining unreserved spaced split between them.

    remarks

    The axis length doesn't include border sizes

    Returns string | number

  • Gets or sets the length of a stacked axis as an absolute number or percentage, e.g. 100, or "30%". A plain number will be interpreted as a number of pixels. A number with % will take that percentage of the total length. Stacked axes without a defined length will have the remaining unreserved spaced split between them.

    remarks

    The axis length doesn't include border sizes

    Parameters

    • value: string | number

    Returns void

textFormatting

  • get textFormatting(): string
  • set textFormatting(textFormatting: string): void

  • Returns string

  • Parameters

    • textFormatting: string

    Returns void

tickCoordinatesProvider

tickProvider

  • Gets or sets a TickProvider - a class which calculates ticks (interval between major and minor gridlines, ticks and labels)

    Returns TickProvider

  • Gets or sets a TickProvider - a class which calculates ticks (interval between major and minor gridlines, ticks and labels)

    Parameters

    Returns void

visibleRange

  • The VisibleRange is the range of the Axis (min to max).

    description

    For example, if you have data-values from 0 to 100 in your DataSeries, but you only want to show values from 15-25 on the axis, then set the visibleRange as follows:

    axis.visibleRange = new NumberRange(15, 25);
    remarks

    The visibleRange is a data-value for NumericAxis, @{link NumericAxis3D} but refers to an index to the data for CategoryAxis types.

    Returns NumberRange

  • The VisibleRange is the range of the Axis (min to max).

    description

    For example, if you have data-values from 0 to 100 in your DataSeries, but you only want to show values from 15-25 on the axis, then set the visibleRange as follows:

    axis.visibleRange = new NumberRange(15, 25);
    remarks

    The visibleRange is a data-value for NumericAxis, @{link NumericAxis3D} but refers to an index to the data for CategoryAxis types.

    Parameters

    Returns void

visibleRangeLimit

zoomExtentsRange

  • Gets or sets a property which, if it is set, will be used as the range when zooming extents, rather than the data max range

    Returns NumberRange

  • Gets or sets a property which, if it is set, will be used as the range when zooming extents, rather than the data max range

    Parameters

    Returns void

Methods

animateVisibleRange

applyTheme

clearCoordCalcCache

  • clearCoordCalcCache(): void

  • Force the recreation of the coordinate calculator the next time it is requested Required if the dataSeries has changed on a category axis

    Returns void

Protected coerceZeroVisibleRange

delete

  • delete(): void

  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

draw

  • Called internally - draws the current axis using the {@link WebGL2RenderingContext}

    Parameters

    Returns void

Protected drawAxisBands

  • drawAxisBands(renderContext: WebGlRenderContext2D, ticks: number[], tickCoords: number[], brush: SCRTSolidBrush): void

  • Called internally - draws the Axis Bands

    Parameters

    • renderContext: WebGlRenderContext2D

      The {@link WebGL2RenderingContext} used for drawing

    • ticks: number[]

      An array of tick numeric values

    • tickCoords: number[]

      An array of tick coordinates

    • brush: SCRTSolidBrush

      The {@link SCRTSolidBrush} used to fill the axis band area in our WebGL graphics engine

    Returns void

Protected drawAxisBandsAndGridLines

  • drawAxisBandsAndGridLines(renderContext: WebGlRenderContext2D, tickObject: TTickObject, penForMinorGridLines: SCRTPen, penForMajorGridLines: SCRTPen): void

  • Called internally - draws the Axis Bands and Gridlines

    Parameters

    • renderContext: WebGlRenderContext2D

      The {@link WebGL2RenderingContext} used for drawing

    • tickObject: TTickObject

      The TTickObject contains the major, minor tick numeric values, coordinates and labels for drawing

    • penForMinorGridLines: SCRTPen

      The {@link SCRTPen} for drawing minor gridlines in our WebGL graphics engine

    • penForMajorGridLines: SCRTPen

      The {@link SCRTPen} for drawing major gridlines in our WebGL graphics engine

    Returns void

drawDebug

Protected drawGridLines

  • Called internally - draws the Axis Grid Lines

    Parameters

    • renderContext: WebGlRenderContext2D

      The {@link WebGL2RenderingContext} used for drawing

    • tickCoords: number[]

      An array of tick coordinates

    • linesPen: SCRTPen

      The {@link SCRTPen} used to draw the axis gridlines in our WebGL graphics engine

    Returns void

getCurrentCoordinateCalculator

Protected getCurrentCoordinateCalculatorInternal

getDefaultNonZeroRange

Protected getIsValidForDrawing

  • getIsValidForDrawing(): boolean

Protected getIsXCategoryAxis

  • getIsXCategoryAxis(xAxisId: string): boolean

Protected getLabels

  • getLabels(majorTicks: number[]): string[]

  • Returns an array of label strings for an array of major tick numeric values

    Parameters

    • majorTicks: number[]

      The major tick numeric values

    Returns string[]

Protected getMaxAutoTicks

  • getMaxAutoTicks(): number

Protected getMaxXRange

getMaximumRange

  • summary

    Part of AutoRanging - Gets the maximum range on this axis

    description

    The getMaximumRange function computes the visibleRange min and max that this axis must have to display all the data in the chart.

    Returns NumberRange

Protected getTicksMaxSize

  • getTicksMaxSize(): number

  • Returns the max size for major/minor ticks. Used in layout and passed to AxisRenderer

    Returns number

getWindowedYRange

  • summary

    Part of AutoRanging - gets the windowed maximum range for Y-Axes

    description

    Returns the max range only for that axis (by the data-series on it), based on associated XAxis visible range of series on the same axis

    Parameters

    • xRanges: Dictionary<NumberRange>

      (optional) if provided, we use previously calculated XAxis ranges keyed by AxisId rather than calculate them again

    Returns NumberRange

Protected getXDataRange

Protected getXVisibleRange

hasDefaultVisibleRange

  • hasDefaultVisibleRange(): boolean

hasValidVisibleRange

  • hasValidVisibleRange(): boolean

isValidRange

  • Tests whether the range passed in is valid

    Parameters

    Returns boolean

measure

  • measure(): void

  • Called internally - measures the axis as part of the layout phase

    Returns void

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAttach

  • onAttach(parentSurface: SciChartSurface, isXAxis: boolean, isPrimaryAxis: boolean): void

prepareRenderData

  • prepareRenderData(): void

scale

  • scale(initialRange: NumberRange, delta: number, isMoreThanHalf: boolean): void

  • Parameters

    • initialRange: NumberRange
    • delta: number
    • isMoreThanHalf: boolean

    Returns void

scroll

  • scroll(pixelsToScroll: number, clipMode: EClipMode): boolean

  • Programmatically scrolls the axis by a number of pixels

    Parameters

    • pixelsToScroll: number

      The number of pixels to scroll

    • clipMode: EClipMode

      The clipping mode. See EClipMode for a list of values

    Returns boolean

Protected setIsXAxis

  • setIsXAxis(isXAxis: boolean): void

  • SET INTERNALLY. Sets whether this axis is an XAxis or not

    remarks

    See AxisBase2D.axisAlignment if you want to set a 2D Axis alignment to the left, right, top or bottom

    Parameters

    • isXAxis: boolean

    Returns void

toJSON

zoom

  • zoom(fromCoord: number, toCoord: number, duration?: number, easingFunction?: TEasingFn): void
  • summary

    Programmatically zooms the axis with a from and to coordinate

    description

    Used by the RubberBandXyZoomModifier, which allows the user to draw a rectangle on the chart to zoom in. The from / too coordinate are the x or y components of the rectangle corners used to zoom in

    Parameters

    • fromCoord: number

      a pixel coordinate to zoom from

    • toCoord: number

      a pixel coordinate to zoom to

    • Default value duration: number = 0

      The duration of animation in milliseconds. Pass 0 for no animation.

    • Default value easingFunction: TEasingFn = easing.outExpo

      An optional easing function passed to specify animation easing. See TEasingFn for a list of values

    Returns void

zoomBy

  • zoomBy(minFraction: number, maxFraction: number): void

  • Programmatically zooms the axis by a min and max fraction

    Parameters

    • minFraction: number

      The Min fraction, e.g. 0.1 will zoom the lower part of the range 10%

    • maxFraction: number

      The Max fraction, e.g. 0.1 will zoom the upper part of the range 10%

    Returns void

Object literals

Protected axisTitleStyleProperty

axisTitleStyleProperty: object

Internal backing property for AxisCore.axisTitleStyle. To fire AxisCore.invalidateParentCallback, set the public property

alignment

alignment: Center = ELabelAlignment.Center

color

color: string = SciChartSurfaceBase.DEFAULT_THEME.axisTitleColor

fontFamily

fontFamily: string = "Arial"

fontSize

fontSize: number = 24

fontStyle

fontStyle: string = "normal"

fontWeight

fontWeight: string = "normal"

padding

padding: Thickness = Thickness.fromNumber(6)

Protected majorGridLineStyleProperty

majorGridLineStyleProperty: object

Internal backing property for AxisCore.majorGridLineStyle. To fire AxisCore.invalidateParentCallback, set the public property

color

color: string = SciChartSurfaceBase.DEFAULT_THEME.majorGridLineBrush

strokeDashArray

strokeDashArray: undefined = undefined

strokeThickness

strokeThickness: number = 1

Protected majorTickLineStyleProperty

majorTickLineStyleProperty: object

Internal backing property for AxisCore.majorTickLineStyle. To fire AxisCore.invalidateParentCallback, set the public property

color

color: string = SciChartSurfaceBase.DEFAULT_THEME.majorGridLineBrush

strokeThickness

strokeThickness: number = 1

tickSize

tickSize: number = 5

Protected minorGridLineStyleProperty

minorGridLineStyleProperty: object

Internal backing property for AxisCore.minorGridLineStyle. To fire AxisCore.invalidateParentCallback, set the public property

color

color: string = SciChartSurfaceBase.DEFAULT_THEME.minorGridLineBrush

strokeDashArray

strokeDashArray: undefined = undefined

strokeThickness

strokeThickness: number = 1

Protected minorTickLineStyleProperty

minorTickLineStyleProperty: object

Internal backing property for AxisCore.minorTickLineStyle. To fire AxisCore.invalidateParentCallback, set the public property

color

color: string = SciChartSurfaceBase.DEFAULT_THEME.minorGridLineBrush

strokeThickness

strokeThickness: number = 1

tickSize

tickSize: number = 3

Generated using TypeDoc