Series class

Series class

Encapsulates the object that represents a single data series in a chart.

The Series type exposes the following members:

Properties

PropertyDescription
is_filteredIndicates whether the series is selected or filtered.True represents this series is filtered, and it will not be displayed on the chart.
layout_propertiesRepresents the properties of layout.
pointsGets the collection of points in a series in a chart.
areaRepresents the background area of Series object.
borderRepresents border of Series object.
nameGets or sets the name of the data series.
display_nameGets the series’s name that displays on the chart graph.
count_of_data_valuesGets the number of the data values.
is_vertical_valuesIndicates whether the data source is vertical.
valuesRepresents the Y values of this chart series.
values_format_codeRepresents format code of Values’s NumberList.
x_values_format_codeRepresents format code of X Values’s NumberList.
x_valuesRepresents the x values of the chart series.
bubble_sizesGets or sets the bubble sizes values of the chart series.
trend_linesReturns all the trendlines of this series.
smoothRepresents curve smoothing.
True if curve smoothing is turned on for the line chart or scatter chart.
Applies only to line and scatter connected by lines charts.
shadowTrue if the series has a shadow.
has_3d_effectTrue if the series has a three-dimensional appearance.
Applies only to bubble charts.
bar_3d_shape_typeGets or sets the 3D shape type used with the 3-D bar or column chart.
data_labelsRepresents the DataLabels object for the specified ASeries.
typeGets or sets a data series’ type.
markerGets the Series.marker.
plot_on_second_axisIndicates if this series is plotted on second value axis.
x_error_barRepresents X direction error bar of the series.
y_error_barRepresents Y direction error bar of the series.
has_hi_lo_linesTrue if the line chart has high-low lines.
Applies only to line charts.
hi_lo_linesReturns a HiLoLines object that represents the high-low lines for a series on a line chart.
Applies only to line charts.
has_series_linesTrue if a stacked column chart or bar chart has series lines or
if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections.
Applies only to stacked column charts, bar charts, Pie of Pie charts, or Bar of Pie charts.
series_linesReturns a SeriesLines object that represents the series lines for a stacked bar chart or a stacked column chart.
Applies only to stacked bar and stacked column charts.
has_drop_linesTrue if the chart has drop lines.
Applies only to line chart or area charts.
drop_linesReturns a Line object that represents the drop lines for a series on the line chart or area chart.
Applies only to line chart or area charts.
has_up_down_barsTrue if a line chart has up and down bars.
Applies only to line charts.
up_barsReturns an DropBars object that represents the up bars on a line chart.
Applies only to line charts.
down_barsReturns a DropBars object that represents the down bars on a line chart.
Applies only to line charts.
is_color_variedRepresents if the color of points is varied.
The chart must contain only one series.
gap_widthReturns or sets the space between bar or column clusters, as a percentage of the bar or column width.
The value of this property must be between 0 and 500.
first_slice_angleGets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical).
Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.
overlapSpecifies how bars and columns are positioned.
Can be a value between – 100 and 100.
Applies only to 2-D bar and 2-D column charts.
second_plot_sizeReturns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart,
as a percentage of the size of the primary pie.
Can be a value from 5 to 200.
split_typeReturns or sets a value that how to determine which data points are in the second pie or bar on a pie of pie or bar of
pie chart.
split_valueReturns or sets a value that shall be used to determine which data points are in the second pie or bar on
a pie of pie or bar of pie chart.
is_auto_splitIndicates whether the threshold value is automatic.
bubble_scaleGets or sets the scale factor for bubbles in the specified chart group.
It can be an integer value from 0 (zero) to 300,
corresponding to a percentage of the default size.
Applies only to bubble charts.
size_representsGets or sets what the bubble size represents on a bubble chart.
show_negative_bubblesTrue if negative bubbles are shown for the chart group. Valid only for bubble charts.
doughnut_hole_sizeReturns or sets the size of the hole in a doughnut chart group.
The hole size is expressed as a percentage of the chart size, between 10 and 90 percent.
explosionThe distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.
has_radar_axis_labelsTrue if a radar chart has category axis labels. Applies only to radar charts.
has_leader_linesTrue if the series has leader lines.
leader_linesRepresents leader lines on a chart. Leader lines connect data labels to data points.
This object isn’t a collection; there’s no object that represents a single leader line.
legend_entryGets the legend entry according to this series.
shape_propertiesGets the ShapePropertyCollection object that holds the visual shape properties of the Series.

Methods

MethodDescription
moveMoves the series up or down.

Example

from aspose.cells import Workbook
from aspose.cells.charts import ChartMarkerType, ChartType, FormattingType
from aspose.pydrawing import Color

# Instantiating a Workbook object
workbook = Workbook()
# Adding a new worksheet to the Excel object
sheetIndex = workbook.worksheets.add()
# Obtaining the reference of the newly added worksheet by passing its sheet index
worksheet = workbook.worksheets[sheetIndex]
# Adding a sample value to "A1" cell
worksheet.cells.get("A1").put_value(50)
# Adding a sample value to "A2" cell
worksheet.cells.get("A2").put_value(100)
# Adding a sample value to "A3" cell
worksheet.cells.get("A3").put_value(150)
# Adding a sample value to "A4" cell
worksheet.cells.get("A4").put_value(200)
# Adding a sample value to "B1" cell
worksheet.cells.get("B1").put_value(60)
# Adding a sample value to "B2" cell
worksheet.cells.get("B2").put_value(32)
# Adding a sample value to "B3" cell
worksheet.cells.get("B3").put_value(50)
# Adding a sample value to "B4" cell
worksheet.cells.get("B4").put_value(40)
# Adding a sample value to "C1" cell as category data
worksheet.cells.get("C1").put_value("Q1")
# Adding a sample value to "C2" cell as category data
worksheet.cells.get("C2").put_value("Q2")
# Adding a sample value to "C3" cell as category data
worksheet.cells.get("C3").put_value("Y1")
# Adding a sample value to "C4" cell as category data
worksheet.cells.get("C4").put_value("Y2")
# Adding a chart to the worksheet
chartIndex = worksheet.charts.add(ChartType.COLUMN, 5, 0, 15, 5)
# Accessing the instance of the newly added chart
chart = worksheet.charts[chartIndex]
# Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
seriesIndex = chart.n_series.add("A1:B4", True)
# Setting the data source for the category data of NSeries
chart.n_series.category_data = "C1:C4"
series = chart.n_series[seriesIndex]
# Setting the values of the series.
series.values = "=B1:B4"
# Changing the chart type of the series.
series.type = ChartType.LINE
# Setting marker properties.
series.marker.marker_style = ChartMarkerType.CIRCLE
series.marker.foreground_color_set_type = FormattingType.AUTOMATIC
series.marker.foreground_color = Color.black
series.marker.background_color_set_type = FormattingType.AUTOMATIC
# do your business
# Saving the Excel file
workbook.save("book1.xls")

See Also