Class PageElement

頁面元素

網頁上顯示的視覺元素。

方法

方法傳回類型簡短說明
alignOnPage(alignmentPosition)PageElement將元素對齊頁面上的指定對齊位置。
asGroup()Group以群組形式傳回網頁元素。
asImage()Image以圖片形式傳回網頁元素。
asLine()Line以線條形式傳回頁面元素。
asShape()Shape以形狀形式傳回頁面元素。
asSheetsChart()SheetsChart傳回頁面元素,做為從 Google 試算表內嵌的連結圖表。
asSpeakerSpotlight()SpeakerSpotlight將頁面元素傳回為講者聚光燈。
asTable()Table以表格形式傳回網頁元素。
asVideo()Video將網頁元素傳回為影片。
asWordArt()WordArt以美工文字形式傳回頁面元素。
bringForward()PageElement將頁面元素在頁面上往前移動一個元素。
bringToFront()PageElement將頁面元素移至頁面最前方。
duplicate()PageElement複製頁面元素。
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傳回元素以中心為軸的順時針旋轉角度 (以度為單位),零度表示未旋轉。
getTitle()String傳回網頁元素的替代文字標題。
getTop()Number取得元素在頁面中的垂直位置 (以點為單位),測量基準為頁面左上角 (元素未旋轉時)。
getTransform()AffineTransform傳回頁面元素的轉換。
getWidth()Number|null以點為單位傳回元素的寬度,也就是元素沒有旋轉時,元素周框的寬度。
preconcatenateTransform(transform)PageElement將提供的轉換預先串連至網頁元素的現有轉換。
remove()void移除頁面元素。
scaleHeight(ratio)PageElement依指定比例縮放元素高度。
scaleWidth(ratio)PageElement依指定比例縮放元素的寬度。
select()void只選取目前簡報中的 PageElement,並移除先前的選取項目。
select(replace)void選取使用中簡報中的 PageElement
sendBackward()PageElement將頁面元素在頁面上往後移動一個元素。
sendToBack()PageElement將頁面元素移到頁面後方。
setDescription(description)PageElement設定頁面元素的替代文字說明。
setHeight(height)PageElement以點為單位設定元素的高度,也就是元素沒有旋轉時,元素周框的高度。
setLeft(left)PageElement以點為單位設定元素在頁面上的水平位置,測量起點為頁面左上角 (元素未旋轉時)。
setRotation(angle)PageElement設定元素以中心為軸,順時針旋轉的角度 (以度為單位)。
setTitle(title)PageElement設定網頁元素的替代文字標題。
setTop(top)PageElement以點為單位設定元素在頁面上的垂直位置,測量起點為頁面左上角 (元素未旋轉時)。
setTransform(transform)PageElement使用提供的轉換設定網頁元素的轉換。
setWidth(width)PageElement以點為單位設定元素寬度,也就是元素沒有旋轉時,元素周框的寬度。

內容詳盡的說明文件

alignOnPage(alignmentPosition)

將元素對齊頁面上的指定對齊位置。

參數

名稱類型說明
alignmentPositionAlignmentPosition頁面元素在頁面上的對齊位置。

回攻員

PageElement - 這個頁面元素,用於鏈結。


asGroup()

以群組形式傳回網頁元素。

回攻員

Group:這個網頁元素做為群組。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

asImage()

以圖片形式傳回網頁元素。

回攻員

Image:將這個網頁元素儲存為圖片。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

asLine()

以線條形式傳回頁面元素。

回攻員

Line:這個頁面元素做為一行。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

asShape()

以形狀形式傳回頁面元素。

回攻員

Shape:這個頁面元素會顯示為形狀。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

asSheetsChart()

傳回頁面元素,做為從 Google 試算表內嵌的連結圖表。

回攻員

SheetsChart:頁面元素 (圖表)。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

asSpeakerSpotlight()

傳回頁面元素做為講者聚光燈。

const slide = SlidesApp.getActivePresentation().getSlides()[0];
const pageElement = slide.getPageElements()[0];
pageElement.asSpeakerSpotlight();

回攻員

SpeakerSpotlight - 頁面元素,做為演講者人物聚焦。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

asTable()

以表格形式傳回網頁元素。

回攻員

Table:這個頁面元素是表格。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

asVideo()

將網頁元素傳回為影片。

