Class ChartAxis

Base chart axis class

Inheritance
System.Object
StateManagedObject
RenderedObject
ChartAxis
ChartXAxis
ChartYAxis
Inherited Members
Namespace: Telerik.Reporting.Charting
Assembly: Telerik.Reporting.dll

Syntax

public abstract class ChartAxis : RenderedObject, IChartingStateManagedItem, IChartingStateManager, IDisposable, IOrdering

Constructors

ChartAxis(ChartPlotArea)

Creates a new instance of the ChartAxis class.

Declaration
public ChartAxis(ChartPlotArea parent)
Parameters
ChartPlotArea parent

ChartAxis(ChartPlotArea, IContainer)

Creates a new instance of the ChartAxis class.

Declaration
public ChartAxis(ChartPlotArea parent, IContainer container)
Parameters
ChartPlotArea parent

IContainer container

Fields

chartAxisAppearance

ChartAxis style

Declaration
protected StyleAxis chartAxisAppearance
Field Value
StyleAxis

chartAxisItems

ChartAxis items

Declaration
protected ChartAxisItemsCollection chartAxisItems
Field Value
ChartAxisItemsCollection

chartAxisLabel

ChartAxis main label

Declaration
protected ChartLabel chartAxisLabel
Field Value
ChartLabel

chartAxisMaxAxisValue

Maximum series value

Declaration
protected double chartAxisMaxAxisValue
Field Value
System.Double

chartAxisMaxItemValue

Max axis item value

Declaration
protected double chartAxisMaxItemValue
Field Value
System.Double

chartAxisMinAxisValue

Minimum series value

Declaration
protected double chartAxisMinAxisValue
Field Value
System.Double

chartAxisMinItemValue

Min axis item value

Declaration
protected double chartAxisMinItemValue
Field Value
System.Double

chartAxisParent

Parent element

Declaration
protected ChartPlotArea chartAxisParent
Field Value
ChartPlotArea

chartAxisPointEnd

Axis zero value end point

Declaration
protected PointF chartAxisPointEnd
Field Value
System.Drawing.PointF

chartAxisPointStart

Axis start point

Declaration
protected PointF chartAxisPointStart
Field Value
System.Drawing.PointF

chartAxisRealIsZeroBased

Is axis zero based

Declaration
protected bool chartAxisRealIsZeroBased
Field Value
System.Boolean

pixelsPerValue

Pixels per value field.

Declaration
protected float pixelsPerValue
Field Value
System.Single

zeroCoord

Cached zero coordinate value.

Declaration
protected float zeroCoord
Field Value
System.Single

Properties

Appearance

ChartAxis style

Declaration
[SkinnableProperty]
public StyleAxis Appearance { get; }
Property Value
StyleAxis

AutoScale

Enables or disables automatic axis scaling.

Declaration
public bool AutoScale { get; set; }
Property Value
System.Boolean

AxisLabel

ChartAxis label

Declaration
[SkinnableProperty]
public ChartLabel AxisLabel { get; }
Property Value
ChartLabel

IsZeroBased

Specifies whether the axis begins from 0.

Declaration
public bool IsZeroBased { get; set; }
Property Value
System.Boolean

Item[Int32]

Returns the axis item at the specified position.

Declaration
public ChartAxisItem this[int index] { get; }
Parameters
System.Int32 index

Property Value
ChartAxisItem

Items

Returns a collection of axis items.

Declaration
public ChartAxisItemsCollection Items { get; }
Property Value
ChartAxisItemsCollection

LabelStep

Draw each 1,2,...,n item

Declaration
public int LabelStep { get; set; }
Property Value
System.Int32

MaxItemsCount

Gets or sets maximal count of the axis items when auto scaling.

Declaration
public int MaxItemsCount { get; set; }
Property Value
System.Int32

MaxValue

Specifies the max value of the axis range.

Declaration
public virtual double MaxValue { get; set; }
Property Value
System.Double

MinValue

Specifies the min value of the axis range.

Declaration
public virtual double MinValue { get; set; }
Property Value
System.Double

Parent

Parent element (PlotArea)

Declaration
public ChartPlotArea Parent { get; }
Property Value
ChartPlotArea

Step

Specifies the step at which axis values are calculated

Declaration
public virtual double Step { get; set; }
Property Value
System.Double

Visible

Specifies whether the axis should be rendered.

Declaration
public ChartAxisVisibility Visible { get; set; }
Property Value
ChartAxisVisibility

VisibleValues

Determines the type of shown values

Declaration
public ChartAxisVisibleValues VisibleValues { get; set; }
Property Value
ChartAxisVisibleValues

Methods

AddItem(List<ChartAxisItem>)

Adds ChartAxisItems to the axis.

Declaration
public void AddItem(List<ChartAxisItem> items)
Parameters
System.Collections.Generic.List<ChartAxisItem> items

AddItem(String, Color)

Adds a new ChartAxisItem object to the axis with the specified label and color.

Declaration
protected ChartAxisItem AddItem(string label, Color color)
Parameters
System.String label

Axis label
System.Drawing.Color color

Item text color
Returns
ChartAxisItem

AddItem(String, Color, Boolean)

Adds a new ChartAxisItem object to the axis with the specified label and color.

Declaration
protected ChartAxisItem AddItem(string label, Color color, bool visible)
Parameters
System.String label

