Keynote Module Reference

New in version 0.0.2.

Control the macOS Keynote application using JXA-like syntax.

Classes:

`XAKeynoteApplication`(properties)	A class for managing and interacting with Keynote.app.
`XAKeynoteContainer`(properties)	A class for managing and interacting with containers in Keynote.
`XAKeynoteContainerList`(properties[, filter, ...])	A wrapper around lists of containers that employs fast enumeration techniques.
`XAKeynoteDocument`(properties)	A class for managing and interacting with TextEdit documents.
`XAKeynoteDocumentList`(properties[, filter])	A wrapper around lists of themes that employs fast enumeration techniques.
`XAKeynoteSlide`(properties)	A class for managing and interacting with Keynote slides.
`XAKeynoteSlideLayout`(properties)	A class for managing and interacting with Keynote slide layouts.
`XAKeynoteSlideLayoutList`(properties[, filter])	A wrapper around lists of themes that employs fast enumeration techniques.
`XAKeynoteSlideList`(properties[, filter, ...])	A wrapper around lists of themes that employs fast enumeration techniques.
`XAKeynoteTheme`(properties)	A class for managing and interacting with Keynote themes.
`XAKeynoteThemeList`(properties[, filter])	A wrapper around lists of themes that employs fast enumeration techniques.
`XAKeynoteTransitionSettings`(properties[, parent])	Properties common to all transtions.
`XAKeynoteWindow`(properties)	A class for managing and interacting with windows in Keynote.app.

class PyXA.apps.Keynote.XAKeynoteApplication(properties)[source]

Bases: XAiWorkApplication

A class for managing and interacting with Keynote.app.

See also

XAKeynoteWindow, XAKeynoteDocument

New in version 0.0.2.

Classes:

`Codec`(value)	Options for which video codec to use.
`ExportFormat`(value)	Options for what format to export a Keynote project as.
`Framerate`(value)	Options for which framerate to use when exporting a Keynote project as a video.
`ObjectType`(value)	Object types available for creation in Keynote.
`PrintSetting`(value)	Options to use when printing slides.
`Transition`(value)	The available options for transitions to assign to slides.

Methods:

`documents`([filter])	Returns a list of documents, as PyXA objects, matching the given filter.
`make`(specifier[, properties, data])	Creates a new element of the given specifier class without adding it to any list.
`new_document`([file_path, theme])	Creates a new document at the specified path and with the specified theme.
`show_next`()	Advance one slide or animation build.
`show_previous`()	Go back one slide or animation build.
`themes`([filter])	Returns a list of themes, as PyXA objects, matching the given filter.

Attributes:

`playing`	Whether a slideshow is currently playing.
`properties`	All properties of the Keynote application.
`slide_switcher_visible`	Whether the slide switcher is visible.

class Codec(value)[source]

Bases: Enum

Options for which video codec to use.

Attributes:

`APPLE_PRO_RES_422`
`APPLE_PRO_RES_422HQ`
`APPLE_PRO_RES_422LT`
`APPLE_PRO_RES_422Proxy`
`APPLE_PRO_RES_4444`
`H264`
`HEVC`

APPLE_PRO_RES_422 = 1265460018

APPLE_PRO_RES_422HQ = 1265460021

APPLE_PRO_RES_422LT = 1265460020

APPLE_PRO_RES_422Proxy = 1265460022

APPLE_PRO_RES_4444 = 1265460019

H264 = 1265460017

HEVC = 1265460023

class ExportFormat(value)[source]

Bases: Enum

Options for what format to export a Keynote project as.

Attributes:

`HTML`
`JPEG`
`KEYNOTE`
`KEYNOTE_09`
`MICROSOFT_POWERPOINT`
`NativeSize`
`PDF`
`PNG`
`QUICKTIME_MOVIE`
`SLIDE_IMAGES`
`TIFF`
`f1080p`
`f2160p`
`f360p`
`f540p`
`f720p`

HTML = 1265136749

