Stay organized with collections Save and categorize content based on your preferences.
ShapeA PageElement
representing a generic shape that does not have a more specific classification. Includes text boxes, rectangles, and other predefined shapes.
alignOnPage(alignmentPosition)
Shape
Aligns the element to the specified alignment position on the page. bringForward()
Shape
Brings the page element forward on the page by one element. bringToFront()
Shape
Brings the page element to the front of the page. duplicate()
PageElement
Duplicates the page element. getAutofit()
Autofit
Returns the Autofit
of the text within this shape. getBorder()
Border
Returns the Border
of the shape. getConnectionSites()
ConnectionSite[]
Returns the list of ConnectionSite
s on the page element, or an empty list if the page element does not have any connection sites. getContentAlignment()
ContentAlignment
Returns the ContentAlignment
of the text in the shape. getDescription()
String
Returns the page element's alt text description. getFill()
Fill
Returns the Fill
of the shape. getHeight()
Number
Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. getInherentHeight()
Number
Returns the element's inherent height in points. getInherentWidth()
Number
Returns the element's inherent width in points. getLeft()
Number
Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. getLink()
Link
Returns the Link
or null
if there is no link. getObjectId()
String
Returns the unique ID for this object. getPageElementType()
PageElementType
Returns the page element's type, represented as a PageElementType
enum. getParentGroup()
Group
Returns the group this page element belongs to, or null
if the element is not in a group. getParentPage()
Page
Returns the page this page element is on. getParentPlaceholder()
PageElement
Returns the parent page element of the placeholder. getPlaceholderIndex()
Integer
Returns the placeholder index of the shape. getPlaceholderType()
PlaceholderType
Returns the placeholder type of the shape, or PlaceholderType.NONE
if the shape is not a placeholder. getRotation()
Number
Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. getShapeType()
ShapeType
Returns the type of the shape. getText()
TextRange
Returns the text content of the shape. getTitle()
String
Returns the page element's alt text title. getTop()
Number
Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. getTransform()
AffineTransform
Returns the page element's transform. getWidth()
Number
Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. preconcatenateTransform(transform)
Shape
Preconcatenates the provided transform to the existing transform of the page element. remove()
void
Removes the page element. removeLink()
void
Removes a Link
. replaceWithImage(blobSource)
Image
Replaces this shape with an image provided by a BlobSource
. replaceWithImage(blobSource, crop)
Image
Replaces this shape with an image provided by a BlobSource
. replaceWithImage(imageUrl)
Image
Replaces this shape with an image. replaceWithImage(imageUrl, crop)
Image
Replaces this shape with an image. replaceWithSheetsChart(sourceChart)
SheetsChart
Replaces this shape with a Google Sheets chart. replaceWithSheetsChartAsImage(sourceChart)
Image
Replaces this shape with an image of a Google Sheets chart. scaleHeight(ratio)
Shape
Scales the element's height by the specified ratio. scaleWidth(ratio)
Shape
Scales the element's width by the specified ratio. select()
void
Selects only the PageElement
in the active presentation and removes any previous selection. select(replace)
void
Selects the PageElement
in the active presentation. sendBackward()
Shape
Sends the page element backward on the page by one element. sendToBack()
Shape
Sends the page element to the back of the page. setContentAlignment(contentAlignment)
Shape
Sets the ContentAlignment
of the text in the shape. setDescription(description)
Shape
Sets the page element's alt text description. setHeight(height)
Shape
Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. setLeft(left)
Shape
Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. setLinkSlide(slideIndex)
Link
Sets a Link
to the given Slide
using the zero-based index of the slide. setLinkSlide(slide)
Link
Sets a Link
to the given Slide
, the link is set by the given slide ID. setLinkSlide(slidePosition)
Link
Sets a Link
to the given Slide
using the relative position of the slide. setLinkUrl(url)
Link
Sets a Link
to the given non-empty URL string. setRotation(angle)
Shape
Sets the element's clockwise rotation angle around its center in degrees. setTitle(title)
Shape
Sets the page element's alt text title. setTop(top)
Shape
Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. setTransform(transform)
Shape
Sets the transform of the page element with the provided transform. setWidth(width)
Shape
Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation. Detailed documentation alignOnPage(alignmentPosition)
Aligns the element to the specified alignment position on the page.
Parameters Name Type DescriptionalignmentPosition
AlignmentPosition
The position to align this page element to on the page. Return
Shape
— This page element, for chaining.
bringForward()
Brings the page element forward on the page by one element.
The page element must not be in a group.
ReturnShape
— This page element, for chaining.
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
bringToFront()
Brings the page element to the front of the page.
The page element must not be in a group.
ReturnShape
— This page element, for chaining.
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
duplicate()
Duplicates the page element.
The duplicate page element is placed on the same page at the same position as the original.
ReturnPageElement
— The new duplicate of this page element.
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
getAutofit()
Returns the Autofit
of the text within this shape. This is null
if the shape doesn't allow text.
Autofit
— The autofit of the text within this shape.
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
getBorder()
Returns the Border
of the shape.
Border
— The border setting of this shape.
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
getConnectionSites()
Returns the list of ConnectionSite
s on the page element, or an empty list if the page element does not have any connection sites.
ConnectionSite[]
— The connection sites list, which may be empty if this element has no connection sites.
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
getContentAlignment()
Returns the ContentAlignment
of the text in the shape.
ContentAlignment
— The alignment of text within this shape.
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
getDescription()
Returns the page element's alt text description. The description is combined with the title to display and read alt text.
ReturnString
— The page element's alt text description.
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
getFill()
Returns the Fill
of the shape.
Fill
— The fill setting of this shape.
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
getHeight()
Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations.
ReturnNumber
— The page element's inherent height in points, or null
if the page element does not have a height.
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
getInherentHeight()
Returns the element's inherent height in points.
The page element's transform is relative to its inherent size. Use the inherent size in conjunction with the element's transform to determine the element's final visual appearance.
ReturnNumber
— The page element's inherent height in points, or null
if the page element does not have a height.
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
getInherentWidth()
Returns the element's inherent width in points.
The page element's transform is relative to its inherent size. Use the inherent size in conjunction with the element's transform to determine the element's final visual appearance.
ReturnNumber
— The page element's inherent width in points, or null
if the page element does not have a width.
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
getLeft()
Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
ReturnNumber
— This element's horizontal position in points, from the upper-left corner of the page.
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
getLink()
Returns the Link
or null
if there is no link.
const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0]; const link = shape.getLink(); if (link != null) { Logger.log(`Shape has a link of type: ${link.getLinkType()}`); }Return
Link
— The Link
or null
if there is no link.
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()
Returns the unique ID for this object. Object IDs used by pages and page elements share the same namespace.
ReturnString
— The unique ID for this object.
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
getPageElementType()
Returns the page element's type, represented as a PageElementType
enum.
PageElementType
— The page element's type.
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
getParentGroup()
Returns the group this page element belongs to, or null
if the element is not in a group.
Group
— The group this page element belongs to, or null
.
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
getParentPage()
Returns the page this page element is on.
ReturnPage
— The page this element resides on.
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
getParentPlaceholder()
Returns the parent page element of the placeholder. Returns null
if the shape is not a placeholder or has no parent.
PageElement
— The parent page element of this shape placeholder, or null
if this shape is not a placeholder or doesn't have a parent.
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
getPlaceholderIndex()
Returns the placeholder index of the shape. If two or more instances of the same placeholder types are present in the same page, they each have their own unique index value. Returns null
if the shape is not a placeholder.
Integer
— This shape's placeholder index, or null
if the shape is not a placeholder.
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
getPlaceholderType()
Returns the placeholder type of the shape, or PlaceholderType.NONE
if the shape is not a placeholder.
PlaceholderType
— The placeholder type of this shape.
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
getRotation()
Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation.
ReturnNumber
— The rotation angle in degrees between 0 (inclusive) and 360 (exclusive).
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
getShapeType()
Returns the type of the shape.
ReturnShapeType
— The type of this shape.
getText()
Returns the text content of the shape.
Text within a shape always terminates with a newline character.
ReturnTextRange
— The text content of this shape.
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
getTitle()
Returns the page element's alt text title. The title is combined with the description to display and read alt text.
ReturnString
— The page element's alt text title.
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
getTop()
Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
ReturnNumber
— This element's vertical position in points, from the upper-left corner of the page.
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
getTransform()
Returns the page element's transform.
The visual appearance of the page element is determined by its absolute transform. To compute the absolute transform, preconcatenate a page element's transform with the transforms of all of its parent groups. If the page element is not in a group, its absolute transform is the same as the value in this field.
ReturnAffineTransform
— The page element's transform.
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
getWidth()
Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation.
This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations.
ReturnNumber
— The page element's inherent width in points, or null
if the page element does not have a width.
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
preconcatenateTransform(transform)
Preconcatenates the provided transform to the existing transform of the page element.
newTransform = argument * existingTransform;
For example, to move a page elements 36 points to the left:
const element = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0]; element.preconcatenateTransform( SlidesApp.newAffineTransformBuilder().setTranslateX(-36.0).build(), );
You can also replace the page element's transform with setTransform(transform)
.
transform
AffineTransform
The transform to preconcatenate onto this page element's transform. Return
Shape
— This page element, for chaining.
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 element.
If after a remove operation, a Group
contains only one or no page elements, the group itself is also removed.
If a placeholder PageElement
is removed on a master or layout, any empty inheriting placeholders are also removed.
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
removeLink()
Removes a Link
.
const slides = SlidesApp.getActivePresentation().getSlides(); slides[1].getShapes()[0].removeLink();
replaceWithImage(blobSource)
Replaces this shape with an image provided by a BlobSource
.
The image is fetched from the provided BlobSource
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 PNG, JPEG, or GIF format.
In order to maintain the image's aspect ratio, the image is scaled and centered with respect to the size of the existing shape.
const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0]; // Get the Drive image file with the given ID. const driveImage = DriveApp.getFileById('123abc'); shape.replaceWithImage(driveImage);Parameters Name Type Description
blobSource
BlobSource
The image data. Return
Image
— The Image
that replaced the shape.
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
replaceWithImage(blobSource, crop)
Replaces this shape with an image provided by a BlobSource
.
Inserting the image fetches it from the BlobSource
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 shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0]; // Get the Drive image file with the given ID. const driveImage = DriveApp.getFileById('123abc'); // Replace and crop the replaced image. shape.replaceWithImage(driveImage, true);Parameters Name Type Description
blobSource
BlobSource
The image data. crop
Boolean
If true
, crops the image to fit the existing shape's size. Otherwise, the image is scaled and centered. Return
Image
— The Image
that replaced the shape.
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
replaceWithImage(imageUrl)
Replaces this shape with an image.
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 size of the existing shape.
Parameters Name Type DescriptionimageUrl
String
The image URL to download the image from. Return
Image
— The Image
that replaced the shape.
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
replaceWithImage(imageUrl, crop)
Replaces this shape with an image.
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 no larger than 2kB. The URL itself is saved with the image and exposed via Image.getSourceUrl()
.
imageUrl
String
The image URL to download the image from. crop
Boolean
If true
, crops the image to fit the existing shape's size. Otherwise, the image is scaled and centered. Return
Image
— The Image
that replaced the shape.
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
replaceWithSheetsChart(sourceChart)
Replaces this shape with a Google Sheets chart.
The 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]; // Replace the shape with the Sheets chart. const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0]; shape.replaceWithSheetsChart(chart);Parameters Name Type Description
sourceChart
EmbeddedChart
The chart in a spreadsheet that replaces the shape. Return
SheetsChart
— The chart that replaced the shape.
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
replaceWithSheetsChartAsImage(sourceChart)
Replaces this shape with an image of a Google Sheets chart.
In order to maintain the Google Sheets chart's aspect ratio, the chart image is scaled and centered with respect to the size of the existing shape.
The 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]; // Replace the shape with the Sheets chart as an image. const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0]; shape.replaceWithSheetsChartAsImage(chart);Parameters Name Type Description
sourceChart
EmbeddedChart
The chart in a spreadsheet that replaces the shape. Return
Image
— The image of the chart that replaced the shape.
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
scaleHeight(ratio)
Scales the element's height by the specified ratio. The element's height is the height of its bounding box when the element has no rotation.
This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations.
Parameters Name Type Descriptionratio
Number
The ratio to scale this page element's height by. Return
Shape
— This page element, for chaining.
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
scaleWidth(ratio)
Scales the element's width by the specified ratio. The element's width is the width of its bounding box when the element has no rotation.
This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations.
Parameters Name Type Descriptionratio
Number
The ratio to scale this page element's width by. Return
Shape
— This page element, for chaining.
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
select()
Selects only the PageElement
in the active presentation and removes any previous selection. This is the same as calling select(replace)
with true
.
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.
This sets the parent Page
of the PageElement
as the current page selection
.
const slide = SlidesApp.getActivePresentation().getSlides()[0]; const pageElement = slide.getPageElements()[0]; // Only select this page element and replace any previous selection. pageElement.select();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
select(replace)
Selects the PageElement
in the active presentation.
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.
Pass true
to this method to select only the PageElement
and remove any previous selection. This also sets the parent Page
of the PageElement
as the current page selection
.
Pass false
to select multiple PageElement
objects. The PageElement
objects must be in the same Page
.
The following conditions must be met while selecting a page element using a false
parameter:
Page
of the PageElement
object must be the current page selection
.Page
objects selected.To make sure that’s the case the preferred approach is to select the parent Page
first using Page.selectAsCurrentPage()
and then select the page elements in that page.
const slide = SlidesApp.getActivePresentation().getSlides()[0]; // First select the slide page, as the current page selection. slide.selectAsCurrentPage(); // Then select all the page elements in the selected slide page. const pageElements = slide.getPageElements(); for (let i = 0; i < pageElements.length; i++) { pageElements[i].select(false); }Parameters Name Type Description
replace
Boolean
If true
, the selection replaces any previous selection; otherwise the selection is added to any previous selection. 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
sendBackward()
Sends the page element backward on the page by one element.
The page element must not be in a group.
ReturnShape
— This page element, for chaining.
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
sendToBack()
Sends the page element to the back of the page.
The page element must not be in a group.
ReturnShape
— This page element, for chaining.
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
setContentAlignment(contentAlignment)
Sets the ContentAlignment
of the text in the shape.
This method automatically deactivates text autofit properties on the updated shapes.
Parameters ReturnShape
— This shape, for chaining.
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
setDescription(description)
Sets the page element's alt text description.
The method is not supported for Group
elements.
// Set the first page element's alt text description to "new alt text // description". const pageElement = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0]; pageElement.setDescription('new alt text description'); Logger.log(pageElement.getDescription());Parameters Name Type Description
description
String
The string to set the alt text description to. Return
Shape
— This page element.
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
setHeight(height)
Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations.
Parameters Name Type Descriptionheight
Number
The new height of this page element to set, in points. Return
Shape
— This page element, for chaining.
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
setLeft(left)
Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
Parameters Name Type Descriptionleft
Number
The new horizontal position to set, in points. Return
Shape
— This page element, for chaining.
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
setLinkSlide(slideIndex)
Sets a Link
to the given Slide
using the zero-based index of the slide.
// Set a link to the first slide of the presentation. const slides = SlidesApp.getActivePresentation().getSlides(); const shape = slides[1].getShapes()[0]; const link = shape.setLinkSlide(0);Parameters Name Type Description
slideIndex
Integer
The zero-based index to the slide. 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
setLinkSlide(slide)
Sets a Link
to the given Slide
, the link is set by the given slide ID.
// Set a link to the first slide of the presentation. const slides = SlidesApp.getActivePresentation().getSlides(); const shape = slides[1].getShapes()[0]; const link = shape.setLinkSlide(slides[0]);Parameters Name Type Description
slide
Slide
The Slide
to be linked. 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
setLinkSlide(slidePosition)
Sets a Link
to the given Slide
using the relative position of the slide.
// Set a link to the first slide of the presentation. const slides = SlidesApp.getActivePresentation().getSlides(); const shape = slides[1].getShapes()[0]; const link = shape.setLinkSlide(SlidesApp.SlidePosition.FIRST_SLIDE);Parameters 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
setLinkUrl(url)
Sets a Link
to the given non-empty URL string.
// Set a link to the URL. const slides = SlidesApp.getActivePresentation().getSlides(); const shape = slides[1].getShapes()[0]; const link = shape.setLinkUrl('https://slides.google.com');Parameters Name Type Description
url
String
The URL string. 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
setRotation(angle)
Sets the element's clockwise rotation angle around its center in degrees.
This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations.
Parameters Name Type Descriptionangle
Number
The new clockwise rotation angle to set, in degrees. Return
Shape
— This page element, for chaining.
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
setTitle(title)
Sets the page element's alt text title.
The method is not supported for Group
elements.
// Set the first page element's alt text title to "new alt text title". const pageElement = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0]; pageElement.setTitle('new alt text title'); Logger.log(pageElement.getTitle());Parameters Name Type Description
title
String
The string to set the alt text title to. Return
Shape
— This page element.
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
setTop(top)
Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
Parameters Name Type Descriptiontop
Number
The new vertical position to set, in points. Return
Shape
— This page element, for chaining.
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
setTransform(transform)
Sets the transform of the page element with the provided transform.
Updating the transform of a group changes the absolute transform of the page elements in that group, which can change their visual appearance.
Updating the transform of a page element that is in a group only changes the transform of that page element; it doesn't affect the transforms of the group or other page elements in the group.
For details on how transforms impact the visual appearance of page elements, see getTransform()
.
transform
AffineTransform
The transform that is set for this page element. Return
Shape
— This element, for chaining.
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
setWidth(width)
Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation.
This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations.
Parameters Name Type Descriptionwidth
Number
The new width of this page element to set, in points. Return
Shape
— This page element, for chaining.
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-03 UTC."],[[["The Google Slides API provides a `Shape` object to interact with and manipulate various elements on a slide, including text boxes, images, and auto-shapes."],["Developers can use the API to programmatically change the position, size, rotation, styling, and content of shapes within a Google Slide."],["The API offers methods for replacing shapes with images, charts, or other content, enabling dynamic presentations."],["Most `Shape` object methods require authorization with specific Google API scopes to ensure proper access and security."],["Refer to the Google Apps Script documentation for in-depth details on each method and its usage within the Google Slides API."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4