is_hidden property

ChartLegendEntry.is_hidden property

Gets or sets a value indicating whether this entry is hidden in the chart legend. The default value is false.

@property
def is_hidden(self) -> bool:
    ...

@is_hidden.setter
def is_hidden(self, value: bool):
    ...

Remarks

When a chart legend entry is hidden, it does not affect the corresponding chart series or trendline that is still displayed on the chart.

Examples

Shows how to work with a legend entry for chart series.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)

shape = builder.insert_chart(awdc.ChartType.COLUMN, 432, 252)

chart = shape.chart
series = chart.series
series.clear()

categories = ["AW Category 1", "AW Category 2"]
series1 = series.add("Series 1", categories, [1, 2])
series.add("Series 2", categories, [3, 4])
series.add("Series 3", categories, [5, 6])
series.add("Series 4", categories, [0, 0])

legend_entries = chart.legend.legend_entries
legend_entries[3].is_hidden = True

doc.save(ARTIFACTS_DIR + "Charts.LegendEntries.docx")

See Also

ChartLegendEntry.font property