回攻員

Video:這個網頁元素是影片。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

asWordArt()

以美工文字形式傳回頁面元素。

回攻員

WordArt:這個網頁元素是文字藝術。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

bringForward()

將頁面元素在頁面上向前移動一個元素。

頁面元素不得位於群組中。

回攻員

PageElement - 這個頁面元素,用於鏈結。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

bringToFront()

將頁面元素移至頁面最前方。

頁面元素不得位於群組中。

回攻員

PageElement - 這個頁面元素,用於鏈結。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

  • 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:頁面元素以點為單位的固有高度,如果頁面元素沒有高度,則為 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 之間 (含 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:頁面元素的固有寬度 (以點為單位),如果頁面元素沒有寬度,則為 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要預先串連至這個頁面元素轉換的轉換。

回攻員

PageElement - 這個頁面元素,用於鏈結。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

  • 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用來縮放此頁面元素高度的比例。

回攻員

PageElement - 這個頁面元素,用於鏈結。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

scaleWidth(ratio)

依指定比例縮放元素的寬度。如果元素未旋轉,則元素寬度就是其周框的寬度。

這種方法不適用於所有網頁元素。如要瞭解哪些網頁元素與這個方法不相容,請參閱 大小和位置限制

參數

名稱類型說明
ratioNumber用來縮放這個網頁元素寬度的比例。

回攻員

PageElement - 這個頁面元素,用於鏈結。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

將頁面元素在頁面上往後移動一個元素。

頁面元素不得位於群組中。

回攻員

PageElement - 這個頁面元素,用於鏈結。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

sendToBack()

將頁面元素移到頁面後方。

頁面元素不得位於群組中。

回攻員

PageElement - 這個頁面元素,用於鏈結。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

  • 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要設定的替代文字說明字串。

回攻員

PageElement:這個網頁元素。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

setHeight(height)

以點為單位設定元素的高度,也就是元素沒有旋轉時的邊界方塊高度。

這種方法不適用於所有網頁元素。如要瞭解哪些網頁元素與這個方法不相容,請參閱 大小和位置限制

參數

名稱類型說明
heightNumber要設定的頁面元素新高度 (以點為單位)。

回攻員

PageElement - 這個頁面元素,用於鏈結。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

setLeft(left)

以點為單位設定元素在頁面上的水平位置,測量起點為頁面左上角 (元素未旋轉時)。

參數

名稱類型說明
leftNumber要設定的新水平位置 (以點為單位)。

回攻員

PageElement - 這個頁面元素,用於鏈結。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

setRotation(angle)

以度為單位,設定元素繞中心點順時針旋轉的角度。

這種方法不適用於所有網頁元素。如要瞭解哪些網頁元素與這個方法不相容,請參閱 大小和位置限制

參數

名稱類型說明
angleNumber要設定的新順時針旋轉角度 (以度為單位)。

回攻員

PageElement - 這個頁面元素,用於鏈結。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

  • 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用來設定替代文字標題的字串。

回攻員

PageElement:這個網頁元素。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

setTop(top)

以點為單位設定元素在頁面上的垂直位置,測量起點為頁面左上角 (元素未旋轉時)。

參數

名稱類型說明
topNumber要設定的新垂直位置 (以點為單位)。

回攻員

PageElement - 這個頁面元素,用於鏈結。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

setTransform(transform)

使用提供的轉換設定網頁元素的轉換。

更新群組的變形會變更該群組中網頁元素的絕對變形,這可能會改變這些元素的外觀。

更新群組中網頁元素的轉換作業時,只會變更該網頁元素的轉換作業,不會影響群組或群組中其他網頁元素的轉換作業。

如要瞭解轉換如何影響網頁元素的視覺外觀,請參閱 getTransform()

參數

名稱類型說明
transformAffineTransform為這個頁面元素設定的轉換。

回攻員

PageElement - 這個元素用於串連。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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

setWidth(width)

以點為單位設定元素寬度,也就是元素未旋轉時的邊界方塊寬度。

這種方法不適用於所有網頁元素。如要瞭解哪些網頁元素與這個方法不相容,請參閱 大小和位置限制

參數

名稱類型說明
widthNumber要設定的頁面元素新寬度 (以點為單位)。

回攻員

PageElement - 這個頁面元素,用於鏈結。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

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