Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PolarNumericAxis

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

A 2D Chart Numeric / Value Axis type for use with Polar Charts.

description

A Polar Numeric axis converts to angles around a circle.

remarks

Set a PolarNumericAxis on the SciChartPolarSurface.xAxes or SciChartPolarSurface.yAxes property.

📚 Docs: https://www.scichart.com/documentation/js/v4/2d-charts/axis-api/axis-types/polar-numeric-axis/

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Properties

ZeroRangeGrowBy

ZeroRangeGrowBy: number = 0.01

If the diff of the visibleRange is 0, this growby fraction will be applied

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: PolarAxisLayoutState = new PolarAxisLayoutState()

Protected axisLengthProperty

axisLengthProperty: number

Protected axisRendererProperty

axisRendererProperty: AxisRenderer

Protected axisTitleProperty

axisTitleProperty: string | string[]

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

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 coordTransform

coordTransform: SCRTPolarCoordinateTransform

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 gridlineModeProperty

gridlineModeProperty: EPolarGridlineMode = EPolarGridlineMode.Circles

Protected growByProperty

growByProperty: NumberRange | undefined

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

Protected hasVisibleRangeSet

hasVisibleRangeSet: boolean = false

If false, autoRange Once will run on this axis. Set true when there is any change to the visibleRange.

Readonly id

id: string

A unique Id for the AxisCore

Protected innerRadiusProperty

innerRadiusProperty: number = 0

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

Readonly isPolarAxis

isPolarAxis: boolean = true

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 lengthScaleProperty

lengthScaleProperty: number = 1

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

Protected offsetOverrideProperty

offsetOverrideProperty: number = undefined

Protected offsetProperty

offsetProperty: number = 0

Protected otherAxisProperty

otherAxisProperty: PolarAxisBase

parentSurface

parentSurface: SciChartSurface

Gets the parent SciChartSurface that this axis is attached to

Protected penCacheForMajorGridLines

penCacheForMajorGridLines: Pen2DCache

Protected penCacheForMinorGridLines

penCacheForMinorGridLines: Pen2DCache

Protected polarAxisModeProperty

polarAxisModeProperty: EPolarAxisMode

Protected polarLabelModeProperty

polarLabelModeProperty: EPolarLabelMode = EPolarLabelMode.Horizontal

Protected solidBrushCacheAxisBackground

solidBrushCacheAxisBackground: SolidBrushCache

Protected solidBrushCacheAxisBands

solidBrushCacheAxisBands: SolidBrushCache

Protected solidBrushCacheBorder

solidBrushCacheBorder: SolidBrushCache

Protected startAngleProperty

startAngleProperty: number = 0

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

Protected totalAngleProperty

totalAngleProperty: number = 2 * Math.PI

Readonly type

type: PolarNumericAxis = EAxisType.PolarNumericAxis

viewRect

viewRect: Rect

Gets the ViewRect - a rectangle defining the location of the axis within the parent SciChartSurface This includes the axis title. Axis border is drawn to this rect. Labels are rawn relative to axisRenderer.viewRect

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 webAssemblyContext2D

webAssemblyContext2D: TSciChart

The SciChart 2D WebAssembly Context containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

Protected xCenterOffsetProperty

xCenterOffsetProperty: number = 0

Protected yCenterOffsetProperty

yCenterOffsetProperty: number = 0

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

axisRenderer

axisThickness

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

  • Gets or 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

    Returns number

  • Gets or 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

    Parameters

    • value: number

    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

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

clipToXRange

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

  • For an X Axis only - Determines whether the series will be clipped to the visibleRange. Defaults true. You may want to set this false if you have stacked horizontal axes, or are using {@link offsetOverride}.

    Returns boolean

  • For an X Axis only - Determines whether the series will be clipped to the visibleRange. Defaults true. You may want to set this false if you have stacked horizontal axes, or are using {@link offsetOverride}.

    Parameters

    • clipToXRange: boolean

    Returns void

cursorTextFormatting

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

deltaCalculator

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

gridlineMode

  • Gets or sets whether the gridlines for the radial axis are drawn as Circles or Polygons (for radar chart).

    Returns EPolarGridlineMode

  • Gets or sets whether the gridlines for the radial axis are drawn as Circles or Polygons (for radar chart).

    Parameters

    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 | undefined

  • 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

