ChartType enumeration

ChartType enumeration

Specifies type of a chart.

Members

NameDescription
AREAArea chart.
AREA_STACKEDStacked Area chart.
AREA_PERCENT_STACKED100% Stacked Area chart.
AREA_3D3D Area chart.
AREA_3D_STACKED3D Stacked Area chart.
AREA_3D_PERCENT_STACKED3D 100% Stacked Area chart.
BARBar chart.
BAR_STACKEDStacked Bar chart.
BAR_PERCENT_STACKED100% Stacked Bar chart.
BAR_3D3D Bar chart.
BAR_3D_STACKED3D Stacked Bar chart.
BAR_3D_PERCENT_STACKED3D 100% Stacked Bar chart.
BUBBLEBubble chart.
BUBBLE_3D3D Bubble chart.
COLUMNColumn chart.
COLUMN_STACKEDStacked Column chart.
COLUMN_PERCENT_STACKED100% Stacked Column chart.
COLUMN_3D3D Column chart.
COLUMN_3D_STACKED3D Stacked Column chart.
COLUMN_3D_PERCENT_STACKED3D 100% Stacked Column chart.
COLUMN_3D_CLUSTERED3D Clustered Column chart.
DOUGHNUTDoughnut chart.
LINELine chart.
LINE_STACKEDStacked Line chart.
LINE_PERCENT_STACKED100% Stacked Line chart.
LINE_3D3D Line chart.
PIEPie chart.
PIE_3D3D Pie chart.
PIE_OF_BARPie of Bar chart.
PIE_OF_PIEPie of Pie chart.
RADARRadar chart.
SCATTERScatter chart.
STOCKStock chart.
SURFACESurface chart.
SURFACE_3D3D Surface chart.
TREEMAPTreemap chart.
SUNBURSTSunburst chart.
HISTOGRAMHistogram chart.
PARETOPareto chart.
BOX_AND_WHISKERBox and Whisker chart.
WATERFALLWaterfall chart.
FUNNELFunnel chart.

Examples

Shows how to create an appropriate type of chart series for a graph type.

def chart_series_collection():
    doc = aw.Document()
    builder = aw.DocumentBuilder(doc)
    # There are several ways of populating a chart's series collection.
    # Different series schemas are intended for different chart types.
    # 1 -  Column chart with columns grouped and banded along the X-axis by category:
    chart = append_chart(builder, aw.drawing.charts.ChartType.COLUMN, 500, 300)
    categories = ['Category 1', 'Category 2', 'Category 3']
    # Insert two series of decimal values containing a value for each respective category.
    # This column chart will have three groups, each with two columns.
    chart.series.add('Series 1', categories, [76.6, 82.1, 91.6])
    chart.series.add('Series 2', categories, [64.2, 79.5, 94.0])
    # Categories are distributed along the X-axis, and values are distributed along the Y-axis.
    self.assertEqual(aw.drawing.charts.ChartAxisType.CATEGORY, chart.axis_x.type)
    self.assertEqual(aw.drawing.charts.ChartAxisType.VALUE, chart.axis_y.type)
    # 2 -  Area chart with dates distributed along the X-axis:
    chart = append_chart(builder, aw.drawing.charts.ChartType.AREA, 500, 300)
    dates = [date(2014, 3, 31), date(2017, 1, 23), date(2017, 6, 18), date(2019, 11, 22), date(2020, 9, 7)]
    # Insert a series with a decimal value for each respective date.
    # The dates will be distributed along a linear X-axis,
    # and the values added to this series will create data points.
    chart.series.add('Series 1', dates=dates, values=[15.8, 21.5, 22.9, 28.7, 33.1])
    self.assertEqual(aw.drawing.charts.ChartAxisType.CATEGORY, chart.axis_x.type)
    self.assertEqual(aw.drawing.charts.ChartAxisType.VALUE, chart.axis_y.type)
    # 3 -  2D scatter plot:
    chart = append_chart(builder, aw.drawing.charts.ChartType.SCATTER, 500, 300)
    # Each series will need two decimal arrays of equal length.
    # The first array contains X-values, and the second contains corresponding Y-values
    # of data points on the chart's graph.
    chart.series.add('Series 1', x_values=[3.1, 3.5, 6.3, 4.1, 2.2, 8.3, 1.2, 3.6], y_values=[3.1, 6.3, 4.6, 0.9, 8.5, 4.2, 2.3, 9.9])
    chart.series.add('Series 2', x_values=[2.6, 7.3, 4.5, 6.6, 2.1, 9.3, 0.7, 3.3], y_values=[7.1, 6.6, 3.5, 7.8, 7.7, 9.5, 1.3, 4.6])
    self.assertEqual(aw.drawing.charts.ChartAxisType.VALUE, chart.axis_x.type)
    self.assertEqual(aw.drawing.charts.ChartAxisType.VALUE, chart.axis_y.type)
    # 4 -  Bubble chart:
    chart = append_chart(builder, aw.drawing.charts.ChartType.BUBBLE, 500, 300)
    # Each series will need three decimal arrays of equal length.
    # The first array contains X-values, the second contains corresponding Y-values,
    # and the third contains diameters for each of the graph's data points.
    chart.series.add('Series 1', [1.1, 5.0, 9.8], [1.2, 4.9, 9.9], [2.0, 4.0, 8.0])
    doc.save(ARTIFACTS_DIR + 'Charts.chart_series_collection.docx')

def append_chart(builder: aw.DocumentBuilder, chart_type: aw.drawing.charts.ChartType, width: float, height: float) -> aw.drawing.charts.Chart:
    """Insert a chart using a document builder of a specified ChartType, width and height, and remove its demo data."""
    chart_shape = builder.insert_chart(chart_type, width, height)
    chart = chart_shape.chart
    chart.series.clear()
    return chart

See Also

ChartTitle class ChartXValue class