此页面由 Cloud Translation API 翻译。

Class SpeakerSpotlight

表示演讲者特写的 PageElement。

const slide = SlidesApp.getActivePresentation().getSlides()[0];
const speakerSpotlight = slide.getPageElements()[0];
console.log(
    `Page element is of type: ${
        speakerSpotlight.getPageElementType().toString()}`,
);

方法

方法	返回类型	简介
`alignOnPage(alignmentPosition)`	`SpeakerSpotlight`	将元素与页面上的指定对齐位置对齐。
`bringForward()`	`SpeakerSpotlight`	将页面元素在页面上向前移动一个元素。
`bringToFront()`	`SpeakerSpotlight`	将页面元素置于页面最前面。
`duplicate()`	`PageElement`	复制页面元素。
`getBorder()`	`Border`	返回发言人聚光灯的 `Border`。
`getConnectionSites()`	`ConnectionSite[]`	返回页面元素上的 `ConnectionSite` 列表；如果页面元素没有任何连接点，则返回空列表。
`getDescription()`	`String`	返回网页元素的替代文本说明。
`getHeight()`	`Number\|null`	获取元素的高度（以磅为单位），即元素未旋转时其边界框的高度。
`getInherentHeight()`	`Number\|null`	返回元素的固有高度（以点为单位）。
`getInherentWidth()`	`Number\|null`	返回元素的固有宽度（以点为单位）。
`getLeft()`	`Number`	返回元素在页面中的水平位置（以点为单位），当元素未旋转时，该位置从页面的左上角开始测量。
`getMaskShapeType()`	`ShapeType\|null`	返回应用于演讲者聚焦画面的遮罩的 `ShapeType`，如果没有遮罩，则返回 `null`。
`getObjectId()`	`String`	返回相应对象的唯一 ID。
`getPageElementType()`	`PageElementType`	返回网页元素的类型，以 `PageElementType` 枚举表示。
`getParentGroup()`	`Group\|null`	返回相应网页元素所属的组；如果该元素不属于任何组，则返回 `null`。
`getParentPage()`	`Page`	返回相应页面元素所在的页面。
`getRotation()`	`Number`	返回元素围绕其中心顺时针旋转的角度（以度为单位），其中零度表示不旋转。
`getTitle()`	`String`	返回网页元素的替代文本标题。
`getTop()`	`Number`	获取元素在页面中的垂直位置（以点为单位），该位置是从元素的左上角测量的（当元素未旋转时）。
`getTransform()`	`AffineTransform`	返回页面元素的转换。
`getWidth()`	`Number\|null`	返回元素的宽度（以磅为单位），即元素未旋转时其边界框的宽度。
`preconcatenateTransform(transform)`	`SpeakerSpotlight`	将提供的转换预串联到网页元素的现有转换。
`remove()`	`void`	移除页面元素。
`scaleHeight(ratio)`	`SpeakerSpotlight`	按指定比例缩放元素的高度。
`scaleWidth(ratio)`	`SpeakerSpotlight`	按指定比例缩放元素的宽度。
`select()`	`void`	仅选择有效演示中的 `PageElement`，并移除任何之前的选择。
`select(replace)`	`void`	选择有效演示中的 `PageElement`。
`sendBackward()`	`SpeakerSpotlight`	将页面元素在页面上向后移动一个元素。
`sendToBack()`	`SpeakerSpotlight`	将页面元素移至页面底部。
`setDescription(description)`	`SpeakerSpotlight`	设置网页元素的替代文本说明。
`setHeight(height)`	`SpeakerSpotlight`	以磅为单位设置元素的高度，即元素未旋转时元素边界框的高度。
`setLeft(left)`	`SpeakerSpotlight`	设置元素在页面中的水平位置（以点为单位），该位置从元素的左上角开始测量（当元素未旋转时）。
`setRotation(angle)`	`SpeakerSpotlight`	设置元素围绕其中心顺时针旋转的角度（以度为单位）。
`setTitle(title)`	`SpeakerSpotlight`	设置网页元素的替代文本标题。
`setTop(top)`	`SpeakerSpotlight`	设置元素的垂直位置（以点为单位），当元素未旋转时，该位置从页面的左上角开始测量。
`setTransform(transform)`	`SpeakerSpotlight`	使用提供的转换设置页面元素的转换。
`setWidth(width)`	`SpeakerSpotlight`	以磅为单位设置元素的宽度，即元素未旋转时，元素边界框的宽度。

