IChartErrorBars module

class IChartErrorBars.IChartErrorBars

Bases: SpireObject

<summary>

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.

</summary>

property Border: IChartBorder

<summary>

Represents border object. Read only.

<example>The following code illustrates how to access and format the IChartBorder for IChartErrorBars: <code>

//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”); </code> </example>

</summary>

property Chart3DOptions: IFormat3D

<summary>

Gets the chart3 D options.

</summary>

<value>The chart3 D options.</value>

ClearFormats()

<summary>

Clears current error bar.

</summary>

Delete()

<summary>

Delete current error bar.

</summary>

property HasCap: bool

<summary>

Indicates if error bar has cap.

<example>The following code illustrates how to remove end style for IChartErrorBars: <code>

//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”); </code> </example>

</summary>

property Include: ErrorBarIncludeType

<summary>

Reprsents error bar include type.

<example>The following code illustrates how to set include type for IChartErrorBars: <code>

//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”); </code> </example>

</summary>

property MinusRange: IXLSRange

<summary>

Represents custom minus value.

<example>The following code illustrates how to set the minus range for IChartErrorBars: <code>

//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”); </code> </example>

</summary>

property NumberValue: float

<summary>

Represents number value.

<example>The following code illustrates how to set the error value for IChartErrorBars: <code>

//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”); </code> </example>

</summary>

property PlusRange: IXLSRange

<summary>

Represents custom plus value.

<example>The following code illustrates how to set the plus range for IChartErrorBars: <code>

//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”); </code> </example>

</summary>

property Shadow: IShadow

<summary>

Gets the shadow.

<example>The following code illustrates how to access and format the IShadow for IChartErrorBars: <code>

//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”); </code> </example>

</summary>

<value>The shadow.</value>

property Type: ErrorBarType

<summary>

Represents excel error bar type.

<example>The following code illustrates how to set the error bar type for IChartErrorBars: <code>

//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”); </code> </example>

</summary>