Creates an instance of a CategoryAxis
The {@link TSciChart | SciChart 2D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods
Optional parameters of type ICategoryAxisOptions used to configure the axis at instantiation time
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
Gets the AxisRenderer instance responsible for drawing the axis
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
Internal backing property for AxisCore.id. To fire AxisCore.invalidateParentCallback, set the public property
Callback to invalidate the parent 2D SciChartSurface or 3D SciChart3DSurface
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.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
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 {@link TSciChart | SciChart 2D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods
The Default AxisCore.id
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
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
Gets or sets the Axis title string
Gets or sets the Axis title string
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
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 @{link AxisCore.visibleRange | VisibleRange} 0..10 will render from 10 to 0
When true, axis coordinates are flipped, e.g. a NumericAxis with @{link AxisCore.visibleRange | 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
When true, the axis has the default AxisCore.visibleRange.
When true, the axis has a valid AxisCore.visibleRange which can be drawn
Gets or sets the unique Axis Id
Gets or sets the unique Axis Id
Gets whether the axis is flipped or not
Gets whether the axis is currently horizontal or not
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
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 or sets whether this axis is an XAxis or not
SET INTERNALLY. Gets or sets whether this axis is an XAxis or not
Gets or sets a LabelProvider - a class which is responsible for formatting axis labels and cursor labels from numeric values
Gets or sets a LabelProvider - 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 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
Sets and animates the visibleRange of the axis from the current value to the provided value over the duration and with Easing Function provided
the NumberRange which we wish to animate AxisCore.visibleRange to
the duration of the animation in milliseconds
the Easing Function to use. Default value is outCubic
the callback function
Applies a theme (defined by IThemeProvider) to the current element
The theme data to apply
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
Gets the current 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 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
Tests whether the range passed in is valid
The range
Called internally - measures the axis as part of the layout phase
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 TEasing 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
A 2D Chart Category Axis type
A category axis uses the X-index not the X-value to measure data-points on the XAxis. For example this can be used in stock chart applications to ensure weekend or overnight gaps are collapsed and each data-point is spaced equidistantly
Set a CategoryAxis on the SciChartSurface.xAxes property. This axis type is not valid for YAxis