Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional allowFastMath

allowFastMath: boolean

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

Optional autoRange

autoRange: EAutoRange

Sets the AxisCore.autoRange mode. For a list of values, see EAutoRange

Optional autoRangeAnimation

autoRangeAnimation: IAutoRangeAnimationOptions

Options to configure if and how the axis should animate when autoRanging

Optional autoTicks

autoTicks: boolean

When true, the AxisCore.majorDelta and AxisCore.minorDelta values will be computed automatically. Else, the user may specify these values by setting the properties.

Optional axisAlignment

axisAlignment: EAxisAlignment

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.

Optional axisBandsFill

axisBandsFill: string

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

remarks

See AxisCore.drawMajorBands to switch band drawing on and off

Optional axisBorder

axisBorder: TBorder

Sets the Axis Border properties

Optional axisThickness

axisThickness: number

Sets axis label area thickness, by default the value is calculated to have enough space for labels. However, this property allows to set minimal width/height for vertical/horizontal axes. Useful to align seriesViewRects for different charts

Optional axisTitle

axisTitle: string | string[]

Set the Axis Title string to display on this axis Use an Array to create a multiline title

Optional axisTitleStyle

axisTitleStyle: TTextStyle
summary

Sets the Axis Title style

remarks

See TTextStyle for the type which contains style options

Optional backgroundColor

backgroundColor: string

Optional drawLabels

drawLabels: boolean

When true, draw labels on the chart, else labels are hidden

remarks

Default value when undefined is true

Optional drawMajorBands

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

Optional drawMajorGridLines

drawMajorGridLines: boolean

When true, draw major gridlines on the chart, else major grid lines are hidden

remarks

Default value when undefined is true

Optional drawMajorTickLines

drawMajorTickLines: boolean

When true, draw major ticklines on the chart, else major ticks are hidden

remarks

Default value when undefined is true

Optional drawMinorGridLines

drawMinorGridLines: boolean

When true, draw minor gridlines on the chart, else minor grid lines are hidden

remarks

Default value when undefined is true

Optional drawMinorTickLines

drawMinorTickLines: boolean

When true, draw minor ticklines on the chart, else minor ticks are hidden

remarks

Default value when undefined is true

Optional flippedCoordinates

flippedCoordinates: boolean

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

Optional growBy

growBy: NumberRange

Sets 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);

Optional hideOverlappingLabels

hideOverlappingLabels: boolean

Default (true) is to not show labels that would overlap. When using rotation you may want to set this false, as the bounding box of rotated text may overlap even if the text itself does not.

Optional id

id: string

The Axis Id - a unique string ID for this axis

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.

Optional isInnerAxis

isInnerAxis: boolean

Sets whether this axis is placed inside the chart viewport

remarks

Center axis uses inner layout strategy

Optional isVisible

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

Optional keepLabelsWithinAxis

keepLabelsWithinAxis: boolean

When true (default), first and last labels will be shifted to stay within axis bounds. If set to false, these labels will stay aligned to their ticks

Optional labelProvider

Sets a LabelProvider - a class which is responsible for formatting axis labels and cursor labels from numeric values

Optional labelStyle

labelStyle: TTextStyle

Sets a TTextStyle object for styling axis labels

Optional majorDelta

majorDelta: number

The MajorDelta is the spacing between major gridlines and axis labels. Available when AxisCore.autoTicks is false

Optional majorGridLineStyle

majorGridLineStyle: TGridLineStyle
summary

Sets the Major gridlines style

remarks

See TGridLineStyle for the type which contains style options

Optional majorTickLineStyle

majorTickLineStyle: TTickLineStyle
summary

Sets the Major tick lines style

remarks

See TTickLineStyle for the type which contains style options

Optional maxAutoTicks

maxAutoTicks: number

The maximum number of ticks on the axis when SciChart's Axis is in AxisCore.autoTicks mode

remarks

The number of ticks on the axis will never exceed this number, but may be smaller than this number when zooming or panning.

Optional minorDelta

minorDelta: number

The MinorDelta is the spacing between major gridlines and axis labels. Available when AxisCore.autoTicks is false

Optional minorGridLineStyle

minorGridLineStyle: TGridLineStyle
summary

Sets the Minor gridlines style

remarks

See TGridLineStyle for the type which contains style options

Optional minorTickLineStyle

minorTickLineStyle: TTickLineStyle
summary

Sets the Minor tick lines style

remarks

See TTickLineStyle for the type which contains style options

Optional minorsPerMajor

minorsPerMajor: number

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

Optional stackedAxisLength

stackedAxisLength: TStackedAxisLength

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

Optional visibleRange

visibleRange: 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.

Optional visibleRangeLimit

visibleRangeLimit: NumberRange

Limits AxisCore.visibleRange, meaning the chart cannot autorange outside that range

Optional zoomExtentsRange

zoomExtentsRange: NumberRange

If this is set, it will be used as the range when zooming extents, rather than the data max range

Optional zoomExtentsToInitialRange

zoomExtentsToInitialRange: boolean

If true, zoomExtentsRange will be set to the visibleRange passed on the options, so that zoomExtents returns to the initially defined range

Generated using TypeDoc