Class ChartAxisLabel

The ChartAxisLabel class holds information about label text, label color, label font and other related information.

Inheritance

System.Object

ChartAxisLabel

Implements

System.ICloneable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms.Chart

Assembly: Syncfusion.Chart.Base.dll

Syntax

public class ChartAxisLabel : ICloneable

Constructors

ChartAxisLabel()

Overloaded Constructor. Each label along a ChartAxis is held in a ChartAxisLabel.

Declaration

public ChartAxisLabel()

ChartAxisLabel(DateTime, String)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(DateTime dt, string dateTimeFormat)

Parameters

Type	Name	Description
System.DateTime	dt	The Date Time value represented by the label.
System.String	dateTimeFormat	The format that is to be used for formatting the display label.

ChartAxisLabel(DateTime, String, String)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(DateTime dt, string dateTimeFormat, string toolTip)

Parameters

Type	Name	Description
System.DateTime	dt	The Date Time value represented by the label.
System.String	dateTimeFormat	The format that is to be used for formatting the display label.
System.String	toolTip	The text that will be displayed as the tooltip for the axis labels.

ChartAxisLabel(Double, String)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(double dvalue, string format)

Parameters

Type	Name	Description
System.Double	dvalue	The value represented by the label.
System.String	format	The format that is to be used for formatting the display label.

ChartAxisLabel(Double, String, ChartValueType)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(double dvalue, string format, ChartValueType valueType)

Parameters

Type	Name	Description
System.Double	dvalue	The value represented by the label.
System.String	format	The format that is to be used for formatting the display label.
ChartValueType	valueType	The value type of the axis label.

ChartAxisLabel(Double, String, String)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(double dvalue, string format, string toolTip)

Parameters

Type	Name	Description
System.Double	dvalue	The value represented by the label.
System.String	format	The format that is to be used for formatting the display label.
System.String	toolTip	The text that will be displayed as the tooltip for the axis labels.

ChartAxisLabel(Double, String, String, ChartValueType)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(double dvalue, string format, string toolTip, ChartValueType valueType)

Parameters

Type	Name	Description
System.Double	dvalue	The value represented by the label.
System.String	format	The format that is to be used for formatting the display label.
System.String	toolTip	The text that will be displayed as tooltip for the label.
ChartValueType	valueType	The value type of the axis label.

ChartAxisLabel(String)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.

ChartAxisLabel(String, Double)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, double value)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.Double	value	The value.

ChartAxisLabel(String, Double, String)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, double value, string toolTip)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.Double	value	The value.
System.String	toolTip	The text that will be displayed as the tooltip for the axis labels.

ChartAxisLabel(String, Color, Font)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, Color color, Font font)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.Drawing.Color	color	The color that is to be used for the label text.
System.Drawing.Font	font	The font that is to be used for the label text.

ChartAxisLabel(String, Color, Font, DateTime, String, String, ChartValueType)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, Color color, Font font, DateTime dateTime, string format, string dateTimeFormat, ChartValueType valueType)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.Drawing.Color	color	The color that is to be used for the label text.
System.Drawing.Font	font	The font that is to be used for the label text.
System.DateTime	dateTime	The DateTime value represented by the label.
System.String	format	The format that is to be used for formatting the display label.
System.String	dateTimeFormat	The date time format that is to be used for formatting the value.
ChartValueType	valueType	The value type of the axis label.

ChartAxisLabel(String, Color, Font, Double)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, Color color, Font font, double dvalue)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.Drawing.Color	color	The color that is to be used for the label text.
System.Drawing.Font	font	The font that is to be used for the label text.
System.Double	dvalue	The value represented by the label.

ChartAxisLabel(String, Color, Font, Double, String)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, Color color, Font font, double dvalue, string toolTip)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.Drawing.Color	color	The color that is to be used for the label text.
System.Drawing.Font	font	The font that is to be used for the label text.
System.Double	dvalue	The value represented by the label.
System.String	toolTip	The text that will be displayed as the tooltip for the axis labels.

ChartAxisLabel(String, Color, Font, Double, String, ChartValueType)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, Color color, Font font, double dvalue, string format, ChartValueType valueType)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.Drawing.Color	color	The color that is to be used for the label text.
System.Drawing.Font	font	The font that is to be used for the label text.
System.Double	dvalue	The value represented by the label.
System.String	format	The format that is to be used for formatting the display label.
ChartValueType	valueType	The value type of the axis label.

ChartAxisLabel(String, Color, Font, Double, String, String, ChartValueType)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, Color color, Font font, double dvalue, string format, string dateTimeFormat, ChartValueType valueType)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.Drawing.Color	color	The color that is to be used for the label text.
System.Drawing.Font	font	The font that is to be used for the label text.
System.Double	dvalue	The value represented by the label.
System.String	format	The format that is to be used for formatting the display label.
System.String	dateTimeFormat	The date time format that is to be used for formatting the value.
ChartValueType	valueType	The value type of the axis label.

