Class NotesPage

A notes page in a presentation.

These pages contain the content for presentation handouts, including a a shape that contains the slide's speaker notes. Each slide has one corresponding notes page. Only the text in the speaker notes shape can be modified.

Methods

Method	Return type	Brief description
`getGroups()`	`Group[]`	Returns the list of `Group` objects on the page.
`getImages()`	`Image[]`	Returns the list of `Image` objects on the page.
`getLines()`	`Line[]`	Returns the list of `Line` objects on the page.
`getObjectId()`	`String`	Gets the unique ID for the page.
`getPageElementById(id)`	`PageElement`	Returns the `PageElement` on the page with the given ID, or `null` if none exists.
`getPageElements()`	`PageElement[]`	Returns the list of `PageElement` objects rendered on the page.
`getPlaceholder(placeholderType)`	`PageElement`	Returns the placeholder `PageElement` object for a specified `PlaceholderType` or `null` if a matching placeholder is not present.
`getPlaceholder(placeholderType, placeholderIndex)`	`PageElement`	Returns the placeholder `PageElement` object for a specified `PlaceholderType` and a placeholder index, or `null` if the placeholder is not present.
`getPlaceholders()`	`PageElement[]`	Returns the list of placeholder `PageElement` objects in the page.
`getShapes()`	`Shape[]`	Returns the list of `Shape` objects on the page.
`getSheetsCharts()`	`SheetsChart[]`	Returns the list of `SheetsChart` objects on the page.
`getSpeakerNotesShape()`	`Shape`	Gets the shape containing the speaker notes on the page.
`getTables()`	`Table[]`	Returns the list of `Table` objects on the page.
`getVideos()`	`Video[]`	Returns the list of `Video` objects on the page.
`getWordArts()`	`WordArt[]`	Returns the list of `WordArt` objects on the page.
`replaceAllText(findText, replaceText)`	`Integer`	Replaces all instances of text matching find text with replace text.
`replaceAllText(findText, replaceText, matchCase)`	`Integer`	Replaces all instances of text matching find text with replace text.

Detailed documentation

`getGroups()`

Returns the list of Group objects on the page.

Return

Group[]

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getImages()`

Returns the list of Image objects on the page.

Return

Image[]

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getLines()`

Returns the list of Line objects on the page.

Return

Line[]

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getObjectId()`

Gets the unique ID for the page. Object IDs used by pages and page elements share the same namespace.

Return

String

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getPageElementById(id)`

Returns the PageElement on the page with the given ID, or null if none exists.

Parameters

Name	Type	Description
`id`	`String`	The ID of the page element that is being retrieved.

Return

PageElement — The page element with the given ID.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getPageElements()`

Returns the list of PageElement objects rendered on the page.

Return

PageElement[]

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getPlaceholder(placeholderType)`

Returns the placeholder PageElement object for a specified PlaceholderType or null if a matching placeholder is not present.

If there are multiple placeholders with the same type, it returns the one with minimal placeholder index. If there are multiple matching placeholders with the same index, it returns the first placeholder from the page's page elements collection.

const slide = SlidesApp.getActivePresentation().getSlides()[0];
const placeholder = slide.getPlaceholder(
    SlidesApp.PlaceholderType.CENTERED_TITLE,
);

Parameters

Name	Type	Description
`placeholderType`	`PlaceholderType`

Return

PageElement

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getPlaceholder(placeholderType, placeholderIndex)`

Returns the placeholder PageElement object for a specified PlaceholderType and a placeholder index, or null if the placeholder is not present.

If there are multiple placeholders with the same type and index, it returns the first placeholder from the page's page elements collection.

const slide = SlidesApp.getActivePresentation().getSlides()[0];
const placeholder = slide.getPlaceholder(
    SlidesApp.PlaceholderType.CENTERED_TITLE,
    0,
);

Parameters

Name	Type	Description
`placeholderType`	`PlaceholderType`
`placeholderIndex`	`Integer`

Return

PageElement

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getPlaceholders()`

Returns the list of placeholder PageElement objects in the page.

const master = SlidesApp.getActivePresentation().getMasters()[0];
Logger.log(
    `Number of placeholders in the master: ${master.getPlaceholders().length}`,
);

Return

PageElement[]

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getShapes()`

Returns the list of Shape objects on the page.

Return

Shape[]

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getSheetsCharts()`

Returns the list of SheetsChart objects on the page.

Return

SheetsChart[]

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getSpeakerNotesShape()`

Gets the shape containing the speaker notes on the page.

Return

Shape

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getTables()`

Returns the list of Table objects on the page.

Return

Table[]

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getVideos()`

Returns the list of Video objects on the page.

Return

Video[]

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getWordArts()`

Returns the list of WordArt objects on the page.

Return

WordArt[]

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`replaceAllText(findText, replaceText)`

Replaces all instances of text matching find text with replace text. The search is case insensitive.

Parameters

Name	Type	Description
`findText`	`String`	The text to find.
`replaceText`	`String`	The text to replace the matched text.

Return

Integer — the number of occurrences changed

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`replaceAllText(findText, replaceText, matchCase)`

Replaces all instances of text matching find text with replace text.

Parameters

Name	Type	Description
`findText`	`String`	The text to find.
`replaceText`	`String`	The text to replace the matched text.
`matchCase`	`Boolean`	If `true`, the search is case sensitive; if `false`, the search is case insensitive.

Return

Integer — the number of occurrences changed

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations