PageElement

A visual element rendered on a page.

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/slides/page-element#alignOnPage(AlignmentPosition)` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Aligns the element to the specified alignment position on the page. |
| `https://developers.google.com/apps-script/reference/slides/page-element#asGroup()` | `https://developers.google.com/apps-script/reference/slides/group` | Returns the page element as a group. |
| `https://developers.google.com/apps-script/reference/slides/page-element#asImage()` | `https://developers.google.com/apps-script/reference/slides/image` | Returns the page element as an image. |
| `https://developers.google.com/apps-script/reference/slides/page-element#asLine()` | `https://developers.google.com/apps-script/reference/slides/line` | Returns the page element as a line. |
| `https://developers.google.com/apps-script/reference/slides/page-element#asShape()` | `https://developers.google.com/apps-script/reference/slides/shape` | Returns the page element as a shape. |
| `https://developers.google.com/apps-script/reference/slides/page-element#asSheetsChart()` | `https://developers.google.com/apps-script/reference/slides/sheets-chart` | Returns the page element as a linked chart embedded from Google Sheets. |
| `https://developers.google.com/apps-script/reference/slides/page-element#asSpeakerSpotlight()` | `https://developers.google.com/apps-script/reference/slides/speaker-spotlight` | Returns the page element as a speaker spotlight. |
| `https://developers.google.com/apps-script/reference/slides/page-element#asTable()` | `https://developers.google.com/apps-script/reference/slides/table` | Returns the page element as a table. |
| `https://developers.google.com/apps-script/reference/slides/page-element#asVideo()` | `https://developers.google.com/apps-script/reference/slides/video` | Returns the page element as a video. |
| `https://developers.google.com/apps-script/reference/slides/page-element#asWordArt()` | `https://developers.google.com/apps-script/reference/slides/word-art` | Returns the page element as word art. |
| `https://developers.google.com/apps-script/reference/slides/page-element#bringForward()` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Brings the page element forward on the page by one element. |
| `https://developers.google.com/apps-script/reference/slides/page-element#bringToFront()` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Brings the page element to the front of the page. |
| `https://developers.google.com/apps-script/reference/slides/page-element#duplicate()` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Duplicates the page element. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getConnectionSites()` | `https://developers.google.com/apps-script/reference/slides/connection-site` | Returns the list of `ConnectionSite`s on the page element, or an empty list if the page element does not have any connection sites. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getDescription()` | `String` | Returns the page element's alt text description. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getHeight()` | `Number|null` | Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getInherentHeight()` | `Number|null` | Returns the element's inherent height in points. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getInherentWidth()` | `Number|null` | Returns the element's inherent width in points. |
| `https://developers.google.com/apps-script/reference/slides/page-element#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. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getObjectId()` | `String` | Returns the unique ID for this object. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getPageElementType()` | `https://developers.google.com/apps-script/reference/slides/page-element-type` | Returns the page element's type, represented as a `https://developers.google.com/apps-script/reference/slides/page-element-type` enum. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getParentGroup()` | `https://developers.google.com/apps-script/reference/slides/group|null` | Returns the group this page element belongs to, or `null` if the element is not in a group. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getParentPage()` | `https://developers.google.com/apps-script/reference/slides/page` | Returns the page this page element is on. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getRotation()` | `Number` | Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getTitle()` | `String` | Returns the page element's alt text title. |
| `https://developers.google.com/apps-script/reference/slides/page-element#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. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getTransform()` | `https://developers.google.com/apps-script/reference/slides/affine-transform` | Returns the page element's transform. |
| `https://developers.google.com/apps-script/reference/slides/page-element#getWidth()` | `Number|null` | Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
| `https://developers.google.com/apps-script/reference/slides/page-element#preconcatenateTransform(AffineTransform)` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Preconcatenates the provided transform to the existing transform of the page element. |
| `https://developers.google.com/apps-script/reference/slides/page-element#remove()` | `void` | Removes the page element. |
| `https://developers.google.com/apps-script/reference/slides/page-element#scaleHeight(Number)` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Scales the element's height by the specified ratio. |
| `https://developers.google.com/apps-script/reference/slides/page-element#scaleWidth(Number)` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Scales the element's width by the specified ratio. |
| `https://developers.google.com/apps-script/reference/slides/page-element#select()` | `void` | Selects only the `https://developers.google.com/apps-script/reference/slides/page-element#` in the active presentation and removes any previous selection. |
| `https://developers.google.com/apps-script/reference/slides/page-element#select(Boolean)` | `void` | Selects the `https://developers.google.com/apps-script/reference/slides/page-element#` in the active presentation. |
| `https://developers.google.com/apps-script/reference/slides/page-element#sendBackward()` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Sends the page element backward on the page by one element. |
| `https://developers.google.com/apps-script/reference/slides/page-element#sendToBack()` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Sends the page element to the back of the page. |
| `https://developers.google.com/apps-script/reference/slides/page-element#setDescription(String)` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Sets the page element's alt text description. |
| `https://developers.google.com/apps-script/reference/slides/page-element#setHeight(Number)` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
| `https://developers.google.com/apps-script/reference/slides/page-element#setLeft(Number)` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
| `https://developers.google.com/apps-script/reference/slides/page-element#setRotation(Number)` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Sets the element's clockwise rotation angle around its center in degrees. |
| `https://developers.google.com/apps-script/reference/slides/page-element#setTitle(String)` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Sets the page element's alt text title. |
| `https://developers.google.com/apps-script/reference/slides/page-element#setTop(Number)` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
| `https://developers.google.com/apps-script/reference/slides/page-element#setTransform(AffineTransform)` | `https://developers.google.com/apps-script/reference/slides/page-element#` | Sets the transform of the page element with the provided transform. |
| `https://developers.google.com/apps-script/reference/slides/page-element#setWidth(Number)` | `https://developers.google.com/apps-script/reference/slides/page-element#` | 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 | Description |
|---|---|---|
| `alignmentPosition` | `https://developers.google.com/apps-script/reference/slides/alignment-position` | The position to align this page element to on the page. |

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

