Chart

class Chart(name_or_index=None)

The chart object is a member of the charts collection:

>>> import xlwings as xw
>>> sheet = xw.books['Book1'].sheets[0]
>>> sheet.charts[0]  # or sheet.charts['ChartName']
<Chart 'Chart 1' in Sheet1>
property api: Any

Returns the native object (pywin32 or appscript obj) of the engine being used.

Added in version 0.9.0.

property category_axis: ChartAxis

Returns the chart’s primary category axis.

Added in version 0.37.5.

property chart_type: str

Returns and sets the chart type of the chart. The following chart types are available:

3d_area, 3d_area_stacked, 3d_area_stacked_100, 3d_bar_clustered, 3d_bar_stacked, 3d_bar_stacked_100, 3d_column, 3d_column_clustered, 3d_column_stacked, 3d_column_stacked_100, 3d_line, 3d_pie, 3d_pie_exploded, area, area_stacked, area_stacked_100, bar_clustered, bar_of_pie, bar_stacked, bar_stacked_100, bubble, bubble_3d_effect, column_clustered, column_stacked, column_stacked_100, combination, cone_bar_clustered, cone_bar_stacked, cone_bar_stacked_100, cone_col, cone_col_clustered, cone_col_stacked, cone_col_stacked_100, cylinder_bar_clustered, cylinder_bar_stacked, cylinder_bar_stacked_100, cylinder_col, cylinder_col_clustered, cylinder_col_stacked, cylinder_col_stacked_100, doughnut, doughnut_exploded, line, line_markers, line_markers_stacked, line_markers_stacked_100, line_stacked, line_stacked_100, pie, pie_exploded, pie_of_pie, pyramid_bar_clustered, pyramid_bar_stacked, pyramid_bar_stacked_100, pyramid_col, pyramid_col_clustered, pyramid_col_stacked, pyramid_col_stacked_100, radar, radar_filled, radar_markers, stock_hlc, stock_ohlc, stock_vhlc, stock_vohlc, surface, surface_top_view, surface_top_view_wireframe, surface_wireframe, xy_scatter, xy_scatter_lines, xy_scatter_lines_no_markers, xy_scatter_smooth, xy_scatter_smooth_no_markers

Added in version 0.1.1.

delete()

Deletes the chart.

async get_png()

Fetch the chart as a base64-encoded PNG, on demand.

Returns the image data rather than writing a file, which is what to_png() does.

Requires xlwings Lite.

Return type:

str

async get_series()

Fetches the chart’s current ordered series collection.

A newly created chart must first be dispatched with await book.flush() so Excel can create its series from the source data.

Requires xlwings Lite.

Added in version 0.37.5.

Return type:

ChartSeriesCollection

property height: float

Returns or sets the number of points that represent the height of the chart.

property left: float

Returns or sets the number of points that represent the horizontal position of the chart.

property legend: ChartLegend

Returns the ChartLegend of the chart.

>>> chart.legend.visible = True
>>> chart.legend.position = "bottom"

Added in version 0.37.3.

property name: str

Returns or sets the name of the chart.

property parent: Sheet

Returns the parent of the chart.

Added in version 0.9.0.

property plot_by: str

Returns or sets whether the data series come from the rows or from the columns of the source data: either "rows" or "columns".

On xlwings Lite and xlwings Server, reading it only works after it has been set in the same script, either via this property or via set_source_data(plot_by=...).

Added in version 0.37.3.

property series: ChartSeriesCollection

Returns the chart’s ordered series collection.

In xlwings Lite, use get_series() before inspecting or indexing the collection.

Added in version 0.37.5.

set_source_data(source, plot_by=None)

Sets the source data range for the chart.

Parameters:

  • source (Range) – Range object, e.g. xw.books['Book1'].sheets[0].range('A1')

  • plot_by (str | None) – Whether the data series come from the "rows" or from the "columns" of the source range. Defaults to letting Excel decide. New in version 0.37.3.

set_x_axis_values(source)

Sets the x-axis values (category labels) for every series in the chart.

This is useful when Excel would otherwise interpret a numeric category column as another data series. Create the chart from the value columns, then assign the category column separately:

chart = sheet.charts.add(
    source=sheet["B1:B11"],
    chart_type="line",
    plot_by="columns",
)
chart.set_x_axis_values(sheet["A2:A11"])
Parameters:

source (Range) – Range containing one x-axis value or category label per data point. Do not include the header cell.

property style: int

Returns or sets the built-in chart style.

Valid values are the legacy styles from 1 to 48 and the modern styles from 201 to 248. The style numbers shown by Excel’s chart gallery can differ from the values exposed by the object model; use the value produced by Excel’s macro recorder to reproduce a gallery style.

On xlwings Lite and xlwings Server, reading it only works after it has been set in the same script.

Added in version 0.37.3.

property title: str | None

Returns or sets the chart title. Setting it to None hides the title, setting it to a string shows it.

>>> chart.title = "Sales 2026"
>>> chart.title = None  # hides the title

On xlwings Lite and xlwings Server, reading the title only works after it has been set in the same script.

Added in version 0.37.3.

to_pdf(path=None, show=None, quality='standard')

Exports the chart as PDF.

Parameters:

  • path (str | PathLike[str] | None) – Path where you want to store the pdf. Defaults to the name of the chart in the same directory as the Excel file if the Excel file is stored and to the current working directory otherwise.

  • show (bool | None) – Once created, open the PDF file with the default application.

  • quality (str) – Quality of the PDF file. Can either be 'standard' or 'minimum'.

Return type:

str

Added in version 0.26.2.

to_png(path=None)

Exports the chart as PNG picture.

Parameters:

path (str | PathLike[str] | None) – Path where you want to store the picture. Defaults to the name of the chart in the same directory as the Excel file if the Excel file is stored and to the current working directory otherwise.

Added in version 0.24.8.

property top: float

Returns or sets the number of points that represent the vertical position of the chart.

property value_axis: ChartAxis

Returns the chart’s primary value axis.

Added in version 0.37.5.

property width: float

Returns or sets the number of points that represent the width of the chart.