Axis label
System.Drawing.Color color

Item text color
System.Boolean visible

Visibility
Returns
ChartAxisItem

AddItem(ChartAxisItem, ChartAxisItem[])

Adds a ChartAxisItem to the axis.

Declaration
public void AddItem(ChartAxisItem item, params ChartAxisItem[] items)
Parameters
ChartAxisItem item

ChartAxisItem[] items

AddItem(ChartAxisItem[])

Adds ChartAxisItems to the axis.

Declaration
public void AddItem(ChartAxisItem[] items)
Parameters
ChartAxisItem[] items

AddItem(ChartAxisItemsCollection)

Adds a ChartAxisItemsCollection to the axis.

Declaration
public void AddItem(ChartAxisItemsCollection items)
Parameters
ChartAxisItemsCollection items

AddRange(Double, Double, Double)

Automatically adds new axis items in AutoScale mode.

Declaration
public void AddRange(double minValue, double maxValue, double step)
Parameters
System.Double minValue

Min range value
System.Double maxValue

Max range value
System.Double step

Axis step value

AutoCalcAxisExtents()

Auto determines the min and max value of the axis

Declaration
protected void AutoCalcAxisExtents()

Clear()

Clears data values of the axis.

Declaration
public void Clear()

DisableCachedValues()

Restores initial values of cached axis settings

Declaration
protected virtual void DisableCachedValues()

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

GetAxisEndCoord()

Gets the end value coordinate

Declaration
protected abstract float GetAxisEndCoord()
Returns
System.Single

Coordinate

GetAxisStartCoord()

Gets the start value coordinate

Declaration
protected abstract float GetAxisStartCoord()
Returns
System.Single

Coordinate

GetDistance(PointF, PointF)

Gets distance between points

Declaration
protected float GetDistance(PointF point1, PointF point2)
Parameters
System.Drawing.PointF point1

First point
System.Drawing.PointF point2

Second point
Returns
System.Single

Distance

GetItem(Int32)

Gets the item at the specified index.

Declaration
public ChartAxisItem GetItem(int index)
Parameters
System.Int32 index

Returns
ChartAxisItem

LoadViewState(Object)

Loading ViewState data

Declaration
protected override void LoadViewState(object savedState)
Parameters
System.Object savedState

Saved state bag
Overrides

RemoveAllItems()

Removes all items

Declaration
public void RemoveAllItems()

RemoveItem(Int32)

Removes the ChartAxisItem at the specified index.

Declaration
public void RemoveItem(int itemIndex)
Parameters
System.Int32 itemIndex

item's index

RemoveItem(Int32, Int32[])

Removes the ChartAxisItems at the specified indexes.

Declaration
public void RemoveItem(int index, params int[] indexes)
Parameters
System.Int32 index

System.Int32[] indexes

RemoveItem(ChartAxisItem, ChartAxisItem[])

Removes the ChartAxisItem specified.

Declaration
public void RemoveItem(ChartAxisItem item, params ChartAxisItem[] items)
Parameters
ChartAxisItem item

ChartAxisItem[] items

RemoveLastItem()

Removes the last item from the axis.

Declaration
public void RemoveLastItem()

ResetMaxValue()

Resets the MaxValue to default

Declaration
protected void ResetMaxValue()

ResetMinValue()

Resets the MinValue to default

Declaration
protected void ResetMinValue()

ResetStep()

Resets the Step value to default

Declaration
protected void ResetStep()

SaveViewState()

Saves data to a State Bag

Declaration
protected override object SaveViewState()
Returns
System.Object

Saved axis data to a state bag
Overrides

SetItemColor(Int32, Color)

Sets new color for the axis item text at the specified position.

Declaration
public void SetItemColor(int itemIndex, Color newColor)
Parameters
System.Int32 itemIndex

Item index in collection
System.Drawing.Color newColor

Item text color

SetItemLabel(Int32, String)

Sets new label text for the axis item at the specified position.

Declaration
public void SetItemLabel(int itemIndex, string newLabelText)
Parameters
System.Int32 itemIndex

Item index in collection
System.String newLabelText

Axis item label text

SetItemLabel(Int32, ChartAxisItem)

Sets new label for the axis item at the specified position.

Declaration
public void SetItemLabel(int itemIndex, ChartAxisItem newLabel)
Parameters
System.Int32 itemIndex

Item index in collection
ChartAxisItem newLabel

SetMaxValue(Double)

Sets the maximum axis range value

Declaration
protected void SetMaxValue(double maxValue)
Parameters
System.Double maxValue

SetMinValue(Double)

Sets the min axis range value

Declaration
protected void SetMinValue(double minValue)
Parameters
System.Double minValue

Value to set

ShouldSerializeMaxValue()

The axis MaxValue design time serialization reason

Declaration
protected bool ShouldSerializeMaxValue()
Returns
System.Boolean

True is value have to be serialized

ShouldSerializeMinValue()

The axis MinValue design time serialization reason

Declaration
protected bool ShouldSerializeMinValue()
Returns
System.Boolean

True is value have to be serialized

ShouldSerializeStep()

The axis Step design time serialization reason

Declaration
protected bool ShouldSerializeStep()
Returns
System.Boolean

True is value have to be serialized

TrackViewState()

Tracking ViewState

Declaration
protected override void TrackViewState()
Overrides