Titles

Add a title or caption to an object and set its properties.

TitleOwning

class creator_studio_doc_format.core.TitleOwning(*, preset_identifier='', genericTitleOwning=None, **extra_data)[source]

The properties for defining a title that an object can display.

table and every type of Chart keep only the title’s characters and its Label.paragraph_properties, so styling that varies from one run to the next inside Label.text is discarded.

field genericTitleOwning : GenericTitleOwning | None = None

GenericTitleOwning

class creator_studio_doc_format.core.GenericTitleOwning(*, preset_identifier='', title=None, **extra_data)[source]

An object with only the properties of title owning.

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 TitleOwning, though, so this object never appears in a document; its properties appear only as part of the types that adopt TitleOwning.

field title : Label | None = None

The object’s title.

CaptionOwning

class creator_studio_doc_format.core.CaptionOwning(*, preset_identifier='', genericCaptionOwning=None, **extra_data)[source]

The properties for defining an optional caption an object can display.

shape, textbox, image, movie, group, table, and every chart type adopt them.

field genericCaptionOwning : GenericCaptionOwning | None = None

GenericCaptionOwning

class creator_studio_doc_format.core.GenericCaptionOwning(*, preset_identifier='', caption=None, **extra_data)[source]

An object with only the properties of caption owning.

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 CaptionOwning, though, so this object never appears in a document; its properties appear only as part of the types that adopt CaptionOwning.

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_visible set to false, so having a value doesn’t mean the caption shows.

PlaceableTitleOwning

class creator_studio_doc_format.core.PlaceableTitleOwning(*, preset_identifier='', genericPlaceableTitleOwning=None, **extra_data)[source]

The properties for defining a title an object can display, positioned above or below the object.

They extend TitleOwning and are used by objects whose title is a free-standing label.

field genericPlaceableTitleOwning : GenericPlaceableTitleOwning | None = None

GenericPlaceableTitleOwning

class creator_studio_doc_format.core.GenericPlaceableTitleOwning(*, preset_identifier='', title=None, title_is_positioned_on_top=True, **extra_data)[source]

A stand-in for an object with a free-standing title label, when the reader doesn’t recognize its kind.

Every set of shared properties has one, to stand in for an object when the reader doesn’t recognize its kind. Nothing in the format has the type PlaceableTitleOwning, though, so this object never appears in a document; its properties appear only as part of the types that adopt PlaceableTitleOwning.

field title : Label | None = None

The object’s title.

field title_is_positioned_on_top : bool = True

When true, the title appears above the object; when false, the title appears below the object, above the caption if there is one. Defaults to true. Keynote ignores this when the object has none, or when it’s hidden with Label.is_visible set to false; Keynote places a hidden title above the object, where it appears when it shows again.