Stay organized with collections Save and categorize content based on your preferences.
SpeakerSpotlightA PageElement representing a speaker spotlight.
const slide = SlidesApp.getActivePresentation().getSlides()[0];
const speakerSpotlight = slide.getPageElements()[0];
console.log(
`Page element is of type: ${
speakerSpotlight.getPageElementType().toString()}`,
); Methods Method Return type Brief description alignOnPage(alignmentPosition) SpeakerSpotlight Aligns the element to the specified alignment position on the page. bringForward() SpeakerSpotlight Brings the page element forward on the page by one element. bringToFront() SpeakerSpotlight Brings the page element to the front of the page. duplicate() PageElement Duplicates the page element. getBorder() Border Returns the Border of the speaker spotlight. getConnectionSites() ConnectionSite[] Returns the list of ConnectionSites on the page element, or an empty list if the page element does not have any connection sites. getDescription() String Returns the page element's alt text description. 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. getMaskShapeType() ShapeType Returns the ShapeType of the mask applied to the speaker spotlight, or null if there is no mask. 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. getRotation() Number Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. 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) SpeakerSpotlight Preconcatenates the provided transform to the existing transform of the page element. remove() void Removes the page element. scaleHeight(ratio) SpeakerSpotlight Scales the element's height by the specified ratio. scaleWidth(ratio) SpeakerSpotlight 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() SpeakerSpotlight Sends the page element backward on the page by one element. sendToBack() SpeakerSpotlight Sends the page element to the back of the page. setDescription(description) SpeakerSpotlight Sets the page element's alt text description. setHeight(height) SpeakerSpotlight 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) SpeakerSpotlight Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. setRotation(angle) SpeakerSpotlight Sets the element's clockwise rotation angle around its center in degrees. setTitle(title) SpeakerSpotlight Sets the page element's alt text title. setTop(top) SpeakerSpotlight 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) SpeakerSpotlight Sets the transform of the page element with the provided transform. setWidth(width) SpeakerSpotlight 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
SpeakerSpotlight — 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.
ReturnSpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationsbringToFront()
Brings the page element to the front of the page.
The page element must not be in a group.
ReturnSpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationsduplicate()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetBorder()
Returns the Border of the speaker spotlight.
const slide = SlidesApp.getActivePresentation().getSlides()[0]; // Gets the first element on the page, which in // this example is of type speaker spotlight. const speakerSpotlight = slide.getPageElements()[0]; // Gets the border of the speaker spotlight. const border = speakerSpotlight.getBorder();Return
Border — The border of the speaker spotlight.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsgetConnectionSites()
Returns the list of ConnectionSites 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.currentonlyhttps://www.googleapis.com/auth/presentationsgetDescription()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetHeight()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetInherentHeight()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetInherentWidth()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetLeft()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetMaskShapeType()
Returns the ShapeType of the mask applied to the speaker spotlight, or null if there is no mask.
const slide = SlidesApp.getActivePresentation().getSlides()[0]; // Gets the first element on the page, which in // this example is of type speaker spotlight. const speakerSpotlight = slide.getPageElements()[0]; // Gets the shape type of the mask on the speaker spotlight. const maskShapeType = speakerSpotlight.getMaskShapeType();Return
ShapeType — The shape type of the speaker spotlight mask.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsgetObjectId()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetPageElementType()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetParentGroup()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetParentPage()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetRotation()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetTitle()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetTop()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetTransform()
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.currentonlyhttps://www.googleapis.com/auth/presentationsgetWidth()
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.currentonlyhttps://www.googleapis.com/auth/presentationspreconcatenateTransform(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
SpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationsremove()
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.currentonlyhttps://www.googleapis.com/auth/presentationsscaleHeight(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
SpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationsscaleWidth(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
SpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationsselect()
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.currentonlyhttps://www.googleapis.com/auth/presentationsselect(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.currentonlyhttps://www.googleapis.com/auth/presentationssendBackward()
Sends the page element backward on the page by one element.
The page element must not be in a group.
ReturnSpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationssendToBack()
Sends the page element to the back of the page.
The page element must not be in a group.
ReturnSpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationssetDescription(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
SpeakerSpotlight — This page element.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetHeight(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
SpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationssetLeft(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
SpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationssetRotation(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
SpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationssetTitle(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
SpeakerSpotlight — This page element.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetTop(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
SpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationssetTransform(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
SpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationssetWidth(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
SpeakerSpotlight — 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.currentonlyhttps://www.googleapis.com/auth/presentationsExcept 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 `SpeakerSpotlight` class in Google Apps Script allows manipulation of speaker spotlight elements in Google Slides."],["It provides methods for positioning, scaling, rotation, appearance control, and information retrieval."],["Developers can access and modify properties like height, width, border, mask, description, and title."],["Authorization with specific Google API scopes is required for most methods."],["Usage examples demonstrate retrieving a spotlight element and aligning it on the slide."]]],[]]
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