Shared chart properties¶
Set the properties that several kinds of chart share.
ChartCommon¶
-
class creator_studio_doc_format.core.ChartCommon(*, preset_identifier=
'', area3Dchart=None, areaChart=None, bar3Dchart=None, barChart=None, barInteractiveChart=None, bubbleChart=None, bubbleInteractiveChart=None, column3Dchart=None, columnChart=None, columnInteractiveChart=None, donutChart=None, genericChartCommon=None, line3Dchart=None, lineChart=None, mixedChart=None, pie3Dchart=None, pieChart=None, radarChart=None, scatterChart=None, scatterInteractiveChart=None, stackedArea3Dchart=None, stackedAreaChart=None, stackedBar3Dchart=None, stackedBarChart=None, stackedColumn3Dchart=None, stackedColumnChart=None, twoAxisChart=None, **extra_data)[source]¶ The properties shared by every kind of chart.
These are the data grid, the styling for each series, the ordered series styles in
chart_colors, the legend, and the title and caption fromTitleOwningandCaptionOwning. Axes come fromCategoryComparisonChartorCorrelationChartinstead. When a chart is read, it takes its style from the theme’s first chart style, and that style supplies any styling the chart doesn’t set. A chart uses the title as its own built-in title and adoptsTitleOwningalone rather thanPlaceableTitleOwning, because it lays out that title itself, and the format offers no placement control over it.-
field area3Dchart : Area3DChart | None =
None¶
-
field bar3Dchart : Bar3DChart | None =
None¶
-
field barInteractiveChart : BarInteractiveChart | None =
None¶
-
field bubbleChart : BubbleChart | None =
None¶
-
field bubbleInteractiveChart : BubbleInteractiveChart | None =
None¶
-
field column3Dchart : Column3DChart | None =
None¶
-
field columnChart : ColumnChart | None =
None¶
-
field columnInteractiveChart : ColumnInteractiveChart | None =
None¶
-
field donutChart : DonutChart | None =
None¶
-
field genericChartCommon : GenericChartCommon | None =
None¶
-
field line3Dchart : Line3DChart | None =
None¶
-
field mixedChart : MixedChart | None =
None¶
-
field pie3Dchart : Pie3DChart | None =
None¶
-
field radarChart : RadarChart | None =
None¶
-
field scatterChart : ScatterChart | None =
None¶
-
field scatterInteractiveChart : ScatterInteractiveChart | None =
None¶
-
field stackedArea3Dchart : StackedArea3DChart | None =
None¶
-
field stackedAreaChart : StackedAreaChart | None =
None¶
-
field stackedBar3Dchart : StackedBar3DChart | None =
None¶
-
field stackedBarChart : StackedBarChart | None =
None¶
-
field stackedColumn3Dchart : StackedColumn3DChart | None =
None¶
-
field stackedColumnChart : StackedColumnChart | None =
None¶
-
field twoAxisChart : TwoAxisChart | None =
None¶
-
field area3Dchart : Area3DChart | None =
ChartColor¶
-
class creator_studio_doc_format.core.ChartColor(*, preset_identifier=
'', fill=None, **extra_data)[source]¶ One entry in a chart’s series styles.
An entry carries only a fill; a series’ stroke isn’t part of the list.
GenericChartCommon¶
-
class creator_studio_doc_format.core.GenericChartCommon(*, preset_identifier=
'', title=None, caption=None, data=None, show_legend=True, legend=None, series=None, chart_colors=None, **extra_data)[source]¶ A stand-in for a chart, when the reader doesn’t recognize its kind.
Every set of shared properties has one, to stand in for an object whose kind isn’t recognized. Nothing in the format has the type
ChartCommon, though, so this object never appears in a document; its properties appear only as part of the types that adoptChartCommon.-
field caption : Label | None =
None¶ The object’s caption, which Keynote always places below the object. If a caption is off, you still write it out with
Label.is_visibleset tofalse, so having a value doesn’t mean the caption shows.
-
field data : ChartData | None =
None¶ The chart’s data grid, together with its plot direction and data-source mode. This data replaces the placeholder data a new chart starts with; when omitted, that placeholder data remains.
-
field show_legend : bool =
True¶ A Boolean value that indicates whether the chart’s legend appears. This value is independent of the
legendproperty, which sets the legend’s placement and text style rather than its visibility.
-
field legend : ChartLegend | None =
None¶ The placement and label text style of the chart’s legend. This value doesn’t control whether the legend appears (see
show_legend), and it only applies to a chart that has a legend.
-
field series : list[ChartSeries] | None =
None¶ The styling and label formatting for individual data series. Each entry applies to the series named by its
ChartSeries.series_index, or to the series at the same position whenChartSeries.series_indexis omitted; entries that don’t correspond to a series in the data don’t have an effect.
-
field chart_colors : list[ChartColor] | None =
None¶ The chart’s ordered series styles. A series takes the entry at its own position, and the chart’s style supplies any position without an entry or with an empty one, so the list doesn’t wrap. Entries past the last series also remain. Keynote reads one entry for each series style in the chart’s style and ignores any further entries.
-
field caption : Label | None =
CategoryComparisonChart¶
-
class creator_studio_doc_format.core.CategoryComparisonChart(*, preset_identifier=
'', area3Dchart=None, areaChart=None, bar3Dchart=None, barChart=None, barInteractiveChart=None, column3Dchart=None, columnChart=None, columnInteractiveChart=None, genericCategoryComparisonChart=None, line3Dchart=None, lineChart=None, mixedChart=None, radarChart=None, stackedArea3Dchart=None, stackedAreaChart=None, stackedBar3Dchart=None, stackedBarChart=None, stackedColumn3Dchart=None, stackedColumnChart=None, twoAxisChart=None, **extra_data)[source]¶ The axes shared by every chart type that compares categories against a value scale.
These chart types are the column, bar, line, and area charts; their stacked, 3D, and interactive variants; and the mixed, radar, and two-axis charts.
-
field area3Dchart : Area3DChart | None =
None¶
-
field bar3Dchart : Bar3DChart | None =
None¶
-
field barInteractiveChart : BarInteractiveChart | None =
None¶
-
field column3Dchart : Column3DChart | None =
None¶
-
field columnChart : ColumnChart | None =
None¶
-
field columnInteractiveChart : ColumnInteractiveChart | None =
None¶
-
field genericCategoryComparisonChart : GenericCategoryComparisonChart | None =
None¶
-
field line3Dchart : Line3DChart | None =
None¶
-
field mixedChart : MixedChart | None =
None¶
-
field radarChart : RadarChart | None =
None¶
-
field stackedArea3Dchart : StackedArea3DChart | None =
None¶
-
field stackedAreaChart : StackedAreaChart | None =
None¶
-
field stackedBar3Dchart : StackedBar3DChart | None =
None¶
-
field stackedBarChart : StackedBarChart | None =
None¶
-
field stackedColumn3Dchart : StackedColumn3DChart | None =
None¶
-
field stackedColumnChart : StackedColumnChart | None =
None¶
-
field twoAxisChart : TwoAxisChart | None =
None¶
-
field area3Dchart : Area3DChart | None =
GenericCategoryComparisonChart¶
-
class creator_studio_doc_format.core.GenericCategoryComparisonChart(*, preset_identifier=
'', category_axis=None, value_axis=None, value_axis_secondary=None, **extra_data)[source]¶ A stand-in for a chart that compares categories against a value scale, when the reader doesn’t recognize its kind.
Every set of shared properties has one, to stand in for an object whose kind isn’t recognized. Nothing in the format has the type
CategoryComparisonChart, though, so this object never appears in a document; its properties appear only as part of the types that adoptCategoryComparisonChart.-
field category_axis : ChartCategoryAxis | None =
None¶ The category axis, along which Keynote lays out the chart’s categories. When omitted, the category axis keeps the appearance it inherits from the chart’s style.
-
field value_axis : ChartValueAxis | None =
None¶ The primary value axis, which carries the numeric scale to measure the series against. When omitted, the value axis keeps the appearance it inherits from the chart’s style.
-
field value_axis_secondary : ChartValueAxis | None =
None¶ The second value axis, used only by a two-axis chart that actually plots a series against a second value scale. On any other chart type, this value doesn’t have an effect.
-
field category_axis : ChartCategoryAxis | None =
CorrelationChart¶
-
class creator_studio_doc_format.core.CorrelationChart(*, preset_identifier=
'', bubbleChart=None, bubbleInteractiveChart=None, genericCorrelationChart=None, scatterChart=None, scatterInteractiveChart=None, **extra_data)[source]¶ The axes shared by every chart type that plots one value scale against another.
These chart types are the scatter and bubble charts and their interactive variants. They have an X and a Y value axis and no category axis.
-
field bubbleChart : BubbleChart | None =
None¶
-
field bubbleInteractiveChart : BubbleInteractiveChart | None =
None¶
-
field genericCorrelationChart : GenericCorrelationChart | None =
None¶
-
field scatterChart : ScatterChart | None =
None¶
-
field scatterInteractiveChart : ScatterInteractiveChart | None =
None¶
-
field bubbleChart : BubbleChart | None =
GenericCorrelationChart¶
-
class creator_studio_doc_format.core.GenericCorrelationChart(*, preset_identifier=
'', value_axis_x=None, value_axis_y=None, **extra_data)[source]¶ A stand-in for a chart that plots one value scale against another, when the reader doesn’t recognize its kind.
Every set of shared properties has one, to stand in for an object whose kind isn’t recognized. Nothing in the format has the type
CorrelationChart, though, so this object never appears in a document; its properties appear only as part of the types that adoptCorrelationChart.-
field value_axis_x : ChartValueAxis | None =
None¶ The horizontal (X) value axis. When omitted, the X axis keeps the appearance it inherits from the chart’s style.
-
field value_axis_y : ChartValueAxis | None =
None¶ The vertical (Y) value axis. When omitted, the Y axis keeps the appearance it inherits from the chart’s style.
-
field value_axis_x : ChartValueAxis | None =
ChartLabelFormatting¶
-
class creator_studio_doc_format.core.ChartLabelFormatting(*, preset_identifier=
'', chartCategoryAxis=None, chartSeries=None, chartValueAxis=None, genericChartLabelFormatting=None, **extra_data)[source]¶ The formatting of a chart element’s numeric labels.
It’s flattened into
ChartValueAxis,ChartCategoryAxis, andChartSeries.label_format_typeselects which of the format properties applies. A prefix or suffix, a fraction accuracy, and a custom format string aren’t preserved.-
field chartCategoryAxis : ChartCategoryAxis | None =
None¶
-
field chartSeries : ChartSeries | None =
None¶
-
field chartValueAxis : ChartValueAxis | None =
None¶
-
field genericChartLabelFormatting : GenericChartLabelFormatting | None =
None¶
-
field chartCategoryAxis : ChartCategoryAxis | None =
GenericChartLabelFormatting¶
-
class creator_studio_doc_format.core.GenericChartLabelFormatting(*, preset_identifier=
'', label_format_type=None, label_date_format=None, label_duration_format=None, label_number_format=None, label_currency_format=None, **extra_data)[source]¶ A stand-in for a chart’s numeric label formatting, when the reader doesn’t recognize its kind.
Every set of shared properties has one, to stand in for an object whose kind isn’t recognized. Nothing in the format has the type
ChartLabelFormatting, though, so this object never appears in a document; its properties appear only as part of the types that adoptChartLabelFormatting.-
field label_format_type : FormatType | None =
None¶ The kind of formatting applied to the label’s value. It also selects which of
label_number_format,label_currency_format,label_date_format, andlabel_duration_formatapplies.text,boolean, andbasehave no equivalent for chart labels and behave likenumber, which is also what omitting this property means.
-
field label_date_format : DateTimeFormat | None =
None¶ The date and time format of the label, used when
label_format_typeisdate_time. An empty format string is treated as no format at all and isn’t preserved.
-
field label_duration_format : DurationFormat | None =
None¶ The label’s duration format, used when
label_format_typeisduration. It covers automatic units, the smallest and largest unit, and the style.
-
field label_number_format : NumberFormat | None =
None¶ The decimal places, negative-number style, and thousands separator of the label, used for number, percentage, and scientific labels. A value of 253 for decimal places means automatic. It’s omitted for fraction, base, and custom labels, which have none of these attributes; a prefix or suffix, a fraction accuracy, and a custom format string aren’t preserved. Currency labels use
label_currency_formatinstead. On a stacked chart whose value axis has aChartValueAxis.scaleofpercent, the value labels of each series don’t use this format, and their decimal places, negative-number style, and thousands separator aren’t preserved.
-
field label_currency_format : CurrencyFormat | None =
None¶ The currency code, accounting style, decimal places, negative-number style, and thousands separator of the label, used when
label_format_typeiscurrency. It takes the place oflabel_number_formatfor currency labels, and it’s what preserves the currency code; a prefix or suffix and a custom format string aren’t preserved.
-
field label_format_type : FormatType | None =