innerRadius

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

  • Gets or Sets the inner radius for a radial axis as a decimal between 0 and 1 which is treated as a fraction of the maximum radius. If you want to set an absolute innerRadius, use overrideOffset

    Returns number

  • Gets or Sets the inner radius for a radial axis as a decimal between 0 and 1 which is treated as a fraction of the maximum radius. If you want to set an absolute innerRadius, use overrideOffset

    Parameters

    • value: number

    Returns void

isAngular

  • get isAngular(): boolean

  • Gets or sets whether this polar axis is angular or radial. The X and Y axes for a series must be different modes.

    inheritdoc

    Returns boolean

isAxisFlipped

  • get isAxisFlipped(): boolean

  • Gets whether the axis is flipped or not

    Returns boolean

isCategoryAxis

  • get isCategoryAxis(): boolean

  • Gets if the Axis is Category

    Returns boolean

isHorizontalAxis

  • get isHorizontalAxis(): 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

isLinearAxis

  • get isLinearAxis(): boolean

  • Get if this axis is linear, and therefore supports optimisations like viewport clamping

    Returns boolean

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

  • 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

isStaticAxis

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

  • Gets whether the gridlines and axis labels keep their initial position when the visible range changes.

    Returns boolean

  • Sets whether the gridlines and axis labels keep their initial position when the visible range changes.

    Parameters

    • value: boolean

    Returns void

isVerticalChart

  • get isVerticalChart(): 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

lengthScale

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

  • Gets or sets the scale of the axis used for zooming. Default 1 (one to one scale).

    Returns number

  • Gets or sets the scale of the axis used for zooming. Default 1 (one to one scale).

    Parameters

    • value: number

    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

maxRadius

  • get maxRadius(): number

  • The maximum radius as set by layout

    Returns number

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

  • Called internally by layout strategies when switching between stacked and non-stacked axes. If you want to set a manual offset, call overrideOffset

    Parameters

    • value: number

    Returns void

otherAxis

polarAxisMode

  • Gets or sets whether this polar axis is angular or radial. The X and Y axes for a series must be different mode.

    Returns EPolarAxisMode

  • Gets or sets whether this polar axis is angular or radial. The X and Y axes for a series must be different mode.

    Parameters

    Returns void

polarLabelMode

stackedAxisLength

  • 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 TStackedAxisLength | undefined

  • 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

    Returns void

startAngle

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

  • For an Angular axis, gets or sets the angle corresponding to the start of the axis. 0 is horizontally right. For a Radial axis, gets or sets the angle at which the axis is drawn

    inheritdoc

    Returns number

  • For an Angular axis, gets or sets the angle corresponding to the start of the axis. 0 is horizontally right. For a Radial axis, gets or sets the angle at which the axis is drawn

    inheritdoc

    Parameters

    • value: number

    Returns void

startAngleDegrees

  • get startAngleDegrees(): number | undefined
  • set startAngleDegrees(value: number | undefined): void

  • Gets or sets the start angle in degrees.

    Returns number | undefined

  • Gets or sets the start angle in degrees.

    Parameters

    • value: number | undefined

    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

totalAngle

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

  • Gets or sets the angular length for an Angular axis. Default 2 pi radians (ie 360 degrees)

    Returns number

  • Gets or sets the angular length for an Angular axis. Default 2 pi radians (ie 360 degrees)

    Parameters

    • value: number

    Returns void

totalAngleDegrees

  • get totalAngleDegrees(): number | undefined
  • set totalAngleDegrees(value: number | undefined): void

  • Gets or sets the total angle in degrees.

    Returns number | undefined

  • Gets or sets the total angle in degrees.

    Parameters

    • value: number | undefined

    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, 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, NumericAxis3D but refers to an index to the data for CategoryAxis types.

    If you override this setter, make sure you add this.hasVisibleRangeSet = true;

    Parameters

    Returns void

visibleRangeLimit

visibleRangeSizeLimit

  • Gets or sets a property which limits the size of AxisCore.visibleRange, meaning that the inequality must hold visibleRangeSizeLimit.min <= visibleRange.max - visiblerRange.min <= visibleRangeSizeLimit.max

    Returns NumberRange

  • Gets or sets a property which limits the size of AxisCore.visibleRange, meaning that the inequality must hold visibleRangeSizeLimit.min <= visibleRange.max - visiblerRange.min <= visibleRangeSizeLimit.max

    Parameters

    Returns void

