Back to Devexpress

SeriesLayoutOptions Interface

officefileapi-devexpress-dot-spreadsheet-dot-charts-7559bdbd.md

latest12.2 KB
Original Source

SeriesLayoutOptions Interface

Contains series options for Excel 2016 charts.

Namespace : DevExpress.Spreadsheet.Charts

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
public interface SeriesLayoutOptions
vb
Public Interface SeriesLayoutOptions

The following members return SeriesLayoutOptions objects:

Remarks

Use the SeriesLayoutOptions object’s members to specify options for Excel 2016 charts.

Box and Whisker Chart

Use the Series.LayoutOptions.BoxAndWhisker property to define options for a box and whisker data series.

PropertyDescription
BoxAndWhiskerSeriesOptions.ShowInnerPointsSpecifies whether to show inner data points that lie between the lower and upper whisker lines.
BoxAndWhiskerSeriesOptions.ShowOutlierPointsSpecifies whether to show outlier data points that lie either below the lower whisker line or above the upper whisker line.
BoxAndWhiskerSeriesOptions.ShowMeanLineSpecifies whether to display a line that connects the means of boxes in the series.
BoxAndWhiskerSeriesOptions.ShowMeanMarkersSpecifies whether to show the mean markers.
BoxAndWhiskerSeriesOptions.QuartileCalculationMethodDefines the quartile calculation method.

csharp
// Create a box and whisker chart and specify its location.
Chart chart = worksheet.Charts.Add(ChartType.BoxAndWhisker, worksheet["B2:E17"]);
chart.TopLeftCell = worksheet.Cells["G2"];
chart.BottomRightCell = worksheet.Cells["N17"];

// Set the minimum and maximum values for the value axis.
Axis axis = chart.PrimaryAxes[1];
axis.Scaling.AutoMax = false;
axis.Scaling.Max = 70;
axis.Scaling.AutoMin = false;
axis.Scaling.Min = 40;

// Specify series options.
foreach (Series series in chart.Series)
{
    var options = series.LayoutOptions.BoxAndWhisker;
    options.ShowInnerPoints = true;
    options.ShowMeanLine = false;
    options.ShowOutlierPoints = true;
    options.ShowMeanMarkers = true;
    options.QuartileCalculationMethod = QuartileCalculationMethod.ExclusiveMedian;
}

// Add the chart title.
chart.Title.Visible = true;
chart.Title.SetValue("Academic Performance Distribution");
vb
' Create a box and whisker chart and specify its location.
Dim chart As Chart = worksheet.Charts.Add(ChartType.BoxAndWhisker, worksheet("B2:E17"))
chart.TopLeftCell = worksheet.Cells("G2")
chart.BottomRightCell = worksheet.Cells("N17")

' Set the minimum and maximum values for the value axis.
Dim axis As Axis = chart.PrimaryAxes(1)
axis.Scaling.AutoMax = False
axis.Scaling.Max = 70
axis.Scaling.AutoMin = False
axis.Scaling.Min = 40

' Specify series options.
For Each series As Series In chart.Series
    Dim options As BoxAndWhiskerSeriesOptions = series.LayoutOptions.BoxAndWhisker
    options.ShowInnerPoints = True
    options.ShowMeanLine = False
    options.ShowOutlierPoints = True
    options.ShowMeanMarkers = True
    options.QuartileCalculationMethod = QuartileCalculationMethod.ExclusiveMedian
Next series

' Add the chart title.
chart.Title.Visible = True
chart.Title.SetValue("Academic Performance Distribution")

Waterfall Chart

Use the Series.LayoutOptions.Waterfall property to specify options for a waterfall data series.

PropertyDescription
WaterfallSeriesOptions.ShowConnectorLinesSpecifies whether to display connector lines between data points.
WaterfallSeriesOptions.SubtotalDataPointsReturns a collection of total points.

csharp
// Create a waterfall chart and specify its location.
Chart chart = worksheet.Charts.Add(ChartType.Waterfall, worksheet["B2:C7"]);
chart.TopLeftCell = worksheet.Cells["E2"];
chart.BottomRightCell = worksheet.Cells["L17"];

// Hide the major gridlines for the value axis.
chart.PrimaryAxes[1].MajorGridlines.Visible = false;

// Specify series options.
var options = chart.Series[0].LayoutOptions.Waterfall;
// Display connector lines.
options.ShowConnectorLines = true;
// Set the third data point as the total.
options.SubtotalDataPoints.Add(2);
// Set the last data point as the total.
options.SubtotalDataPoints.Add(5);

// Add the chart title.
chart.Title.Visible = true;
chart.Title.SetValue("Income Statement");
vb
' Create a waterfall chart and specify its location.
Dim chart As Chart = worksheet.Charts.Add(ChartType.Waterfall, worksheet("B2:C7"))
chart.TopLeftCell = worksheet.Cells("E2")
chart.BottomRightCell = worksheet.Cells("L17")

' Hide the major gridlines for the value axis.
chart.PrimaryAxes(1).MajorGridlines.Visible = False