*** ** * ** ***

### `asGroup()`

Returns the page element as a group.

#### Return


`https://developers.google.com/apps-script/reference/slides/group` --- This page element as a group.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `asImage()`

Returns the page element as an image.

#### Return


`https://developers.google.com/apps-script/reference/slides/image` --- This page element as an image.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `asLine()`

Returns the page element as a line.

#### Return


`https://developers.google.com/apps-script/reference/slides/line` --- This page element as a line.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `asShape()`

Returns the page element as a shape.

#### Return


`https://developers.google.com/apps-script/reference/slides/shape` --- This page element as a shape.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `asSheetsChart()`

Returns the page element as a linked chart embedded from Google Sheets.

#### Return


`https://developers.google.com/apps-script/reference/slides/sheets-chart` --- The page element as a chart.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `asSpeakerSpotlight()`

Returns the page element as a speaker spotlight.

```javascript
const slide = SlidesApp.getActivePresentation().getSlides()[0];
const pageElement = slide.getPageElements()[0];
pageElement.asSpeakerSpotlight();
```

#### Return


`https://developers.google.com/apps-script/reference/slides/speaker-spotlight` --- The page element as a speaker spotlight.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `asTable()`

Returns the page element as a table.

#### Return


`https://developers.google.com/apps-script/reference/slides/table` --- This page element as a table.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `asVideo()`

Returns the page element as a video.

#### Return


`https://developers.google.com/apps-script/reference/slides/video` --- This page element as a video.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `asWordArt()`

Returns the page element as word art.

#### Return


`https://developers.google.com/apps-script/reference/slides/word-art` --- This page element as word art.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `bringForward()`

Brings the page element forward on the page by one element.

The page element must not be in a group.

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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


`https://developers.google.com/apps-script/reference/slides/page-element#` --- The new duplicate of this page element.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### Return


