ChartArea.GetSeriesDepth(Series) Method

Reference

Definition

Namespace:: System.Windows.Forms.DataVisualization.Charting

Assembly:: System.Windows.Forms.DataVisualization.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the depth of a Series in a chart area.

public:
 float GetSeriesDepth(System::Windows::Forms::DataVisualization::Charting::Series ^ series);

public float GetSeriesDepth (System.Windows.Forms.DataVisualization.Charting.Series series);

member this.GetSeriesDepth : System.Windows.Forms.DataVisualization.Charting.Series -> single

Public Function GetSeriesDepth (series As Series) As Single

Parameters

series: Series

The Series for which the depth is retrieved.

Returns

Single

A float value that represents the depth of the specified Series, which is measured as a percentage of the chart area's depth.

Remarks

Call this method to get the depth of a specified series. The returned value is measured as a percentage of the chart area's depth, which is the same unit of measurement used in the Z property.

All series have a depth, regardless of their chart type. For example, even point and bubble series have a depth, even though the entire depth is not used to draw the points or bubbles.

The depth of a series can be used to determine a Z value for a point that is used in a custom drawing routine.

Note

Any points used in custom 3D drawing must be transformed from relative 3D coordinates to relative 2D coordinates using the TransformPoints method.

To get relative X and Y-values from an axis, use the ValueToPosition method for both the X and Y axes.

Applies to

Jaa