Class WordArt

WordArt

表示艺术字的 PageElement

方法

方法返回类型简介
alignOnPage(alignmentPosition)WordArt将元素与页面上的指定对齐位置对齐。
bringForward()WordArt将页面上的页面元素前移一个元素。
bringToFront()WordArt将页面元素移到页面的前面。
duplicate()PageElement复制页面元素。
getConnectionSites()ConnectionSite[]返回页面元素上的 ConnectionSite 列表;如果页面元素没有任何连接站点,则返回空列表。
getDescription()String返回页面元素的替代文本说明。
getHeight()Number获取元素的高度(以点为单位),这是元素在没有旋转时,元素边界框的高度。
getInherentHeight()Number返回元素的固有高度(以点为单位)。
getInherentWidth()Number返回元素的固有宽度(以点为单位)。
getLeft()Number返回元素的水平位置(以点为单位),当元素没有旋转时,从页面左上角开始测量。
getLink()Link如果没有链接,则返回 Linknull
getObjectId()String返回此对象的唯一 ID。
getPageElementType()PageElementType返回页面元素的类型,表示为 PageElementType 枚举。
getParentGroup()Group返回此网页元素所属的群组,如果该元素不在任何群组中,则返回 null
getParentPage()Page返回此页面元素所在的页面。
getRenderedText()String获取呈现为艺术字的文本。
getRotation()Number返回元素围绕其中心的顺时针旋转角度(以度为单位),其中 0 度表示不旋转。
getTitle()String返回页面元素的替代文本标题。
getTop()Number获取元素的垂直位置(以点为单位),当元素没有旋转时,从页面左上角开始测量。
getTransform()AffineTransform返回页面元素的转换。
getWidth()Number返回元素的宽度(以点为单位),这是元素在没有旋转时,其边界框的宽度。
preconcatenateTransform(transform)WordArt将提供的转换与页面元素的现有转换预串联。
remove()void移除页面元素。
removeLink()void移除 Link
scaleHeight(ratio)WordArt按指定的比率缩放元素的高度。
scaleWidth(ratio)WordArt按指定的比率缩放元素的宽度。
select()void仅选择当前演示中的 PageElement,并移除之前的所有选择。
select(replace)void在当前演示文稿中选择 PageElement
sendBackward()WordArt将页面上的页面元素向后移动一个元素。
sendToBack()WordArt将页面元素发送到页面的背面。
setDescription(description)WordArt设置页面元素的替代文本说明。
setHeight(height)WordArt设置元素的高度(以点为单位),这是元素没有旋转时元素边界框的高度。
setLeft(left)WordArt设置元素的水平位置(以点为单位),当元素没有旋转时,从页面左上角开始测量。
setLinkSlide(slideIndex)Link使用幻灯片索引(从零开始)将 Link 设为指定的 Slide
setLinkSlide(slide)LinkLink 设为指定的 Slide,链接由指定的幻灯片 ID 设置。
setLinkSlide(slidePosition)Link使用幻灯片的相对位置将 Link 设为指定的 Slide
setLinkUrl(url)LinkLink 设置为指定的非空网址字符串。
setRotation(angle)WordArt设置元素围绕其中心的顺时针旋转角度(以度为单位)。
setTitle(title)WordArt设置页面元素的替代文本标题。
setTop(top)WordArt设置元素的垂直位置(以点为单位),当元素没有旋转时,从页面左上角开始测量。
setTransform(transform)WordArt使用提供的转换设置页面元素的转换。
setWidth(width)WordArt设置元素的宽度(以点为单位),这是元素在没有旋转时元素边界框的宽度。

详细文档

alignOnPage(alignmentPosition)

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

参数

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

弃踢回攻

WordArt - 此页面元素,用于链接。


bringForward()

将页面上的页面元素前移一个元素。

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

弃踢回攻

WordArt - 此页面元素,用于链接。

授权

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

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

bringToFront()

将页面元素移到页面的前面。

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

弃踢回攻

WordArt - 此页面元素,用于链接。

授权

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

  • 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

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

如果没有链接,则返回 Linknull

