Interface IChartArea

The interface that the ChartArea type implements.

Namespace: Syncfusion.Windows.Forms.Chart

Assembly: Syncfusion.Chart.Base.dll

Syntax

public interface IChartArea

Properties

AdjustPlotAreaMargins

Gets or sets the mode of drawing the edge labels.

Declaration

ChartSetMode AdjustPlotAreaMargins { get; set; }

Property Value

Type
ChartSetMode

AutoScale

Gets or sets a value indicating whether area should scale automatically in 3D mode.

Declaration

bool AutoScale { get; set; }

Property Value

Type	Description
System.Boolean	true if area should scale automatically; otherwise, false.

Axes

Collection of axes associated with this chart. You can add and remove axes from this collection. Primary X and Y axes may not be removed.

Declaration

ChartAxisCollection Axes { get; }

Property Value

Type
ChartAxisCollection

AxesInfoBar

Gets or sets the ChartAxesInfoBar which displays the labels between the rectangular axes.

Declaration

ChartAxesInfoBar AxesInfoBar { get; }

Property Value

Type
ChartAxesInfoBar

AxisSpacing

Gets or sets the spacing between different axes on the same side of the ChartArea. This spacing is useful when you display multiple axes side by side.

Declaration

SizeF AxisSpacing { get; set; }

Property Value

Type
System.Drawing.SizeF

BackImage

Gets or sets the image that is to be used as the background for this ChartArea.

Declaration

Image BackImage { get; set; }

Property Value

Type
System.Drawing.Image

BackInterior

Gets or sets the color with which the ChartArea is to be filled initially before any rendering takes place.

Declaration

BrushInfo BackInterior { get; set; }

Property Value

Type
BrushInfo

BorderColor

Gets or sets the border color of the rectangular area occupied by this ChartArea.

Declaration

Color BorderColor { get; set; }

Property Value

Type
System.Drawing.Color

Bounds

Returns the bounds associated with this ChartArea.

Declaration

Rectangle Bounds { get; set; }

Property Value

Type
System.Drawing.Rectangle

Center

Returns the center point of this ChartArea.

Declaration

PointF Center { get; }

Property Value

Type
System.Drawing.PointF

Chart

Gets the chart.

Declaration

IChartAreaHost Chart { get; }

Property Value

Type	Description
IChartAreaHost	The chart.

ChartAreaMargins

Returns the margins that will be deduced from the rectangular area that represents the ChartArea. Negative values are supported.

Declaration

ChartMargins ChartAreaMargins { get; set; }

Property Value

Type
ChartMargins

ChartAreaToolTip

Gets or sets the ToolTip text associated with this ChartArea.

Declaration

string ChartAreaToolTip { get; set; }

Property Value

Type
System.String

ChartPlotAreaMargins

Returns the margins of ChartArea (excluding label width and height).

Declaration

ChartMargins ChartPlotAreaMargins { get; set; }

Property Value

Type
ChartMargins

ChartRegions

Gets the chart regions.

Declaration

IList ChartRegions { get; }

Property Value

Type	Description
System.Collections.IList	The chart regions.

ClientRectangle

Gets or sets the ClientRectangle associated with this ChartArea.

Declaration

Rectangle ClientRectangle { get; }

Property Value

Type
System.Drawing.Rectangle

CustomPoints

Collection of custom points associated with this ChartArea. Custom points can be used to add labels to chart points.

Declaration

ChartCustomPointCollection CustomPoints { get; }

Property Value

Type
ChartCustomPointCollection

Remarks

ChartCustomPointCollection

Depth

Gets or sets the perception of depth that is to be used when the ChartArea is rendered in 3D.

Declaration

float Depth { get; set; }

Property Value

Type
System.Single

DivideArea

If set to true, the legend will show the series text (for Pie Chart).

Declaration

bool DivideArea { get; set; }

Property Value

Type
System.Boolean

FullStackMax

Gets or sets the maximal value of full stracking charts.

Declaration

double FullStackMax { get; set; }

Property Value

Type	Description
System.Double	The maximal value of full stracking charts.

Height

Gets or sets the height of the rectangular area that is occupied by this ChartArea.

Declaration

int Height { get; set; }

Property Value

Type
System.Int32

InteractiveCursors

Gets the interactive cursors.

Declaration

ChartAreaCursorCollection InteractiveCursors { get; }

Property Value

Type	Description
ChartAreaCursorCollection	The interactive cursors.

LegacyAppearance

Indicates to change the appearance of chart.

Declaration

bool LegacyAppearance { get; set; }

Property Value

Type
System.Boolean

Location

Gets or sets the location of the rectangular area occupied by this ChartArea.

Declaration

Point Location { get; set; }

Property Value

Type
System.Drawing.Point

MinSize

Gets or sets the minimum size of this ChartArea.

Declaration

SizeF MinSize { get; set; }

Property Value

Type
System.Drawing.SizeF

MultiplePies

If set to true, multiple pie chart series will be rendered in the same chart area.

Declaration

bool MultiplePies { get; set; }

Property Value

Type
System.Boolean

OffsetX

Returns the X axis offset value used when rendering in 3D mode.

Declaration

float OffsetX { get; }

Property Value

Type
System.Single

OffsetY

Returns the Y axis offset value used when rendering in 3D mode.

Declaration

float OffsetY { get; }

Property Value

Type
System.Single

PrimaryXAxis

The primary X axis of Chart.

Declaration

ChartAxis PrimaryXAxis { get; }

Property Value

Type
ChartAxis

PrimaryYAxis

The primary Y axis of Chart.

Declaration

ChartAxis PrimaryYAxis { get; }

Property Value

Type
ChartAxis

