IChartSerie module

class IChartSerie.IChartSerie

Bases: IExcelApplication

<summary>

Represents a series in the chart.

</summary>

abstract property Bubbles: IXLSRange

<summary>

Bubble sizes for the series.

<example>The following code illustrates how to set Bubbles for IChartSerie in charts: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set serie IChartSerie serie = chart.Series.Add(ExcelChartType.Bubble); //Set values and bubble chart range serie.Values = worksheet.Range[“A1:C1”];; serie.Bubbles = worksheet.Range[“A2:C2”]; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property CategoryLabels: IXLSRange

<summary>

Category labels for the series.

<example>The following code illustrates how to set category labels for IChartSerie in charts: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set serie IChartSerie serie = chart.Series.Add(); //Set category labels and values serie.CategoryLabels = worksheet.Range[“A1:C1”]; serie.Values = worksheet.Range[“A2:C2”]; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property DataLabels: IChartDataLabels

abstract property DataPoints: IChartDataPoints

<summary>

Returns collection of data points. Read-only.

<example>The following code illustrates how to access the IChartDataPoints collection from IChartSerie: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set range chart.DataRange = worksheet[“A1:C3”]; //Set data points IChartDataPoints dataPoints = chart.Series[0].DataPoints; //Set data labels value visibility dataPoints.DefaultDataPoint.DataLabels.HasValue = true; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property EnteredDirectlyBubbles: List[SpireObject]

<summary>

Represents bubble values as entered directly.

<example>The following code illustrates how series data for second value axis of ExcelChartType.Bubble charts can be directly given for charts: <code>

//Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set serie IChartSerie serie = chart.Series.Add(ExcelChartType.Bubble); //Set direct values serie.EnteredDirectlyValues = new object[] { 10, 20, 30 }; //Set bubble chart direct values serie.EnteredDirectlyBubbles = new object[] { 1, 4, 2 }; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property EnteredDirectlyCategoryLabels: List[SpireObject]

<summary>

Represents category values as entered directly.

<example>The following code illustrates how series category labels can be directly given for charts: <code>

//Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set serie IChartSerie serie = chart.Series.Add(ExcelChartType.Pie); //Set direct values serie.EnteredDirectlyValues = new object[] { 2000, 1000, 1000 }; //Set direct category label serie.EnteredDirectlyCategoryLabels = new object[] { “Total Income”, “Expenses”, “Profit” }; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property EnteredDirectlyValues: List[SpireObject]

<summary>

Represents value as entered directly.

<example>The following code illustrates how series data can be directly given for charts: <code>

//Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set serie IChartSerie serie = chart.Series.Add(ExcelChartType.Pie); //Set direct values serie.EnteredDirectlyValues = new object[] { 2000, 1000, 1000 }; //Set direct category label serie.EnteredDirectlyCategoryLabels = new object[] { “Total Income”, “Expenses”, “Profit” }; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

ErrorBar

<summary>

Creates error bar object.

<example>The following code illustrates how to set IChartErrorBars on Y-axis of a particular IChartSerie: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set range chart.DataRange = worksheet.Range[“A1:C2”]; //Set error bar chart.Series[0].ErrorBar(true); //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary> <param name=”bIsY”>If true - on Y axis; otherwise on X axis.</param> <returns>Return error bar objcet.</returns>

abstract property ErrorBarsX: IChartErrorBars

<summary>

Represents X error bars. Read only.

<example>The following code illustrates how IChartErrorBars in X-axis can be accessed: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set chart type chart.ChartType = ExcelChartType.ScatterLine; //Set range chart.DataRange = worksheet.Range[“A1:C2”]; //Set error bar chart.Series[0].HasErrorBarsX = true; IChartErrorBars errorBar = chart.Series[0].ErrorBarsX; //Set error bar type errorBar.Type = ErrorBarType.Percentage; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property ErrorBarsY: IChartErrorBars

<summary>

Represents Y error bars. Read only.

<example>The following code illustrates how IChartErrorBars on Y-axis can be accessed: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set chart type chart.ChartType = ExcelChartType.ScatterLine; //Set range chart.DataRange = worksheet.Range[“A1:C2”]; //Set error bar chart.Series[0].HasErrorBarsY = true; IChartErrorBars errorBar = chart.Series[0].ErrorBarsY; //Set error bar type errorBar.Type = ErrorBarType.Percentage; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property Format: IChartSerieDataFormat

<summary>

Returns format of current serie.

<example>The following code illustrates how to access the IChartSerieDataFormat from IChartSerie: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set range chart.DataRange = worksheet[“A1:C2”]; //Set chart type chart.ChartType = ExcelChartType.Line; //Set serie format IChartSerieDataFormat format = chart.Series[0].Format; //Set marker style format.MarkerStyle = ChartMarkerType.Star; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property HasErrorBarsX: bool

<summary>

Indicates if serie contains X error bars.

<example>The following code illustrates how HasErrorBarsX property can be used: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set chart type chart.ChartType = ExcelChartType.ScatterLine; //Set range chart.DataRange = worksheet.Range[“A1:C2”]; //Set error bar chart.Series[0].HasErrorBarsX = true; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property HasErrorBarsY: bool

<summary>

Indicates if serie contains Y error bars.

<example>The following code illustrates how HasErrorBarsY property can be used: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set chart type chart.ChartType = ExcelChartType.ScatterLine; //Set range chart.DataRange = worksheet.Range[“A1:C2”]; //Set error bar chart.Series[0].HasErrorBarsY = true; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property Name: str

<summary>

Name of the series.

<example>The following code illustrates how to access the name of the IChartSerie: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set serie IChartSerie serie = chart.Series.Add(“BarSerie”); //Set category labels and values serie.CategoryLabels = worksheet.Range[“A1:C1”]; serie.Values = worksheet.Range[“A2:C2”]; //Get Serie name Console.Write(serie.Name); //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property NamedRange: CellRange

<summary>

Series Name range for the series.

</summary>

abstract property SerieType: ExcelChartType

<summary>

Represents serie type.

<example>The following code illustrates how to set SerieType for charts: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set range chart.DataRange = worksheet[“A1:C2”]; //Set chart type chart.Series[0].SerieType = ExcelChartType.Line; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property TrendLines: IChartTrendLines

<summary>

Represents serie trend lines collection. Read only.

<example>The following code illustrates how IChartTrendLines collection can be accessed from a particular IChartSerie: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set range chart.DataRange = worksheet.Range[“A1:C2”]; //Set trend line IChartTrendLines trendLines = chart.Series[0].TrendLines; IChartTrendLine trendLine = trendLines.Add(TrendLineType.Linear); //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property UsePrimaryAxis: bool

<summary>

Indicates whether to use primary axis for series drawing.

<example>The following code illustrates how the secondary axis can be used by disabling primary axis: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set range chart.DataRange = worksheet[“A1:C3”]; //Set secondary axis IChartSerie serie = chart.Series[1]; serie.UsePrimaryAxis = false; chart.SecondaryCategoryAxis.Visible = true; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

abstract property Values: IXLSRange

<summary>

Values range for the series.

<example>The following code illustrates how to set values for IChartSerie in charts: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart IChart chart = worksheet.Charts.Add(); //Set serie IChartSerie serie = chart.Series.Add(); //Set category labels and values serie.CategoryLabels = worksheet.Range[“A1:C1”]; serie.Values = worksheet.Range[“A2:C2”]; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>