AI-generated Key Takeaways
-  WordArt is a PageElement that represents word art and provides methods to manipulate its properties and behavior. 
-  WordArt elements can be aligned on the page, moved forward or backward in layering, duplicated, and removed. 
-  You can retrieve various properties of a WordArt element, such as its connection sites, alt text description and title, dimensions, position, link, object ID, page element type, parent group or page, rendered text, rotation, and transform. 
-  You can modify properties of a WordArt element, including its alt text description and title, dimensions (height and width), position (left and top), link, rotation, and transform. 
-  WordArt elements can be selected in the active presentation, replacing previous selections or being added to the current selection. 
A  Page  
representing word art.
Methods
| Method | Return type | Brief description | 
|---|---|---|
|  Word  | Aligns the element to the specified alignment position on the page. | |
|  Word  | Brings the page element forward on the page by one element. | |
|  Word  | Brings the page element to the front of the page. | |
|  Page  | Duplicates the page element. | |
|  Connection  | Returns the list of Connection s on the page element, or an empty list if the page
element does not have any connection sites. | |
| String | Returns the page element's alt text description. | |
| Number | Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. | |
| Number | Returns the element's inherent height in points. | |
| Number | Returns the element's inherent width in points. | |
| Number | Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. | |
|  Link 
 | Returns the  Link 
ornullif there is no link. | |
| String | Returns the unique ID for this object. | |
|  Page  | Returns the page element's type, represented as a  Page enum. | |
|  Group 
 | Returns the group this page element belongs to, or nullif the element is not in a
group. | |
|  Page 
 | Returns the page this page element is on. | |
| String | Gets the text that is rendered as word art. | |
| Number | Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. | |
| String | Returns the page element's alt text title. | |
| Number | Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. | |
|  Affine  | Returns the page element's transform. | |
| Number | Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. | |
|  Word  | Preconcatenates the provided transform to the existing transform of the page element. | |
| void | Removes the page element. | |
| void | Removes a  Link 
. | |
|  Word  | Scales the element's height by the specified ratio. | |
|  Word  | Scales the element's width by the specified ratio. | |
| void | Selects only the  Page in the active presentation and removes any previous
selection. | |
| void | Selects the  Page in the active presentation. | |
|  Word  | Sends the page element backward on the page by one element. | |
|  Word  | Sends the page element to the back of the page. | |
|  Word  | Sets the page element's alt text description. | |
|  Word  | Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. | |
|  Word  | Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. | |
|  Link 
 | Sets a  Link 
to the given Slide 
using the zero-based index of the slide. | |
|  Link 
 | Sets a  Link 
to the given Slide 
, the link is set by the given slide ID. | |
|  Link 
 | Sets a  Link 
to the given Slide 
using the relative position of the slide. | |
|  Link 
 | Sets a  Link 
to the given non-empty URL string. | |
|  Word  | Sets the element's clockwise rotation angle around its center in degrees. | |
|  Word  | Sets the page element's alt text title. | |
|  Word  | Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. | |
|  Word  | Sets the transform of the page element with the provided transform. | |
|  Word  | 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
 align  
 
 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
  Word  
— This page element, for chaining.
 bring  
 
 Brings the page element forward on the page by one element.
The page element must not be in a group.
Return
  Word  
— This page element, for chaining.
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
 bring  
 
 Brings the page element to the front of the page.
The page element must not be in a group.
Return
  Word  
— This page element, for chaining.
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
 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 following scopes :
-  https://www.googleapis.com/auth/presentations.currentonly
-  https://www.googleapis.com/auth/presentations
 get  
 
 Returns the list of Connection  
s on the page element, or an empty list if the page
element 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 following scopes :
-  https://www.googleapis.com/auth/presentations.currentonly
-  https://www.googleapis.com/auth/presentations
 get  
 
 Returns the page element's alt text description. The description is combined with the title to display 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 following scopes :
-  https://www.googleapis.com/auth/presentations.currentonly
-  https://www.googleapis.com/auth/presentations
 get  
 
 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 .
Return
 Number 
— The page element's inherent height in points, or null 
if the page element does
    not have a height.
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
 get  
 
 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.
Return
 Number 
— The page element's inherent height in points, or null 
if the page element does
    not have a height.
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
 get  
 
 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.
Return
 Number 
— The page element's inherent width in points, or null 
if the page element does
    not have a width.
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
 get  
 
 Returns the element's horizontal position in points, measured from the upper-left corner of the page 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 following scopes :