详细文档

`alignOnPage(alignmentPosition)`

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

参数

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

SpeakerSpotlight - 此页面元素，用于链式调用。

`bringForward()`

将页面元素在页面上向前移动一个元素。

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

SpeakerSpotlight - 此页面元素，用于链式调用。

授权

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

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

`bringToFront()`

将页面元素置于页面最前面。

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

SpeakerSpotlight - 此页面元素，用于链式调用。

授权

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

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

`getBorder()`

返回发言人聚光灯的 Border。

const slide = SlidesApp.getActivePresentation().getSlides()[0];
// Gets the first element on the page, which in
// this example is of type speaker spotlight.
const speakerSpotlight = slide.getPageElements()[0];
// Gets the border of the speaker spotlight.
const border = speakerSpotlight.getBorder();

Border - 演讲者聚焦的边框。

授权

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

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 - 页面元素的固有高度（以点为单位），如果页面元素没有高度，则为 null。

授权

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

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

`getInherentHeight()`

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

网页元素的转换是相对于其固有大小而言的。结合使用固有大小和元素的转换来确定元素的最终视觉外观。

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

授权

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

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

`getInherentWidth()`

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

网页元素的转换是相对于其固有大小而言的。结合使用固有大小和元素的转换来确定元素的最终视觉外观。

Number|null - 页面元素的固有宽度（以点为单位），如果页面元素没有宽度，则为 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

`getMaskShapeType()`

返回应用于演讲者聚焦画面的遮盖的 ShapeType，如果没有遮盖，则返回 null。

const slide = SlidesApp.getActivePresentation().getSlides()[0];
// Gets the first element on the page, which in
// this example is of type speaker spotlight.
const speakerSpotlight = slide.getPageElements()[0];
// Gets the shape type of the mask on the speaker spotlight.
const maskShapeType = speakerSpotlight.getMaskShapeType();

ShapeType|null - 演讲者特写蒙版的形状类型。

授权

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

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 - 此网页元素所属的群组，或 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 - 页面元素的固有宽度（以点为单位），如果页面元素没有宽度，则为 null。

授权

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

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

`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`	要预先串联到此页面元素的转换的转换。

SpeakerSpotlight - 此页面元素，用于链式调用。

授权

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

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)`

按指定比例缩放元素的高度。当元素未旋转时，元素的高度是其边界框的高度。

此方法不适用于所有网页元素。如需了解哪些页面元素与此方法不兼容，请参阅大小调整和定位限制。

参数

名称	类型	说明
`ratio`	`Number`	用于缩放相应网页元素高度的比率。

SpeakerSpotlight - 此页面元素，用于链式调用。

授权

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

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

`scaleWidth(ratio)`

按指定比例缩放元素的宽度。元素的宽度是指元素未旋转时其边界框的宽度。

此方法不适用于所有网页元素。如需了解哪些页面元素与此方法不兼容，请参阅大小调整和定位限制。

参数

名称	类型	说明
`ratio`	`Number`	用于缩放相应网页元素宽度的比率。

SpeakerSpotlight - 此页面元素，用于链式调用。

授权

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

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

`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()`

将页面元素在页面上向后移动一个元素。

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

SpeakerSpotlight - 此页面元素，用于链式调用。

授权

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

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

`sendToBack()`

将页面元素发送到页面后方。

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

SpeakerSpotlight - 此页面元素，用于链式调用。

授权

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

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`	用于设置替代文本说明的字符串。

