Themes and styles

Apply a theme and the named styles that a presentation’s objects and text refer to.

KeynoteTheme

class creator_studio_doc_format.core.KeynoteTheme(*, preset_identifier='', name=None, locale=None, slide_layouts=None, **extra_data)[source]

The Keynote theme a presentation is based on.

A theme provides the presentation’s default slide layouts, styles, and background. It’s chosen by its name, as shown in Keynote, and slide_layouts can replace the layouts it provides.

field name : str | None = None

The name of the theme to base the presentation on, as shown in Keynote’s theme chooser (for example, White or Gradient). Because the name is localized, pair it with locale. Themes in My Themes are matched before built-in ones, and a name that matches nothing, like an absent name, falls back to the White theme. When Keynote exports a presentation whose custom theme isn’t in My Themes, it writes White here, so the presentation opens in the White theme even where that theme is available.

field locale : str | None = None

The locale of the theme name given in name. If it’s absent, the system locale is used. The value is a BCP 47 language identifier, such as en_US or en-u-nu-thai-ca-buddhist, or an ICU-style identifier, such as en@calendar=buddhist;numbers=thai.

field slide_layouts : list[SlideLayout] | None = None

The slide layouts to use in place of the ones the theme provides. If it’s present, the list replaces the theme’s own layouts entirely and must contain at least one entry. Each entry’s name must be unique within the theme, because a slide selects its layout by identifier or name. If it’s absent, it defaults to the theme’s layouts.

Constraints:
  • min_length = 1

Stylesheet

class creator_studio_doc_format.core.Stylesheet(*, preset_identifier='', line_styles=None, shape_styles=None, textbox_styles=None, image_styles=None, movie_styles=None, table_style_collections=None, character_styles=None, paragraph_styles=None, list_styles=None, **extra_data)[source]

A collection of styles to use as presets for various objects in a document.

field line_styles : list[ShapeStyle] | None = None

The preset styles that you can apply to lines and connection lines. If you omit this property, it defaults to the document’s built-in line styles.

field shape_styles : list[ShapeStyle] | None = None

The preset styles that you can apply to shapes. If you omit this property, it defaults to the document’s built-in shape styles.

field textbox_styles : list[ShapeStyle] | None = None

The preset styles that you can apply to text boxes. If you omit this property, it defaults to the document’s built-in text box styles.

field image_styles : list[MediaStyle] | None = None

The preset styles that you can apply to images. If you omit this property, it defaults to the document’s built-in image styles.

field movie_styles : list[MediaStyle] | None = None

The preset styles that you can apply to movies. If you omit this property, it defaults to the document’s built-in movie styles.

field table_style_collections : list[TableStyleCollection] | None = None

The preset table styles. Each entry groups the styles that make up one table style preset: the table as a whole, its cell borders, and the cell and text styles that the body, header rows, header columns, and footer rows use.

field character_styles : list[CharacterStyle] | None = None

The preset character styles that you can apply to a range of text. If you omit this property, it defaults to the document’s built-in character styles.

field paragraph_styles : list[ParagraphStyle] | None = None

The preset paragraph styles that you can apply to whole paragraphs. If you omit this property, it defaults to the document’s built-in paragraph styles.

field list_styles : list[ListStyle] | None = None

The preset list styles, which control bullets and numbering. If you omit this property, it defaults to the document’s built-in list styles.

ShapeStyle

class creator_studio_doc_format.core.ShapeStyle(*, preset_identifier='', name=None, properties, **extra_data)[source]

A preset for shapes, text boxes, lines, and connection lines.

It covers fill, border, opacity, shadow, reflection, and the default layout of the text inside.

field name : str | None = None

The name of the style as shown in Keynote. It’s absent for styles that have no name.

field properties : ShapeProperties [Required]

The properties that make up the style. When a preset_identifier is present, the entry is only a reference and carries no property values; otherwise, this is the style’s complete set of resolved properties.

ShapeProperties

class creator_studio_doc_format.core.ShapeProperties(*, preset_identifier='', stroke=Override.not_set(), opacity=Override.not_set(), reflection=Override.not_set(), shadow=Override.not_set(), fill=Override.not_set(), head=Override.not_set(), tail=Override.not_set(), layout_properties=None, paragraph_properties=None, **extra_data)[source]

The appearance that a shape style applies.

field stroke : Override[Stroke] = Override.not_set()

The stroke or border drawn around the shape or, for a line or connection line, the stroke drawn along the line itself.

field opacity : Override[float] = Override.not_set()

The opacity of the shape, in the range 0 to 1.

field reflection : Override[Reflection] = Override.not_set()

The reflection of the shape.

field shadow : Override[Shadow] = Override.not_set()

The shadow cast behind the shape.

field fill : Override[Fill] = Override.not_set()

The fill used to decorate the interior of the shape. null clears the fill; if the key is omitted, the fill is inherited, and with no fill to inherit, the shape is unfilled.

field head : Override[LineEnd] = Override.not_set()

The head end of a line or connection line, drawn at its end point.

field tail : Override[LineEnd] = Override.not_set()

The tail end of a line or connection line, drawn at its start point.

field layout_properties : LayoutProperties | None = None

A set of properties defining how text is laid out inside the shape: padding, columns, and vertical alignment. It’s absent when the style sets none of these.

field paragraph_properties : ParagraphProperties | None = None

A set of properties that define the default paragraph formatting for text inside the shape. It’s absent when the style carries no default.

MediaStyle

class creator_studio_doc_format.core.MediaStyle(*, preset_identifier='', name=None, properties, **extra_data)[source]

A preset for images and movies.

It covers border, opacity, shadow, and reflection.

field name : str | None = None

The name of the style as shown in Keynote. It’s absent for styles that have no name.

field properties : MediaProperties [Required]

The properties that make up the style. When a preset_identifier is present, the entry is only a reference and carries no property values; otherwise, this is the style’s complete set of resolved properties.

MediaProperties

class creator_studio_doc_format.core.MediaProperties(*, preset_identifier='', stroke=Override.not_set(), opacity=Override.not_set(), reflection=Override.not_set(), shadow=Override.not_set(), **extra_data)[source]

The appearance that a media style applies.

field stroke : Override[Stroke] = Override.not_set()

The stroke or border drawn around an image or movie.

field opacity : Override[float] = Override.not_set()

The opacity of the image or movie, in the range 0 to 1.

field reflection : Override[Reflection] = Override.not_set()

The reflection of the image or movie.

field shadow : Override[Shadow] = Override.not_set()

The shadow cast behind the image or movie.

ParagraphStyle

class creator_studio_doc_format.core.ParagraphStyle(*, preset_identifier='', name=None, properties, **extra_data)[source]

A preset that the reader applies to whole paragraphs, such as a title or body style.

field name : str | None = None

The name of the style as shown in Keynote. It’s absent for styles that have no name.

field properties : ParagraphProperties [Required]

The properties that make up the style. When a preset_identifier is present, the entry is only a reference and carries no property values; otherwise, this is the style’s complete set of resolved properties.

CharacterStyle

class creator_studio_doc_format.core.CharacterStyle(*, preset_identifier='', name=None, properties, **extra_data)[source]

A preset that the reader applies to a range of text within a paragraph.

field name : str | None = None

The name of the style as shown in Keynote. It’s absent for styles that have no name.

field properties : CharacterProperties [Required]

The properties that make up the style. When a preset_identifier is present, the entry is only a reference and carries no property values; otherwise, this is the style’s complete set of resolved properties.

ListStyle

class creator_studio_doc_format.core.ListStyle(*, preset_identifier='', name=None, properties, **extra_data)[source]

A preset for bullets and numbering.

field name : str | None = None

The name of the style as shown in Keynote. It’s absent for styles that have no name.

field properties : ListProperties [Required]

The properties that make up the style. When a preset_identifier is present, the entry is only a reference and carries no property values; otherwise, this is the style’s complete set of resolved properties.

TableStyleCollection

class creator_studio_doc_format.core.TableStyleCollection(*, preset_identifier='', table_name_shape_style=None, table_name_style=None, overall_style, body_cell_style, body_text_style, body_stroke_style, header_row_cell_style, header_row_text_style, header_row_stroke_style, header_column_cell_style, header_column_text_style, header_column_stroke_style, footer_row_cell_style, footer_row_text_style, footer_row_stroke_style, category_level1_cell_style=None, category_level1_text_style=None, category_level2_cell_style=None, category_level2_text_style=None, category_level3_cell_style=None, category_level3_text_style=None, category_level4_cell_style=None, category_level4_text_style=None, category_level5_cell_style=None, category_level5_text_style=None, label_level1_cell_style=None, label_level1_text_style=None, label_level2_cell_style=None, label_level2_text_style=None, label_level3_cell_style=None, label_level3_text_style=None, label_level4_cell_style=None, label_level4_text_style=None, label_level5_cell_style=None, label_level5_text_style=None, pivot_body_summary_row_cell_style=None, pivot_body_summary_column_cell_style=None, pivot_header_column_summary_cell_style=None, **extra_data)[source]

The styles that make up one table style preset.

Each style applies to one region of a table, and the category and label styles are numbered by grouping depth, with 1 the outermost. The category and pivot styles apply to categorized and pivot tables, which version 1.0 doesn’t support. An omitted style is filled in from the collection’s other styles.

