Class SheetsChart

表格

表示从 Google 表格嵌入的链接图表的 PageElement

方法

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

详细文档

alignOnPage(alignmentPosition)

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

参数

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

返回

SheetsChart - 此页面元素,用于串联。


asImage()

以图片形式返回图表;如果图表不是嵌入式图片,则返回 null

返回

Image - 此图表是图片形式;如果图表不是嵌入式图片,则是 null

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

bringForward()

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

页面元素不得位于组中。

返回

SheetsChart - 此页面元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

bringToFront()

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

页面元素不得位于组中。

返回

SheetsChart - 此页面元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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

getChartId()

获取嵌入的 Google 表格电子表格中特定图表的 ID。

返回

Integer - 嵌入图表的 ID。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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

getEmbedType()

返回 Google 表格的嵌入类型。

返回

SheetsChartEmbedType - 此图表的嵌入类型。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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

getRotation()

返回元素围绕其中心顺时针旋转的角度(以度为单位),其中零度表示无旋转。

返回

Number - 旋转角度,介于 0(含)和 360(不含)之间。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

getSpreadsheetId()

获取包含源图表的 Google 表格电子表格的 ID。

返回

String - 包含来源图表的电子表格的 ID。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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) 替换 page 元素的转换。

参数

名称类型说明
transformAffineTransform要与该页面元素的转换串联的转换。

返回

SheetsChart - 此页面元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

refresh()

使用 Google 表格中的最新版本的图表替换图表。如果图表已是最新版本,则不会在演示文稿中对图表进行任何更改。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.readonly

remove()

移除页面元素。

如果执行移除操作后,Group 仅包含一个页面元素或不包含页面元素,则该组本身也会被移除。

如果在母版或布局中移除了占位符 PageElement,所有空的继承占位符也会被移除。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

移除 Link

shape.removeLink();

scaleHeight(ratio)

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

参数

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

返回

SheetsChart - 此页面元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

scaleWidth(ratio)

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

参数

名称类型说明
ratioNumber该页面元素的宽度的比例。

返回

SheetsChart - 此页面元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

使用一个元素向后发送网页上的元素。

页面元素不得位于组中。

返回

SheetsChart - 此页面元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

sendToBack()

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

页面元素不得位于组中。

返回

SheetsChart - 此页面元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

返回

SheetsChart - 此页面元素。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

setHeight(height)

以点为单位设置元素的高度,即元素无旋转时元素边界框的高度。

参数

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

返回

SheetsChart - 此页面元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

setLeft(left)

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

参数

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

返回

SheetsChart - 此页面元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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要设置的新顺时针旋转角度(以度为单位)。

返回

SheetsChart - 此页面元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

返回

SheetsChart - 此页面元素。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

setTop(top)

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

参数

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

返回

SheetsChart - 此页面元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

setTransform(transform)

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

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

更新组内页面元素的转换仅会更改该网页元素的转换,而不会影响组或其他组中元素的转换。

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

参数

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

返回

SheetsChart - 此元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

setWidth(width)

以点为单位设置元素的宽度,即元素没有旋转时边框的宽度。

参数

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

返回

SheetsChart - 此页面元素,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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