Class Video

视频

表示视频的 PageElement

方法

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

详细文档

alignOnPage(alignmentPosition)

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

参数

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

返回

Video - 此页面元素,用于链式调用。


bringForward()

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

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

返回

Video - 此页面元素,用于链式调用。

授权

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

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

bringToFront()

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

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

返回

Video - 此页面元素,用于链式调用。

授权

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

  • 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

返回

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

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

getSource()

获取视频源。

返回

VideoSourceType - 相应视频的来源。

授权

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

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

getThumbnailUrl()

获取视频缩略图的网址。此网址已与请求者的账号相关联。 拥有该网址的任何人都可以像原始要求提出者一样访问缩略图。如果演示文稿的共享设置发生变化,您可能无法再访问缩略图。该网址会在短时间内过期。

返回

String - 视频缩略图的网址。

授权

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

  • 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

getUrl()

获取视频的网址。只要源视频存在且共享设置未发生变化,该网址就有效。如果不支持视频源,则返回 null

返回

String|null - 相应视频的网址,如果不支持视频来源,则为 null

授权

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

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

getVideoId()

获取相应视频的视频源的唯一标识符。

返回

String - 相应视频的来源 ID。

授权

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

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

参数

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

返回

Video - 此页面元素,用于链式调用。

授权

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

  • 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用于缩放相应网页元素高度的比率。

返回

Video - 此页面元素,用于链式调用。

授权

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

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

scaleWidth(ratio)

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

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

参数

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

返回

Video - 此页面元素,用于链式调用。

授权

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

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

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

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

返回

Video - 此页面元素,用于链式调用。

授权

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

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

sendToBack()

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

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

返回

Video - 此页面元素,用于链式调用。

授权

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

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

返回

Video - 此页面元素。

授权

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

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

setHeight(height)

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

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

参数

名称类型说明
heightNumber要设置的相应页面元素的新高度(以点为单位)。

返回

Video - 此页面元素,用于链式调用。

授权

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

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

setLeft(left)

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

参数

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

返回

Video - 此页面元素,用于链式调用。

授权

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

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

setRotation(angle)

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

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

参数

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

返回

Video - 此页面元素,用于链式调用。

授权

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

  • 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要将替代文本标题设置为的字符串。

返回

Video - 此页面元素。

授权

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

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

setTop(top)

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

参数

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

返回

Video - 此页面元素,用于链式调用。

授权

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

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

setTransform(transform)

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

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

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

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

参数

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

返回

Video - 此元素,用于链式调用。

授权

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

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

setWidth(width)

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

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

参数

名称类型说明
widthNumber要设置的相应页面元素的新宽度(以磅为单位)。

返回

Video - 此页面元素,用于链式调用。

授权

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

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