A layout in a presentation.
Each layout serves as a template for slides that inherit from it, determining how content on those slides is arranged and styled.
Methods
Method | Return type | Brief description |
---|---|---|
get | Page | Gets the page's background. |
get | Color | Gets the Color associated with the page. |
get | Group[] | Returns the list of Group objects on the page. |
get | Image[] | Returns the list of Image objects on the page. |
get | String | Gets the name of the layout. |
get | Line[] | Returns the list of Line objects on the page. |
get | Master | Gets the master that the layout is based on. |
get | String | Gets the unique ID for the page. |
get | Page | Returns the Page on the page with the given ID, or null if none exists. |
get | Page | Returns the list of Page objects rendered on the page. |
get | Page | Gets the type of the page. |
get | Page | Returns the placeholder Page object for a specified Placeholder or
null if a matching placeholder is not present. |
get | Page | Returns the placeholder Page object for a specified Placeholder and
a placeholder index, or null if the placeholder is not present. |
get | Page | Returns the list of placeholder Page objects in the page. |
get | Shape[] | Returns the list of Shape objects on the page. |
get | Sheets | Returns the list of Sheets objects on the page. |
get | Table[] | Returns the list of Table objects on the page. |
get | Video[] | Returns the list of Video objects on the page. |
get | Word | Returns the list of Word objects on the page. |
group(pageElements) | Group | Groups all the specified page elements. |
insert | Group | Inserts a copy of the provided Group on the page. |
insert | Image | Inserts an image at the top left corner of the page with a default size from the specified image blob. |
insert | Image | Inserts an image on the page with the provided position and size from the specified image blob. |
insert | Image | Inserts a copy of the provided Image on the page. |
insert | Image | Inserts an image at the top left corner of the page with a default size from the provided URL. |
insert | Image | Inserts an image on the page with the provided position and size from the provided URL. |
insert | Line | Inserts a copy of the provided Line on the page. |
insert | Line | Inserts a line on the page connecting two connection sites . |
insert | Line | Inserts a line on the page. |
insert | Page | Inserts a copy of the provided Page on the page. |
insert | Shape | Inserts a copy of the provided Shape on the page. |
insert | Shape | Inserts a shape on the page. |
insert | Shape | Inserts a shape on the page. |
insert | Sheets | Inserts a Google Sheets chart on the page. |
insert | Sheets | Inserts a Google Sheets chart on the page with the provided position and size. |
insert | Sheets | Inserts a copy of the provided Sheets on the page. |
insert | Image | Inserts a Google Sheets chart as an Image on the page. |
insert | Image | Inserts a Google Sheets chart as an Image on the page with the provided position and
size. |
insert | Table | Inserts a table on the page. |
insert | Table | Inserts a table on the page with the provided position and size. |
insert | Table | Inserts a copy of the provided Table on the page. |
insert | Shape | Inserts a text box Shape containing the provided string on the page. |
insert | Shape | Inserts a text box Shape containing the provided string on the page. |
insert | Video | Inserts a video at the top left corner of the page with a default size. |
insert | Video | Inserts a video on the page with the provided position and size. |
insert | Video | Inserts a copy of the provided Video on the page. |
insert | Word | Inserts a copy of the provided Word on the page. |
remove() | void | Removes the page. |
replace | Integer | Replaces all instances of text matching find text with replace text. |
replace | Integer | Replaces all instances of text matching find text with replace text. |
select | void | Selects the Page in the active presentation as the current page selection and removes any previous selection. |
Detailed documentation
getBackground()
Gets the page's background.
Return
Page
— The page's background.
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
getColorScheme()
Gets the Color
associated with the page.
Return
Color
— The page's color scheme.
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
getGroups()
getImages()
getLayoutName()
Gets the name of the layout.
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
getLines()
getMaster()
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 Page
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
Page
— 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 Page
objects rendered on the page.
Return
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
getPageType()
getPlaceholder(placeholderType)
Returns the placeholder Page
object for a specified Placeholder
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 |
---|---|---|
placeholder | Placeholder |
Return
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 Page
object for a specified Placeholder
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 |
---|---|---|
placeholder | Placeholder | |
placeholder | Integer |
Return
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 Page
objects in the page.
const master = SlidesApp.getActivePresentation().getMasters()[0]; Logger.log( `Number of placeholders in the master: ${master.getPlaceholders().length}`, );
Return
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()
getSheetsCharts()
Returns the list of Sheets
objects on the page.
Return
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()
getVideos()
getWordArts()
group(pageElements)
Groups all the specified page elements.
There should be at least two page elements on the same page that are not already in another
group. Some page elements, such as Videos
, Tables
and placeholder Shapes
cannot be grouped.
Parameters
Name | Type | Description |
---|---|---|
page | Page | The elements to group together. |
Return
Group
— The new 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
insertGroup(group)
Inserts a copy of the provided Group
on the page.
The inserted element's position on this page is determined from the source element's position on its respective page.
If the provided element is a placeholder being copied from within the current presentation, properties that inherit from master or layout pages also inherit on the inserted element.
If the provided element is a placeholder being copied from a different presentation, properties that inherit from master or layout pages are copied onto the element from the source presentation.
// Copy a group between presentations. const otherPresentationSlide = SlidesApp.openById('presentationId').getSlides()[0]; const currentPresentationSlide = SlidesApp.getActivePresentation().getSlides()[0]; const group = otherPresentationSlide.getGroups()[0]; currentPresentationSlide.insertGroup( group); // Also available for Layout, Master, and Page.
Parameters
Name | Type | Description |
---|---|---|
group | Group | The group to be copied and inserted. |
Return
Group
— The inserted 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
insertImage(blobSource)
Inserts an image at the top left corner of the page with a default size from the specified image blob.
Inserting the image fetches it from the Blob
once and a copy is stored for
display inside the presentation. Images must be less than 50MB in size, cannot exceed 25
megapixels, and must be in either in PNG, JPEG, or GIF format.
const slide = SlidesApp.getActivePresentation().getSlides()[0]; // Get the Drive image file with the given ID. const image = DriveApp.getFileById('123abc'); slide.insertImage(image);
Parameters
Name | Type | Description |
---|---|---|
blob | Blob | The image data. |
Return
Image
— The inserted 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
insertImage(blobSource, left, top, width, height)
Inserts an image on the page with the provided position and size from the specified image blob.
The image is fetched from the provided Blob
once at insertion time and a copy
is stored for display inside the presentation. Images must be less than 50MB in size, cannot
exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF format.
In order to maintain the image's aspect ratio, the image is scaled and centered with respect to the provided size.
const slide = SlidesApp.getActivePresentation().getSlides()[0]; // Get the Drive image file with the given ID. const image = DriveApp.getFileById('123abc'); const position = { left: 0, top: 0 }; const size = { width: 300, height: 100 }; slide.insertImage(image, position.left, position.top, size.width, size.height);
Parameters
Name | Type | Description |
---|---|---|
blob | Blob | The image data. |
left | Number | The horizontal position of the image in points, measured from the upper left corner of the page. |
top | Number | The vertical position of the image in points, measured from the upper left corner of the page. |
width | Number | The width of the image in points. |
height | Number | The height of the image in points. |
Return
Image
— The inserted 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
insertImage(image)
Inserts a copy of the provided Image
on the page.
The inserted images's position on this page is determined from the source image's position on its respective page.
If the provided image is a placeholder being copied from within the current presentation, properties that inherit from master or layout pages also inherit on the inserted image.
If the provided image is a placeholder being copied from a different presentation, properties that inherit from master or layout pages are copied onto the image from the source presentation. If the copied placeholder image is empty, nothing is inserted in the destination presentation.
// Copy an image between presentations. const otherPresentationSlide = SlidesApp.openById('presentationId').getSlides()[0]; const currentPresentationSlide = SlidesApp.getActivePresentation().getSlides()[0]; const image = otherPresentationSlide.getImages[0]; currentPresentationSlide.insertImage(image);
Parameters
Name | Type | Description |
---|---|---|
image | Image | The image to be copied and inserted. |
Return
Image
— The inserted 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
insertImage(imageUrl)
Inserts an image at the top left corner of the page with a default size from the provided URL.
Inserting the image fetches it from the URL once and a copy is stored for display inside the presentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF format.
The provided URL must be publicly accessible and no larger than 2kB. The URL itself is saved
with the image and exposed via Image.getSourceUrl()
.
Parameters
Name | Type | Description |
---|---|---|
image | String | The image URL. |
Return
Image
— The inserted 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
insertImage(imageUrl, left, top, width, height)
Inserts an image on the page with the provided position and size from the provided URL.
Inserting the image fetches it from the URL once and a copy is stored for display inside the presentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF format.
The provided URL must be publicly accessible and no larger than 2kB. The URL itself is saved
with the image and exposed via Image.getSourceUrl()
.
In order to maintain the image's aspect ratio, the image is scaled and centered with respect to the provided size.
Parameters
Name | Type | Description |
---|---|---|
image | String | The image URL. |
left | Number | The horizontal position of the image in points, measured from the upper left corner of the page. |
top | Number | The vertical position of the image in points, measured from the upper left corner of the page. |
width | Number | The width of the image in points. |
height | Number | The height of the image in points. |
Return
Image
— The inserted 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
insertLine(line)
Inserts a copy of the provided Line
on the page.
The inserted element's position on this page is determined from the source element's position on its respective page.
If the provided element is a placeholder being copied from within the current presentation, properties that inherit from master or layout pages also inherit on the inserted element.
If the provided element is a placeholder being copied from a different presentation, properties that inherit from master or layout pages are copied onto the element from the source presentation.
// Copy a line between presentations. const otherPresentationSlide = SlidesApp.openById('presentationId').getSlides()[0]; const currentPresentationSlide = SlidesApp.getActivePresentation().getSlides()[0]; const line = otherPresentationSlide.getLines[0]; currentPresentationSlide.insertLine(line);
Parameters
Name | Type | Description |
---|---|---|
line | Line | The line to be copied and inserted. |
Return
Line
— The inserted 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
insertLine(lineCategory, startConnectionSite, endConnectionSite)
Inserts a line on the page connecting two connection sites
. The two
connection sites must be on this page.
// Insert a line in the first slide of the presentation connecting two shapes. const slide = SlidesApp.getActivePresentation().getSlides()[0]; const shape1 = slide.insertShape(SlidesApp.ShapeType.RECTANGLE); const shape2 = slide.insertShape(SlidesApp.ShapeType.CLOUD); slide.insertLine( SlidesApp.LineCategory.BENT, shape1.getConnectionSites()[0], shape2.getConnectionSites()[1], );
Parameters
Name | Type | Description |
---|---|---|
line | Line | The category of the line to insert. |
start | Connection | The connection site where the start of the line is to be connected. |
end | Connection | The connection site where the end of the line is to be connected. |
Return
Line
— The inserted 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
insertLine(lineCategory, startLeft, startTop, endLeft, endTop)
Inserts a line on the page.
// Insert a line in the first slide of the presentation. const slide = SlidesApp.getActivePresentation().getSlides()[0]; const startPoint = { left: 10, top: 10 }; const endPoint = { left: 40, top: 40 }; slide.insertLine( SlidesApp.LineCategory.STRAIGHT, startPoint.left, startPoint.top, endPoint.left, endPoint.top, );
Parameters
Name | Type | Description |
---|---|---|
line | Line | The category of the line to insert. |
start | Number | The horizontal position of the start point of the line, measured in points from the upper left corner of the page. |
start | Number | The vertical position of the start point of the line, measured in points from the upper left corner of the page. |
end | Number | The horizontal position of the end point of the line, measured in points from the upper left corner of the page. |
end | Number | The vertical position of the end point of the line, measured in points from the upper left corner of the page. |
Return
Line
— The inserted 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
insertPageElement(pageElement)
Inserts a copy of the provided Page
on the page.
The inserted element's position on this page is determined from the source element's position on its respective page.
If the provided element is a placeholder being copied from within the current presentation, properties that inherit from master or layout pages also inherit on the inserted element.
If the provided element is a placeholder being copied from a different presentation, properties that inherit from master or layout pages are copied onto the element from the source presentation.
// Copy a page element between presentations. const otherPresentationSlide = SlidesApp.openById('presentationId').getSlides()[0]; const currentPresentationSlide = SlidesApp.getActivePresentation().getSlides()[0]; const pageElement = otherPresentationSlide.getPageElements()[0]; // Also available for Layout, Master, and Page. currentPresentationSlide.insertPageElement(pageElement);
Parameters
Name | Type | Description |
---|---|---|
page | Page | The page element to be copied and inserted. |
Return
Page
— The inserted page element.
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
insertShape(shape)
Inserts a copy of the provided Shape
on the page.
The inserted element's position on this page is determined from the source element's position on its respective page.
If the provided element is a placeholder being copied from within the current presentation, properties that inherit from master or layout pages also inherit on the inserted element.
If the provided element is a placeholder being copied from a different presentation, properties that inherit from master or layout pages are copied onto the element from the source presentation.
// Copy a shape between presentations. const otherPresentationSlide = SlidesApp.openById('presentationId').getSlides()[0]; const currentPresentationSlide = SlidesApp.getActivePresentation().getSlides()[0]; const shape = otherPresentationSlide.getShapes[0]; currentPresentationSlide.insertShape( shape); // Also available for Layout, Master, and Page.
Parameters
Name | Type | Description |
---|---|---|
shape | Shape | The shape to be copied and inserted. |
Return
Shape
— The inserted 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
insertShape(shapeType)
Inserts a shape on the page.
The shape is inserted with a default size at the top left corner of the page.
// Insert a shape in the first slide of the presentation. const slide = SlidesApp.getActivePresentation().getSlides()[0]; // Also available for Layout, Master, and Page. slide.insertShape(SlidesApp.ShapeType.RECTANGLE);
Parameters
Name | Type | Description |
---|---|---|
shape | Shape | The type of shape to insert. |
Return
Shape
— The inserted 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
insertShape(shapeType, left, top, width, height)
Inserts a shape on the page.
Parameters
Name | Type | Description |
---|---|---|
shape | Shape | The type of shape to insert. |
left | Number | The horizontal position of the shape, measured from the upper left corner of the page. |
top | Number | The vertical position of the shape, measured from the upper left corner of the page. |
width | Number | The width of the shape. |
height | Number | The height of the shape. |
Return
Shape
— The inserted 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
insertSheetsChart(sourceChart)
Inserts a Google Sheets chart on the page.
The chart is inserted with a default size at the top left corner of the page.
The inserted chart is linked with the source Google Sheets chart which allows it to be updated. Other collaborators can see the link to the source spreadsheet.
const sheet = SpreadsheetApp.openById('spreadsheetId').getSheets()[0]; const chart = sheet.getCharts()[0]; // Insert the spreadsheet chart in the first slide. const slide = SlidesApp.getActivePresentation().getSlides()[0]; slide.insertSheetsChart(chart);
Parameters
Name | Type | Description |
---|---|---|
source | Embedded | The chart in a spreadsheet to be inserted in the page. |
Return
Sheets
— The inserted chart in the page.
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
insertSheetsChart(sourceChart, left, top, width, height)
Inserts a Google Sheets chart on the page with the provided position and size.
In order to maintain the chart's aspect ratio, the chart is scaled and centered with respect to the provided size.
The inserted chart is linked with the source Google Sheets chart which allows it to be updated. Other collaborators can see the link to the source spreadsheet.
const sheet = SpreadsheetApp.openById('spreadsheetId').getSheets()[0]; const chart = sheet.getCharts()[0]; // Insert the spreadsheet chart in the first slide. const slide = SlidesApp.getActivePresentation().getSlides()[0]; const position = { left: 0, top: 0 }; const size = { width: 200, height: 200 }; // Also available for Layout, Master, and Page. slide.insertSheetsChart( chart, position.left, position.top, size.width, size.height, );
Parameters
Name | Type | Description |
---|---|---|
source | Embedded | The chart in a spreadsheet to be inserted in the page. |
left | Number | The horizontal position of the chart in points, measured from the upper left corner of the page. |
top | Number | The vertical position of the chart in points, measured from the upper left corner of the page. |
width | Number | The width of the chart in points. |
height | Number | The height of the chart in points. |
Return
Sheets
— The inserted chart in the page.
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
insertSheetsChart(sheetsChart)
Inserts a copy of the provided Sheets
on the page.
The inserted element's position on this page is determined from the source element's position on its respective page.
If the provided element is a placeholder being copied from within the current presentation, properties that inherit from master or layout pages also inherit on the inserted element.
If the provided element is a placeholder being copied from a different presentation, properties that inherit from master or layout pages are copied onto the element from the source presentation.
// Copy a sheets chart between presentations. const otherPresentationSlide = SlidesApp.openById('presentationId').getSlides()[0]; const currentPresentationSlide = SlidesApp.getActivePresentation().getSlides()[0]; const sheetsChart = otherPresentationSlide.getSheetsCharts[0]; // Also available for Layout, Master, and Page. currentPresentationSlide.insertSheetsChart(sheetsChart);
Parameters
Name | Type | Description |
---|---|---|
sheets | Sheets | The sheets chart to be copied and inserted. |
Return
Sheets
— The inserted sheets chart.
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
insertSheetsChartAsImage(sourceChart)
Inserts a Google Sheets chart as an Image
on the page.
The image of the chart is inserted with a default size at the top left corner of the page.
The inserted image of chart is not linked with the source Google Sheets chart.
const sheet = SpreadsheetApp.openById('spreadsheetId').getSheets()[0]; const chart = sheet.getCharts()[0]; // Insert the spreadsheet chart in the first slide. const slide = SlidesApp.getActivePresentation().getSlides()[0]; slide.insertSheetsChartAsImage( chart); // Also available for Layout, Master, and Page.
Parameters
Name | Type | Description |
---|---|---|
source | Embedded | The chart in a spreadsheet to be inserted in the page. |
Return
Image
— The inserted image of the chart in the page.
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
insertSheetsChartAsImage(sourceChart, left, top, width, height)
Inserts a Google Sheets chart as an Image
on the page with the provided position and
size.
In order to maintain the chart image's aspect ratio, the image is scaled and centered with respect to the provided size.
The inserted image of the chart is not linked with the source Google Sheets chart.
const sheet = SpreadsheetApp.openById('spreadsheetId').getSheets()[0]; const chart = sheet.getCharts()[0]; // Insert the spreadsheet chart in the first slide. const slide = SlidesApp.getActivePresentation().getSlides()[0]; const position = { left: 0, top: 0 }; const size = { width: 200, height: 200 }; // Also available for Layout, Master, and Page. slide.insertSheetsChartAsImage( chart, position.left, position.right, size.width, size.height, );
Parameters
Name | Type | Description |
---|---|---|
source | Embedded | The chart in a spreadsheet to be inserted in the page. |
left | Number | The horizontal position of the chart in points, measured from the upper left corner of the page. |
top | Number | The vertical position of the chart in points, measured from the upper left corner of the page. |
width | Number | The width of the chart in points. |
height | Number | The height of the chart in points. |
Return
Image
— The inserted image of the chart in the page.
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
insertTable(numRows, numColumns)
Inserts a table on the page.
The table is centered on the page with default size and evenly distributed rows and columns.
Parameters
Name | Type | Description |
---|---|---|
num | Integer | The number of rows in the table. |
num | Integer | The number of columns in the table. |
Return
Table
— The inserted 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
insertTable(numRows, numColumns, left, top, width, height)
Inserts a table on the page with the provided position and size.
Rows and columns are evenly distributed in the created table.
Parameters
Name | Type | Description |
---|---|---|
num | Integer | The number of rows in the table. |
num | Integer | The number of columns in the table. |
left | Number | The horizontal position of the table, measured from the upper left corner of the page. |
top | Number | The vertical position of the table, measured from the upper left corner of the page. |
width | Number | The width of the table. |
height | Number | The minimum height of the table. The actual height of the rendered table depends on factors such as text font size. |
Return
Table
— The inserted 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
insertTable(table)
Inserts a copy of the provided Table
on the page.
The inserted element's position on this page is determined from the source element's position on its respective page.
If the provided element is a placeholder being copied from within the current presentation, properties that inherit from master or layout pages also inherit on the inserted element.
If the provided element is a placeholder being copied from a different presentation, properties that inherit from master or layout pages are copied onto the element from the source presentation.
// Copy a table between presentations. const otherPresentationSlide = SlidesApp.openById('presentationId').getSlides()[0]; const currentPresentationSlide = SlidesApp.getActivePresentation().getSlides()[0]; const table = otherPresentationSlide.getTables[0]; currentPresentationSlide.insertTable( table); // Also available for Layout, Master, and Page.
Parameters
Name | Type | Description |
---|---|---|
table | Table | The table to be copied and inserted. |
Return
Table
— The inserted 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
insertTextBox(text)
Inserts a text box Shape
containing the provided string on the page.
The text box shape is inserted with a default size at the top left corner of the page.
// Insert text box with "Hello" on the first slide of presentation. const slide = SlidesApp.getActivePresentation().getSlides()[0]; slide.insertTextBox('Hello'); // Also available for Layout, Master, and Page.
Parameters
Name | Type | Description |
---|---|---|
text | String | The string the text box shape should contain. |
Return
Shape
— The inserted text box 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
insertTextBox(text, left, top, width, height)
Inserts a text box Shape
containing the provided string on the page.
// Insert text box with "Hello" on the first slide of presentation. This text // box is a square with a length of 10 points on each side. const slide = SlidesApp.getActivePresentation().getSlides()[0]; slide.insertTextBox( 'Hello', 0, 0, 10, 10); // Also available for Layout, Master, and Page.
Parameters
Name | Type | Description |
---|---|---|
text | String | The string the text box shape should contain. |
left | Number | The horizontal position of the text box shape, measured from the upper left corner of the page. |
top | Number | The vertical position of the text box shape, measured from the upper left corner of the page. |
width | Number | The width of the text box shape. |
height | Number | The height of the text box shape. |
Return
Shape
— The inserted text box 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
insertVideo(videoUrl)
Inserts a video at the top left corner of the page with a default size.
Only YouTube videos are currently supported.
Parameters
Name | Type | Description |
---|---|---|
video | String | The URL of the video to insert. |
Return
Video
— The inserted 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
insertVideo(videoUrl, left, top, width, height)
Inserts a video on the page with the provided position and size.
Only YouTube videos are currently supported.
Parameters
Name | Type | Description |
---|---|---|
video | String | The URL of the video to insert. |
left | Number | The horizontal position of the video in points, measured from the upper left corner of the page. |
top | Number | The vertical position of the video in points, measured from the upper left corner of the page. |
width | Number | The width of the video in points. |
height | Number | The height of the video in points. |
Return
Video
— The inserted 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
insertVideo(video)
Inserts a copy of the provided Video
on the page.
The inserted element's position on this page is determined from the source element's position on its respective page.
If the provided element is a placeholder being copied from within the current presentation, properties that inherit from master or layout pages also inherit on the inserted element.
If the provided element is a placeholder being copied from a different presentation, properties that inherit from master or layout pages are copied onto the element from the source presentation.
// Copy a video between presentations. const otherPresentationSlide = SlidesApp.openById('presentationId').getSlides()[0]; const currentPresentationSlide = SlidesApp.getActivePresentation().getSlides()[0]; const video = otherPresentationSlide.getVideos[0]; currentPresentationSlide.insertVideo( video); // Also available for Layout, Master, and Page.
Parameters
Name | Type | Description |
---|---|---|
video | Video | The video to be copied and inserted. |
Return
Video
— The inserted 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
insertWordArt(wordArt)
Inserts a copy of the provided Word
on the page.
The inserted element's position on this page is determined from the source element's position on its respective page.
If the provided element is a placeholder being copied from within the current presentation, properties that inherit from master or layout pages also inherit on the inserted element.
If the provided element is a placeholder being copied from a different presentation, properties that inherit from master or layout pages are copied onto the element from the source presentation.
// Copy a word art between presentations. const otherPresentationSlide = SlidesApp.openById('presentationId').getSlides()[0]; const currentPresentationSlide = SlidesApp.getActivePresentation().getSlides()[0]; const wordArt = otherPresentationSlide.getWordArts[0]; // Also available for Layout, Master, and Page. currentPresentationSlide.insertWordArt(wordArt);
Parameters
Name | Type | Description |
---|---|---|
word | Word | The group to be copied and inserted. |
Return
Word
— The inserted word art.
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
remove()
Removes the page.
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 |
---|---|---|
find | String | The text to find. |
replace | 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 |
---|---|---|
find | String | The text to find. |
replace | String | The text to replace the matched text. |
match | 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
selectAsCurrentPage()
Selects the Page
in the active presentation as the current page selection
and removes any previous selection.
A script can only access the selection of the user who is running the script, and only if the script is bound to the presentation.
// Select the first slide as the current page selection and replace any previous // selection. const slide = SlidesApp.getActivePresentation().getSlides()[0]; slide.selectAsCurrentPage(); // Also available for Layout, Master, and Page.
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