Creates an instance of the AxisBase2D
The SciChart 2D WebAssembly Context containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods
Optional parameters of type IAxisBase2dOptions used to configure the axis at instantiation time
If the diff of the visibleRange is 0, this growby fraction will be applied
Internal backing property for AxisCore.autoRange. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.autoTicks. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.axisBandsFill. To fire AxisCore.invalidateParentCallback, set the public property
Gets the AxisLayoutState class which manages layout
Internal backing property for AxisCore.axisTitle. To fire AxisCore.invalidateParentCallback, set the public property
Gets the AxisTitleRenderer instance responsible for drawing the axis title
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.
Internal backing property for AxisCore.cursorTextFormatting. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.deltaCalculator. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.drawLabels. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.drawMajorBands. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.drawMajorGridLines. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.drawMajorTickLines. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.drawMinorGridLines. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.drawMinorTickLines. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.flippedCoordinates. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.growBy. To fire AxisCore.invalidateParentCallback, set the public property
If false, autoRange Once will run on this axis. Set true when there is any change to the visibleRange.
Internal backing property for AxisCore.id. To fire AxisCore.invalidateParentCallback, set the public property
Callback to invalidate the parent 2D SciChartSurface or 3D SciChart3DSurface
A flag to indicate if measure has been called this frame. Properties updated after measure must trigger a redraw
Internal backing property for AxisCore.isVisible. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for {@link AxisCore.isAxis}. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.labelProvider. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.majorDelta. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.maxAutoTicks. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.minorDelta. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.minorsPerMajor. To fire AxisCore.invalidateParentCallback, set the public property
Gets the parent SciChartSurface that this axis is attached to
Internal backing property for AxisCore.textFormatting. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.tickCoordinatesProvider. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.tickProvider. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for {@link AxisCore.tickTextBrush}. To fire AxisCore.invalidateParentCallback, set the public property
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
An EventHandler which fires a callback when the AxisCore.visibleRange property changes.
Internal backing property for AxisCore.visibleRange. To fire AxisCore.invalidateParentCallback, set the public property
The SciChart 2D WebAssembly Context containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods
The Default AxisCore.id
When true, 32-bit faster paths for coordinate calculation maths are used. This improves performance in edge-cases where every CPU cycle counts.
When true, 32-bit faster paths for coordinate calculation maths are used. This improves performance in edge-cases where every CPU cycle counts.
gets or sets the Auto-Ranging behaviour on the axis. See EAutoRange for a list of values. The default value is EAutoRange.Once
gets or sets the Auto-Ranging behaviour on the axis. See EAutoRange for a list of values. The default value is EAutoRange.Once
Gets or sets a IAutoRangeAnimationOptions object that controls if and how the visible range is animated during autoRanging
Gets or sets a IAutoRangeAnimationOptions object that controls if and how the visible range is animated during autoRanging
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
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
Gets or sets the Axis Alignment. See EAxisAlignment for a list of values
Gets or sets the Axis Alignment. See EAxisAlignment for a list of values
Gets or sets the Axis Bands fill as an HTML Color code
Gets or sets the Axis Bands fill as an HTML Color code
Called internally - Gets or sets the length the current Axis. E.g. width of horizontal axis or height of vertical axis.
Called internally - Gets or sets the length the current Axis. E.g. width of horizontal axis or height of vertical axis.
Gets the AxisRenderer instance responsible for drawing the axis
Sets the AxisRenderer instance responsible for drawing the axis
Gets or sets the Axis title string Use an array to create a multiLine title
Gets or sets the Axis title string Use an array to create a multiLine title
Gets the background color of separate Axis
Sets the background color of separate Axis
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}.
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}.
Gets or sets a DeltaCalculator - a class which is responsible for calculating the Major and Minor delta, which are used for gridline spacing
Gets or sets a DeltaCalculator - a class which is responsible for calculating the Major and Minor delta, which are used for gridline spacing
Gets the axisTitleStyle adjusted for current DPI / Browser zoom level
Gets the labelStyle adjusted for current DPI / Browser zoom level
When true, draws labels on the axis, else they are not drawn
When true, draws labels on the axis, else they are not drawn
When true, draws bands, a solid color fill between alternative major gridlines, else they are not drawn
When true, draws bands, a solid color fill between alternative major gridlines, else they are not drawn
When true, major gridlines (lines inside the chart viewport area) are drawn, else they are not drawn
When true, major gridlines (lines inside the chart viewport area) are drawn, else they are not drawn
When true, major gridlines (small lines outside the chart viewport area) are drawn, else they are not drawn
When true, major gridlines (small lines outside the chart viewport area) are drawn, else they are not drawn
When true, minor gridlines (lines inside the chart viewport area) are drawn, else they are not drawn
When true, minor gridlines (lines inside the chart viewport area) are drawn, else they are not drawn
When true, minor gridlines (small lines outside the chart viewport area) are drawn, else they are not drawn
When true, minor gridlines (small lines outside the chart viewport area) are drawn, else they are not drawn
When true, axis coordinates are flipped, e.g. a NumericAxis with VisibleRange 0..10 will render from 10 to 0
When true, axis coordinates are flipped, e.g. a NumericAxis with VisibleRange 0..10 will render from 10 to 0
Gets or sets the GrowBy: a padding factor on the axis
Gets or sets the GrowBy: a padding factor on the axis
Gets or sets the unique Axis Id
Gets or sets the unique Axis Id
Gets whether the axis is flipped or not
Gets if the Axis is Category
Gets whether the axis is currently horizontal or not
Gets or sets whether this axis is placed inside the chart viewport
Gets or sets whether this axis is placed inside the chart viewport
Gets or sets whether this axis is the Primary axis on the chart
Gets or sets whether this axis is the Primary axis on the chart
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
Gets whether the gridlines and axis labels keep their initial position when the visible range changes.
Sets whether the gridlines and axis labels keep their initial position when the visible range changes.
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
When true, the axis is visible. Default value is also true for the axis
When true, the axis is visible. Default value is also true for the axis
SET INTERNALLY. Gets whether this axis is an XAxis or not
Gets or sets a LabelProviderBase2D - a class which is responsible for formatting axis labels and cursor labels from numeric values
Gets or sets a LabelProviderBase2D - a class which is responsible for formatting axis labels and cursor labels from numeric values
Gets or sets a TTextStyle object for styling axis labels
Gets or sets a TTextStyle object for styling axis labels
The MajorDelta is the spacing between major gridlines and axis labels.
The MajorDelta is the spacing between major gridlines and axis labels.
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
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
The MinorDelta is the spacing between minor gridlines.
The MinorDelta is the spacing between minor gridlines.
When AxisCore.autoTicks is true, minorsPerMajor is a hint of how many minor gridlines should be drawn between each major gridline
When AxisCore.autoTicks is true, minorsPerMajor is a hint of how many minor gridlines should be drawn between each major gridline
Gets or sets the offset of the axis position. Defines a position of the axis along the layout flow.
Called internally by layout strategies when switching between stacked and non-stacked axes. If you want to set a manual offset, call overrideOffset
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.
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.
Gets or sets a TickCoordinatesProvider - a class which is responsible for converting tick values to pixel coordinates
Gets or sets a TickCoordinatesProvider - a class which is responsible for converting tick values to pixel coordinates
Gets or sets a TickProvider - a class which calculates ticks (interval between major and minor gridlines, ticks and labels)
Gets or sets a TickProvider - a class which calculates ticks (interval between major and minor gridlines, ticks and labels)
The VisibleRange is the range of the Axis (min to max).
The VisibleRange is the range of the Axis (min to max).
Gets or sets a property which limits AxisCore.visibleRange, meaning the chart cannot autorange outside that range
Gets or sets a property which limits AxisCore.visibleRange, meaning the chart cannot autorange outside that range
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
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
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
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
Applies a theme (defined by IThemeProvider) to the current element
The theme data to apply
Force the recreation of the coordinate calculator the next time it is requested Required if the dataSeries has changed on a category axis
Deletes native (WebAssembly) memory used by this type, after which it cannot be used.
Called internally - draws the current axis using the {@link WebGL2RenderingContext}
Called internally - draws the Axis Bands
The {@link WebGL2RenderingContext} used for drawing
An array of tick numeric values
An array of tick coordinates
The {@link SCRTSolidBrush} used to fill the axis band area in our WebGL graphics engine
Called internally - draws the Axis Bands and Gridlines
The {@link WebGL2RenderingContext} used for drawing
The TTickObject contains the major, minor tick numeric values, coordinates and labels for drawing
The {@link SCRTPen} for drawing minor gridlines in our WebGL graphics engine
The {@link SCRTPen} for drawing major gridlines in our WebGL graphics engine
Function to draw axis areas with red color
Called internally - draws the Axis Grid Lines
The {@link WebGL2RenderingContext} used for drawing
An array of tick coordinates
The {@link SCRTPen} used to draw the axis gridlines in our WebGL graphics engine
Creates new CoordinateCalculatorBase instance. Valid for this render-pass only, the coordinate-calculator allows you to transform between pixel and data coordinates (and vice versa)
When true, the axis is valid for drawing
Returns an array of label strings for an array of major tick numeric values
The major tick numeric values
Returns the max size for major/minor ticks. Used in layout and passed to AxisRenderer
(optional) if provided, we use previously calculated XAxis ranges keyed by AxisId rather than calculate them again
Gets the total range on the XAxis required to display all the series zoomed to fit on this axis
When true, the axis has the default AxisCore.visibleRange.
When true, the axis has a valid AxisCore.visibleRange which can be drawn
Tests whether the range passed in is valid
The range
Called internally - measures the axis as part of the layout phase
Called when the AxisBase2D is attached to an SciChartSurface
Called when the AxisBase2D is detached from an SciChartSurface
called internally - allow axis to respond to dpi changes
set an offset value that overrides the one used by layout calculation
Called internally - prepares render data before a draw operation
SET INTERNALLY. Sets whether this axis is an XAxis or not
a pixel coordinate to zoom from
a pixel coordinate to zoom to
The duration of animation in milliseconds. Pass 0 for no animation.
An optional easing function passed to specify animation easing. See TEasingFn for a list of values
Programmatically zooms the axis by a min and max fraction
The Min fraction, e.g. 0.1 will zoom the lower part of the range 10%
The Max fraction, e.g. 0.1 will zoom the upper part of the range 10%
Internal backing property for AxisCore.axisTitleStyle. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.majorGridLineStyle. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.majorTickLineStyle. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.minorGridLineStyle. To fire AxisCore.invalidateParentCallback, set the public property
Internal backing property for AxisCore.minorTickLineStyle. To fire AxisCore.invalidateParentCallback, set the public property
Generated using TypeDoc
The base class for 2D Chart Axis within SciChart - High Performance JavaScript Charts.
AxisBase2D is a base class for both 2D Axis types in SciChart. Concrete types include:
NumericAxis: a Numeric 2D value-axis
CategoryAxis: A category 2D axis used for stock chart applications
Set axis on the SciChartSurface.xAxes or SciChartSurface.yAxes collections in 2D Charts.