IAxis Interface Members
The following tables list the members exposed by IAxis.
Public Properties
| Name | Description | |
|---|---|---|
 | ActualHeight | Gets the height of the SciChart.Core.Framework.IHitTestable (Inherited from SciChart.Core.Framework.IHitTestable) |
| ActualWidth | Gets the width of the SciChart.Core.Framework.IHitTestable (Inherited from SciChart.Core.Framework.IHitTestable) |
| AllowFastMath | Gets or sets whether it's allowed to use fast math when rendering axis. This enables using faster but less precise calculations in some cases. Due to lower precision this may cause issues with very large or very small values. Be especially careful when applying this to ever-growing charts (for example, when your X axis value grows over time unconstrained) as this may cause artifacts to appear only after hours (or days) of runtime. |
| AnimatedVisibleRange | Gets or sets the animated VisibleRange of the Axis. When this property is set, the axis animates the VisibleRange to the new value (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| AutoRange | Gets or sets whether this current axis IAxisCore.AutoRange. Default is AutoRange.Once (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| AutoTicks | Gets or sets value, that indicates whether calculate ticks automatically. Default is True. (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| AxisAlignment | Gets or sets the AxisAlignment for this Axis. Default is Right. |
| AxisBandsFill | Gets or sets the Fill of the Axis Bands. Also see IAxisCore.DrawMajorBands to enable this behaviour (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| AxisTitle | Gets or sets the Axis Title (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| CursorTextFormatting | Gets or sets the Text Formatting String for Labels on this cursor (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| DataContext | Gets or sets the binding DataContext on the Axis |
| DataRange | Gets the DataRange (full extents of the data) of the Axis |
| DrawLabels | If True, draw labels for each major tick on the Axis, else skips this step (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| DrawMajorBands | If True, draws Major Axis Bands (a filled area between major gridlines), else skips this step (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| DrawMajorGridLines | If True, draws Major Grid Lines, else skips this step (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| DrawMajorTicks | If True, draws Major Tick Lines, else skips this step (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| DrawMinorGridLines | If True, draws Minor Grid Lines, else skips this step (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| DrawMinorTicks | If True, draws Minor Tick Lines, else skips this step (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| FlipCoordinates | Gets or sets a flag indicating whether to flip the tick and pixel coordinate generation for this axis, causing the axis ticks to decrement and chart to be flipped in the axis direction (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| GrowBy | Gets or sets the GrowBy Factor. e.g. GrowBy(0.1, 0.2) will increase the axis extents by 10% (min) and 20% (max) outside of the data range (Inherited from SciChart.Charting.Visuals.Axes.IAxisParams) |
| HasDefaultVisibleRange | Gets whether the VisibleRange has default value (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| HasValidVisibleRange | Gets whether the VisibleRange is valid, e.g. is not null, is not NaN and the difference between Max and Min is not zero (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| Height | Gets or sets the height of the SciChart.Charting.Visuals.IDrawable in pixels (Inherited from SciChart.Charting.Visuals.IDrawable) |
| HorizontalAlignment | Gets or sets the horizontal alignment characteristics that are applied to a System.Windows.FrameworkElement when it is composed in a layout parent, such as a panel or items control. |
| Id | Gets or sets the string Id of this axis. Used to associated SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries and SciChart.Charting.ChartModifiers.YAxisDragModifier (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| IsAxisFlipped | Gets whether the current axis is flipped (e.g. YAxis on the bottom or top, or XAxis on the left or right) |
| IsCategoryAxis | Gets a value indicating whether this instance is a category axis. |
| IsCenterAxis | Gets or sets whether current Axis should placed in the center of chart or not |
| IsHorizontalAxis | Gets whether this axis is horizontal or not |
| IsLabelCullingEnabled | Gets or sets a value indicating whether Label Culling is enabled (when labels overlap) on this AxisPanel instance |
| IsLogarithmicAxis | Gets a value indicating whether this instance is a logarithmic axis. (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| IsPolarAxis | Gets a value indicating whether this instance is a polar axis. |
| IsPrimaryAxis | Gets or sets whether current Axis is the main one in axis collection. This is the axis which is responsible for drawing grid lines on the GridLinesPanel and by default, is the first axis in the collection |
| IsStaticAxis | Gets or sets whether current Axis is a static axis |
| IsSuspended | Gets a value indicating whether updates for the target are currently suspended (Inherited from SciChart.Core.Framework.ISuspendable) |
| IsXAxis | Gets whether this axis is an X-Axis or not (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| LabelProvider | Gets or sets a SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider instance, which may be used to programmatically override the formatting of text and cursor labels. For examples, see the SciChart.Charting.Visuals.Axes.LabelProviders.NumericLabelProvider and SciChart.Charting.Visuals.Axes.LabelProviders.TradeChartAxisLabelProvider |
| MajorDelta | Gets or sets the Major Delta (Inherited from SciChart.Charting.Visuals.Axes.IAxisParams) |
| MajorGridLineStyle | Gets or sets the Major Grid Line Style (TargetType System.Windows.Shapes.Line), applied to all major gridlines drawn by this axis (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| MajorTickLineStyle | Gets or sets the Major Tick Line Style (TargetType System.Windows.Shapes.Line), applied to all major ticks on this axis (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| MaxAutoTicks | Gets or sets the max ticks. (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| MinimalZoomConstrain | Gets or sets the MinimalZoomConstrain of the Axis. This is used to set minimum distance between Min and Max of the VisibleRange (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| MinorDelta | Gets or sets the Minor Delta (Inherited from SciChart.Charting.Visuals.Axes.IAxisParams) |
| MinorGridLineStyle | Gets or sets the Minor Grid Line Style (TargetType System.Windows.Shapes.Line), applied to all minor gridlines drawn by this axis (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| MinorsPerMajor | Gets or sets the number of Minor Delta ticks per Major Tick (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| MinorTickLineStyle | Gets or sets the Minor Tick Line Style (TargetType System.Windows.Shapes.Line), applied to all major ticks on this axis (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| ModifierAxisCanvas | Gets the modifier axis canvas, which is used by the CursorModifier to overlay cursor labels and by AxisMarkerAnnotations |
| Orientation | Gets or sets the Axis Orientation, e.g. Horizontal (XAxis) or Vertical (YAxis) |
| ParentSurface | Gets or sets the ParentSurface that this Axis is associated with |
| Services | Gets the SciChart.Core.Utility.ServiceContainer which provides access to services throughout SciChart. ServiceContainers are created one per SciChart.Charting.Visuals.SciChartSurface instance and shared between various scichart components throughout the surface instance. (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| TextFormatting | Gets or sets the Text Formatting String for Tick Labels on this axis (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| TickLabelStyle | Gets or sets a style for the labels on this Axis. (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| TickProvider | Gets or sets a SciChart.Charting.Numerics.TickProviders.ITickProvider instance on current axis, which is used to compute the data-values of Axis Gridlines, Ticks and Labels. (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| TickTextBrush | Gets or sets the tick text brush applied to text labels |
| TitleStyle | Gets or sets the Style of the Axis Title (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| VerticalAlignment | Gets or sets the vertical alignment characteristics that are applied to a System.Windows.FrameworkElement when it is composed in a parent object such as a panel or items control. |
| Visibility | Gets or sets the visibility of the Axis |
| VisibleRange | Gets or sets the VisibleRange of the Axis. In the case of XAxis, this will cause an align to X-Axis operation to take place (Inherited from SciChart.Charting.Visuals.Axes.IAxisParams) |
| VisibleRangeLimit | Gets or sets the VisibleRangeLimit of the Axis. This will be used to clip the axis during ZoomExtents and AutoRange operations |
| VisibleRangeLimitMode | Gets or setts the VisibleRangeLimitMode of the Axis. This property defines which parts of VisibleRangeLimit will be used by axis |
| Width | Gets or sets the width of the SciChart.Charting.Visuals.IDrawable in pixels (Inherited from SciChart.Charting.Visuals.IDrawable) |
Public Methods
| Name | Description | |
|---|---|---|
 | AnimateVisibleRangeTo | Animates the visible range of the axis to the destination VisibleRange, over the specified Duration. Also see AxisCore.AnimatedVisibleRange property which has a default duration of 500ms (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| AssertDataType | Asserts the type passed in is supported by the current axis implementation |
| CacheModifersAxisLabel | Caches axis label in corresopngin axis |
| CalculateYRange | Gets the aligned VisibleRange of the axis. |
| CaptureMouse | Captures the mouse for this Axis |
| Clear | Clears the axis of tick-marks and labels |
| Clone | Clones this instance. |
| DecrementSuspend | Called by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called (Inherited from SciChart.Core.Framework.ISuspendable) |
| DrawGridLinesAndBands | Called to draw grid lines on main chart area |
| FormatCursorText | String formats text for the cursor, using the AxisCore.CursorTextFormatting property as a formatting string |
| FormatText | String formats the text, using the AxisCore.TextFormatting property as a formatting string |
| GetAxisOffset | Returns the offset of the Axis (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| GetAxisSize | Gets the size of the axis in the Viewport (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| GetBoundsRelativeTo | Gets the bounds of the current SciChart.Core.Framework.IHitTestable element relative to another SciChart.Core.Framework.IHitTestable element (Inherited from SciChart.Core.Framework.IHitTestable) |
| GetCoordinate | Given the Data Value, returns the x or y pixel coordinate at that value on the Axis (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| GetCurrentCoordinateCalculator | Gets the current SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator<T> for this Axis, based on current Visible Range and axis type (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| GetCurrentInteractivityHelper | Gets the current IAxisInteractivityHelper for this Axis |
| GetDataValue | Given the x or y pixel coordinate, returns the data value at that coordinate (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| GetDefaultNonZeroRange | Returns an default non zero SciChart.Data.Model.IRange, called internally by SciChart to reset the VisibleRange of an axis to an undefined state |
| GetMaximumRange | Gets the maximum range of the axis, based on the data-range of all series (Inherited from SciChart.Charting.Visuals.Axes.IAxisParams) |
| GetModifersAxisLabel | Returns the axis label for corresponding modifier to place it on axis |
| GetModifersAxisLabelStyle | Returns the axis label style for corresponding modifier |
| GetModifersAxisLabelTempalte | Returns the axis label template for corresponding modifier |
| GetUndefinedRange | Returns an undefined SciChart.Data.Model.IRange, called internally by SciChart to reset the VisibleRange of an axis to an undefined state |
| GetWindowedYRange | Called by the SciCharXtSurface internally. Returns the max range only for that axis (by the data-series on it), based on xRanges "windowed" = "displayed in current viewport" uses GrowBy() |
| HitTest | Performs a HitTest on this axis. Given the input mouse point, returns an AxisInfo struct containing the Value and FormattedValue closest to that point |
| InvalidateElement | Asynchronously requests that the element redraws itself plus children. Will be ignored if the element is ISuspendable and currently IsSuspended (within a SuspendUpdates/ResumeUpdates call) (Inherited from SciChart.Core.Framework.IInvalidatableElement) |
| IsPointWithinBounds | Returns true if the Point is within the bounds of the current SciChart.Core.Framework.IHitTestable element (Inherited from SciChart.Core.Framework.IHitTestable) |
| IsValidRange | Checks whether range is valid visible range for this axis (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| OnBeginRenderPass | Called internally immediately before a render pass begins |
| OnDraw | Called when the instance is drawn (Inherited from SciChart.Charting.Visuals.IDrawable) |
| ReleaseMouseCapture | Releases the mouse for this Axis |
| ResumeUpdates | Resumes updates on the target, intended to be called by IUpdateSuspender (Inherited from SciChart.Core.Framework.ISuspendable) |
| Scroll | Overloaded. Scrolls current IAxisParams.VisibleRange by the specified number of pixels |
| ScrollByDataPoints | Overloaded. Translates current IAxisParams.VisibleRange by the specified number of datapoints |
| ScrollTo | From the starting SciChart.Data.Model.IRange, scrolls to a new range by the specified number of pixels |
| ScrollToWithLimit | From the starting SciChart.Data.Model.IRange, scrolls to a new range by the specified number of pixels, with the specified range limit |
| SetMouseCursor | Sets the cursor for this Axis |
| SuspendUpdates | Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued (Inherited from SciChart.Core.Framework.ISuspendable) |
| TranslatePoint | Translates the point relative to the other SciChart.Core.Framework.IHitTestable element (Inherited from SciChart.Core.Framework.IHitTestable) |
| ValidateAxis | Called by the SciChart.Charting.Visuals.SciChartSurfaceBase internally to validate current axis during render pass (Inherited from SciChart.Charting.Visuals.Axes.IAxisCore) |
| Zoom | Overloaded. Performs zoom on current IAxis, using fromCoord as a coordinate of new range start and toCoord as a coordinate of new range end |
| ZoomBy | Overloaded. Performs zoom on current IAxis, using minFraction as a multiplier of range start and maxFraction as a multiplier of range end |
Public Events
| Name | Description | |
|---|---|---|
 | DataRangeChanged | Raised when data range is changed |
| VisibleRangeChanged | Raised when the VisibleRange is changed |
See Also