SpeakerSpotlight - 此页面元素。

授权

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

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

`setHeight(height)`

以磅为单位设置元素的高度，即元素在未旋转时其边界框的高度。

此方法不适用于所有网页元素。如需了解哪些页面元素与此方法不兼容，请参阅大小调整和定位限制。

参数

名称	类型	说明
`height`	`Number`	要设置的相应页面元素的新高度（以点为单位）。

SpeakerSpotlight - 此页面元素，用于链式调用。

授权

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

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

`setLeft(left)`

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

参数

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

SpeakerSpotlight - 此页面元素，用于链式调用。

授权

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

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

`setRotation(angle)`

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

此方法不适用于所有网页元素。如需了解哪些页面元素与此方法不兼容，请参阅大小调整和定位限制。

参数

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

SpeakerSpotlight - 此页面元素，用于链式调用。

授权

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

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".
const pageElement =
    SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0];
pageElement.setTitle('new alt text title');
Logger.log(pageElement.getTitle());

参数

名称	类型	说明
`title`	`String`	要将替代文本标题设置为的字符串。

SpeakerSpotlight - 此页面元素。

授权

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

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

`setTop(top)`

设置元素的垂直位置（以点为单位），当元素未旋转时，该位置从页面的左上角开始测量。

参数

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

SpeakerSpotlight - 此页面元素，用于链式调用。

授权

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

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

`setTransform(transform)`

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

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

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

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

参数

名称	类型	说明
`transform`	`AffineTransform`	为相应网页元素设置的转换。

SpeakerSpotlight - 此元素，用于链式调用。

授权

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

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

`setWidth(width)`

以磅为单位设置元素的宽度，即元素在未旋转时其边界框的宽度。

此方法不适用于所有网页元素。如需了解哪些页面元素与此方法不兼容，请参阅大小调整和定位限制。

参数

名称	类型	说明
`width`	`Number`	要设置的相应页面元素的新宽度（以磅为单位）。

SpeakerSpotlight - 此页面元素，用于链式调用。

授权

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

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

Class SpeakerSpotlight 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

方法

详细文档

alignOnPage(alignmentPosition)

参数

返回

bringForward()

返回

授权

bringToFront()

返回

授权

duplicate()

返回

授权

getBorder()

返回

授权

getConnectionSites()

返回

授权

getDescription()

返回

授权

getHeight()

返回

授权

getInherentHeight()

返回

授权

getInherentWidth()

返回

授权

getLeft()

返回

授权

getMaskShapeType()

返回

授权

getObjectId()

返回

授权

getPageElementType()

返回

授权

getParentGroup()

返回

授权

getParentPage()

返回

授权

getRotation()

返回

授权

getTitle()

返回

授权

getTop()

返回

授权

getTransform()

返回

授权

getWidth()

返回

授权

preconcatenateTransform(transform)

参数

返回

授权

remove()

授权

scaleHeight(ratio)

参数

返回

授权

scaleWidth(ratio)

参数

返回

授权

Class SpeakerSpotlight

`alignOnPage(alignmentPosition)`

`bringForward()`

`bringToFront()`

`duplicate()`

`getBorder()`

`getConnectionSites()`

`getDescription()`

`getHeight()`

`getInherentHeight()`

`getInherentWidth()`

`getLeft()`

`getMaskShapeType()`

`getObjectId()`

`getPageElementType()`

`getParentGroup()`

`getParentPage()`

`getRotation()`

`getTitle()`

`getTop()`

`getTransform()`

`getWidth()`

`preconcatenateTransform(transform)`

`remove()`

`scaleHeight(ratio)`

`scaleWidth(ratio)`

`select()`

`select(replace)`

`sendBackward()`

`sendToBack()`

`setDescription(description)`

`setHeight(height)`

`setLeft(left)`

`setRotation(angle)`

`setTitle(title)`

`setTop(top)`

`setTransform(transform)`

`setWidth(width)`