Class ChartRegionData

Represents the data of ChartRegion

Inheritance

System.Object

ChartRegionData

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 sealed class ChartRegionData : ICloneable

Constructors

ChartRegionData(ChartRegionType, RectangleF, PointF, Int32, Int32, String)

Initializes a new instance of the ChartRegionData class.

Declaration

public ChartRegionData(ChartRegionType type, RectangleF bounds, PointF pointF, int seriesIndex, int pointIndex, string description)

Parameters

Type	Name	Description
ChartRegionType	type
System.Drawing.RectangleF	bounds	The rectangle bounds.
System.Drawing.PointF	pointF	The point x, y position.
System.Int32	seriesIndex	Index of the series.
System.Int32	pointIndex	Index of the point.
System.String	description	The description.

ChartRegionData(ChartRegionType, String, Int32, String)

Initializes a new instance of the ChartRegionData class.

Declaration

public ChartRegionData(ChartRegionType regionType, string toolTip, int index, string description)

Parameters

Type	Name	Description
ChartRegionType	regionType	Type of the region.
System.String	toolTip	The tool tip.
System.Int32	index	Axis index.
System.String	description	The description.

ChartRegionData(ChartRegionType, String, Int32, String, Int32, String)

Initializes a new instance of the ChartRegionData class.

Declaration

public ChartRegionData(ChartRegionType regionType, string toolTip, int axisIndex, string text, int labelIndex, string description)

Parameters

Type	Name	Description
ChartRegionType	regionType	Type of the region.
System.String	toolTip	The tool tip.
System.Int32	axisIndex	Axis index.
System.String	text	Axis label text
System.Int32	labelIndex	Index of the label in axis
System.String	description	The description.

ChartRegionData(ChartRegionType, String, String)

Initializes a new instance of the ChartRegionData class.

Declaration

public ChartRegionData(ChartRegionType regionType, string toolTip, string description)

Parameters

Type	Name	Description
ChartRegionType	regionType	Type of the region.
System.String	toolTip	The tool tip.
System.String	description	The description.

ChartRegionData(Int32, Int32, String, String)

Initializes a new instance of the ChartRegionData class.

Declaration

public ChartRegionData(int seriesIndex, int pointIndex, string toolTip, string description)

Parameters

Type	Name	Description
System.Int32	seriesIndex	Index of the series.
System.Int32	pointIndex	Index of the point.
System.String	toolTip	The tool tip.
System.String	description	The description.

ChartRegionData(Int32, String, String)

Initializes a new instance of the ChartRegionData class.

Declaration

public ChartRegionData(int seriesIndex, string toolTip, string description)

Parameters

Type	Name	Description
System.Int32	seriesIndex	Index of the series.
System.String	toolTip	The tool tip.
System.String	description	The description.

ChartRegionData(String, String)

Initializes a new instance of the ChartRegionData class.

Declaration

public ChartRegionData(string toolTip, string description)

Parameters

Type	Name	Description
System.String	toolTip	The tool tip.
System.String	description	The description.

Properties

AxisIndex

Gets the index of the Axis.

Declaration

public int AxisIndex { get; }

Property Value

Type	Description
System.Int32	The index of the Axis.

AxisLabelIndex

Gets the index of the label.

Declaration

public int AxisLabelIndex { get; }

Property Value

Type	Description
System.Int32	The index of the label.

AxisLabelText

Gets the clicked label text.

Declaration

public string AxisLabelText { get; }

Property Value

Type	Description
System.String	Value of the clicked label.

Bounds

Gets the rectangle bounds

Declaration

public RectangleF Bounds { get; }

Property Value

Type	Description
System.Drawing.RectangleF	The bounds value of the point.

Description

Gets the description.

Declaration

public string Description { get; }

Property Value

Type	Description
System.String	The description.

IsChartPoint

Indicates whether the region represents a chart point.

Declaration

public bool IsChartPoint { get; }

Property Value

Type	Description
System.Boolean	true if this instance is chart point; otherwise, false.

PointIndex

Gets the index of the point.

Declaration

public int PointIndex { get; }

Property Value

Type	Description
System.Int32	The index of the point.

PointXY

Gets the point x,y value

Declaration

public PointF PointXY { get; }

Property Value

Type	Description
System.Drawing.PointF	The x y value of the point.

SeriesIndex

Gets the index of the series.

Declaration

public int SeriesIndex { get; }

Property Value

Type	Description
System.Int32	The index of the series.

ToolTip

Gets or sets the ToolTip for this region.

Declaration

public string ToolTip { get; set; }

Property Value

Type	Description
System.String	The tool tip.

Type

Gets the type.

Declaration

public ChartRegionType Type { get; }

Property Value

Type	Description
ChartRegionType	The type.

Methods

Clone()

Clones a data.

Declaration

public ChartRegionData Clone()

Returns

Type	Description
ChartRegionData	Return ChartRegion Data.

GetChartRegion(Region)

Gets the chart region.

Declaration

public ChartRegion GetChartRegion(Region region)

Parameters

Type	Name	Description
System.Drawing.Region	region	The region.

Returns

Type
ChartRegion

Explicit Interface Implementations

ICloneable.Clone()

Implementation of interface ICloneable.

Declaration

object ICloneable.Clone()

Returns

Type	Description
System.Object	Returns ChartRegiondata clone.

Implements

System.ICloneable