`https://developers.google.com/apps-script/reference/slides/connection-site` --- 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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](https://developers.google.com/apps-script/guides/slides/moving-elements#limitations).

#### Return


`Number|null` --- 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### Return


`Number|null` --- 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### Return


`Number|null` --- 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `getPageElementType()`

Returns the page element's type, represented as a `https://developers.google.com/apps-script/reference/slides/page-element-type` enum.

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element-type` --- The page element's type.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### Return


`https://developers.google.com/apps-script/reference/slides/group|null` --- 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `getParentPage()`

Returns the page this page element is on.

#### Return


`https://developers.google.com/apps-script/reference/slides/page` --- The page this element resides on.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### Return


`https://developers.google.com/apps-script/reference/slides/affine-transform` --- The page element's transform.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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](https://developers.google.com/apps-script/guides/slides/moving-elements#limitations).

#### Return


`Number|null` --- 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

```text
newTransform = argument * existingTransform;
```

For example, to move a page elements 36 points to the left:

```javascript
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 `https://developers.google.com/apps-script/reference/slides/page-element#setTransform(AffineTransform)`.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `transform` | `https://developers.google.com/apps-script/reference/slides/affine-transform` | The transform to preconcatenate onto this page element's transform. |

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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](https://developers.google.com/apps-script/guides/slides/moving-elements#limitations).

#### Parameters

| Name | Type | Description |
|---|---|---|
| `ratio` | `Number` | The ratio to scale this page element's height by. |

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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](https://developers.google.com/apps-script/guides/slides/moving-elements#limitations).

#### Parameters

| Name | Type | Description |
|---|---|---|
| `ratio` | `Number` | The ratio to scale this page element's width by. |

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `select()`

Selects only the `https://developers.google.com/apps-script/reference/slides/page-element#` in the active presentation and removes any previous
selection. This is the same as calling `https://developers.google.com/apps-script/reference/slides/page-element#select(Boolean)` with `true`.

A script can only access the selection of the user who is running the script, and only if
the script is [bound](https://developers.google.com/apps-script/scripts_containers) to the presentation.

This sets the parent `https://developers.google.com/apps-script/reference/slides/page` of the `https://developers.google.com/apps-script/reference/slides/page-element#` as the `https://developers.google.com/apps-script/reference/slides/selection#getCurrentPage()`.

```javascript
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://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`

*** ** * ** ***

### `select(replace)`

Selects the `https://developers.google.com/apps-script/reference/slides/page-element#` 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](https://developers.google.com/apps-script/scripts_containers) to the presentation.

Pass `true` to this method to select only the `https://developers.google.com/apps-script/reference/slides/page-element#` and remove any
previous selection. This also sets the parent `https://developers.google.com/apps-script/reference/slides/page` of the `https://developers.google.com/apps-script/reference/slides/page-element#` as the
`https://developers.google.com/apps-script/reference/slides/selection#getCurrentPage()`.

Pass `false` to select multiple `https://developers.google.com/apps-script/reference/slides/page-element#` objects. The `https://developers.google.com/apps-script/reference/slides/page-element#`
objects must be in the same `https://developers.google.com/apps-script/reference/slides/page`.

The following conditions must be met while selecting a page element using a `false`
parameter:

1. The parent `https://developers.google.com/apps-script/reference/slides/page` of the `https://developers.google.com/apps-script/reference/slides/page-element#` object must be the `https://developers.google.com/apps-script/reference/slides/selection#getCurrentPage()`.
2. There should not be multiple `https://developers.google.com/apps-script/reference/slides/page` objects selected.

To make sure that's the case the preferred approach is to select the parent `https://developers.google.com/apps-script/reference/slides/page`
first using `https://developers.google.com/apps-script/reference/slides/page#selectAsCurrentPage()` and then select the page elements in that page.

```javascript
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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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.

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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 `https://developers.google.com/apps-script/reference/slides/group` elements.

```javascript
// 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


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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](https://developers.google.com/apps-script/guides/slides/moving-elements#limitations).

#### Parameters

| Name | Type | Description |
|---|---|---|
| `height` | `Number` | The new height of this page element to set, in points. |

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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 | Description |
|---|---|---|
| `left` | `Number` | The new horizontal position to set, in points. |

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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](https://developers.google.com/apps-script/guides/slides/moving-elements#limitations).

#### Parameters

| Name | Type | Description |
|---|---|---|
| `angle` | `Number` | The new clockwise rotation angle to set, in degrees. |

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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 `https://developers.google.com/apps-script/reference/slides/group` elements.

```javascript
// 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


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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 | Description |
|---|---|---|
| `top` | `Number` | The new vertical position to set, in points. |

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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 `https://developers.google.com/apps-script/reference/slides/page-element#getTransform()`.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `transform` | `https://developers.google.com/apps-script/reference/slides/affine-transform` | The transform that is set for this page element. |

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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](https://developers.google.com/apps-script/guides/slides/moving-elements#limitations).

#### Parameters

| Name | Type | Description |
|---|---|---|
| `width` | `Number` | The new width of this page element to set, in points. |

#### Return


`https://developers.google.com/apps-script/reference/slides/page-element#` --- This page element, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/presentations.currentonly`
- `https://www.googleapis.com/auth/presentations`