PageElement
表示没有更具体的分类的通用形状。包括文本框、矩形和其他预定义形状。
方法
详细文档
alignOnPage(alignmentPosition)
将元素对齐到页面上的指定对齐位置。
参数
名称 | 类型 | 说明 |
---|---|---|
alignmentPosition | AlignmentPosition | 此页面元素在页面上的对齐位置。 |
返回
Shape
- 此页面元素,用于链式调用。
bringForward()
bringToFront()
duplicate()
复制了页面元素。
重复的页面元素位于同一页面上与原始元素相同的位置。
返回
PageElement
- 此网页元素的新重复项。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getAutofit()
getBorder()
getConnectionSites()
返回页面元素上的 ConnectionSite
列表,如果页面元素没有任何连接网站,则返回空列表。
返回
ConnectionSite[]
- 连接点列表,如果此元素没有连接点,则此列表可能为空。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getContentAlignment()
返回形状中文本的 ContentAlignment
。
返回
ContentAlignment
- 此形状中的文本对齐方式。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
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
getFill()
getHeight()
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
getLink()
如果没有关联,则返回 Link
或 null
。
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()}`); }
返回
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
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()
getParentPage()
getParentPlaceholder()
返回占位符的父页面元素。如果形状不是占位符或没有父项,则返回 null
。
返回
PageElement
- 此形状占位符的父页面元素;如果此形状不是占位符或没有父元素,则为 null
。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getPlaceholderIndex()
返回形状的占位符索引。如果同一页面中存在两个或更多相同占位符类型的实例,则每个实例都有自己的唯一索引值。如果形状不是占位符,则返回 null
。
返回
Integer
- 此形状的占位符索引;如果形状不是占位符,则为 null
。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getPlaceholderType()
返回形状的占位符类型;如果形状不是占位符,则返回 PlaceholderType.NONE
。
返回
PlaceholderType
- 此形状的占位符类型。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getRotation()
返回元素围绕其中心顺时针旋转的角度(以度为单位),其中 0 度表示不旋转。
返回
Number
- 旋转角度(以度为单位),介于 0(包括)和 360(不包括)之间。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getShapeType()
getText()
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()
preconcatenateTransform(transform)
将提供的转换预连接到页面元素的现有转换。
newTransform = argument * existingTransform;
例如,如需将页面元素向左移动 36 点,请执行以下操作:
const element = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0]; element.preconcatenateTransform( SlidesApp.newAffineTransformBuilder().setTranslateX(-36.0).build(), );
您还可以将页面元素的转换替换为 setTransform(transform)
。
参数
名称 | 类型 | 说明 |
---|---|---|
transform | AffineTransform | 要预连接到此页面元素的转换的转换。 |
返回
Shape
- 此页面元素,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
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
removeLink()
移除 Link
。
const slides = SlidesApp.getActivePresentation().getSlides(); slides[1].getShapes()[0].removeLink();
replaceWithImage(blobSource)
将此形状替换为 BlobSource
提供的图片。
系统会在插入时从提供的 BlobSource
提取一次图片,并存储一个副本以在演示文稿中显示。图片大小不得超过 50MB,不得超过 2500 万像素,且必须为 PNG、JPEG 或 GIF 格式。
为了保持图片的宽高比,系统会根据现有形状的大小缩放图片并将其居中。
const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0]; // Get the Drive image file with the given ID. const driveImage = DriveApp.getFileById('123abc'); shape.replaceWithImage(driveImage);
参数
名称 | 类型 | 说明 |
---|---|---|
blobSource | BlobSource | 图片数据。 |
返回
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
replaceWithImage(blobSource, crop)
将此形状替换为 BlobSource
提供的图片。
插入图片会从 BlobSource
中提取一次,并存储一个副本以在演示文稿中显示。图片大小不得超过 50MB,不得超过 2500 万像素,且必须为 PNG、JPEG 或 GIF 格式。
const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0]; // Get the Drive image file with the given ID. const driveImage = DriveApp.getFileById('123abc'); // Replace and crop the replaced image. shape.replaceWithImage(driveImage, true);
参数
名称 | 类型 | 说明 |
---|---|---|
blobSource | BlobSource | 图片数据。 |
crop | Boolean | 如果为 true ,则会剪裁图片以适应现有形状的大小。否则,系统会缩放图片并将其居中显示。 |
返回
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
replaceWithImage(imageUrl)
将此形状替换为图片。
插入图片会从网址中提取一次图片,并存储一个副本以供在演示文稿中显示。图片大小不得超过 50MB,不得超过 2500 万像素,且必须为 PNG、JPEG 或 GIF 格式。
提供的网址必须可供公开访问,且不得大于 2KB。网址本身会随图片一起保存,并通过 Image.getSourceUrl()
公开。
为了保持图片的宽高比,系统会根据现有形状的大小缩放图片并将其居中。
参数
名称 | 类型 | 说明 |
---|---|---|
imageUrl | String | 用于下载图片的图片网址。 |
返回
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
replaceWithImage(imageUrl, crop)
将此形状替换为图片。
插入图片会从网址中提取一次图片,并存储一个副本以供在演示文稿中显示。图片大小不得超过 50MB,不得超过 2500 万像素,且必须为 PNG、JPEG 或 GIF 格式。
提供的网址不得大于 2KB。网址本身会随图片一起保存,并通过 Image.getSourceUrl()
公开。
参数
名称 | 类型 | 说明 |
---|---|---|
imageUrl | String | 用于下载图片的图片网址。 |
crop | Boolean | 如果为 true ,则会剪裁图片以适应现有形状的大小。否则,系统会缩放图片并将其居中显示。 |
返回
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
replaceWithSheetsChart(sourceChart)
将此形状替换为 Google 表格图表。
该图表与 Google 表格中的源图表相关联,因此可以更新。其他协作者可以看到指向源电子表格的链接。
const sheet = SpreadsheetApp.openById('spreadsheetId').getSheets()[0]; const chart = sheet.getCharts()[0]; // Replace the shape with the Sheets chart. const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0]; shape.replaceWithSheetsChart(chart);
参数
名称 | 类型 | 说明 |
---|---|---|
sourceChart | EmbeddedChart | 电子表格中用于替换形状的图表。 |
返回
SheetsChart
- 替换形状的图表。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
replaceWithSheetsChartAsImage(sourceChart)
将此形状替换为 Google 表格图表的图片。
为了保持 Google 表格图表的宽高比,系统会根据现有形状的大小缩放图表图片并将其居中。
图表的图片未与源 Google 表格图表相关联。
const sheet = SpreadsheetApp.openById('spreadsheetId').getSheets()[0]; const chart = sheet.getCharts()[0]; // Replace the shape with the Sheets chart as an image. const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0]; shape.replaceWithSheetsChartAsImage(chart);
参数
名称 | 类型 | 说明 |
---|---|---|
sourceChart | EmbeddedChart | 电子表格中用于替换形状的图表。 |
返回
Image
- 替换形状的图表的图片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
scaleHeight(ratio)
scaleWidth(ratio)
select()
仅选择当前演示文稿中的 PageElement
,并移除之前的所有选择。这与使用 true
调用 select(replace)
相同。
脚本只能访问运行脚本的用户的选择,并且只有在脚本绑定到演示文稿的情况下才能访问。
这会将 PageElement
的父 Page
设置为 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();
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
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
参数选择页面元素时,必须满足以下条件:
PageElement
对象的父Page
必须是current page selection
。- 不应选择多个
Page
对象。
为确保如此,首选方法是先使用 Page.selectAsCurrentPage()
选择父 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); }
参数
名称 | 类型 | 说明 |
---|---|---|
replace | Boolean | 如果为 true ,则所选内容会替换之前的所有选择;否则,所选内容会添加到之前的所有选择中。 |
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
sendBackward()
sendToBack()
setContentAlignment(contentAlignment)
设置形状中文本的 ContentAlignment
。
此方法会自动停用更新后的形状的文本自动调整大小属性。
参数
名称 | 类型 | 说明 |
---|---|---|
contentAlignment | ContentAlignment | 要设置的对齐方式。 |
返回
Shape
- 此形状,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
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". const pageElement = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0]; pageElement.setDescription('new alt text description'); Logger.log(pageElement.getDescription());
参数
名称 | 类型 | 说明 |
---|---|---|
description | String | 要将替代文本说明设置为的字符串。 |
返回
Shape
- 此页面元素。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setHeight(height)
setLeft(left)
setLinkSlide(slideIndex)
使用幻灯片的从零开始的索引将 Link
设置为指定的 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);
参数
名称 | 类型 | 说明 |
---|---|---|
slideIndex | Integer | 幻灯片的索引(从零开始)。 |
返回
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setLinkSlide(slide)
将 Link
设置为给定的 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]);
参数
名称 | 类型 | 说明 |
---|---|---|
slide | Slide | 要关联的 Slide 。 |
返回
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setLinkSlide(slidePosition)
// 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);
参数
名称 | 类型 | 说明 |
---|---|---|
slidePosition | SlidePosition | 相对 SlidePosition 。 |
返回
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setLinkUrl(url)
将 Link
设置为给定的非空网址字符串。
// 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');
参数
名称 | 类型 | 说明 |
---|---|---|
url | String | 网址字符串。 |
返回
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setRotation(angle)
setTitle(title)
设置网页元素的替代文本标题。
Group
元素不支持此方法。
// 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());
参数
名称 | 类型 | 说明 |
---|---|---|
title | String | 要将替代文本标题设置为的字符串。 |
返回
Shape
- 此页面元素。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setTop(top)
setTransform(transform)
使用提供的转换设置页面元素的转换。
更新组的转换会更改该组中页面元素的绝对转换,这可能会更改其视觉外观。
更新分组中的页面元素的转换只会更改该页面元素的转换;不会影响该分组或分组中的其他页面元素的转换。
如需详细了解转换对页面元素的外观有何影响,请参阅 getTransform()
。
参数
名称 | 类型 | 说明 |
---|---|---|
transform | AffineTransform | 为此页面元素设置的转换。 |
返回
Shape
- 此元素,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations