Canvas

Place objects on a slide, in a group, or inline in a paragraph, and set the properties they share.

CanvasObject

class creator_studio_doc_format.core.CanvasObject(*, preset_identifier='', audio=None, chart=None, connectionLine=None, genericCanvasObject=None, group=None, image=None, movie=None, shape=None, table=None, textbox=None, **extra_data)[source]

The identity, placement, and accessibility properties shared by objects you can place on a slide, in a group, or inline in text.

When authoring a Keynote Interchange Format document, you don’t create these directly, but instead create objects with the type_identifier that include these same properties directly rather than under a key of their own. The same name is also the type that holds any one of those objects, which is what SlideObject.object, Group.children, and a paragraph’s inline object contain.

field audio : Audio | None = None
field chart : Chart | None = None
field connectionLine : ConnectionLine | None = None
field genericCanvasObject : GenericCanvasObject | None = None
field group : Group | None = None
field image : Image | None = None
field movie : Movie | None = None
field shape : Shape | None = None
field table : Table | None = None
field textbox : Textbox | None = None

GenericCanvasObject

class creator_studio_doc_format.core.GenericCanvasObject(*, preset_identifier='', identifier=None, geometry=None, aspect_ratio_locked=False, description=None, **extra_data)[source]

An object with only the properties of CanvasObject.

It’s the form CanvasObject reserves for a kind of object this version doesn’t recognize, such as one a later version of the format introduces. Because it doesn’t name a specific kind, Keynote can’t rebuild an object written this way, and drops it when it reads the document, so a producer writes the specific kind instead.

field identifier : str | None = None

An identifier for this object that other objects use to refer to it. This identifier must be unique across the whole document.

field geometry : Geometry | None = None

The object’s position and size. If this value is absent, Keynote places the object automatically, with a default position and size for its kind.

field aspect_ratio_locked : bool = False

A Boolean value that indicates whether the object’s width-to-height ratio is locked when the object resizes. The lock doesn’t constrain the geometry property. If this property is absent, images, movies, and groups default to true, and other objects to false.

field description : str | None = None

The accessibility description for the object, read aloud by assistive technologies such as VoiceOver.