Class SpeakerSpotlight
Page Summary
SpeakerSpotlight is a PageElement representing a speaker spotlight in Google Slides.
SpeakerSpotlight provides methods to manipulate its position, size, appearance, and properties.
Methods like
alignOnPage,bringForward,bringToFront,sendBackward, andsendToBackcontrol the element's layering and alignment.Properties like border, connection sites, description, height, width, left, top, rotation, title, mask shape type, object ID, page element type, parent group, parent page, and transform can be accessed and modified using dedicated methods.
SpeakerSpotlight can be duplicated, removed, and selected using the
duplicate,remove, andselectmethods respectively.
APage representing a speaker spotlight.
constslide=SlidesApp.getActivePresentation().getSlides()[0];constspeakerSpotlight=slide.getPageElements()[0];console.log(`Page element is of type:${speakerSpotlight.getPageElementType().toString()}`,);
Methods
| Method | Return type | Brief description |
|---|---|---|
align | Speaker | Aligns the element to the specified alignment position on the page. |
bring | Speaker | Brings the page element forward on the page by one element. |
bring | Speaker | Brings the page element to the front of the page. |
duplicate() | Page | Duplicates the page element. |
get | Border | Returns theBorder of the speaker spotlight. |
get | Connection | Returns the list ofConnections on the page element, or an empty list if the pageelement does not have any connection sites. |
get | String | Returns the page element's alt text description. |
get | Number|null | Gets the element's height in points, which is the height of the element's bounding box when theelement has no rotation. |
get | Number|null | Returns the element's inherent height in points. |
get | Number|null | Returns the element's inherent width in points. |
get | Number | Returns the element's horizontal position in points, measured from the upper-left corner of thepage when the element has no rotation. |
get | Shape | Returns theShape of the mask applied to the speaker spotlight, ornull ifthere is no mask. |
get | String | Returns the unique ID for this object. |
get | Page | Returns the page element's type, represented as aPage enum. |
get | Group|null | Returns the group this page element belongs to, ornull if the element is not in agroup. |
get | Page | Returns the page this page element is on. |
get | Number | Returns the element's clockwise rotation angle around its center in degrees, where zero degreesmeans no rotation. |
get | String | Returns the page element's alt text title. |
get | Number | Gets the element's vertical position in points, measured from the upper-left corner of the pagewhen the element has no rotation. |
get | Affine | Returns the page element's transform. |
get | Number|null | Returns the element's width in points, which is the width of the element's bounding box whenthe element has no rotation. |
preconcatenate | Speaker | Preconcatenates the provided transform to the existing transform of the page element. |
remove() | void | Removes the page element. |
scale | Speaker | Scales the element's height by the specified ratio. |
scale | Speaker | Scales the element's width by the specified ratio. |
select() | void | Selects only thePage in the active presentation and removes any previousselection. |
select(replace) | void | Selects thePage in the active presentation. |
send | Speaker | Sends the page element backward on the page by one element. |
send | Speaker | Sends the page element to the back of the page. |
set | Speaker | Sets the page element's alt text description. |
set | Speaker | Sets the element's height in points, which is the height of the element's bounding box when theelement has no rotation. |
set | Speaker | Sets the element's horizontal position in points, measured from the upper-left corner of thepage when the element has no rotation. |
set | Speaker | Sets the element's clockwise rotation angle around its center in degrees. |
set | Speaker | Sets the page element's alt text title. |
set | Speaker | Sets the element's vertical position in points, measured from the upper-left corner of the pagewhen the element has no rotation. |
set | Speaker | Sets the transform of the page element with the provided transform. |
set | Speaker | Sets the element's width in points, which is the width of the element's bounding box when theelement has no rotation. |
Detailed documentation
alignOnPage(alignmentPosition)
Aligns the element to the specified alignment position on the page.
Parameters
| Name | Type | Description |
|---|---|---|
alignment | Alignment | The position to align this page element to on the page. |
Return
Speaker — 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.
Return
Speaker — This page element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://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.
Return
Speaker — This page element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://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.
Return
Page — The new duplicate of this page element.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getBorder()
Returns theBorder of the speaker spotlight.
constslide=SlidesApp.getActivePresentation().getSlides()[0];// Gets the first element on the page, which in// this example is of type speaker spotlight.constspeakerSpotlight=slide.getPageElements()[0];// Gets the border of the speaker spotlight.constborder=speakerSpotlight.getBorder();
Return
Border — The border of the speaker spotlight.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getConnectionSites()
Returns the list ofConnections on the page element, or an empty list if the pageelement does not have any connection sites.
Return
Connection — The connection sites list, which may be empty if this element has no connection sites.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getDescription()
Returns the page element's alt text description. The description is combined with the title todisplay and read alt text.
Return
String — The page element's alt text description.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getHeight()
Gets the element's height in points, which is the height of the element's bounding box when theelement has no rotation.
This method isn't compatible with all page elements. To learn which page elements aren'tcompatible with this method, refer to thesizing and positioning limitations.
Return
Number|null — The page element's inherent height in points, ornull if the page element does not have a height.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://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 inconjunction with the element's transform to determine the element's final visual appearance.
Return
Number|null — The page element's inherent height in points, ornull if the page element does not have a height.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://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 inconjunction with the element's transform to determine the element's final visual appearance.
Return
Number|null — The page element's inherent width in points, ornull if the page element does not have a width.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getLeft()
Returns the element's horizontal position in points, measured from the upper-left corner of thepage when the element has no rotation.
Return
Number — This element's horizontal position in points, from the upper-left corner of the page.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getMaskShapeType()
Returns theShape of the mask applied to the speaker spotlight, ornull ifthere is no mask.
constslide=SlidesApp.getActivePresentation().getSlides()[0];// Gets the first element on the page, which in// this example is of type speaker spotlight.constspeakerSpotlight=slide.getPageElements()[0];// Gets the shape type of the mask on the speaker spotlight.constmaskShapeType=speakerSpotlight.getMaskShapeType();
Return
Shape — The shape type of the speaker spotlight mask.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getObjectId()
Returns the unique ID for this object. Object IDs used by pages and page elements share thesame namespace.
Return
String — The unique ID for this object.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getPageElementType()
Returns the page element's type, represented as aPage enum.
Return
Page — The page element's type.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getParentGroup()
Returns the group this page element belongs to, ornull if the element is not in agroup.
Return
Group|null — The group this page element belongs to, ornull.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getParentPage()
getRotation()
Returns the element's clockwise rotation angle around its center in degrees, where zero degreesmeans no rotation.
Return
Number — The rotation angle in degrees between 0 (inclusive) and 360 (exclusive).
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getTitle()
Returns the page element's alt text title. The title is combined with the description todisplay and read alt text.
Return
String — The page element's alt text title.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getTop()
Gets the element's vertical position in points, measured from the upper-left corner of the pagewhen the element has no rotation.
Return
Number — This element's vertical position in points, from the upper-left corner of the page.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://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. Tocompute the absolute transform, preconcatenate a page element's transform with the transformsof all of its parent groups. If the page element is not in a group, its absolute transform isthe same as the value in this field.
Return
Affine — The page element's transform.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
getWidth()
Returns the element's width in points, which is the width of the element's bounding box whenthe element has no rotation.
This method isn't compatible with all page elements. To learn which page elements aren'tcompatible with this method, refer to thesizing and positioning limitations.
Return
Number|null — The page element's inherent width in points, ornull if the page element does not have a width.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://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:
constelement=SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0];element.preconcatenateTransform(SlidesApp.newAffineTransformBuilder().setTranslateX(-36.0).build(),);
You can also replace the page element's transform withset.
Parameters
| Name | Type | Description |
|---|---|---|
transform | Affine | The transform to preconcatenate onto this page element's transform. |
Return
Speaker — This page element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
remove()
Removes the page element.
If after a remove operation, aGroup contains only one or no page elements, thegroup itself is also removed.
If a placeholderPage is removed on a master or layout, any empty inheritingplaceholders are also removed.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
scaleHeight(ratio)
Scales the element's height by the specified ratio. The element's height is the height of itsbounding box when the element has no rotation.
This method isn't compatible with all page elements. To learn which page elements aren'tcompatible with this method, refer to thesizing and positioning limitations.
Parameters
| Name | Type | Description |
|---|---|---|
ratio | Number | The ratio to scale this page element's height by. |
Return
Speaker — This page element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
scaleWidth(ratio)
Scales the element's width by the specified ratio. The element's width is the width of itsbounding box when the element has no rotation.
This method isn't compatible with all page elements. To learn which page elements aren'tcompatible with this method, refer to thesizing and positioning limitations.
Parameters
| Name | Type | Description |
|---|---|---|
ratio | Number | The ratio to scale this page element's width by. |
Return
Speaker — This page element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
select()
Selects only thePage in the active presentation and removes any previousselection. This is the same as callingselect(replace) withtrue.
A script can only access the selection of the user who is running the script, and only ifthe script isbound to the presentation.
This sets the parentPage of thePage as thecurrent page selection.
constslide=SlidesApp.getActivePresentation().getSlides()[0];constpageElement=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 followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
select(replace)
Selects thePage in the active presentation.
A script can only access the selection of the user who is running the script, and only ifthe script isbound to the presentation.
Passtrue to this method to select only thePage and remove anyprevious selection. This also sets the parentPage of thePage as thecurrent page selection.
Passfalse to select multiplePage objects. ThePageobjects must be in the samePage.
The following conditions must be met while selecting a page element using afalseparameter:
- The parent
Pageof thePageobject must be theElement current page selection. - There should not be multiple
Pageobjects selected.
To make sure that’s the case the preferred approach is to select the parentPagefirst usingPage.selectAsCurrentPage() and then select the page elements in that page.
constslide=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.constpageElements=slide.getPageElements();for(leti=0;i <pageElements.length;i++){pageElements[i].select(false);}
Parameters
| Name | Type | Description |
|---|---|---|
replace | Boolean | Iftrue, 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 followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://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.
Return
Speaker — This page element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://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.
Return
Speaker — This page element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
setDescription(description)
Sets the page element's alt text description.
The method is not supported forGroup elements.
// Set the first page element's alt text description to "new alt text// description".constpageElement=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
Speaker — This page element.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://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 theelement has no rotation.
This method isn't compatible with all page elements. To learn which page elements aren'tcompatible with this method, refer to thesizing and positioning limitations.
Parameters
| Name | Type | Description |
|---|---|---|
height | Number | The new height of this page element to set, in points. |
Return
Speaker — This page element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
setLeft(left)
Sets the element's horizontal position in points, measured from the upper-left corner of thepage when the element has no rotation.
Parameters
| Name | Type | Description |
|---|---|---|
left | Number | The new horizontal position to set, in points. |
Return
Speaker — This page element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://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'tcompatible with this method, refer to thesizing and positioning limitations.
Parameters
| Name | Type | Description |
|---|---|---|
angle | Number | The new clockwise rotation angle to set, in degrees. |
Return
Speaker — This page element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
setTitle(title)
Sets the page element's alt text title.
The method is not supported forGroup elements.
// Set the first page element's alt text title to "new alt text title".constpageElement=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
Speaker — This page element.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
setTop(top)
Sets the element's vertical position in points, measured from the upper-left corner of the pagewhen the element has no rotation.
Parameters
| Name | Type | Description |
|---|---|---|
top | Number | The new vertical position to set, in points. |
Return
Speaker — This page element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://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 inthat group, which can change their visual appearance.
Updating the transform of a page element that is in a group only changes the transform ofthat page element; it doesn't affect the transforms of the group or other page elements in thegroup.
For details on how transforms impact the visual appearance of page elements, seeget.
Parameters
| Name | Type | Description |
|---|---|---|
transform | Affine | The transform that is set for this page element. |
Return
Speaker — This element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://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 theelement has no rotation.
This method isn't compatible with all page elements. To learn which page elements aren'tcompatible with this method, refer to thesizing and positioning limitations.
Parameters
| Name | Type | Description |
|---|---|---|
width | Number | The new width of this page element to set, in points. |
Return
Speaker — This page element, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentations
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.