Class NumericalAxis

Class implementation for RangeAxisBase

Inheritance
System.Object
ChartAxis
ChartAxisBase2D
RangeAxisBase
NumericalAxis
Implements
Inherited Members
Namespace: Syncfusion.UI.Xaml.Charts
Assembly: Syncfusion.SfChart.WPF.dll
Syntax
public class NumericalAxis : RangeAxisBase, ICloneable, IRangeAxis

Constructors

NumericalAxis()

Called when instance created for NumericalAxis.

Declaration
public NumericalAxis()

Fields

AxisScaleBreaksProperty

The DependencyProperty for AxisScaleBreaks property.

Declaration
public static readonly DependencyProperty AxisScaleBreaksProperty
Field Value
Type
System.Windows.DependencyProperty

BreakPositionProperty

The DependencyProperty for BreakPosition property.

Declaration
public static readonly DependencyProperty BreakPositionProperty
Field Value
Type
System.Windows.DependencyProperty

IntervalProperty

The DependencyProperty for Interval property.

Declaration
public static readonly DependencyProperty IntervalProperty
Field Value
Type
System.Windows.DependencyProperty

MaximumProperty

The DependencyProperty for Maximum property.

Declaration
public static readonly DependencyProperty MaximumProperty
Field Value
Type
System.Windows.DependencyProperty

MinimumProperty

The DependencyProperty for Minimum property.

Declaration
public static readonly DependencyProperty MinimumProperty
Field Value
Type
System.Windows.DependencyProperty

RangePaddingProperty

The DependencyProperty for RangePadding property.

Declaration
public static readonly DependencyProperty RangePaddingProperty
Field Value
Type
System.Windows.DependencyProperty

StartRangeFromZeroProperty

The DependencyProperty for StartRangeFromZero property.

Declaration
public static readonly DependencyProperty StartRangeFromZeroProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

AxisScaleBreaks

Gets or sets the scale break collection for the axis.

Declaration
public ChartAxisScaleBreaks AxisScaleBreaks { get; set; }
Property Value
Type
ChartAxisScaleBreaks

BreakPosition

Gets or sets the property used to position the breaks.

Declaration
public ScaleBreakPosition BreakPosition { get; set; }
Property Value
Type Description
ScaleBreakPosition

DataCount, Break will be placed based on the data count, Percent, Break will be placed based on the given BreakPercent, Scale, Break will be placed based on the delta of the range

Interval

Gets or sets a value that determines the interval between labels. Its nullable. If this property is not set, interval will be calculated automatically.

Declaration
public double? Interval { get; set; }
Property Value
Type
System.Nullable<System.Double>

Maximum

Gets or sets the maximum value for the axis range. This is nullable property.

Declaration
public double? Maximum { get; set; }
Property Value
Type
System.Nullable<System.Double>
Remarks

If we didn't set the maximum value, it will be calculate from the underlying collection.

Minimum

Gets or sets the minimum value for the axis range. This is nullable property.

Declaration
public double? Minimum { get; set; }
Property Value
Type
System.Nullable<System.Double>
Remarks

If we didn't set the minimum value, it will be calculate from the underlying collection.

RangePadding

Gets or sets the padding used to shift the numeric range inside or outside.

Declaration
public NumericalPadding RangePadding { get; set; }
Property Value
Type Description
NumericalPadding

Additional, to extend the range, Round, to round-off the range, None, do nothing, Auto, auto range based on type of series.

StartRangeFromZero

Gets or sets a value indicating whether to start range from zero when range calculated automatically.

Declaration
public bool StartRangeFromZero { get; set; }
Property Value
Type Description
System.Boolean

True will reset the range starting from zero.

Methods

ApplyRangePadding(DoubleRange, Double)

Apply padding based on interval

Declaration
protected override DoubleRange ApplyRangePadding(DoubleRange range, double interval)
Parameters
Type Name Description
DoubleRange range
System.Double interval
Returns
Type
DoubleRange
Overrides

CalculateActualInterval(DoubleRange, Size)

Calculates actual interval

Declaration
protected override double CalculateActualInterval(DoubleRange range, Size availableSize)
Parameters
Type Name Description
DoubleRange range
System.Windows.Size availableSize
Returns
Type
System.Double
Overrides

CalculateActualRange()

Calculates actual range

Declaration
protected override DoubleRange CalculateActualRange()
Returns
Type
DoubleRange
Overrides

CalculateVisibleRange(Size)

Calculates the visible range.

Declaration
protected override void CalculateVisibleRange(Size avalableSize)
Parameters
Type Name Description
System.Windows.Size avalableSize
Overrides

CloneAxis(DependencyObject)

Declaration
protected override DependencyObject CloneAxis(DependencyObject obj)
Parameters
Type Name Description
System.Windows.DependencyObject obj
Returns
Type
System.Windows.DependencyObject
Overrides

CoefficientToValue(Double)

Declaration
public override double CoefficientToValue(double value)
Parameters
Type Name Description
System.Double value
Returns
Type
System.Double
Overrides

GenerateVisibleLabels()

Method implementation for Generate Labels in ChartAxis

Declaration
protected override void GenerateVisibleLabels()
Overrides

OnIntervalChanged(DependencyPropertyChangedEventArgs)

Called when interval changed

Declaration
protected virtual void OnIntervalChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

OnMaximumChanged(DependencyPropertyChangedEventArgs)

Called when Maximum property changed

Declaration
protected virtual void OnMaximumChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs args

OnMinimumChanged(DependencyPropertyChangedEventArgs)

called when Minimum property changed

Declaration
protected virtual void OnMinimumChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs args

PolarCoefficientToValue(Double)

Converts the PolarCoefficient to the required chart axis value.

Declaration
public override double PolarCoefficientToValue(double value)
Parameters
Type Name Description
System.Double value

The polar coefficient.
Returns
Type Description
System.Double

The chart co-ordinate value.
Overrides

ValueToCoefficient(Double)

Declaration
public override double ValueToCoefficient(double value)
Parameters
Type Name Description
System.Double value
Returns
Type
System.Double
Overrides

ValueToPolarCoefficient(Double)

Converts co-ordinate of point related to chart control to axis units.

Declaration
public override double ValueToPolarCoefficient(double value)
Parameters
Type Name Description
System.Double value

The absolute point value.
Returns
Type Description
System.Double

The value of point on axis.
Overrides

Implements