Class ChartAxis

Enables plotting of data points in a chart control.

Inheritance

System.Object

ChartAxis

ChartAxisBase2D

Namespace: Syncfusion.UI.Xaml.Charts

Assembly: Syncfusion.Chart.WinUI.dll

Syntax

public abstract class ChartAxis : Control

Remarks

The Chart requires a minimum of two axes namely primary axis and secondary axis to plot data points. Values / data in the chart are plotted against these two axes. Chart WINRT also supports adding multiple axes to the chart and the series can be drawn with reference to any x-axis,y-axis added to ChartBase

Examples

    <syncfusion:SfChart>
          <syncfusion:SfChart.PrimaryAxis>
                <syncfusion:ChartAxis/>
          </syncfusion:SfChart.PrimaryAxis>
          <syncfusion:SfChart.SecondaryAxis >
                <syncfusion:ChartAxis/>                      
          </syncfusion:SfChart.SecondaryAxis>
    </syncfusion:SfChart >

    ChartAxis xAxis = new ChartAxis();
        chartArea.PrimaryAxis = xAxis;
    ChartAxis yAxis = new ChartAxis();
        chartArea.SecondaryAxis = yAxis;

Constructors

ChartAxis()

Called when instance created for ChartAxis

Declaration

public ChartAxis()

Fields

AxisLineOffsetProperty

The DependencyProperty for AxisLineOffset property.

Declaration

public static readonly DependencyProperty AxisLineOffsetProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

AxisLineStyleProperty

The DependencyProperty for AxisLineStyle property.

Declaration

public static readonly DependencyProperty AxisLineStyleProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

ContentPathProperty

The DependencyProperty for ContentPath property.

Declaration

public static readonly DependencyProperty ContentPathProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

CrosshairLabelTemplateProperty

The DependencyProperty for CrosshairLabelTemplate property.

Declaration

public static readonly DependencyProperty CrosshairLabelTemplateProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

DesiredIntervalsCountProperty

The DependencyProperty for DesiredIntervalsCount property.

Declaration

public static readonly DependencyProperty DesiredIntervalsCountProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

EdgeLabelsDrawingModeProperty

The DependencyProperty for EdgeLabelsDrawingMode property.

Declaration

public static readonly DependencyProperty EdgeLabelsDrawingModeProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

EdgeLabelsVisibilityModeProperty

The DependencyProperty for EdgeLabelsVisibilityMode property.

Declaration

public static readonly DependencyProperty EdgeLabelsVisibilityModeProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

EnableAutoIntervalOnZoomingProperty

The DependencyProperty for EnableAutoIntervalOnZooming property.

Declaration

public static readonly DependencyProperty EnableAutoIntervalOnZoomingProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

HeaderProperty

The DependencyProperty for Header property.

Declaration

public static readonly DependencyProperty HeaderProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

HeaderStyleProperty

The DependencyProperty for HeaderStyle property.

Declaration

public static readonly DependencyProperty HeaderStyleProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

HeaderTemplateProperty

The DependencyProperty for HeaderTemplate property.

Declaration

public static readonly DependencyProperty HeaderTemplateProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

IsInversedProperty

The DependencyProperty for IsInversed property.

Declaration

public static readonly DependencyProperty IsInversedProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

LabelExtentProperty

The DependencyProperty for LabelExtent property.

Declaration

public static readonly DependencyProperty LabelExtentProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

LabelFormatProperty

The DependencyProperty for LabelFormat property.

Declaration

public static readonly DependencyProperty LabelFormatProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

LabelIntersectActionProperty

The DependencyProperty for LabelIntersectAction property.

Declaration

public static readonly DependencyProperty LabelIntersectActionProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

LabelPositionProperty

The DependencyProperty for LabelPosition property.

Declaration

public static readonly DependencyProperty LabelPositionProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

LabelRotationAngleProperty

The DependencyProperty for LabelRotationAngle property.

Declaration

public static readonly DependencyProperty LabelRotationAngleProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

LabelSourceProperty

The DependencyProperty for LabelSource property.

Declaration

public static readonly DependencyProperty LabelSourceProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

LabelStyleProperty

The DependencyProperty for LabelStyle property.

