Class PageElement

PageElement

A visual element rendered on a page.

Methods

MethodReturn typeBrief description
alignOnPage(alignmentPosition)PageElementAligns the element to the specified alignment position on the page.
asGroup()GroupReturns the page element as a group.
asImage()ImageReturns the page element as an image.
asLine()LineReturns the page element as a line.
asShape()ShapeReturns the page element as a shape.
asSheetsChart()SheetsChartReturns the page element as a linked chart embedded from Google Sheets.
asTable()TableReturns the page element as a table.
asVideo()VideoReturns the page element as a video.
asWordArt()WordArtReturns the page element as word art.
duplicate()PageElementDuplicates the page element.
getDescription()StringGets the page element's description.
getHeight()NumberGets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
getInherentHeight()NumberGets the element's inherent height in points.
getInherentWidth()NumberGets the element's inherent width in points.
getLeft()NumberGets the element's horizontal position in points, measured from the upper left corner of the page when the element has no rotation.
getObjectId()StringGets the unique ID for this object.
getPageElementType()PageElementTypeGets the page element's type, represented as a PageElementType enum.
getParentGroup()GroupGets the group this page element is in, or null if the element is not in a group.
getParentPage()PageGets the page this page element is on.
getRotation()NumberGets the element's clockwise rotation angle around its center in degrees, where 0 degrees means no rotation.
getTitle()StringGets the page element's title.
getTop()NumberGets the element's vertical position in points, measured from the upper left corner of the page when the element has no rotation.
getTransform()AffineTransformGets the page element's transform.
getWidth()NumberGets the element's width in points, which is the width of the element's bounding box when the element has no rotation.
preconcatenateTransform(transform)PageElementPreconcatenates the provided transform to the existing transform of the page element.
remove()voidRemoves the page element.
scaleHeight(ratio)PageElementScales the element's height by the specified ratio.
scaleWidth(ratio)PageElementScales the element's width by the specified ratio.
select()voidSelects only the PageElement in the active presentation and removes any previous selection.
select(replace)voidSelects the PageElement in the active presentation.
setHeight(height)PageElementSets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
setLeft(left)PageElementSets the element's horizontal position in points, measured from the upper left corner of the page when the element has no rotation.
setRotation(angle)PageElementSets the element's clockwise rotation angle around its center in degrees.
setTop(top)PageElementSets the element's vertical position in points, measured from the upper left corner of the page when the element has no rotation.
setTransform(transform)PageElementSets the transform of the page element with the provided transform.
setWidth(width)PageElementSets 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

NameTypeDescription
alignmentPositionAlignmentPosition

Return

PageElement


asGroup()

Returns the page element as a group.

Return

Group


asImage()

Returns the page element as an image.

Return

Image


asLine()

Returns the page element as a line.

Return

Line


asShape()

Returns the page element as a shape.

Return

Shape


asSheetsChart()

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

Return

SheetsChart


asTable()

Returns the page element as a table.

Return

Table


asVideo()

Returns the page element as a video.

Return

Video


asWordArt()

Returns the page element as word art.

Return

WordArt


duplicate()

Duplicates the page element.

The duplicate page element is placed on the same page at the same position as the original.

Return

PageElement


getDescription()

Gets the page element's description. The description is combined with the title to display and read alt text.

Return

String — the page element's description.


getHeight()

Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation.

Return

Number — the page element's inherent height in points, or null if the page element does not have a height.


getInherentHeight()

Gets 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.


getInherentWidth()

Gets 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.


getLeft()

Gets the element's horizontal position in points, measured from the upper left corner of the page when the element has no rotation.

Return

Number


getObjectId()

Gets 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.


getPageElementType()

Gets the page element's type, represented as a PageElementType enum.

Return

PageElementType — the page element's type.


getParentGroup()

Gets the group this page element is in, or null if the element is not in a group.

Return

Group


getParentPage()

Gets the page this page element is on.

Return

Page


getRotation()

Gets the element's clockwise rotation angle around its center in degrees, where 0 degrees means no rotation.

Return

Number — the rotation angle in degrees between 0 (inclusive) and 360 (exclusive)


getTitle()

Gets the page element's title. The title is combined with the description to display and read alt text.

Return

String — the page element's title.


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


getTransform()

Gets 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

AffineTransform — the page element's transform.


getWidth()

Gets the element's width in points, which is the width of the element's bounding box when the element has no rotation.

Return

Number — the page element's inherent width in points, or null if the page element does not have a width.


preconcatenateTransform(transform)

Preconcatenates the provided transform to the existing transform of the page element.

newTransform = argument * existingTransform

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


 element.preconcatenateTransform(SlidesApp.newAffineTransformBuilder()
     .setTranslateX(-36.0)
     .build());
 

You can also replace the page element's transform with setTransform(transform).

Parameters

NameTypeDescription
transformAffineTransform

Return

PageElement


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 Shape is removed on a master or layout, any empty inheriting shapes are also removed.


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.

Parameters

NameTypeDescription
ratioNumber

Return

PageElement


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.

Parameters

NameTypeDescription
ratioNumber

Return

PageElement


select()

Selects only the PageElement in the active presentation and removes any previous selection. This is 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.

 var slide = SlidesApp.getActivePresentation().getSlides()[0];
 var pageElement = slide.getPageElements()[0];
 // Only select this page element and replace any previous selection.
 pageElement.select();
 

select(replace)

Selects the PageElement in the active presentation.

A script can only access the selection of the user who is running the script, and only if the script is bound to the presentation.

The select(true) selects only the PageElement and removes any previous selection. This also sets the parent Page of the PageElement as the current page selection.

select(false) should be used 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 select(false):
1) The parent Page of the PageElement object must be the current page selection
2) There should not be multiple 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.

 var 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.
 var pageElements = slide.getPageElements();
 for (var i = 0; i < pageElements.length; i++) {
   pageElements[i].select(false);
 }
 

Parameters

NameTypeDescription
replaceBooleanif true, the selection replaces any previous selection, otherwise the selection is added to any previous selection.

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.

Parameters

NameTypeDescription
heightNumber

Return

PageElement


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

NameTypeDescription
leftNumber

Return

PageElement


setRotation(angle)

Sets the element's clockwise rotation angle around its center in degrees.

Parameters

NameTypeDescription
angleNumber

Return

PageElement


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

NameTypeDescription
topNumber

Return

PageElement


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 visual appearance of page elements, see getTransform().

Parameters

NameTypeDescription
transformAffineTransform

Return

PageElement


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.

Parameters

NameTypeDescription
widthNumber

Return

PageElement

Send feedback about...

Apps Script
Apps Script