Class PageElement

PageElement

在网页上呈现的视觉元素。

方法

方法返回类型简介
alignOnPage(alignmentPosition)PageElement使元素与页面上的指定对齐位置对齐。
asGroup()Group以组形式返回页面元素。
asImage()Image以图片形式返回页面元素。
asLine()Line以行的形式返回页面元素。
asShape()Shape以形状形式返回页面元素。
asSheetsChart()SheetsChart以嵌入 Google 表格中的关联图表的形式返回页面元素。
asTable()Table以表格形式返回页面元素。
asVideo()Video以视频形式返回页面元素。
asWordArt()WordArt以艺术字的形式返回页面元素。
bringForward()PageElement使页面元素在页面上前移一个元素。
bringToFront()PageElement将页面元素移至页面的前面。
duplicate()PageElement复制页面元素。
getConnectionSites()ConnectionSite[]返回页面元素上的 ConnectionSite 列表；如果页面元素没有任何连接网站，则返回空列表。
getDescription()String返回页面元素的替代文本说明。
getHeight()Number获取元素的高度（以点为单位），即当元素不旋转时，元素边界框的高度。
getInherentHeight()Number返回元素的固有高度（以点为单位）。
getInherentWidth()Number返回元素的固有宽度（以点为单位）。
getLeft()Number返回元素的水平位置（以点为单位），在元素没有旋转时从页面的左上角测量。
getObjectId()String返回此对象的唯一 ID。
getPageElementType()PageElementType返回页面元素的类型，以 PageElementType 枚举的形式表示。
getParentGroup()Group返回此页面元素所属的组；如果该元素不在组中，则返回 null。
getParentPage()Page返回此页面元素所在的页面。
getRotation()Number返回元素围绕其中心顺时针旋转的角度（以度为单位），零度表示不旋转。
getTitle()String返回页面元素的替代文本标题。
getTop()Number获取元素的垂直位置（以点为单位），在元素没有旋转时从页面的左上角进行测量。
getTransform()AffineTransform返回页面元素的转换。
getWidth()Number返回元素的宽度（以点为单位），即当元素不旋转时，元素边界框的宽度。
preconcatenateTransform(transform)PageElement将提供的转换串联到页面元素的现有转换上。
remove()void移除页面元素。
scaleHeight(ratio)PageElement根据指定比例缩放元素的高度。
scaleWidth(ratio)PageElement根据指定比例缩放元素的宽度。
select()void仅选择当前演示文稿中的 PageElement，并移除之前选择的所有内容。
select(replace)void选择当前演示文稿中的 PageElement。
sendBackward()PageElement将一个元素在页面上向后传送。
sendToBack()PageElement将页面元素发送到页面背面。
setDescription(description)PageElement设置页面元素的替代文本说明。
setHeight(height)PageElement以点数设置元素的高度，即当元素不旋转时，元素边界框的高度。
setLeft(left)PageElement设置元素的水平位置（以点为单位），在元素不旋转时从页面的左上角开始测量。
setRotation(angle)PageElement设置元素围绕其中心顺时针旋转的角度（以度为单位）。
setTitle(title)PageElement设置页面元素的替代文本标题。
setTop(top)PageElement设置元素的垂直位置（以点为单位），在元素不旋转时从页面的左上角进行测量。
setTransform(transform)PageElement使用提供的转换设置页面元素的转换。
setWidth(width)PageElement设置元素的宽度（以点为单位），即当元素不旋转时，元素边界框的宽度。

详细文档

alignOnPage(alignmentPosition)

使元素与页面上的指定对齐位置对齐。

参数

名称类型说明
alignmentPositionAlignmentPosition相应页面元素在页面上的对齐位置。

返回

PageElement - 此页面元素（用于串联）。

asGroup()

以组形式返回页面元素。

返回

Group - 此页面元素为一个组。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

asImage()

以图片形式返回页面元素。

返回

Image - 此页面为图片元素。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

asLine()

以行的形式返回页面元素。

返回

Line - 表示此页面元素的线条。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

asShape()

以形状形式返回页面元素。

返回

Shape - 表示页面元素的形状。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

asSheetsChart()

以嵌入 Google 表格中的关联图表的形式返回页面元素。

返回

SheetsChart - 表示图表的页面元素。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

asTable()

以表格形式返回页面元素。

返回

Table - 表示页面元素的表格。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

asVideo()

以视频形式返回页面元素。

返回

Video - 此页面为视频元素。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

asWordArt()

以艺术字的形式返回页面元素。

返回

WordArt - 表示艺术字的页面元素。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

bringForward()

使页面上的页面元素前移一个元素。

页面元素不得位于群组中。