JPEG = 1265198698

KEYNOTE = 1265526374

KEYNOTE_09 = 1265329529

MICROSOFT_POWERPOINT = 1265660020

NativeSize = 1265460814

PDF = 1265656934

PNG = 1265198704

QUICKTIME_MOVIE = 1265463158

SLIDE_IMAGES = 1265200487

TIFF = 1265198708

f1080p = 1265460792

f2160p = 1265460788

f360p = 1265460787

f540p = 1265460789

f720p = 1265460791

class Framerate(value)[source]

Bases: Enum

Options for which framerate to use when exporting a Keynote project as a video.

Attributes:

`FPS_12`
`FPS_2398`
`FPS_24`
`FPS_25`
`FPS_2997`
`FPS_30`
`FPS_50`
`FPS_5994`
`FPS_60`

FPS_12 = 1265005105

FPS_2398 = 1265005106

FPS_24 = 1265005107

FPS_25 = 1265005108

FPS_2997 = 1265005109

FPS_30 = 1265005110

FPS_50 = 1265005111

FPS_5994 = 1265005112

FPS_60 = 1265005113

class ObjectType(value)[source]

Bases: Enum

Object types available for creation in Keynote.

Attributes:

`AUDIO_CLIP`
`CHART`
`DOCUMENT`
`GROUP`
`IMAGE`
`LINE`
`MOVIE`
`SHAPE`
`SLIDE`
`TABLE`
`TEXT_ITEM`
`TRANSITION_SETTINGS`
`iWORK_ITEM`

AUDIO_CLIP = 'audio_clip'

CHART = 'chart'

DOCUMENT = 'document'

GROUP = 'group'

IMAGE = 'image'

LINE = 'line'

MOVIE = 'movie'

SHAPE = 'shape'

SLIDE = 'slide'

TABLE = 'table'

TEXT_ITEM = 'text_item'

TRANSITION_SETTINGS = 'transition_settings'

iWORK_ITEM = 'iwork_item'

class PrintSetting(value)[source]

Bases: Enum

Options to use when printing slides.

Attributes:

`DETAILED_ERROR_HANDLING`
`HANDOUTS`
`INDIVIDUAL_SLIDES`
`SLIDE_WITH_NOTES`
`STANDARD_ERROR_HANDLING`

DETAILED_ERROR_HANDLING = 1819763828

HANDOUTS = 1265661800

INDIVIDUAL_SLIDES = 1265661801

SLIDE_WITH_NOTES = 1265661806

STANDARD_ERROR_HANDLING = 1819767668

class Transition(value)[source]

Bases: Enum

The available options for transitions to assign to slides.

Attributes:

`BLINDS`
`CLOTHESLINE`
`COLOR_PANES`
`CONFETTI`
`CUBE`
`DISSOLVE`
`DOORWAY`
`DROP`
`DROPLET`
`FADE_AND_MOVE`
`FADE_THROUGH_COLOR`
`FALL`
`FLIP`
`FLOP`
`GRID`
`IRIS`
`MAGIC_MOVE`
`MOSAIC`
`MOVE_IN`
`NONE`
`OBJECT_CUBE`
`OBJECT_FLIP`
`OBJECT_POP`
`OBJECT_PUSH`
`OBJECT_REVOLVE`
`OBJECT_ZOOM`
`PAGE_FLIP`
`PERSPECTIVE`
`PIVOT`
`PUSH`
`REFLECTION`
`REVEAL`
`REVOLVING_DOOR`
`SCALE`
`SHIMMER`
`SPARKLE`
`SWAP`
`SWING`
`SWITCH`
`SWOOSH`
`TWIRL`
`TWIST`
`WIPE`

BLINDS = 1952607332

CLOTHESLINE = 1952672879

COLOR_PANES = 1952673900

CONFETTI = 1952671348

CUBE = 1952675170

DISSOLVE = 1952737651

DOORWAY = 1952741241

DROP = 1952739952

