Class SpeakerSpotlight

SpeakerSpotlight

表示演讲者特写的 PageElement。 

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。 

// 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 没有蒙版 

// 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 点： 

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

移除页面元素。

如果在执行 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。 

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 先使用 Page.selectAsCurrentPage()，然后选择该页面中的页面元素。 

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

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

页面元素不得位于组中。

返回

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".
var 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".
var 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