' Specify series options.
Dim options As WaterfallSeriesOptions = chart.Series(0).LayoutOptions.Waterfall
' Display connector lines.
options.ShowConnectorLines = True
' Set the third data point as the total.
options.SubtotalDataPoints.Add(2)
' Set the last data point as the total.
options.SubtotalDataPoints.Add(5)

' Add the chart title.
chart.Title.Visible = True
chart.Title.SetValue("Income Statement")

Histogram Chart

Use the Series.LayoutOptions.Histogram property to specify options for a histogram data series.

PropertyDescription
HistogramSeriesOptions.BinTypeSpecifies how to calculate bins for a histogram.
HistogramSeriesOptions.BinCountDefines the number of histogram bins.
HistogramSeriesOptions.BinWidthDefines the bin size.
HistogramSeriesOptions.OverflowType,
HistogramSeriesOptions.OverflowValueAllow you to create a bin for all values that are above a specific value.
HistogramSeriesOptions.UnderflowType,
HistogramSeriesOptions.UnderflowValueAllow you to create a bin for all values that are below or equal to a specific value.
HistogramSeriesOptions.IntervalClosedSideSpecifies the bin closed side.

csharp
// Create a histogram chart and specify its location.
Chart chart = worksheet.Charts.Add(ChartType.Histogram, worksheet["B2:B21"]);
chart.TopLeftCell = worksheet.Cells["D2"];
chart.BottomRightCell = worksheet.Cells["K18"];

// Specify histogram series options.
var options = chart.Series[0].LayoutOptions.Histogram;
options.BinType = HistogramBinType.BinWidth;
options.BinWidth = 24;
// Specify the gap width.
chart.Series[0].GapWidth = 10;

// Add the chart title.
chart.Title.Visible = true;
chart.Title.SetValue("Exam Score Distribution");
vb
' Create a histogram chart and specify its location.
Dim chart As Chart = worksheet.Charts.Add(ChartType.Histogram, worksheet("B2:B21"))
chart.TopLeftCell = worksheet.Cells("D2")
chart.BottomRightCell = worksheet.Cells("K18")

' Specify histogram series options.
Dim options As HistogramSeriesOptions = chart.Series(0).LayoutOptions.Histogram
options.BinType = HistogramBinType.BinWidth
options.BinWidth = 24
' Specify the gap width.
chart.Series(0).GapWidth = 10

' Add the chart title.
chart.Title.Visible = True
chart.Title.SetValue("Exam Score Distribution")

Pareto Chart

Use the Series.LayoutOptions.Histogram property to specify bin options for a Pareto data series.

csharp
// Create a Pareto chart and specify its location.
Chart chart = worksheet.Charts.Add(ChartType.Pareto, worksheet["B2:C7"]);
chart.TopLeftCell = worksheet.Cells["E2"];
chart.BottomRightCell = worksheet.Cells["L17"];

// Specify series options.
var options = chart.Series[0].LayoutOptions.Histogram;
options.BinType = HistogramBinType.ByCategory;
// Specify the gap width.
chart.Series[0].GapWidth = 15;

// Add the chart title.
chart.Title.Visible = true;
chart.Title.SetValue("Key Causes of Late Projects");
vb
' Create a Pareto chart and specify its location.
Dim chart As Chart = worksheet.Charts.Add(ChartType.Pareto, worksheet("B2:C7"))
chart.TopLeftCell = worksheet.Cells("E2")
chart.BottomRightCell = worksheet.Cells("L17")

' Specify series options.
Dim options As HistogramSeriesOptions = chart.Series(0).LayoutOptions.Histogram
options.BinType = HistogramBinType.ByCategory
' Specify the gap width.
chart.Series(0).GapWidth = 15

' Add the chart title.
chart.Title.Visible = True
chart.Title.SetValue("Key Causes of Late Projects")

Treemap Chart

Use the Series.LayoutOptions.Treemap property to specify options for a treemap data series.

PropertyDescription
TreemapSeriesOptions.ParentLabelLayoutDefines the layout of parent labels.

csharp
// Create a treemap chart and specify its location.
Chart chart = worksheet.Charts.Add(ChartType.Treemap, worksheet["B2:E14"]);
chart.TopLeftCell = worksheet.Cells["G2"];
chart.BottomRightCell = worksheet.Cells["N17"];

// Specify series options.
var options = chart.Series[0].LayoutOptions.Treemap;
options.ParentLabelLayout = TreemapParentLabelLayout.Banner;

// Add the chart title.
chart.Title.Visible = true;
chart.Title.SetValue("Daily Food Sales");
vb
' Create a treemap chart and specify its location.
Dim chart As Chart = worksheet.Charts.Add(ChartType.Treemap, worksheet("B2:E14"))
chart.TopLeftCell = worksheet.Cells("G2")
chart.BottomRightCell = worksheet.Cells("N17")

' Specify series options.
Dim options As TreemapSeriesOptions = chart.Series(0).LayoutOptions.Treemap
options.ParentLabelLayout = TreemapParentLabelLayout.Banner

' Add the chart title.
chart.Title.Visible = True
chart.Title.SetValue("Daily Food Sales")

See Also

SeriesLayoutOptions Members

DevExpress.Spreadsheet.Charts Namespace