DROPLET = 1952739436

FADE_AND_MOVE = 1952866660

FADE_THROUGH_COLOR = 1952871523

FALL = 1952866668

FLIP = 1952868720

FLOP = 1952870256

GRID = 1952936548

IRIS = 1953067635

MAGIC_MOVE = 1953327734

MOSAIC = 1953330019

MOVE_IN = 1953330793

NONE = 1953393004

OBJECT_CUBE = 1953456994

OBJECT_FLIP = 1953457776

OBJECT_POP = 1953460336

OBJECT_PUSH = 1953460328

OBJECT_REVOLVE = 1953460854

OBJECT_ZOOM = 1953462893

PAGE_FLIP = 1953523308

PERSPECTIVE = 1953526387

PIVOT = 1953527412

PUSH = 1953526632

REFLECTION = 1953654380

REVEAL = 1953658476

REVOLVING_DOOR = 1953654134

SCALE = 1953719148

SHIMMER = 1953720429

SPARKLE = 1953722475

SWAP = 1953724272

SWING = 1953724263

SWITCH = 1953724265

SWOOSH = 1953724275

TWIRL = 1953789804

TWIST = 1953789801

WIPE = 1953984613

documents(filter: dict | None = None) → XAKeynoteDocumentList[source]

Returns a list of documents, as PyXA objects, matching the given filter.

Parameters:: filter (Union[dict, None]) – A dictionary specifying property-value pairs that all returned documents will have, or None
Returns:: The list of documents
Return type:: XAKeynoteDocumentList
Example 1:: List the name of every open Keynote document

>>> import PyXA
>>> app = PyXA.Application("Keynote")
>>> docs = app.documents()
>>> for doc in docs:
>>>     print(doc.name)
Example1.key
Example2.key

New in version 0.0.2.

make(specifier: str | ObjectType, properties: dict | None = None, data: Any | None = None)[source]

Creates a new element of the given specifier class without adding it to any list.

Use XABase.XAList.push() to push the element onto a list.

Parameters:

specifier (Union[str, XAKeynoteApplication.ObjectType]) – The classname of the object to create
properties (dict) – The properties to give the object
data (Any) – The data to initialize the object with

Returns:

A PyXA wrapped form of the object

Return type:

XABase.XAObject

New in version 0.0.5.

new_document(file_path: str | XAPath = './Untitled.key', theme: XAKeynoteTheme | None = None) → XAKeynoteDocument[source]

Creates a new document at the specified path and with the specified theme.

Parameters:

file_path (str, optional) – The path to create the document at, defaults to “./Untitled.key”
template (XAKeynoteTheme, optional) – The theme to initialize the document with, defaults to None

Returns:

The newly created document object

Return type:

XAKeynoteDocument

New in version 0.0.8.

property playing: bool: Whether a slideshow is currently playing.

property properties: dict: All properties of the Keynote application.

show_next() → XAKeynoteApplication[source]: Advance one slide or animation build.

show_previous() → XAKeynoteApplication[source]: Go back one slide or animation build.

property slide_switcher_visible: bool: Whether the slide switcher is visible.

themes(filter: dict | None = None) → XAKeynoteThemeList[source]

Returns a list of themes, as PyXA objects, matching the given filter.

Parameters:: filter (Union[dict, None]) – A dictionary specifying property-value pairs that all returned themes will have, or None
Returns:: The list of themes
Return type:: XAKeynoteThemeList
Example 1:: List the name of each theme