var link = shape.getLink();
if (link != null) {
  Logger.log('Shape has a link of type: ' + link.getLinkType());
}

弃踢回攻

Link

授权

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

  • 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

getRenderedText()

获取呈现为艺术字的文本。

弃踢回攻

String - 呈现为此艺术字的文本。

授权

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

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

弃踢回攻

WordArt - 此页面元素,用于链接。

授权

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

  • 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

移除 Link

shape.removeLink();

scaleHeight(ratio)

按指定的比率缩放元素的高度。当元素没有旋转时,元素的高度就是其边界框的高度。

此方法并非与所有页面元素都兼容。如需了解哪些页面元素与此方法不兼容,请参阅 大小和定位限制

参数

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

弃踢回攻

WordArt - 此页面元素,用于链接。

授权

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

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

scaleWidth(ratio)

按指定的比率缩放元素的宽度。元素的宽度是其边界框在元素没有旋转时的宽度。

此方法并非与所有页面元素都兼容。如需了解哪些页面元素与此方法不兼容,请参阅 大小和定位限制

参数

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

弃踢回攻

WordArt - 此页面元素,用于链接。

授权

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

  • 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.selectAsCurrentPage() 选择父 Page,然后选择该页面中的页面元素。

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

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

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

弃踢回攻

WordArt - 此页面元素,用于链接。

授权

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

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

sendToBack()

将页面元素发送到页面的背面。

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

弃踢回攻

WordArt - 此页面元素,用于链接。

授权

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

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

弃踢回攻

WordArt - 此页面元素。

授权

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

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

setHeight(height)

设置元素的高度(以点为单位),这是元素没有旋转时元素边界框的高度。

此方法并非与所有页面元素都兼容。如需了解哪些页面元素与此方法不兼容,请参阅 大小和定位限制

参数

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

弃踢回攻

WordArt - 此页面元素,用于链接。

授权

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

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

setLeft(left)

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

参数

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

弃踢回攻

WordArt - 此页面元素,用于链接。

授权

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

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

setLinkSlide(slideIndex)

使用幻灯片的索引(从零开始)将 Link 设为指定的 Slide

// Set a link to the first slide of the presentation.
shape.setLinkSlide(0);

参数

名称类型说明
slideIndexInteger幻灯片的索引(从零开始)。

弃踢回攻

Link - 设置的 Link

授权

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

  • 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.
var slide = presentation.getSlides()[0];
shape.setLinkSlide(slide);

参数

名称类型说明
slideSlide要关联的 Slide

弃踢回攻

Link - 设置的 Link

授权

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

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

setLinkSlide(slidePosition)

使用幻灯片的相对位置将 Link 设为指定的 Slide

// Set a link to the first slide of the presentation.
shape.setLinkSlide(SlideApp.SlidePosition.FIRST_SLIDE);

参数

名称类型说明
slidePositionSlidePosition相对 SlidePosition

弃踢回攻

Link - 设置的 Link

授权

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

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

setLinkUrl(url)

Link 设置为指定的非空网址字符串。

// Set a link to the URL.
shape.setLinkUrl("https://slides.google.com");

参数

名称类型说明
urlString网址字符串。

弃踢回攻

Link - 设置的 Link

授权

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

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

setRotation(angle)

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

此方法并非与所有页面元素都兼容。如需了解哪些页面元素与此方法不兼容,请参阅 大小和定位限制

参数

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

弃踢回攻

WordArt - 此页面元素,用于链接。

授权

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

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

弃踢回攻

WordArt - 此页面元素。

授权

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

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

setTop(top)

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

参数

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

弃踢回攻

WordArt - 此页面元素,用于链接。

授权

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

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

setTransform(transform)

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

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

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

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

参数

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

弃踢回攻

WordArt - 此元素,用于链接。

授权

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

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

setWidth(width)

设置元素的宽度(以点为单位),这是元素在没有旋转时元素边界框的宽度。

此方法并非与所有页面元素都兼容。如需了解哪些页面元素与此方法不兼容,请参阅 大小和定位限制

参数

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

弃踢回攻

WordArt - 此页面元素,用于链接。

授权

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

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