ChartAxisLabel(String, Color, Font, String)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, Color color, Font font, string toolTip)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.Drawing.Color	color	The color that is to be used for the label text.
System.Drawing.Font	font	The font that is to be used for the label text.
System.String	toolTip	The text that will be displayed as the tooltip for the axis labels.

ChartAxisLabel(String, String)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, string toolTip)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.String	toolTip	The text that will be displayed as the tooltip for the axis labels.

ChartAxisLabel(String, String, Color, Font, DateTime, String, String, ChartValueType)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, string toolTip, Color color, Font font, DateTime dateTime, string format, string dateTimeFormat, ChartValueType valueType)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.String	toolTip	The text that will be displayed as tooltip for the label.
System.Drawing.Color	color	The color that is to be used for the label text.
System.Drawing.Font	font	The font that is to be used for the label text.
System.DateTime	dateTime	The DateTime value represented by the label.
System.String	format	The format that is to be used for formatting the display label.
System.String	dateTimeFormat	The date time format that is to be used for formatting the value.
ChartValueType	valueType	The value type of the axis label.

ChartAxisLabel(String, String, Color, Font, Double, String, ChartValueType)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, string toolTip, Color color, Font font, double dvalue, string format, ChartValueType valueType)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.String	toolTip	The text that will be displayed as the tooltip for the axis labels.
System.Drawing.Color	color	The color that is to be used for the label text.
System.Drawing.Font	font	The font that is to be used for the label text.
System.Double	dvalue	The value represented by the label.
System.String	format	The format that is to be used for formatting the display label.
ChartValueType	valueType	The value type of the axis label.

ChartAxisLabel(String, String, Color, Font, Double, String, String, ChartValueType)

Constructor. Each label along a ChartAxis is held in the ChartAxisLabel.

Declaration

public ChartAxisLabel(string customText, string toolTip, Color color, Font font, double dvalue, string format, string dateTimeFormat, ChartValueType valueType)

Parameters

Type	Name	Description
System.String	customText	The text that will be displayed as the label for the axis point.
System.String	toolTip	The text that will be displayed as tooltip for the label.
System.Drawing.Color	color	The color that is to be used for the label text.
System.Drawing.Font	font	The font that is to be used for the label text.
System.Double	dvalue	The value represented by the label.
System.String	format	The format that is to be used for formatting the display label.
System.String	dateTimeFormat	The date time format that is to be used for formatting the value.
ChartValueType	valueType	The value type of the axis label.

Properties

AxisLabelPlacement

Gets or sets a value indicates whether label is located inside or outside of chart area.

Declaration

public ChartPlacement AxisLabelPlacement { get; set; }

Property Value

Type
ChartPlacement

Color

Gets or sets the color that is to be used for the label text.

Declaration

public Color Color { get; set; }

Property Value

Type
System.Drawing.Color

CustomText

Gets or sets the custom text that is to be used as the label.

Declaration

public string CustomText { get; set; }

Property Value

Type
System.String

DateTimeFormat

Gets or sets the date format that is to be used for formatting the value into the label text. See "Date and Time format strings" section in MSDN for more info.

Declaration

public string DateTimeFormat { get; set; }

Property Value

Type
System.String

DoubleValue

Gets or sets the value that the label represents.

Declaration

public double DoubleValue { get; set; }

Property Value

Type
System.Double

Font

Gets or sets the font that is to be used for the label text.

Declaration

public Font Font { get; set; }

Property Value

Type
System.Drawing.Font

Format

Gets or sets the format that is to be used for formatting the double values into the label text. See "Numeric Format Strings" section in MSDN for more on the supported formats.

Declaration

public string Format { get; set; }

Property Value

Type
System.String

LogBase

Gets or sets the log base that is to be used by the label. Default is 2.

Declaration

public double LogBase { get; set; }

Property Value

Type
System.Double

RoundingPlaces

Number of relevant rounding places that is to be used for the label. Default is 2.

Declaration

public int RoundingPlaces { get; set; }

Property Value

Type
System.Int32

Text

Gets the formatted text that is to be displayed as the label.

Declaration

public string Text { get; }

Property Value

Type
System.String

ToolTip

Gets or sets the tooltip for the axis label.

Declaration

public string ToolTip { get; set; }

Property Value

Type
System.String

ValueType

Gets or sets the value type that is to be associated with the axis label. Default is Double.

Declaration

public ChartValueType ValueType { get; set; }

Property Value

Type
ChartValueType

Methods

Clone()

Creates a new object that is a copy of the current instance.

Declaration

public ChartAxisLabel Clone()

Returns

Type	Description
ChartAxisLabel	A new object that is a copy of this instance.

Dispose()

Method to dispose labels.

Declaration

public void Dispose()

InitializeStaticVariables()

Method to initialize disposed static objects

Declaration

public static ChartAxisLabel InitializeStaticVariables()

Returns

Type
ChartAxisLabel

Explicit Interface Implementations

ICloneable.Clone()

Creates a new object that is a copy of the current instance.

Declaration

object ICloneable.Clone()

Returns

Type	Description
System.Object	A new object that is a copy of this instance.

Implements

System.ICloneable