field table_name_shape_style : ShapeStyle | None = None
field table_name_style : ParagraphStyle | None = None
field overall_style : OverallStyle [Required]
field body_cell_style : CellStyle [Required]
field body_text_style : ParagraphStyle [Required]
field body_stroke_style : BodyStrokeStyle [Required]
field header_row_cell_style : CellStyle [Required]
field header_row_text_style : ParagraphStyle [Required]
field header_row_stroke_style : HeaderFooterStrokeStyle [Required]
field header_column_cell_style : CellStyle [Required]
field header_column_text_style : ParagraphStyle [Required]
field header_column_stroke_style : HeaderFooterStrokeStyle [Required]
field footer_row_cell_style : CellStyle [Required]
field footer_row_text_style : ParagraphStyle [Required]
field footer_row_stroke_style : HeaderFooterStrokeStyle [Required]
field category_level1_cell_style : CellStyle | None = None

The cell styling for the group rows of a categorized table at grouping depth 1.

field category_level1_text_style : ParagraphStyle | None = None

The text style used in the group rows of a categorized table at grouping depth 1.

field category_level2_cell_style : CellStyle | None = None

The cell styling for the group rows of a categorized table at grouping depth 2.

field category_level2_text_style : ParagraphStyle | None = None

The text style used in the group rows of a categorized table at grouping depth 2.

field category_level3_cell_style : CellStyle | None = None

The cell styling for the group rows of a categorized table at grouping depth 3.

field category_level3_text_style : ParagraphStyle | None = None

The text style used in the group rows of a categorized table at grouping depth 3.

field category_level4_cell_style : CellStyle | None = None

The cell styling for the group rows of a categorized table at grouping depth 4.

field category_level4_text_style : ParagraphStyle | None = None

The text style used in the group rows of a categorized table at grouping depth 4.

field category_level5_cell_style : CellStyle | None = None

The cell styling for the group rows of a categorized table at grouping depth 5.

field category_level5_text_style : ParagraphStyle | None = None

The text style used in the group rows of a categorized table at grouping depth 5.

field label_level1_cell_style : CellStyle | None = None

The cell styling for the row of captions naming a group’s summary values, at grouping depth 1.

field label_level1_text_style : ParagraphStyle | None = None

The text style used in the row of captions naming a group’s summary values, at grouping depth 1.

field label_level2_cell_style : CellStyle | None = None

The cell styling for the row of captions naming a group’s summary values, at grouping depth 2.

field label_level2_text_style : ParagraphStyle | None = None

The text style used in the row of captions naming a group’s summary values, at grouping depth 2.

field label_level3_cell_style : CellStyle | None = None

The cell styling for the row of captions naming a group’s summary values, at grouping depth 3.

field label_level3_text_style : ParagraphStyle | None = None

The text style used in the row of captions naming a group’s summary values, at grouping depth 3.

field label_level4_cell_style : CellStyle | None = None

The cell styling for the row of captions naming a group’s summary values, at grouping depth 4.

field label_level4_text_style : ParagraphStyle | None = None

The text style used in the row of captions naming a group’s summary values, at grouping depth 4.

field label_level5_cell_style : CellStyle | None = None

The cell styling for the row of captions naming a group’s summary values, at grouping depth 5.

field label_level5_text_style : ParagraphStyle | None = None

The text style used in the row of captions naming a group’s summary values, at grouping depth 5.

field pivot_body_summary_row_cell_style : CellStyle | None = None

The cell styling for the subtotal rows in the body of a pivot table.

field pivot_body_summary_column_cell_style : CellStyle | None = None

The cell styling for the subtotal columns in the body of a pivot table.

field pivot_header_column_summary_cell_style : CellStyle | None = None

The cell styling for the header column cells that label a pivot table’s subtotal rows.

OverallStyle

class creator_studio_doc_format.core.OverallStyle(*, preset_identifier='', name=None, properties, **extra_data)[source]

A table style’s table-wide settings, with an optional name.

field name : str | None = None
field properties : OverallProperties [Required]

CellStyle

class creator_studio_doc_format.core.CellStyle(*, preset_identifier='', name=None, properties, **extra_data)[source]

Cell styling for one region of a table, with an optional name.

field name : str | None = None
field properties : CellProperties [Required]

BodyStrokeStyle

class creator_studio_doc_format.core.BodyStrokeStyle(*, preset_identifier='', name=None, properties, **extra_data)[source]

Gridlines and outer borders for the body of a table, with an optional name.

field name : str | None = None
field properties : BodyStrokeProperties [Required]

HeaderFooterStrokeStyle

class creator_studio_doc_format.core.HeaderFooterStrokeStyle(*, preset_identifier='', name=None, properties, **extra_data)[source]

Gridlines, outer border, and separator line for one header or footer region of a table, with an optional name.

field name : str | None = None
field properties : HeaderFooterStrokeProperties [Required]