>>> import PyXA
>>> app = PyXA.Application("Keynote")
>>> themes = app.themes()
>>> print(themes.name())
['Basic White', 'Basic Black', 'Classic White', 'White', 'Black', 'Basic Color', 'Color Gradient Light', 'Color Gradient', 'Gradient', 'Showroom', 'Modern Portfolio', 'Slate', 'Photo Essay', 'Bold Color', 'Showcase', 'Briefing', 'Academy', 'Modern Type', 'Exhibition', 'Feature Story', 'Look Book', 'Classic', 'Editorial', 'Cream Paper', 'Industrial', 'Blueprint', 'Graph Paper', 'Chalkboard', 'Photo Portfolio', 'Leather Book', 'Artisan', 'Improv', 'Drafting', 'Kyoto', 'Brushed Canvas', 'Craft', 'Parchment', 'Renaissance', 'Moroccan', 'Hard Cover', 'Linen Book', 'Vintage', 'Typeset', 'Harmony', 'Formal']

New in version 0.0.2.

class PyXA.apps.Keynote.XAKeynoteContainer(properties)[source]

Bases: XAiWorkContainer

A class for managing and interacting with containers in Keynote.

New in version 0.0.2.

class PyXA.apps.Keynote.XAKeynoteContainerList(properties: dict, filter: dict | None = None, obj_class=None)[source]

Bases: XAiWorkContainerList

A wrapper around lists of containers that employs fast enumeration techniques.

New in version 0.0.5.

class PyXA.apps.Keynote.XAKeynoteDocument(properties)[source]

Bases: XAiWorkDocument

A class for managing and interacting with TextEdit documents.

See also

XAKeynoteApplication

New in version 0.0.2.

Methods:

`accept_slide_switcher`()	Advances the slideshow to the selected slide of the slide switcher.
`cancel_slide_switcher`()	Dismisses the slide switcher.
`export`([file_path, format])	Exports the slideshow in the specified format.
`hide_slide_switcher`()	Hides the slide switcher.
`make_image_slides`(files[, set_titles, ...])	Creates slides out of image files.
`move_slide_switcher_backward`()	Goes back one slide in the slide switcher.
`move_slide_switcher_forward`()	Advances the slide switcher one slide forward.
`new_slide`(properties)	Creates a new slide at the end of the presentation.
`save`()	Saves the Keynote file.
`show_slide_switcher`()	Shows the slide switch within the active slideshow interface.
`slide_layouts`([filter])	Returns a list of slide layouts, as PyXA objects, matching the given filter.
`slides`([filter])	Returns a list of slides, as PyXA objects, matching the given filter.
`start_from`(slide)	Starts the slideshow from the specified slide.
`stop`()	Stops the currently playing slideshow.

Attributes:

`auto_loop`	Whether the slideshow should play repeatedly.
`auto_play`	Whether the slideshow should automatically play when opening the file.
`auto_restart`	Whether the slideshow should restart if its inactive for the maximum idle duration.
`current_slide`	The currently selected slide, or the slide that would display is the presentation was started.
`document_theme`	The theme assigned to the document.
`file`	The location of the document on the disk, if one exists.
`height`	The height of the document in points; standard is 768; wide slide height is 1080.
`id`	The unique identifier for the document.
`maximum_idle_duration`	The duration before which the slideshow restarts due to inactivity.
`modified`	Whether the document has been modified since its last save.
`name`	The name of the document.
`password_protected`	Whether the document is password protected.
`properties`	All properties of the document.
`selection`	A list of the currently selected items.
`slide_numbers_showing`	Whether slide numbers are displayed.
`width`	The width of the document in points; standard is 1080; wide slide width is 1920.

accept_slide_switcher()[source]: Advances the slideshow to the selected slide of the slide switcher.

New in version 0.0.3.

property auto_loop: bool: Whether the slideshow should play repeatedly.

property auto_play: bool: Whether the slideshow should automatically play when opening the file.

property auto_restart: bool: Whether the slideshow should restart if its inactive for the maximum idle duration.

cancel_slide_switcher()[source]: Dismisses the slide switcher.

New in version 0.0.3.

property current_slide: XAKeynoteSlide: The currently selected slide, or the slide that would display is the presentation was started.

property document_theme: XAKeynoteTheme: The theme assigned to the document.

export(file_path: str | XAPath | None = None, format: ExportFormat = ExportFormat.PDF)[source]

Exports the slideshow in the specified format.