Declaration

public static readonly DependencyProperty LabelStyleProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

LabelTemplateProperty

The DependencyProperty for LabelTemplate property.

Declaration

public static readonly DependencyProperty LabelTemplateProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

MajorGridLineStyleProperty

The DependencyProperty for MajorGridLineStyle property.

Declaration

public static readonly DependencyProperty MajorGridLineStyleProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

MajorTickLineStyleProperty

The DependencyProperty for MajorTickLineStyle property.

Declaration

public static readonly DependencyProperty MajorTickLineStyleProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

MaximumLabelsProperty

The DependencyProperty for MaximumLabels property.

Declaration

public static readonly DependencyProperty MaximumLabelsProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

MaxPixelsCount

MaxPixelsCount variable declarations

Declaration

protected double MaxPixelsCount

Field Value

Type	Description
System.Double

MinorGridLineStyleProperty

The DependencyProperty for MinorGridLineStyle property.

Declaration

public static readonly DependencyProperty MinorGridLineStyleProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

MinorTickLineStyleProperty

The DependencyProperty for MinorTickLineStyle property.

Declaration

public static readonly DependencyProperty MinorTickLineStyleProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

OpposedPositionProperty

The DependencyProperty for OpposedPosition property.

Declaration

public static readonly DependencyProperty OpposedPositionProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

PlotOffsetEndProperty

The DependencyProperty for PlotOffsetEnd property.

Declaration

public static readonly DependencyProperty PlotOffsetEndProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

PlotOffsetProperty

The DependencyProperty for PlotOffset property.

Declaration

public static readonly DependencyProperty PlotOffsetProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

PlotOffsetStartProperty

The DependencyProperty for PlotOffsetStart property.

Declaration

public static readonly DependencyProperty PlotOffsetStartProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

ShowGridLinesProperty

The DependencyProperty for ShowGridLines property.

Declaration

public static readonly DependencyProperty ShowGridLinesProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

ShowTrackballInfoProperty

The DependencyProperty for ShowTrackballInfo property.

Declaration

public static readonly DependencyProperty ShowTrackballInfoProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

TickLineSizeProperty

The DependencyProperty for TickLineSize property.

Declaration

public static readonly DependencyProperty TickLineSizeProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

TickLinesPositionProperty

The DependencyProperty for TickLinesPosition property.

Declaration

public static readonly DependencyProperty TickLinesPositionProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

TrackballLabelTemplateProperty

The DependencyProperty for TrackballLabelTemplate property.

Declaration

public static readonly DependencyProperty TrackballLabelTemplateProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty

Properties

ActualPlotOffset

Gets or sets the plot offset value

Declaration

public double ActualPlotOffset { get; }

Property Value

Type	Description
System.Double

ArrangeRect

Gets the bounds of the chart axis size.

Declaration

public Rect ArrangeRect { get; }

Property Value

Type	Description
Windows.Foundation.Rect

AxisLineOffset

Gets or sets the offset value for applying padding to the axis line.

Declaration

public double AxisLineOffset { get; set; }

Property Value

Type	Description
System.Double

AxisLineStyle

Gets or sets the options for customizing for the axis line.

Declaration