返回

PageElement - 此页面元素（用于串联）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

bringToFront()

将页面元素移至页面的前面。

页面元素不得位于群组中。

返回

PageElement - 此页面元素（用于串联）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

duplicate()

复制页面元素。

复制的页面元素将位于与原始页面相同的位置。

返回

PageElement - 此网页元素的新副本。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getConnectionSites()

返回页面元素上的 ConnectionSite 列表；如果页面元素没有任何连接网站，则返回空列表。

返回

ConnectionSite[] - 连接网站列表。如果此元素没有任何连接网站，此列表可能为空。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getDescription()

返回页面元素的替代文本说明。说明与标题相结合，可显示和阅读替代文本。

返回

String - 页面元素的替代文本说明。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getHeight()

获取元素的高度（以点为单位），即当元素不旋转时，元素边界框的高度。

此方法并非与所有页面元素都兼容。如需了解哪些页面元素与此方法不兼容，请参阅尺寸和定位限制。

返回

Number - 页面元素的固有高度（以点为单位），如果页面元素没有高度，则为 null。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getInherentHeight()

返回元素的固有高度（以点为单位）。

页面元素的转换是相对于其固有尺寸发生的。使用固有尺寸与元素的转换相结合来确定元素的最终视觉外观。

返回

Number - 页面元素的固有高度（以点为单位），如果页面元素没有高度，则为 null。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getInherentWidth()

返回元素的固有宽度（以点为单位）。

页面元素的转换是相对于其固有尺寸发生的。使用固有尺寸与元素的转换相结合来确定元素的最终视觉外观。

返回

Number - 页面元素的固有宽度（以点为单位），如果页面元素没有宽度，则为 null。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getLeft()

返回元素的水平位置（以点为单位），在元素没有旋转时从页面的左上角测量。

返回

Number - 此元素自页面左上角的水平位置（以点为单位）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getObjectId()

返回此对象的唯一 ID。页面和页面元素使用的对象 ID 共用同一个命名空间。

返回

String - 此对象的唯一 ID。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getPageElementType()

返回页面元素的类型，以 PageElementType 枚举的形式表示。

返回

PageElementType - 页面元素的类型。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getParentGroup()

返回此页面元素所属的组；如果该元素不在组中，则返回 null。

返回

Group - 该页面元素所属的组，或 null。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getParentPage()

返回此页面元素所在的页面。

返回

Page - 此元素所在的页面。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getRotation()

返回元素围绕其中心顺时针旋转的角度（以度为单位），零度表示不旋转。

返回

Number - 旋转角度，介于 0（含）和 360（不含）之间。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getTitle()

返回页面元素的替代文本标题。标题将与说明结合使用，以显示和阅读替代文本。

返回

String - 页面元素的替代文本标题。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getTop()

获取元素的垂直位置（以点为单位），在元素没有旋转时从页面的左上角进行测量。

返回

Number - 此元素自页面左上角的垂直位置（以点为单位）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getTransform()

返回页面元素的转换。

页面元素的视觉外观由其绝对转换决定。如需计算绝对转换，请将页面元素的转换与其所有父组的转换串联起来。如果页面元素不在组中，则其绝对转换与此字段中的值相同。

返回

AffineTransform - 页面元素的转换。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getWidth()

返回元素的宽度（以点为单位），即当元素不旋转时，元素边界框的宽度。

此方法并非与所有页面元素都兼容。如需了解哪些页面元素与此方法不兼容，请参阅尺寸和定位限制。

返回

Number - 页面元素的固有宽度（以点为单位），如果页面元素没有宽度，则为 null。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

preconcatenateTransform(transform)

将提供的转换串联到页面元素的现有转换上。 

newTransform = argument * existingTransform

例如，要将页面元素向左移动 36 个点，请按以下步骤操作： 

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

您也可以使用 setTransform(transform) 替换页面元素的转换。

参数

名称类型说明
transformAffineTransform要串联到此页面元素的转换上的转换。

返回

PageElement - 此页面元素（用于串联）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

remove()

移除页面元素。

如果在移除操作之后，Group 仅包含一个或不包含任何页面元素，则该组本身也会被移除。

如果对母版或布局移除了占位符 PageElement，所有继承的空占位符也会一并移除。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

scaleHeight(ratio)

根据指定比例缩放元素的高度。元素的高度是其没有旋转时边界框的高度。

此方法并非与所有页面元素都兼容。如需了解哪些页面元素与此方法不兼容，请参阅尺寸和定位限制。

参数

名称类型说明
ratioNumber此网页元素的高度缩放比例。

返回

PageElement - 此页面元素（用于串联）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

scaleWidth(ratio)