-  https://www.googleapis.com/auth/presentations.currentonly
-  https://www.googleapis.com/auth/presentations
 get  
 
 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.
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
 get  
 
 Returns the unique ID for this object. Object IDs used by pages and page elements share the same namespace.
Return
 String 
— The unique ID for this object.
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
 get  
 
 Returns the page element's type, represented as a  Page  
enum.
Return
  Page  
— The page element's type.
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
 get  
 
 Returns the group this page element belongs to, or null 
if the element is not in a
group.
Return
  Group 
 
— The group this page element belongs to, or null 
.
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
 get  
 
 Returns the page this page element is on.
Return
  Page 
 
— The page this element resides on.
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
 get  
 
 Gets the text that is rendered as word art.
Return
 String 
— The text that is rendered as this 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
 get  
 
 Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means 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 following scopes :
-  https://www.googleapis.com/auth/presentations.currentonly
-  https://www.googleapis.com/auth/presentations
 get  
 
 Returns the page element's alt text title. The title is combined with the description to display 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 following scopes :
-  https://www.googleapis.com/auth/presentations.currentonly
-  https://www.googleapis.com/auth/presentations
 get  
 
 Gets the element's vertical position in points, measured from the upper-left corner of the page when 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 following scopes :
-  https://www.googleapis.com/auth/presentations.currentonly
-  https://www.googleapis.com/auth/presentations
 get  
 
 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.
Return
  Affine  
— The page element's transform.
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
 get  
 
 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 .
Return
 Number 
— The page element's inherent width in points, or null 
if the page element does
    not have a width.
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
 preconcatenate  
 
 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  set  
.
Parameters
| Name | Type | Description | 
|---|---|---|
| transform |  Affine  | The transform to preconcatenate onto this page element's transform. | 
Return
  Word  
— This page element, for chaining.
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 element.
If after a remove operation, a Group 
contains only one or no page elements, the
group itself is also removed.
If a placeholder Page  
is removed on a master or layout, any empty inheriting
placeholders are also removed.
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 a  Link 
 
.
const slides = SlidesApp . getActivePresentation (). getSlides (); slides [ 1 ]. getShapes ()[ 0 ]. removeLink ();
 scale  
 
 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 | Description | 
|---|---|---|
| ratio | Number | The ratio to scale this page element's height by. | 
Return
  Word  
— This page element, for chaining.
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
 scale  
 
 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 | Description | 
|---|---|---|
| ratio | Number | The ratio to scale this page element's width by. | 
Return
  Word  
— This page element, for chaining.
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() 
 
 Selects only the  Page  
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  Page  
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  Page  
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  Page  
and remove any
previous selection. This also sets the parent  Page 
 
of the  Page  
as the  current page selection 
 
.
Pass false 
to select multiple  Page  
objects. The  Page  
objects must be in the same  Page 
 
.
The following conditions must be met while selecting a page element using a false 
parameter:
- 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 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
 send  
 
 Sends the page element backward on the page by one element.
The page element must not be in a group.
Return
  Word  
— This page element, for chaining.
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
 send  
 
 Sends the page element to the back of the page.
The page element must not be in a group.
Return
  Word  
— This page element, for chaining.
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
 set  
 
 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
  Word  
— This 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
 set  
 
 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 | Description | 
|---|---|---|
| height | Number | The new height of this page element to set, in points. | 
Return
  Word  
— This page element, for chaining.
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
 set  
 
 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 | Description | 
|---|---|---|
| left | Number | The new horizontal position to set, in points. | 
Return
  Word  
— This page element, for chaining.
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
 set  
 
 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 | 
|---|---|---|
| slide  | 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
 set  
 
 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
 set  
 
 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
| Name | Type | Description | 
|---|---|---|
| slide  |  Slide  | The relative  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
 set  
 
 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
 set  
 
 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 | Description | 
|---|---|---|
| angle | Number | The new clockwise rotation angle to set, in degrees. | 
Return
  Word  
— This page element, for chaining.
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
 set  
 
 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
  Word  
— This 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
 set  
 
 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 | Description | 
|---|---|---|
| top | Number | The new vertical position to set, in points. | 
Return
  Word  
— This page element, for chaining.
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
 set  
 
 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  get  
.
Parameters
| Name | Type | Description | 
|---|---|---|
| transform |  Affine  | The transform that is set for this page element. | 
Return
  Word  
— This element, for chaining.
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
 set  
 
 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 | Description | 
|---|---|---|
| width | Number | The new width of this page element to set, in points. | 
Return
  Word  
— This page element, for chaining.
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

