New to Telerik Reporting? Start a free 30-day trial

LogarithmicScale

Class

The LogarithmicScale is similar to the NumericalScale, except there's a logarithmic transform that is applied to the input domain value before the output range value is computed. The mapping to the output range value y can be expressed as a function of the input domain value x: y = m log(x) + b. The LogarithmicScale does not support zero or negative values.

Definition

Namespace:Telerik.Reporting

Assembly:Telerik.Reporting.dll

Syntax:

[AIAssistantDescription("Logarithmic numeric axis scale. Applies y = m·log(x) + b transform. Use when data spans several orders of magnitude. Does not support zero or negative values. Default base is 10.")]
public class LogarithmicScale : NumericalScaleBase

Inheritance: objectScaleNumericalScaleBaseLogarithmicScale

Inherited Members NumericalScaleBase.autoNumericalScaleBase.DataPointTicksScale.GetDefaultCrossAxisPosition(bool)Scale.ToString()Scale.ReversedScale.CrossAxisPositionScale.SpacingSlotCount...

Constructors

LogarithmicScale()

TODO: Add documentation.

public LogarithmicScale()

Properties

Base

double

Gets or sets the base value of the logarithm.

public double Base { get; set; }

CrossAxisPositions

LogarithmicScaleCrossAxisPositionCollection

A collection of LogarithmicScaleCrossAxisPosition items that defines the where the other axes cross the current one.

public LogarithmicScaleCrossAxisPositionCollection CrossAxisPositions { get; }

CrossAxisValue

double

Applied when GraphScaleCrossAxisPosition is set to GraphAxisZeroValueMode.Specific. Zero value is where the other axis crosses the current axis.

[Obsolete("The CrossAxisValue property is now obsolete. Please use the CrossAxisPositions property instead.")]
[Browsable(false)]
public double CrossAxisValue { get; set; }

MajorStep

double

Gets or sets the step/interval for the major ticks/grid lines.

[Browsable(false)]
[Obsolete("The LogarithmicScale.MajorStep property is now obsolete. The LogarithmicScale now determines the major/minor tick steps automatically according to the value of the LogarithmicScale.Base property.")]
public double MajorStep { get; set; }

Maximum

double

Graph axis range - maximum value. Set to float.NaN to automatically calculate the value based on the data.

public override double Maximum { get; set; }

Property Value:

A positive number that indicates the maximum value for the scale.

Overrides: NumericalScaleBase.Maximum

Remarks:

Due to the nature of the logarithmic transformation applied to the scale the Maximum property accepts only positive numbers and throws an error for zero or negative values.

Minimum

double

Axis' minimum value. Set to float.NaN to automatically calculate the value based on the data.

public override double Minimum { get; set; }

Property Value:

A positive number that defines the minimum value for the scale. A NaN value indicates that the scale will automatically calculate its minimum value based on the data. The default value is NaN.

Overrides: NumericalScaleBase.Minimum

Remarks:

Due to the nature of the logarithmic transformation applied to the scale the Minimum property accepts only positive numbers and throws an error for zero or negative values.

MinorStep

double

Gets or sets the step/interval for the minor ticks/grid lines.

[Browsable(false)]
[Obsolete("The LogarithmicScale.MinorStep property is now obsolete. The LogarithmicScale now determines the major/minor tick steps automatically according to the value of the LogarithmicScale.Base property.")]
public double MinorStep { get; set; }