Paper Office
paper-pptxAPI referencechart.chart

Chart

paper-pptx 0.2.0 API reference

A chart object.

Chart(chartSpace, chart_part)

Attributes

category_axis

attributecategory_axis

The category axis of this chart. In the case of an XY or Bubble chart, this is the X axis. Raises ValueError if no category axis is defined (as is the case for a pie chart, for example).

chart_style

attributechart_style

Read/write integer index of chart style used to format this chart. Range is from 1 to 48. Value is None if no explicit style has been assigned, in which case the default chart style is used. Assigning None causes any explicit setting to be removed. The integer index corresponds to the style's position in the chart style gallery in the PowerPoint UI.

chart_title

attributechart_title

A ChartTitle object providing access to title properties.

Calling this property is destructive in the sense it adds a chart title element (c:title) to the chart XML if one is not already present. Use :attr:has_title to test for presence of a chart title non-destructively.

chart_type

attributechart_type

Member of :ref:XlChartType enumeration specifying type of this chart.

If the chart has two plots, for example, a line plot overlayed on a bar plot, the type reported is for the first (back-most) plot. Read-only.

element

attributeelement

The lxml element proxied by this object.

font

attributefont

Font object controlling text format defaults for this chart.

has_legend

attributehas_legend

Read/write boolean, True if the chart has a legend. Assigning True causes a legend to be added to the chart if it doesn't already have one. Assigning False removes any existing legend definition along with any existing legend settings.

has_title

attributehas_title

Read/write boolean, specifying whether this chart has a title.

Assigning True causes a title to be added if not already present. Assigning False removes any existing title along with its text and settings.

legend

attributelegend

A Legend object providing access to the properties of the legend for this chart.

part

attributepartXmlPart

The package part containing this object.

plots

attributeplots

The sequence of plots in this chart. A plot, called a chart group in the Microsoft API, is a distinct sequence of one or more series depicted in a particular charting type. For example, a chart having a series plotted as a line overlaid on three series plotted as columns would have two plots; the first corresponding to the three column series and the second to the line series. Plots are sequenced in the order drawn, i.e. back-most to front-most. Supports len(), membership (e.g. p in plots), iteration, slicing, and indexed access (e.g. plot = plots[i]).

series

attributeseries

A SeriesCollection object containing all the series in this chart. When the chart has multiple plots, all the series for the first plot appear before all those for the second, and so on. Series within a plot have an explicit ordering and appear in that sequence.

value_axis

attributevalue_axis

The ValueAxis object providing access to properties of the value axis of this chart. Raises ValueError if the chart has no value axis.

Functions

replace_data

funcreplace_data(chart_data)

Use the categories and series values in the ChartData object chart_data to replace those in the XML and Excel worksheet for this chart.

paramchart_data

replace_data_safe

funcreplace_data_safe(categories, series, *, number_format=None)

Validate categories/series fully, then route to :meth:replace_data.

paper-pptx addition: the safety-and-addressing wrapper over the existing replacement mechanism. categories is a sequence of str; series is a sequence of (name, values) pairs where each values is a sequence of numbers (or None for a missing point) exactly as long as categories.

Data-shape problems raise ValueError (programmer error). Structural refusals (UnsupportedStructureError, document untouched): a chart type outside the supported category-chart families (XY/bubble/stock/surface/radar and 3-D variants are not supported) or a multi-plot (combo) chart. Charts without an embedded workbook (e.g. LibreOffice/Google-authored) are supported: their chart XML is rewritten and the (absent) workbook update is skipped.

paramcategories
paramseries
paramnumber_format
= None

On this page