Parameters:

file_path (Union[str, XABase.XAPath], optional) – The path to save the exported file at, defaults to None
format (XAKeynoteApplication.ExportFormat, optional) – The format to export the file in, defaults to XAKeynoteApplication.ExportFormat.PDF

New in version 0.0.3.

property file: str: The location of the document on the disk, if one exists.

property height: int: The height of the document in points; standard is 768; wide slide height is 1080.

hide_slide_switcher()[source]: Hides the slide switcher.

New in version 0.0.3.

property id: str: The unique identifier for the document.

make_image_slides(files: list[str | XAPath], set_titles: bool = False, slide_layout: XAKeynoteSlideLayout | None = None) → XAKeynoteDocument[source]

Creates slides out of image files.

Creates a new slide for each image file path in the files list, if the image can be found.

Parameters:

files (list[Union[str, XABase.XAPath]]) – A list of paths to image files
set_titles (bool, optional) – Whether to set the slide titles to the image file name, defaults to False
slide_layout (XAKeynoteSlideLayout, optional) – The base slide layout to use for the new slides, defaults to None

Returns:

A reference back to this PyXA object.

Return type:

XAKeynoteDocument

New in version 0.0.3.

property maximum_idle_duration: int: The duration before which the slideshow restarts due to inactivity.

property modified: bool: Whether the document has been modified since its last save.

move_slide_switcher_backward()[source]: Goes back one slide in the slide switcher.

New in version 0.0.3.

move_slide_switcher_forward()[source]: Advances the slide switcher one slide forward.

New in version 0.0.3.

property name: str: The name of the document.

new_slide(properties: dict) → XAKeynoteSlide[source]

Creates a new slide at the end of the presentation.

Parameters:: properties (dict) – The properties to give the new slide
Returns:: A reference to the newly created slide
Return type:: XAKeynoteSlide

New in version 0.0.2.

property password_protected: bool: Whether the document is password protected.

property properties: dict: All properties of the document.

save()[source]: Saves the Keynote file.

New in version 0.0.3.

property selection: XAiWorkiWorkItemList: A list of the currently selected items.

show_slide_switcher()[source]: Shows the slide switch within the active slideshow interface.

New in version 0.0.3.

slide_layouts(filter: dict | None = None) → XAKeynoteSlideLayoutList[source]

Returns a list of slide layouts, as PyXA objects, matching the given filter.

Parameters:: filter (Union[dict, None]) – A dictionary specifying property-value pairs that all returned slide layouts will have, or None
Returns:: The list of slide layouts
Return type:: XAKeynoteSlideLayoutList
Example:: List all slide layouts

>>> import PyXA
>>> app = PyXA.Application("Keynotes")
>>> print(app.slide_layouts())

New in version 0.0.2.

property slide_numbers_showing: bool: Whether slide numbers are displayed.

slides(filter: dict | None = None) → XAKeynoteSlideList[source]

Returns a list of slides, as PyXA objects, matching the given filter.

Parameters:: filter (Union[dict, None]) – A dictionary specifying property-value pairs that all returned slides will have, or None
Returns:: The list of slides
Return type:: XAKeynoteSlideList
Example 1:: List all slides

>>> import PyXA
>>> app = PyXA.Application("Keynotes")
>>> print(app.slides())

Example 2:: List slides after applying a filter

>>> import PyXA
>>> app = PyXA.Application("Keynotes")
>>> print(app.slides().greater_than("slideNumber", 5))

New in version 0.0.2.

start_from(slide: XAKeynoteSlide) → XAKeynoteSlide[source]: Starts the slideshow from the specified slide.

New in version 0.0.3.

stop()[source]: Stops the currently playing slideshow.

New in version 0.0.3.

property width: int: The width of the document in points; standard is 1080; wide slide width is 1920.

class PyXA.apps.Keynote.XAKeynoteDocumentList(properties: dict, filter: dict | None = None)[source]

