Options
All
  • Public
  • Public/Protected
  • All
Menu

The base class for 3D Chart Axis within SciChart - High Performance JavaScript 3D Charts.

description

AxisBase3D is a base class for both 3D Axis types in SciChart. Concrete types include:

Set axis on the SciChart3DSurface.xAxis, SciChart3DSurface.yAxis or SciChart3DSurface.zAxis in 3D Charts.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

Protected constructor

  • Creates an instance of the AxisBase3D

    Parameters

    • webAssemblyContext: TSciChart3D

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

    • Optional options: IAxisBase3dOptions

      optional parameters of type IAxisBase3dOptions to pass to the constructor

    Returns AxisBase3D

Properties

Protected allowFastMathProperty

allowFastMathProperty: boolean = false

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

Protected axisTitleProperty

axisTitleProperty: string | string[]

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

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

Readonly labelStyle

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

Gets the parent SciChart3DSurface 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 Abstract type

type: EAxisType

The type of axis. See EAxisType for a list of values

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 webAssemblyContext3D

webAssemblyContext3D: TSciChart3D

The {@link TSciChart3D | SciChart 3D 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

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

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

axisPlaneBackgroundFill

  • get axisPlaneBackgroundFill(): string
  • set axisPlaneBackgroundFill(axisPlaneBackgroundFill: string): void
  • Gets or sets the fill of the Axis Plane background as an HTML Color code. Defaults to transparent

    Returns string

  • Gets or sets the fill of the Axis Plane background as an HTML Color code. Defaults to transparent

    Parameters

    • axisPlaneBackgroundFill: string

    Returns void

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 or sets the color of the background of the axis plane as an HTML Color code

    Returns string

  • Gets or sets the color of the background of the axis plane as an HTML Color code

    Parameters

    • value: string

    Returns void

cursorTextFormatting

  • get cursorTextFormatting(): string
  • set cursorTextFormatting(cursorTextFormatting: string): 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

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

isCategoryAxis

  • get isCategoryAxis(): boolean
  • Gets if the Axis is Category

    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

isYAxis

  • get isYAxis(): boolean
  • Used internally - gets whether this axis is a Y Axis

    Returns boolean

isZAxis

  • get isZAxis(): boolean
  • Used internally - gets whether this axis is a Z Axis

    Returns boolean

labelDepthTestEnabled

  • get labelDepthTestEnabled(): boolean
  • set labelDepthTestEnabled(labelDepthTestEnabled: boolean): void
  • Gets or sets if Label Depth test is enabled

    description

    When true, Labels are rendered with depth and can be behind chart objects. Else, labels are always on top and closest to the viewer

    Returns boolean

  • Gets or sets if Label Depth test is enabled

    description

    When true, Labels are rendered with depth and can be behind chart objects. Else, labels are always on top and closest to the viewer

    Parameters

    • labelDepthTestEnabled: boolean

    Returns void

labelProvider

  • Gets or sets a LabelProvider - a class which is responsible for formatting axis labels and cursor labels from numeric values

    Returns LabelProvider

  • Gets or sets a LabelProvider - a class which is responsible for formatting axis labels and cursor labels from numeric values

    Parameters

    Returns void

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

negativeSideClipping

planeBorderColor

  • get planeBorderColor(): string
  • set planeBorderColor(planeBorderColor: string): void
  • Gets or sets the color of the axis plane border as an HTML Color code

    Returns string

  • Gets or sets the color of the axis plane border as an HTML Color code

    Parameters

    • planeBorderColor: string

    Returns void

planeBorderThickness

  • get planeBorderThickness(): number
  • set planeBorderThickness(planeBorderThickness: number): void
  • Gets or sets a thickness of the axis plane border.

    Returns number

  • Gets or sets a thickness of the axis plane border.

    Parameters

    • planeBorderThickness: number

    Returns void

positiveSideClipping

textFormatting

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

  • Parameters

    • textFormatting: string

    Returns void

tickCoordinatesProvider

tickLabelAlignment

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

    Returns ETextAlignment3D

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

    Parameters

    Returns void

tickLabelsOffset

  • get tickLabelsOffset(): number
  • set tickLabelsOffset(value: number): void
  • Gets or sets tick labels offset from the axis plane

    Returns number

  • Gets or sets tick labels offset from the axis plane

    Parameters

    • value: number

    Returns void

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

titleOffset

  • get titleOffset(): number
  • set titleOffset(value: number): void
  • Gets or sets title text offset from the axis plane

    Returns number

  • Gets or sets title text offset from the axis plane

    Parameters

    • value: number

    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

Methods

Abstract 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

Protected getAxisSize

  • getAxisSize(): number
  • gets the axis size from the WorldDimensions, depending on whether it is an X,Y or ZAxis

    Returns number

getCurrentCoordinateCalculator

Protected Abstract getCurrentCoordinateCalculatorInternal

Abstract getDefaultNonZeroRange

Protected getLabels

  • getLabels(majorTicks: number[]): string[]
  • Given an array of numeric values for axis labels, returns a list of strings. Uses labelProvider property to format labels

    Parameters

    • majorTicks: number[]

      The major tick values as numbers to be converted to labels

    Returns string[]

Protected getMaxAutoTicks

  • getMaxAutoTicks(): number

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

getMaximumRangeAs

  • 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.

    remarks

    This overload impersonates a specific axis according to the EWhichAxis parameter

    Parameters

    Returns NumberRange

hasDefaultVisibleRange

  • hasDefaultVisibleRange(): boolean

hasValidVisibleRange

  • hasValidVisibleRange(): boolean

isValidRange

  • Tests whether the range passed in is valid

    Parameters

    Returns boolean

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void
  • Notifies listeners to AxisCore.invalidateParentCallback that a property has changed and the parent chart needs to be redrawn.

    remarks

    Override this in derived classes if you want to notified of a specific property change

    Parameters

    • propertyName: string

      The property name which has changed.

    Returns void

onAttach

  • onAttach(parentSurface: SciChart3DSurface, isXaxis: boolean, isYAxis: boolean, isZAxis: boolean): void
  • Parameters

    • parentSurface: SciChart3DSurface
    • isXaxis: boolean
    • isYAxis: boolean
    • isZAxis: boolean

    Returns void

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

setIsYAxis

  • setIsYAxis(isYAxis: boolean): void
  • Used internally - sets whether this axis is a Y Axis

    Parameters

    • isYAxis: boolean

    Returns void

setIsZAxis

  • setIsZAxis(isZAxis: boolean): void
  • Used internally - sets whether this axis is a Z Axis

    Parameters

    • isZAxis: boolean

    Returns void

toAxisDescriptor

  • Called internally - returns an IAxisDescriptor which contains parameters, property and data to pass to the WebAssembly 3D Engine for drawing this axis

    Returns IAxisDescriptor

validateAxis

  • validateAxis(): void
  • 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