Interface IChartErrorBars

Namespace

Spire.Xls.Core

Assembly

Spire.XLS.dll

Represent error bars on the chart series. Error bars indicate the degree of uncertainty for chart data. Only series in area, bar, column, line, and scatter groups on a 2-D chart can have error bars. Only series in scatter groups can have x and y error bars.

public interface IChartErrorBars

Properties

Border

Represents border object. Read only. The following code illustrates how to access and format the IChartBorder for IChartErrorBars:

//Create worksheet
Workbook workbook = new Workbook();
workbook.LoadFromFile("Sample.xlsx");
Worksheet worksheet = workbook.Worksheets[0];

//Create chart and set range
IChart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C3"];

//Set chart type
chart.ChartType = ExcelChartType.ColumnClustered;

//Get chart serie
IChartSerie serie = chart.Series[0];

//Enabling the Y Error bars
serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
IChartErrorBars errorBars = serie.ErrorBarsY;

//Set Error bars border color
errorBars.Border.Color = Color.Red;

//Save to file
workbook.SaveToFile("Chart.xlsx");

IChartBorder Border { get; }

Property Value

IChartBorder

Chart3DOptions

Gets the chart3 D options.

IFormat3D Chart3DOptions { get; }

Property Value

IFormat3D

The chart3 D options.

HasCap

Indicates if error bar has cap. The following code illustrates how to remove end style for IChartErrorBars:

//Create worksheet
Workbook workbook = new Workbook();
workbook.LoadFromFile("Sample.xlsx");
Worksheet worksheet = workbook.Worksheets[0];

//Create chart and set range
IChart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C3"];

//Set chart type
chart.ChartType = ExcelChartType.ColumnClustered;

//Get chart serie
IChartSerie serie = chart.Series[0];

//Enabling the Y Error bars
serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
IChartErrorBars errorBars = serie.ErrorBarsY;

//Set false to remove the end style
errorBars.HasCap = false;

//Save to file
workbook.SaveToFile("Chart.xlsx");

bool HasCap { get; set; }

Property Value

bool

Include

Reprsents error bar include type. The following code illustrates how to set include type for IChartErrorBars:

//Create worksheet
Workbook workbook = new Workbook();
workbook.LoadFromFile("Sample.xlsx");
Worksheet worksheet = workbook.Worksheets[0];

//Create chart and set range
IChart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C3"];

//Set chart type
chart.ChartType = ExcelChartType.ColumnClustered;

//Get chart serie
IChartSerie serie = chart.Series[0];

//Enabling the Y Error bars
serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
IChartErrorBars errorBars = serie.ErrorBarsY;

//Set negative error only to include
errorBars.Include = ErrorBarIncludeType.Minus;

//Save to file
workbook.SaveToFile("Chart.xlsx");

ErrorBarIncludeType Include { get; set; }

Property Value

ErrorBarIncludeType

MinusRange

Represents custom minus value. The following code illustrates how to set the minus range for IChartErrorBars:

//Create worksheet
Workbook workbook = new Workbook();
workbook.LoadFromFile("Sample.xlsx");
Worksheet worksheet = workbook.Worksheets[0];

//Create chart and set range
IChart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C3"];

//Set chart type
chart.ChartType = ExcelChartType.ColumnClustered;

//Get chart serie
IChartSerie serie = chart.Series[0];

//Enabling the Y Error bars
serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
IChartErrorBars errorBars = serie.ErrorBarsY;

//Set minus range
errorBars.MinusRange = worksheet["D2"];

//Save to file
workbook.SaveToFile("Chart.xlsx");

IXLSRange MinusRange { get; set; }

Property Value

IXLSRange

NumberValue

Represents number value. The following code illustrates how to set the error value for IChartErrorBars:

//Create worksheet
Workbook workbook = new Workbook();
workbook.LoadFromFile("Sample.xlsx");
Worksheet worksheet = workbook.Worksheets[0];

//Create chart and set range
IChart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C3"];

//Set chart type
chart.ChartType = ExcelChartType.ColumnClustered;

//Get chart serie
IChartSerie serie = chart.Series[0];

//Enabling the Y Error bars
serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
IChartErrorBars errorBars = serie.ErrorBarsY;

//Set error value
errorBars.NumberValue = 3.0;

//Save to file
workbook.SaveToFile("Chart.xlsx");

double NumberValue { get; set; }

Property Value

double

PlusRange

Represents custom plus value. The following code illustrates how to set the plus range for IChartErrorBars:

//Create worksheet
Workbook workbook = new Workbook();
workbook.LoadFromFile("Sample.xlsx");
Worksheet worksheet = workbook.Worksheets[0];

//Create chart and set range
IChart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C3"];

//Set chart type
chart.ChartType = ExcelChartType.ColumnClustered;

//Get chart serie
IChartSerie serie = chart.Series[0];

//Enabling the Y Error bars
serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
IChartErrorBars errorBars = serie.ErrorBarsY;

//Set plus range
errorBars.PlusRange = worksheet["D2"];

//Save to file
workbook.SaveToFile("Chart.xlsx");

IXLSRange PlusRange { get; set; }

Property Value

IXLSRange

Shadow

Gets the shadow. The following code illustrates how to access and format the IShadow for IChartErrorBars:

//Create worksheet
Workbook workbook = new Workbook();
workbook.LoadFromFile("Sample.xlsx");
Worksheet worksheet = workbook.Worksheets[0];

//Create chart and set range
IChart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C3"];

//Set chart type
chart.ChartType = ExcelChartType.ColumnClustered;

//Get chart serie
IChartSerie serie = chart.Series[0];

//Enabling the Y Error bars
serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
IChartErrorBars errorBars = serie.ErrorBarsY;

//Set Error bars shadow color
errorBars.Shadow.Color = Color.Red;

//Set Error bars shadow outer presets
errorBars.Shadow.ShadowOuterType = XLSXChartShadowOuterType.OffsetDiagonalTopRight;

//Save to file
workbook.SaveToFile("Chart.xlsx");

IShadow Shadow { get; }

Property Value

IShadow

The shadow.

Type

Represents excel error bar type. The following code illustrates how to set the error bar type for IChartErrorBars:

//Create worksheet
Workbook workbook = new Workbook();
workbook.LoadFromFile("Sample.xlsx");
Worksheet worksheet = workbook.Worksheets[0];

//Create chart and set range
IChart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C3"];

//Set chart type
chart.ChartType = ExcelChartType.ColumnClustered;

//Get chart serie
IChartSerie serie = chart.Series[0];

//Enabling the Y Error bars
serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
IChartErrorBars errorBars = serie.ErrorBarsY;

//Set error amount to standard deviation
errorBars.Type = ErrorBarType.StandardDeviation;

//Save to file
workbook.SaveToFile("Chart.xlsx");

ErrorBarType Type { get; set; }

Property Value

ErrorBarType

Methods

ClearFormats()

Clears current error bar.

void ClearFormats()

Delete()

Delete current error bar.

void Delete()