Bases: XAiWorkDocumentList

A wrapper around lists of themes that employs fast enumeration techniques.

All properties of themes can be called as methods on the wrapped list, returning a list containing each theme’s value for the property.

New in version 0.0.5.

Methods:

`auto_loop`()
`auto_play`()
`auto_restart`()
`by_auto_loop`(auto_loop)
`by_auto_play`(auto_play)
`by_auto_restart`(auto_restart)
`by_current_slide`(current_slide)
`by_document_theme`(document_theme)
`by_height`(height)
`by_maximum_idle_duration`(maximum_idle_duration)
`by_password_protected`(password_protected)
`by_properties`(properties)
`by_selection`(selection)
`by_slide_numbers_showing`(slide_numbers_showing)
`by_width`(width)
`current_slide`()
`document_theme`()
`height`()
`maximum_idle_duration`()
`properties`()
`slide_numbers_showing`()
`width`()

auto_loop() → list[bool][source]

auto_play() → list[bool][source]

auto_restart() → list[bool][source]

by_auto_loop(auto_loop: bool) → XAKeynoteDocument | None[source]

by_auto_play(auto_play: bool) → XAKeynoteDocument | None[source]

by_auto_restart(auto_restart: bool) → XAKeynoteDocument | None[source]

by_current_slide(current_slide: XAKeynoteSlide) → XAKeynoteDocument | None[source]

by_document_theme(document_theme: XAKeynoteTheme) → XAKeynoteDocument | None[source]

by_height(height: int) → XAKeynoteDocument | None[source]

by_maximum_idle_duration(maximum_idle_duration: int) → XAKeynoteDocument | None[source]

by_password_protected(password_protected: bool) → XAKeynoteDocument | None[source]

by_properties(properties: dict) → XAKeynoteDocument | None[source]

by_selection(selection: XAiWorkiWorkItemList) → XAKeynoteDocument | None[source]

by_slide_numbers_showing(slide_numbers_showing: bool) → XAKeynoteDocument | None[source]

by_width(width: int) → XAKeynoteDocument | None[source]

current_slide() → XAKeynoteSlideList[source]

document_theme() → XAKeynoteThemeList[source]

height() → list[int][source]

maximum_idle_duration() → list[int][source]

properties() → list[dict][source]

slide_numbers_showing() → list[bool][source]

width() → list[int][source]

class PyXA.apps.Keynote.XAKeynoteSlide(properties)[source]

Bases: XAKeynoteContainer

A class for managing and interacting with Keynote slides.

See also

XAKeynoteApplication, iWorkApplicationBase.XAiWorkiWorkItem

New in version 0.0.2.

Methods:

`add_chart`(row_names, column_names, data[, ...])	_summary_
`add_image`(file_path)	Adds the image at the specified path to the slide.
`delete`()	Deletes the slide.
`duplicate`([location, position])	Duplicates the slide, mimicking the action of copying and pasting the slide manually.
`move`(location[, position])	Moves the slide to the specified location, at the specified position.

Attributes:

`base_layout`	The slide layout this slide is based on.
`body_showing`	Whether the default body text is displayed.
`default_body_item`	The default body container of the slide.
`default_title_item`	The default title container of the slide.
`presenter_notes`	The presenter notes for the slide.
`properties`	All properties of the slide.
`skipped`	Whether the slide is skipped.
`slide_number`	The index of the slide in the document.
`title_showing`	Whether the default slide title is displayed.
`transition_properties`	The transition settings applied to the slide.

add_chart(row_names: list[str], column_names: list[str], data: list[list[Any]], type: int = 1818848818, group_by: int = 1262708594) → XAiWorkChart[source]

_summary_

_extended_summary_

Parameters:

row_names (list[str]) – A list of row names.
column_names (list[str]) – A list of column names.
data (list[list[Any]]) – A 2d array
type (int, optional) – The chart type, defaults to _KeynoteLegacyChartType.KeynoteLegacyChartTypeLine_2d.value
group_by (int, optional) – The grouping schema, defaults to _KeynoteLegacyChartGrouping.KeynoteLegacyChartGroupingChartRow.value