根据指定比例缩放元素的宽度。元素的宽度是其没有旋转时边框的宽度。

此方法并非与所有页面元素都兼容。如需了解哪些页面元素与此方法不兼容，请参阅尺寸和定位限制。

参数

名称类型说明
ratioNumber按此比例调整此网页元素的宽度。

返回

PageElement - 此页面元素（用于串联）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

select()

仅选择当前演示文稿中的 PageElement，并移除之前选择的所有内容。这与使用 true 调用 select(replace) 相同。

脚本只能访问正在运行该脚本的用户，并且该脚本必须绑定到演示文稿。

这会将 PageElement 的父级 Page 设置为 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();

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

select(replace)

选择当前演示文稿中的 PageElement。

脚本只能访问正在运行该脚本的用户，并且该脚本必须绑定到演示文稿。

将 true 传递给此方法可仅选择 PageElement 并移除之前选择的所有内容。这还会将 PageElement 的父级 Page 设置为 current page selection。

传递 false 可选择多个 PageElement 对象。PageElement 对象必须位于同一 Page 中。

使用 false 参数选择页面元素时，必须满足以下条件：

  1. PageElement 对象的父级 Page 必须是 current page selection。
  2. 不应选择多个 Page 对象。

为了确保出现这种情况，首选方法是先使用 Page.selectAsCurrentPage() 选择父级 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);
}

参数

名称类型说明
replaceBoolean如果为 true，所做的选择会代替之前的任何选择；否则，选择会添加到之前的任何选择中。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

sendBackward()

将一个元素在页面上向后发送。

页面元素不得位于群组中。

返回

PageElement - 此页面元素（用于串联）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

sendToBack()

将页面元素发送到页面底部。

页面元素不得位于群组中。

返回

PageElement - 此页面元素（用于串联）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setDescription(description)

设置页面元素的替代文本说明。

Group 元素不支持此方法。 

// Set the first page element's alt text description to "new alt text description".
var pageElement = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0];
pageElement.setDescription('new alt text description');
Logger.log(pageElement.getDescription());

参数

名称类型说明
descriptionString要设置替代文本说明的字符串。

返回

PageElement - 此页面元素。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setHeight(height)

以点数设置元素的高度，即当元素不旋转时，元素边界框的高度。

此方法并非与所有页面元素都兼容。如需了解哪些页面元素与此方法不兼容，请参阅尺寸和定位限制。

参数

名称类型说明
heightNumber要设置的此页面元素的新高度（以点为单位）。

返回

PageElement - 此页面元素（用于串联）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setLeft(left)

设置元素的水平位置（以点为单位），在元素不旋转时从页面的左上角开始测量。

参数

名称类型说明
leftNumber要设置的新水平位置（以点为单位）。

返回

PageElement - 此页面元素（用于串联）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setRotation(angle)

设置元素围绕其中心顺时针旋转的角度（以度为单位）。

此方法并非与所有页面元素都兼容。如需了解哪些页面元素与此方法不兼容，请参阅尺寸和定位限制。

参数

名称类型说明
angleNumber要设置的新顺时针旋转角度（以度为单位）。

返回

PageElement - 此页面元素（用于串联）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setTitle(title)

设置页面元素的替代文本标题。

Group 元素不支持此方法。 

// Set the first page element's alt text title to "new alt text title".
var pageElement = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0];
pageElement.setTitle('new alt text title');
Logger.log(pageElement.getTitle());

参数

名称类型说明
titleString要设置替代文本标题的字符串。

返回

PageElement - 此页面元素。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setTop(top)

设置元素的垂直位置（以点为单位），在元素不旋转时从页面的左上角进行测量。

参数

名称类型说明
topNumber要设置的新垂直位置（以点为单位）。

返回

PageElement - 此页面元素（用于串联）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setTransform(transform)

使用提供的转换设置页面元素的转换。

更新组的转换会更改该组中页面元素的绝对转换，从而改变其外观。

更新某个组内的页面元素转换仅会更改该页面元素的转换，而不会影响组或其他组元素的转换。

如需详细了解转换如何影响页面元素的视觉外观，请参阅 getTransform()。

参数

名称类型说明
transformAffineTransform为此页面元素设置的转换。

返回

PageElement - 此元素，用于实现链式处理。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setWidth(width)

设置元素的宽度（以点为单位），即当元素不旋转时，元素边界框的宽度。

此方法并非与所有页面元素都兼容。如需了解哪些页面元素与此方法不兼容，请参阅尺寸和定位限制。

参数

名称类型说明
widthNumber要设置的此网页元素的新宽度（以点为单位）。

返回

PageElement - 此页面元素（用于串联）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations