Class ChartAxisGroupingLabel

The ChartAxisGroupingLabel class holds information about Grouping Label text, Grouping Label color, Grouping Label font and other related information.

Inheritance

System.Object

ChartAxisGroupingLabel

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 ChartAxisGroupingLabel

Constructors

ChartAxisGroupingLabel(DoubleRange)

Overloaded Constructor. Each Grouping Label along a ChartAxis is held in a ChartAxisGroupingLabel.

Declaration

public ChartAxisGroupingLabel(DoubleRange range)

Parameters

Type	Name	Description
DoubleRange	range	The range to group labels.

ChartAxisGroupingLabel(DoubleRange, String)

Constructor. Each Grouping Label along a ChartAxis is held in the ChartAxisGroupingLabel.

Declaration

public ChartAxisGroupingLabel(DoubleRange range, string text)

Parameters

Type	Name	Description
DoubleRange	range	The range to group labels.
System.String	text	The text that will be displayed as the Grouping Label for the axis point.

ChartAxisGroupingLabel(DoubleRange, String, Color, Color, Font)

Constructor. Each Grouping Label along a ChartAxis is held in the ChartAxisGroupingLabel.

Declaration

public ChartAxisGroupingLabel(DoubleRange range, string text, Color color, Color borderColor, Font font)

Parameters

Type	Name	Description
DoubleRange	range	The range to group labels.
System.String	text	The text that will be displayed as the Grouping Label for the axis point.
System.Drawing.Color	color	The color that is to be used for the Grouping Label text.
System.Drawing.Color	borderColor	The border color to render group.
System.Drawing.Font	font	The font that is to be used for the Grouping Label text.

ChartAxisGroupingLabel(DoubleRange, String, Color, Font)

Constructor. Each Grouping Label along a ChartAxis is held in the ChartAxisGroupingLabel.

Declaration

public ChartAxisGroupingLabel(DoubleRange range, string text, Color color, Font font)

Parameters

Type	Name	Description
DoubleRange	range	The range to group labels.
System.String	text	The text that will be displayed as the Grouping Label for the axis point.
System.Drawing.Color	color	The color that is to be used for the Grouping Label text.
System.Drawing.Font	font	The font that is to be used for the Grouping Label text.

ChartAxisGroupingLabel(DoubleRange, String, Color, Pen, Font)

Constructor. Each Grouping Label along a ChartAxis is held in the ChartAxisGroupingLabel.

Declaration

public ChartAxisGroupingLabel(DoubleRange range, string text, Color color, Pen borderPen, Font font)

Parameters

Type	Name	Description
DoubleRange	range	The range to group labels.
System.String	text	The text that will be displayed as the Grouping Label for the axis point.
System.Drawing.Color	color	The color that is to be used for the Grouping Label text.
System.Drawing.Pen	borderPen	Border System.Drawing.Pen to render group border.
System.Drawing.Font	font	The font that is to be used for the Grouping Label text.

Properties

BackColor

Gets or sets back color. Default is Transparent.

Declaration

public Color BackColor { get; set; }

Property Value

Type
System.Drawing.Color

BorderPadding

Gets or sets the Padding of border drawing that is to be used for the Grouping Label. Default is 2.0f.

Declaration

public float BorderPadding { get; set; }

Property Value

Type
System.Single

BorderPen

Gets or sets the color that is to be used for the Grouping Label border/brace etc. Default is Black.

Declaration

public Pen BorderPen { get; set; }

Property Value

Type
System.Drawing.Pen

BorderStyle

Gets or sets the Style of border drawing that is to be used for the Grouping Label. Default is Rectangle

Declaration

public ChartAxisGroupingLabelBorderStyle BorderStyle { get; set; }

Property Value

Type
ChartAxisGroupingLabelBorderStyle

Broadness

Gets or sets label broadness(thickness, wideness).

Declaration

[Obsolete]
public float Broadness { get; set; }

Property Value

Type
System.Single

Color

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

Declaration

public Color Color { get; set; }

Property Value

Type
System.Drawing.Color

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 System.Drawing.StringFormat to render label. Default is GenericDefault.

Declaration

public StringFormat Format { get; set; }

Property Value

Type
System.Drawing.StringFormat

LabelTextAlignment

Gets or sets label alignment. Default is Center.

Declaration

public ChartAxisGroupingLabelTextAlignment LabelTextAlignment { get; set; }

Property Value

Type
ChartAxisGroupingLabelTextAlignment

LabelTextFitMode

Gets or sets label fit mode. Default is Shrink.

Declaration

public ChartAxisGroupingLabelTextFitMode LabelTextFitMode { get; set; }

Property Value

Type
ChartAxisGroupingLabelTextFitMode

Lines

Lets you specify the grouping label text in multiple lines

Declaration

public string[] Lines { get; set; }

Property Value

Type
System.String[]

MaxTextHeightToWidthRatio

Gets or sets max text height to width ratio. Default is 2.5

Declaration

public float MaxTextHeightToWidthRatio { get; set; }

Property Value

Type
System.Single

MaxTextWidth

Gets or sets max text width. Default is 200.

Declaration

public float MaxTextWidth { get; set; }

Property Value

Type
System.Single

Range

Gets or sets the double range that this Grouping Label with cover. If the range in the axis is DateTime, use DateTime.ToOADate to get the double value.

Declaration

public DoubleRange Range { get; set; }

Property Value

Type
DoubleRange

Rect

Gets the rectangle in which to draw the label.

Declaration

public RectangleF Rect { get; }

Property Value

Type
System.Drawing.RectangleF

RegionDescription

Gets or sets the the region description text for this region.

Declaration

public string RegionDescription { get; set; }

Property Value

Type
System.String

RotateAngle

Gets or sets labels rotate angle. Default is 0.

Declaration

public float RotateAngle { get; set; }

Property Value

Type
System.Single

Row

Gets or sets row in which to render this grouping label. specify 0 for the 1st row and so on. Default is 0.

Declaration

public int Row { get; set; }

Property Value

Type
System.Int32

Tag

Gets or sets tag

Declaration

public object Tag { get; set; }

Property Value

Type
System.Object

Text

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

Declaration

public string Text { get; set; }

Property Value

Type
System.String

Methods

Dispose()

Method to dispose labels

Declaration

public void Dispose()