Returns:

A reference to the newly created chart object.

Return type:

iWorkApplicationBase.XAiWorkChart

New in version 0.0.2.

add_image(file_path: str | XAPath | XAURL) → XAiWorkImage[source]

Adds the image at the specified path to the slide.

Parameters:: file_path (Union[str, XABase.XAPath, XABase.XAURL]) – The path to the image file.
Returns:: The newly created image object.
Return type:: iWorkApplicationBase.XAiWorkImage

New in version 0.0.2.

property base_layout: XAKeynoteSlideLayout: The slide layout this slide is based on.

property body_showing: bool: Whether the default body text is displayed.

property default_body_item: XAiWorkShape: The default body container of the slide.

property default_title_item: XAiWorkShape: The default title container of the slide.

delete()[source]: Deletes the slide.

New in version 0.0.2.

duplicate(location: XAKeynoteDocument | XAKeynoteSlideList | None = None, position: int = -1) → XAKeynoteSlide[source]

Duplicates the slide, mimicking the action of copying and pasting the slide manually.

Parameters:

location (Union[XAKeynoteDocument, XAKeynoteSlideList, None], optional) – The document or list of slides to duplicate this slide to, or None to duplicate into the current document, defaults to None
position (int, optional) – The index to insert the slide within a list, defaults to -1

Returns:

A reference to newly created (duplicate) slide object.

Return type:

XAKeynoteSlide

Example:

Duplicate Slide From One Document To Another

>>> import PyXA
>>> app = PyXA.Keynote()
>>> doc1 = app.documents()[0]
>>> doc2 = app.documents()[1]
>>> doc1.slides()[0].duplicate(doc2)
<<class 'PyXA.apps.Keynote.XAKeynoteSlide'>slide number: 5>

New in version 0.2.2.

move(location: XAKeynoteDocument | XAKeynoteSlideList, position: int = -1) → XAKeynoteSlide[source]

Moves the slide to the specified location, at the specified position.

Parameters:

location (Union[XAKeynoteDocument, XAKeynoteSlideList]) – The document or list of slides to move this slide to
position (int, optional) – The index to insert the slide within a list, defaults to -1

Returns:

A reference to the slide object

Return type:

XAKeynoteSlide

Example:

>>> import PyXA
>>> app = PyXA.Keynote()
>>> doc = app.documents()[0]
>>> doc2 = app.documents()[1]
>>> doc.slides()[0].move(doc2)
<<class 'PyXA.apps.Keynote.XAKeynoteSlide'>slide number: 5>

New in version 0.2.2.

property presenter_notes: XAText: The presenter notes for the slide.

property properties: dict: All properties of the slide.

property skipped: bool: Whether the slide is skipped.

property slide_number: int: The index of the slide in the document.

property title_showing: bool: Whether the default slide title is displayed.

property transition_properties: dict: The transition settings applied to the slide.

class PyXA.apps.Keynote.XAKeynoteSlideLayout(properties)[source]

Bases: XAKeynoteSlide

A class for managing and interacting with Keynote slide layouts.

See also

XAKeynoteSlide

New in version 0.0.2.

Attributes:

name

The name of the slide layout.

property name: str: The name of the slide layout.

class PyXA.apps.Keynote.XAKeynoteSlideLayoutList(properties: dict, filter: dict | None = None)[source]

Bases: XAKeynoteSlideList

A wrapper around lists of themes that employs fast enumeration techniques.

All properties of themes can be called as methods on the wrapped list, returning a list containing each theme’s value for the property.

New in version 0.0.5.

Methods:

`by_name`(name)
`name`()

by_name(name: str) → XAKeynoteSlideLayout[source]

name() → list[str][source]

class PyXA.apps.Keynote.XAKeynoteSlideList(properties: dict, filter: dict | None = None, obj_class=None)[source]