public Style AxisLineStyle { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Style

ContentPath

Gets or sets the property path to be bind with axis label content(text).

Declaration

public string ContentPath { get; set; }

Property Value

Type	Description
System.String

Remarks

While using custom label source, the label text will get from this property.

CrosshairLabelTemplate

Gets or sets the custom template for the Crosshair labels.

Declaration

public DataTemplate CrosshairLabelTemplate { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.DataTemplate	Microsoft.UI.Xaml.DataTemplate

Examples

    <syncfusion:SfChart.PrimaryAxis>
        <syncfusion:ChartAxis CrosshairLabelTemplate="{StaticResource crossHairTemplateX}"/>
    </syncfusion:SfChart.PrimaryAxis>
    <syncfusion:SfChart.SecondaryAxis>
        <syncfusion:ChartAxis CrosshairLabelTemplate="{StaticResource crossHairTemplateY}"/>
    </syncfusion:SfChart.SecondaryAxis>

    primaryAxis.ShowTrackballInfo = true;
    primaryAxis.CrosshairLabelTemplate = dataTemplateX;
    secondaryAxis.ShowTrackballInfo= true;
    secondaryAxis.CrosshairLabelTemplate = dataTemplateY;

CustomLabels

Gets the axis custom labels collection.

Declaration

public ChartAxisLabelCollection CustomLabels { get; }

Property Value

Type	Description
ChartAxisLabelCollection

DesiredIntervalsCount

Gets or sets the interval for the axis auto range calculation, if axis Interval is not set explicitly.

Declaration

public object DesiredIntervalsCount { get; set; }

Property Value

Type	Description
System.Object

EdgeLabelsDrawingMode

Gets or sets mode which decides the mechanism for extreme(edge) labels. It can be position center, hide, etc.

Declaration

public EdgeLabelsDrawingMode EdgeLabelsDrawingMode { get; set; }

Property Value

Type	Description
EdgeLabelsDrawingMode	EdgeLabelsDrawingMode

EdgeLabelsVisibilityMode

Gets or sets the edge labels visibility mode for hiding the edge labels on zooming.

Declaration

public EdgeLabelsVisibilityMode EdgeLabelsVisibilityMode { get; set; }

Property Value

Type	Description
EdgeLabelsVisibilityMode

EnableAutoIntervalOnZooming

GGets or sets the value that indicates whether to calculate the axis intervals on zooming.

Declaration

public bool EnableAutoIntervalOnZooming { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

While zooming, the range and interval will change with respect to zoom position or zoom factor

Header

Gets or sets the header for the chart axis.

Declaration

public object Header { get; set; }

Property Value

Type	Description
System.Object

HeaderStyle

Gets or sets the style for the chart axis header.

Declaration

public LabelStyle HeaderStyle { get; set; }

Property Value

Type	Description
LabelStyle	LabelStyle

HeaderTemplate

Gets or sets the custom template for the chart header.

Declaration

public DataTemplate HeaderTemplate { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.DataTemplate	Microsoft.UI.Xaml.DataTemplate

IsInversed

Gets or sets the value that indicates whether the axis visible range is inversed. When reversed, the axis will render points from right to left if horizontal, top to bottom when vertical and clockwise if radial.

Declaration

public bool IsInversed { get; set; }

Property Value

Type	Description
System.Boolean

IsLogarithmic

Gets or sets IsLogarithmic property

Declaration

public bool IsLogarithmic { get; }

Property Value

Type	Description
System.Boolean

LabelExtent

Gets or sets the value that determines the distance between the axis label and axis title.

Declaration

public double LabelExtent { get; set; }

Property Value

Type	Description
System.Double

LabelFormat

Gets or sets the label formatting for the axis labels.

Declaration

public string LabelFormat { get; set; }

Property Value

Type	Description
System.String

LabelIntersectAction

Gets or sets a value which decides the mechanism to avoid the axis labels overlapping. The overlapping labels can be hided, rotated or placed on next row.

Declaration

public AxisLabelIntersectAction LabelIntersectAction { get; set; }

Property Value

Type	Description
AxisLabelIntersectAction	AxisLabelIntersectAction

LabelPosition

Gets or sets the position for the axis labels. Either inside or outside of the plot area.

Declaration

public AxisElementPosition LabelPosition { get; set; }

Property Value

Type	Description
AxisElementPosition	AxisElementPosition

LabelRotationAngle

Gets or sets the rotation angle of the axis labels.

Declaration

public double LabelRotationAngle { get; set; }

Property Value

Type	Description
System.Double

Remarks

The default value is 0 and the label will be rotated with center as origin.

LabelSource

Gets or sets the custom labels collection to be displayed in axis .

Declaration

public object LabelSource { get; set; }

Property Value

Type	Description
System.Object

LabelStyle

Gets or sets the options for customizing the axis labels.

Declaration

public LabelStyle LabelStyle { get; set; }

Property Value

Type	Description
LabelStyle

LabelTemplate

Gets or sets the custom template for the axis labels.

Declaration

public DataTemplate LabelTemplate { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.DataTemplate	Microsoft.UI.Xaml.DataTemplate

MajorGridLineStyle

Gets or sets the style for the major grid lines.

Declaration

public Style MajorGridLineStyle { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Style

MajorTickLineStyle

Gets or sets the style for the major tick line style.

Declaration

public Style MajorTickLineStyle { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Style

MaximumLabels

Gets or sets the maximum no of label to be displayed per 100 pixels.

Declaration

public int MaximumLabels { get; set; }

Property Value

Type	Description
System.Int32

Remarks

This property used to avoid more no of labels on auto range calculation.

MinorGridLineStyle

Gets or sets the style for the minor grid lines.

Declaration

public Style MinorGridLineStyle { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Style

MinorTickLineStyle

Gets or sets the style for the minor tick line style.

Declaration

public Style MinorTickLineStyle { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Style

OpposedPosition

Gets or sets a value indicating whether to enable the axis to position opposite to its actual position. That is, to the other side of plot area.

Declaration

public bool OpposedPosition { get; set; }

Property Value

Type	Description
System.Boolean

PlotOffset

Gets or sets the offset value for applying the padding to the plot area.

Declaration

public double PlotOffset { get; set; }

Property Value

Type	Description
System.Double

PlotOffsetEnd

Gets or sets the value that used to offset the rendering of the axis at end position.

Declaration

public double PlotOffsetEnd { get; set; }

Property Value

Type	Description
System.Double	The default value is 0.

Remarks

PlotOffsetEnd applies padding at end of plot area where the axis and its elements are rendered in chart with padding at end. PlotOffsetEnd is not applicable for polar and radar chart series. If the values set to both PlotOffset and PlotOffsetEnd, then PlotOffset takes highest precedence.

See Also

PlotOffset

PlotOffsetStart

PlotOffsetStart

Gets or sets the value that used to offset the rendering of the axis at start position.

Declaration

public double PlotOffsetStart { get; set; }

Property Value

Type	Description
System.Double	The default value is 0.

Remarks

PlotOffsetStart applies padding at start of plot area where the axis and its elements are rendered in chart with padding at start. PlotOffsetStart is not applicable for polar and radar chart series. If the values set to both PlotOffset and PlotOffsetStart, then PlotOffset takes highest precedence.

See Also

PlotOffset

PlotOffsetEnd

ShowGridLines

Gets or sets a value indicating whether the axis gird lines can be display or not.

Declaration

public bool ShowGridLines { get; set; }

Property Value

Type	Description
System.Boolean

ShowTrackballInfo

Gets or sets the value that indicates whether to show the axis information, when the trackball is shown.

Declaration

public bool ShowTrackballInfo { get; set; }

Property Value

Type	Description
System.Boolean

TickLineSize

Gets or sets the size for the axis tick lines.

Declaration

public double TickLineSize { get; set; }

Property Value

Type	Description
System.Double

Remarks

The default value is 8.

TickLinesPosition

Gets or sets a value indicating whether the tick line position, either inside or outside.

Declaration

public AxisElementPosition TickLinesPosition { get; set; }

Property Value

Type	Description
AxisElementPosition

TrackballLabelTemplate

Gets or sets the custom template for the trackball tooltip label.

Declaration

public DataTemplate TrackballLabelTemplate { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.DataTemplate	Microsoft.UI.Xaml.DataTemplate

VisibleLabels

Gets the collection of axis labels in the visible region.

Declaration

public ObservableCollection<ChartAxisLabel> VisibleLabels { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<ChartAxisLabel>

VisibleRange

Gets the visible range of the axis.

Declaration

public DoubleRange VisibleRange { get; protected set; }

Property Value

Type	Description
DoubleRange

Methods

AddSmallTicksPoint(Double)

Method implementation for Add SamllTicksPoint

Declaration

protected virtual void AddSmallTicksPoint(double position)

Parameters

Type	Name	Description
System.Double	position

AddSmallTicksPoint(Double, Double)

Method implementation for Add smallTicks to axis

Declaration

protected virtual void AddSmallTicksPoint(double position, double interval)

Parameters

Type	Name	Description
System.Double	position
System.Double	interval

ApplyRangePadding(DoubleRange, Double)

Apply padding based on interval

Declaration

protected virtual DoubleRange ApplyRangePadding(DoubleRange range, double interval)

Parameters

Type	Name	Description
DoubleRange	range
System.Double	interval

Returns

Type	Description
DoubleRange

CalculateActualInterval(DoubleRange, Size)

Calculates actual interval

Declaration

protected virtual double CalculateActualInterval(DoubleRange range, Size availableSize)

Parameters

Type	Name	Description
DoubleRange	range
Windows.Foundation.Size	availableSize

Returns

Type	Description
System.Double

CalculateActualRange()

Calculates actual range

Declaration

protected virtual DoubleRange CalculateActualRange()

Returns

Type	Description
DoubleRange

CalculateNiceInterval(DoubleRange, Size)

Calculates nice interval

Declaration

protected virtual double CalculateNiceInterval(DoubleRange actualRange, Size availableSize)

Parameters

Type	Name	Description
DoubleRange	actualRange
Windows.Foundation.Size	availableSize

Returns

Type	Description
System.Double

CalculateVisibleRange(Size)

Calculates the visible range.

Declaration

protected virtual void CalculateVisibleRange(Size availableSize)

Parameters

Type	Name	Description
Windows.Foundation.Size	availableSize

GenerateVisibleLabels()

Method implementation for Generate Labels in ChartAxis

Declaration

protected virtual void GenerateVisibleLabels()

GetActualDesiredIntervalsCount(Size)

Returns the maximum desired intervals count.

Declaration

protected double GetActualDesiredIntervalsCount(Size availableSize)

Parameters

Type	Name	Description
Windows.Foundation.Size	availableSize

Returns

Type	Description
System.Double

GetArrangeRect()

Gets the rect co-ordinates of an axis excluding its value of LabelOffset and AxisLineOffset.

Declaration

public Rect GetArrangeRect()

Returns

Type	Description
Windows.Foundation.Rect	returns rect

GetRenderedRect()

Gets the actual rect co-ordinates of an ChartAxis.

Declaration

public Rect GetRenderedRect()

Returns

Type	Description
Windows.Foundation.Rect	returns rect

MeasureOverride(Size)

Provides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior.

Declaration

protected override Size MeasureOverride(Size availableSize)

Parameters

Type	Name	Description
Windows.Foundation.Size	availableSize

Returns

Type	Description
Windows.Foundation.Size	The size that this object determines it needs during layout, based on its calculations of the allocated sizes for child objects; or based on other considerations, such as a fixed container size.

OnAxisBoundsChanged(ChartAxisBoundsEventArgs)

Event invokes when axis bounds changed.

Declaration

protected virtual void OnAxisBoundsChanged(ChartAxisBoundsEventArgs args)

Parameters

Type	Name	Description
ChartAxisBoundsEventArgs	args	Which indicates ChartAxisBoundsEventArgs

OnAxisVisibleRangeChanged(VisibleRangeChangedEventArgs)

Event invokes when axis VisibleRange is changed.

Declaration

protected virtual void OnAxisVisibleRangeChanged(VisibleRangeChangedEventArgs args)

Parameters

Type	Name	Description
VisibleRangeChangedEventArgs	args	Which indicates VisibleRangeChangedEventArgs

OnPropertyChanged()

Event correspond to property value changed. It invokes when the ChartAxis properties changed.

Declaration

protected virtual void OnPropertyChanged()

OnRegisteredSeriesCollectionChanged(Object, NotifyCollectionChangedEventArgs)

Occurs when axis registered series collection changed.

Declaration

protected virtual void OnRegisteredSeriesCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.Collections.Specialized.NotifyCollectionChangedEventArgs	e

Events

ActualRangeChanged

Occurs when [actual range changed].

Declaration

public event EventHandler<ActualRangeChangedEventArgs> ActualRangeChanged

Event Type

Type	Description
System.EventHandler<ActualRangeChangedEventArgs>

AxisBoundsChanged

Occurs when axis plot area size changed.

Declaration

public event EventHandler<ChartAxisBoundsEventArgs> AxisBoundsChanged

Event Type

Type	Description
System.EventHandler<ChartAxisBoundsEventArgs>

LabelCreated

Occurs when the labels is created.

Declaration

public event EventHandler<LabelCreatedEventArgs> LabelCreated

Event Type

Type	Description
System.EventHandler<LabelCreatedEventArgs>