Radius

Returns the radius of the Radar chart occupied by this ChartArea.

Declaration

float Radius { get; }

Property Value

Type
System.Single

RealSeries3D

Indicates if the ChartArea is to be rendered in 3D. Default value is false.

Declaration

bool RealSeries3D { get; set; }

Property Value

Type
System.Boolean

RenderBounds

Returns the actual rectangular bounds used for rendering.

Declaration

Rectangle RenderBounds { get; }

Property Value

Type
System.Drawing.Rectangle

RequireAxes

Indicates if the ChartArea requires axes to be rendered (for the Chart types being rendered).

Declaration

bool RequireAxes { get; set; }

Property Value

Type
System.Boolean

RequireInvertedAxes

Indicates if Chart requires Inverted Axes.

Declaration

bool RequireInvertedAxes { get; set; }

Property Value

Type
System.Boolean

Rotation

Gets or sets the rotational angle that is to be used when the ChartArea is rendered in 3D.

Declaration

float Rotation { get; set; }

Property Value

Type
System.Single

Scale3DCoeficient

Gets or sets a scale value in 3D mode.

Declaration

float Scale3DCoeficient { get; set; }

Property Value

Type
System.Single

Series3D

Indicates if the ChartArea is to be rendered in 3D. Default value is false.

Declaration

bool Series3D { get; set; }

Property Value

Type
System.Boolean

SeriesParameters

Gets the series rendering parameters.

Declaration

ChartSeriesParameters SeriesParameters { get; }

Property Value

Type	Description
ChartSeriesParameters	The series parameters.

Settings3D

Gets the 3D mode settings.

Declaration

Graphics3DState Settings3D { get; }

Property Value

Type	Description
Graphics3DState	The 3D mode settings.

Size

Gets or sets the size of the rectangular area occupied by the ChartArea.

Declaration

Size Size { get; set; }

Property Value

Type
System.Drawing.Size

Tilt

Gets or sets the tilt that is to be used when the ChartArea is rendered in 3D.

Declaration

float Tilt { get; set; }

Property Value

Type
System.Single

Transform3D

Gets transformation for real 3d mode.

Declaration

Transform3D Transform3D { get; }

Property Value

Type
Transform3D

Turn

Gets or sets the turn that is to be used when the ChartArea is rendered in Real 3D only.

Declaration

float Turn { get; set; }

Property Value

Type
System.Single

UpdateClientBounds

Gets or sets whether client bounds of chart should be updated or not.

Declaration

bool UpdateClientBounds { get; set; }

Property Value

Type
System.Boolean

Width

Gets or sets the width of the rectangular area occupied by this ChartArea.

Declaration

int Width { get; set; }

Property Value

Type
System.Int32

XAxesLayoutMode

Gets or sets the X axes layout mode.

Declaration

ChartAxesLayoutMode XAxesLayoutMode { get; set; }

Property Value

Type	Description
ChartAxesLayoutMode	The X axes layout mode.

YAxesLayoutMode

Gets or sets the Y axes layout mode.

Declaration

ChartAxesLayoutMode YAxesLayoutMode { get; set; }

Property Value

Type	Description
ChartAxesLayoutMode	The Y axes layout mode.

Methods

CalculateSizes(Rectangle)

Calculates the size of ChartArea.

Declaration

void CalculateSizes(Rectangle rect)

Parameters

Type	Name	Description
System.Drawing.Rectangle	rect

CorrectionFrom(Point)

Declaration

Point CorrectionFrom(Point pt)

Parameters

Type	Name	Description
System.Drawing.Point	pt

Returns

Type
System.Drawing.Point

CorrectionFrom(PointF)

Declaration

PointF CorrectionFrom(PointF pt)

Parameters

Type	Name	Description
System.Drawing.PointF	pt

Returns

Type
System.Drawing.PointF

CorrectionTo(Point)

Declaration

Point CorrectionTo(Point pt)

Parameters

Type	Name	Description
System.Drawing.Point	pt

Returns

Type
System.Drawing.Point

CorrectionTo(PointF)

Declaration

PointF CorrectionTo(PointF pt)

Parameters

Type	Name	Description
System.Drawing.PointF	pt

Returns

Type
System.Drawing.PointF

Draw(PaintEventArgs)

Declaration

void Draw(PaintEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e

Draw(PaintEventArgs, ChartPaintFlags)

Declaration

void Draw(PaintEventArgs e, ChartPaintFlags flags)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e
ChartPaintFlags	flags

DrawZoomingRange(Graphics)

Method used to draw the zooming area of Chart.

Declaration

void DrawZoomingRange(Graphics g)

Parameters

Type	Name	Description
System.Drawing.Graphics	g

GetPointByValue(ChartPoint)

Gets the real point value at this chart point.

Declaration

Point GetPointByValue(ChartPoint cpt)

Parameters

Type	Name	Description
ChartPoint	cpt

Returns

Type
System.Drawing.Point

GetValueByPoint(Point)

Returns the chartpoint value at this real point.

Declaration

ChartPoint GetValueByPoint(Point pt)

Parameters

Type	Name	Description
System.Drawing.Point	pt

Returns

Type
ChartPoint

GetXAxis(ChartSeries)

Returns the x axis of associated with this chartseries.

Declaration

ChartAxis GetXAxis(ChartSeries ser)

Parameters

Type	Name	Description
ChartSeries	ser

Returns

Type
ChartAxis

GetYAxis(ChartSeries)

Returns the y axis associated with this chartseries.

Declaration

ChartAxis GetYAxis(ChartSeries ser)

Parameters

Type	Name	Description
ChartSeries	ser

Returns

Type
ChartAxis