Axis<TDrawingContext, TTextGeometry, TLineGeometry>
Class

Assembly LiveChartsCore
Namespace LiveChartsCore

Summary:
Defines an Axis in a Cartesian chart.

Type parameters:
TDrawingContext The type of the drawing context.
TTextGeometry The type of the text geometry.
TLineGeometry The type of the line geometry.
Inheritance:
Object =>
ChartElement<TDrawingContext> =>
Axis<TDrawingContext, TTextGeometry, TLineGeometry>
Implements:
IChartElement<TDrawingContext>
ICartesianAxis<TDrawingContext>
IPlane<TDrawingContext>
Derived:

Properties

Gets the data bounds, the min and max values in the axis.
Type: Bounds
Gets the data visible bounds, the min and max visible values in the axis that are currently in the UI.
Type: Bounds
Gets or sets the axis name.
Type: String
Gets or sets the size of the name label.
Type: Double
Gets or sets the padding of the name label.
Type: Padding
Gets or sets the labels alignment, default is null and means that the library will set it based on the Orientation and Position properties.
Type: Nullable<Align>
Gets the orientation.
Type: AxisOrientation
Gets or sets the padding around the tick labels along the axis.
Type: Padding
Gets or sets the labeler, a function that receives a number and return the label content as string.
Type: Func<Double, String>
Gets or sets the minimum step, the step defines the interval between every separator in the axis, LiveCharts will calculate it automatically based on the chart data and the chart size size, if the calculated step is less than the MinStep then MinStep will be used as the axis step, default is 0.
Type: Double
Gets or sets whether the axis should use the MinStep as the actual step of the axis, if true, the library will not calculate the step of the axis automatically, instead it will use the value in the MinStep property. Be careful when setting this property to true, it might cause performance issues if the step is too small for the current data in the chart. Default value is false.
Type: Boolean
Gets or sets the minimum value visible in the axis, any point less than this value will be hidden, set it to null to use a value based on the smaller value in the chart.
Type: Nullable<Double>
Gets or sets the maximum value visible in the axis, any point greater than this value will be hidden, set it null to use a value based on the greater value in the chart.
Type: Nullable<Double>
Gets or sets the unit with, it means the width of every point (if the series requires it) in the chart values scale, this value should normally be 1, unless you are plotting in a custom scale, default is 1.
Type: Double
Gets or sets the axis position.
Type: AxisPosition
Gets or sets the labels rotation in degrees.
Type: Double
Gets or sets the size of the labels.
Type: Double
Gets or sets the labels, if labels are not null, then the axis label will be pulled from the labels collection, the label is mapped to the chart based on the position of the label and the position of the point, both integers, if the axis requires a label outside the bounds of the labels collection, then the index will be returned as the label. Default value is null.
Type: IList<String>
Gets or sets a value indicating whether the separator lines are visible.
Type: Boolean
Gets or sets the custom separators array, when this property is set (not null) the axis will use the values in this array instead of calculating the separators automatically. Defalut is null.
Type: IEnumerable<Double>
Gets or sets a value indicating whether this instance is visible.
Type: Boolean
Gets or sets a value indicating whether the axis is inverted based on the Cartesian coordinate system.
Type: Boolean
Gets or sets a value indicating whether the separators are centered to the UnitWidth, default is true.
Type: Boolean
Gets or sets a value indicating whether the ticks are centered to the UnitWidth, default is true.
Type: Boolean
Gets or sets the name paint.
Type: IPaint<TDrawingContext>
Gets or sets the text paint.
Type: IPaint<TDrawingContext>
Gets or sets the separators paint.
Type: IPaint<TDrawingContext>
Gets or sets the sub-separators paint.
Type: IPaint<TDrawingContext>
Gets or sets the number of subseparators to draw.
Type: Int32
Gets or sets whether the ticks path should be drawn.
Type: Boolean
Gets or sets the separators paint.
Type: IPaint<TDrawingContext>
Gets or sets the separators paint.
Type: IPaint<TDrawingContext>
Gets or sets the zero paint.
Type: IPaint<TDrawingContext>
Gets or sets the crosshair paint.
Type: IPaint<TDrawingContext>
Gets or sets the crosshair labels paint.
Type: IPaint<TDrawingContext>
Gets or sets the crosshair background.
Type: Nullable<LvcColor>
Gets or sets the crosshair labels padding.
Type: Padding
Gets or sets whether the crosshair snaps to nearest series.
Type: Boolean

Type: IPaint<TDrawingContext>

Type: IPaint<TDrawingContext>
Gets or sets the animations speed, if this property is null, the AnimationsSpeed property will be used.
Type: Nullable<TimeSpan>
Gets or sets the easing function to animate the series, if this property is null, the EasingFunction property will be used.
Type: Func<Single, Single>
Gets or sets the min zoom delta, the minimum difference between the max and min visible limits of the axis. default is null and null means that the library will calculate this value based on the current data.
Type: Nullable<Double>
Gets or sets the min zoom delta, the minimum difference between the max and min visible limits of the axis. default is null and null means that the library will calculate this value based on the current data.
Type: Boolean
Tag
Gets or sets the object that contains data about the control.
Type: Object

Events

Occurs when the axis is initialized.
Handler definition: Action<ICartesianAxis>
Occurs when a property value changes.
Handler definition: PropertyChangedEventHandler

Methods

// Invalidates the IChartElement`1 in the user interface.
Chart<TDrawingContext> chart// The chart.
)
// Invalidates the crosshair visual.
Chart<TDrawingContext> chart, // The chart.
LvcPoint pointerPosition// The pointer position
)
// Gets the size of the axis name label.
Chart<TDrawingContext> chart// the chart.
)
// Gets the size of the possible.
Chart<TDrawingContext> chart// The chart.
)
// Deletes the specified chart.
Chart<TDrawingContext> chart// The chart.
)
// Removes the element from the UI.
Chart<TDrawingContext> chart// The chart.
)
// Deletes the IPaint`1 instances that changed from the user interface.
IChartView<TDrawingContext> chart// The chart.
)