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获取元素的高度（以点为单位），即元素未旋转时的元素边界框的高度。
getInherentHeight()Number返回元素的固有高度（以点为单位）。
getInherentWidth()Number返回元素固有的宽度（以点为单位）。
getLeft()Number返回元素的水平位置（以点为单位），从页面左上角（当元素未旋转时）测量。
getMaskShapeType()ShapeType返回应用于演讲者聚焦画面的遮罩的 ShapeType；如果没有遮罩，则返回 null。
getObjectId()String返回此对象的唯一 ID。
getPageElementType()PageElementType返回页面元素的类型，表示为 PageElementType 枚举。
getParentGroup()Group返回此页面元素所属的组；如果该元素不属于任何组，则返回 null。
getParentPage()Page返回此页面元素所在的页面。
getRotation()Number返回元素围绕其中心顺时针旋转的角度（以度为单位），其中 0 度表示不旋转。
getTitle()String返回网页元素的替代文本标题。
getTop()Number获取元素的垂直位置（以像素为单位），从页面左上角测量，前提是元素未旋转。
getTransform()AffineTransform返回页面元素的转换。
getWidth()Number返回元素的宽度（以像素为单位），即元素未旋转时的边界框宽度。
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)

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

参数

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

返回

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。

授权

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

  • 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

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 - 演讲者聚焦画面遮罩的形状类型。

授权

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

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

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

返回

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 点，请执行以下操作： 

const element = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0];
element.preconcatenateTransform(
    SlidesApp.newAffineTransformBuilder().setTranslateX(-36.0).build(),
);

您还可以将页面元素的转换替换为 setTransform(transform)。

参数

名称类型说明
transformAffineTransform要预连接到此页面元素的转换的转换。

返回

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)

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

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

参数

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

返回

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

授权

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

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

scaleWidth(ratio)

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

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

参数

名称类型说明
ratioNumber用于缩放此页面元素宽度的比例。

返回

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 参数选择页面元素时，必须满足以下条件：

  1. PageElement 对象的父 Page 必须是 current page selection。
  2. 不应选择多个 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);
}

参数

名称类型说明
replaceBoolean如果为 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());

参数

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

返回

SpeakerSpotlight - 此页面元素。

授权

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

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

setHeight(height)

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

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

参数

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

返回

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

授权

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

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

setLeft(left)

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

参数

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

返回

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

授权

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

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

setRotation(angle)

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

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

参数

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

返回

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

参数

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

返回

SpeakerSpotlight - 此页面元素。

授权

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

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

setTop(top)

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

参数

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

返回

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

授权

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

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

setTransform(transform)

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

更新组的转换会更改该组中页面元素的绝对转换，这可能会更改其视觉外观。

更新分组中的页面元素的转换只会更改该页面元素的转换；不会影响该分组或分组中的其他页面元素的转换。

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

参数

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

返回

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

授权

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

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

setWidth(width)

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

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

参数

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

返回

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

授权

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

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