Bases: XAKeynoteContainerList

A wrapper around lists of themes that employs fast enumeration techniques.

All properties of themes can be called as methods on the wrapped list, returning a list containing each theme’s value for the property.

New in version 0.0.5.

Methods:

`base_layout`()
`body_showing`()
`by_base_layout`(base_layout)
`by_body_showing`(body_showing)
`by_default_body_item`(default_body_item)
`by_default_text_item`(default_text_item)
`by_presenter_notes`(presenter_notes)
`by_properties`(properties)
`by_skipped`(skipped)
`by_slide_number`(slide_number)
`by_title_showing`(title_showing)
`by_transition_properties`(transition_properties)
`default_body_item`()
`default_title_item`()
`presenter_notes`()
`properties`()
`skipped`()
`slide_number`()
`title_showing`()
`transition_properties`()

base_layout() → XAKeynoteSlideLayoutList[source]

body_showing() → list[bool][source]

by_base_layout(base_layout: XAKeynoteSlideLayout) → XAKeynoteSlide[source]

by_body_showing(body_showing: bool) → XAKeynoteSlide[source]

by_default_body_item(default_body_item: XAiWorkShape) → XAKeynoteSlide[source]

by_default_text_item(default_text_item: XAiWorkShape) → XAKeynoteSlide[source]

by_presenter_notes(presenter_notes: str | XAText) → XAKeynoteSlide[source]

by_properties(properties: dict) → XAKeynoteSlide[source]

by_skipped(skipped: bool) → XAKeynoteSlide[source]

by_slide_number(slide_number: int) → XAKeynoteSlide[source]

by_title_showing(title_showing: bool) → XAKeynoteSlide[source]

by_transition_properties(transition_properties: XAKeynoteTransitionSettings | dict) → XAKeynoteSlide[source]

default_body_item() → XAiWorkShapeList[source]

default_title_item() → XAiWorkShapeList[source]

presenter_notes() → XATextList[source]

properties() → list[dict][source]

skipped() → list[bool][source]

slide_number() → list[int][source]

title_showing() → list[bool][source]

transition_properties() → list[dict][source]

class PyXA.apps.Keynote.XAKeynoteTheme(properties)[source]

Bases: XAObject

A class for managing and interacting with Keynote themes.

See also

XAKeynoteApplication

New in version 0.0.2.

Attributes:

`id`	The unique identifier for the theme.
`name`	The name of the theme.
`properties`	All properties of the theme.

property id: str: The unique identifier for the theme.

property name: str: The name of the theme.

property properties: dict: All properties of the theme.

class PyXA.apps.Keynote.XAKeynoteThemeList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of themes that employs fast enumeration techniques.

All properties of themes can be called as methods on the wrapped list, returning a list containing each theme’s value for the property.

New in version 0.0.5.

Methods:

`by_id`(id)
`by_name`(name)
`by_properties`(properties)
`id`()
`name`()
`properties`()

by_id(id: str) → XAKeynoteTheme | None[source]

by_name(name: str) → XAKeynoteTheme | None[source]

by_properties(properties: dict) → XAKeynoteTheme | None[source]

id() → list[str][source]

name() → list[str][source]

properties() → list[str][source]

class PyXA.apps.Keynote.XAKeynoteTransitionSettings(properties: dict, parent: XAObject | None = None)[source]

Bases: XAObject

Properties common to all transtions.

New in version 0.1.0.

Attributes:

`automatic_transition`
`transition_delay`
`transition_duration`
`transition_effect`

property automatic_transition: float

property transition_delay: float

property transition_duration: float

property transition_effect: Transition

class PyXA.apps.Keynote.XAKeynoteWindow(properties)[source]

Bases: XAiWorkWindow

A class for managing and interacting with windows in Keynote.app.

New in version 0.0.1.

Attributes:

document

The document currently displayed in the window.

property document: XAKeynoteDocument: The document currently displayed in the window.