xCenterOffset

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

  • Gets or sets the x offset in pixels for the center of the polar chart. Set this for the angular axis and the radial axis will use the same value.

    inheritdoc

    Returns number

  • Gets or sets the x offset in pixels for the center of the polar chart. Set this for the angular axis and the radial axis will use the same value.

    inheritdoc

    Parameters

    • value: number

    Returns void

yCenterOffset

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

  • Gets or sets the y offset in pixels for the center of the polar chart. Set this for the angular axis and the radial axis will use the same value.

    inheritdoc

    Returns number

  • Gets or sets the y offset in pixels for the center of the polar chart. Set this for the angular axis and the radial axis will use the same value.

    inheritdoc

    Parameters

    • value: number

    Returns void

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

Protected createAxisRender

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

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

  • drawGridLines(renderContext: WebGlRenderContext2D, tickCoords: number[], linesPen: SCRTPen, isMajor: boolean): void

getAxisSize

  • getAxisSize(): number

getCurrentCoordinateCalculator

Protected getCurrentCoordinateCalculatorInternal

getDefaultNonZeroRange

Protected getIsValidForDrawing

  • getIsValidForDrawing(): boolean

  • When true, the axis is valid for drawing

    Returns boolean

Protected getIsXCategoryAxis

  • getIsXCategoryAxis(xAxisId: string | undefined): boolean

  • Parameters

    • xAxisId: string | undefined

    Returns 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 getMajorTickIndex

  • getMajorTickIndex(tick: number): number

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 getPenForLines

  • getPenForLines(penCache: Pen2DCache, stroke: string, strokeThickness: number, strokeDashArray?: number[]): SCRTPen

Protected getTicksMaxSize

  • getTicksMaxSize(): number

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

    Returns number

Protected getTicksWithCoords

getTransform

  • getTransform(usePixelRatio?: boolean): SCRTPolarCoordinateTransform

  • Return the transform function is used to transform from polar to cartesian coordinates

    Parameters

    • Default value usePixelRatio: boolean = false

      is needed for correct transform for SVG annotations

    Returns SCRTPolarCoordinateTransform

getVisibleRenderableSeriesByXAxis

getVisibleRenderableSeriesByYAxis

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> | undefined

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

    Returns NumberRange

Protected getXDataRange

  • Gets the total range on the XAxis required to display all the series zoomed to fit on this axis

    Returns NumberRange

Protected getXVisibleRange

  • getXVisibleRange(xAxisId: string | undefined): NumberRange

hasDefaultVisibleRange

  • hasDefaultVisibleRange(): boolean

hasValidVisibleRange

  • hasValidVisibleRange(): boolean

isValidRange

  • Tests whether the range passed in is valid

    Parameters

    Returns boolean

measure

  • measure(): void

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAttach

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

onDetach

  • onDetach(): void

onDpiChanged

  • onDpiChanged(): void

  • called internally - allow axis to respond to dpi changes

    Returns void

overrideOffset

  • overrideOffset(value: number): void

  • set an offset value that overrides the one used by layout calculation

    Parameters

    • value: number

    Returns void

prepareRenderData

  • prepareRenderData(): void

  • Called internally - prepares render data before a draw operation

    Returns void

Protected removeLinksToAxis

  • removeLinksToAxis(): void

  • Removes links to the axis, is called when axis is detached

    Returns void

reverseTransform

  • reverseTransform(x: number, y: number, flipXYForVertical?: boolean): Point

  • Converts from cartesian to polar coordinates

    Parameters

    • x: number

      X cartesian coordinate

    • y: number

      Y cartesian coordinate

    • Default value flipXYForVertical: boolean = true

    Returns Point

    Point where Point.x is angle and Point.y is radius

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

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

setVisibleRangeWithLimits

  • Apply the axis visibleRangeLimit and visibleRangeSizeLimit to the given range and set the result as the axis visibleRange.

    Parameters

    Returns void

toJSON

toRadians

  • toRadians(angleInDegrees: number): number

  • Converts angle from degrees to radians

    Parameters

    • angleInDegrees: number

    Returns number

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

    Parameters

    • minFraction: number
    • maxFraction: number

    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 = getDefaultFontName()

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