代表文字藝術的 PageElement。
方法
| 方法 | 傳回類型 | 簡短說明 |
|---|---|---|
align | Word | 將元素對齊頁面上的指定對齊位置。 |
bring | Word | 將網頁元素在頁面上往前移動一個元素。 |
bring | Word | 將網頁元素移至頁面最前方。 |
duplicate() | Page | 複製網頁元素。 |
get | Connection | 傳回網頁元素上的 Connection 清單;如果網頁元素沒有任何連結網站,則傳回空白清單。 |
get | String | 傳回網頁元素的替代文字說明。 |
get | Number|null | 以點為單位取得元素的高度,也就是元素沒有旋轉時,元素定界框的高度。 |
get | Number|null | 傳回元素固有的高度 (以點為單位)。 |
get | Number|null | 傳回元素固有的寬度 (以點為單位)。 |
get | Number | 傳回元素在頁面上的水平位置 (以點為單位),測量基準為元素未旋轉時的頁面左上角。 |
get | Link|null | 如果沒有連結,則傳回 Link 或 null。 |
get | String | 傳回這個物件的專屬 ID。 |
get | Page | 傳回頁面元素的類型,以 Page 列舉表示。 |
get | Group|null | 傳回這個網頁元素所屬的群組,如果元素不在群組中,則傳回 null。 |
get | Page | 傳回這個網頁元素所在的頁面。 |
get | String | 取得以文字藝術形式呈現的文字。 |
get | Number | 傳回元素以中心為軸的順時針旋轉角度 (以度為單位),零度表示未旋轉。 |
get | String | 傳回網頁元素的替代文字標題。 |
get | Number | 取得元素在頁面中的垂直位置 (以點為單位),測量基準為頁面左上角 (元素未旋轉時)。 |
get | Affine | 傳回頁面元素的轉換。 |
get | Number|null | 傳回元素的寬度 (以點為單位),如果元素未旋轉,這就是元素的定界框寬度。 |
preconcatenate | Word | 將提供的轉換預先串連至網頁元素的現有轉換。 |
remove() | void | 移除網頁元素。 |
remove | void | 移除 Link。 |
scale | Word | 依指定比例縮放元素高度。 |
scale | Word | 依指定比例縮放元素的寬度。 |
select() | void | 只選取目前簡報中的 Page,並移除先前的選取項目。 |
select(replace) | void | 選取使用中簡報中的 Page。 |
send | Word | 將網頁元素在頁面上往後移動一個元素。 |
send | Word | 將網頁元素傳送到頁面後方。 |
set | Word | 設定頁面元素的替代文字說明。 |
set | Word | 以點為單位設定元素的高度,也就是元素沒有旋轉時,元素的定界框高度。 |
set | Word | 以點為單位設定元素在頁面上的水平位置,測量起點為頁面左上角 (元素未旋轉時)。 |
set | Link | 使用投影片的索引 (從零開始計算),將 Link 設為指定的 Slide。 |
set | Link | 將 Link 設為指定 Slide,連結會依指定投影片 ID 設定。 |
set | Link | 使用投影片的相對位置,將 Link 設為指定 Slide。 |
set | Link | 將 Link 設為指定的非空白網址字串。 |
set | Word | 設定元素以中心為軸,順時針旋轉的角度 (以度為單位)。 |
set | Word | 設定網頁元素的替代文字標題。 |
set | Word | 以點為單位設定元素在頁面上的垂直位置,測量起點為頁面左上角 (元素未旋轉時)。 |
set | Word | 使用提供的轉換設定網頁元素的轉換。 |
set | Word | 以點為單位設定元素的寬度,也就是元素沒有旋轉時,元素的定界框寬度。 |
內容詳盡的說明文件
alignOnPage(alignmentPosition)
將元素對齊頁面上的指定對齊位置。
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
alignment | Alignment | 網頁元素在頁面上的對齊位置。 |
回攻員
WordArt — 這個網頁元素,用於鏈結。
bringForward()
bringToFront()
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()
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
getLink()
如果沒有連結,則傳回 Link 或 null。
const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0]; const link = shape.getLink(); if (link != null) { Logger.log(`Shape has a link of type: ${link.getLinkType()}`); }
回攻員
Link|null:如果沒有連結,則為 Link 或 null。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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()
getParentPage()
getRenderedText()
取得以文字藝術形式呈現的文字。
回攻員
String:以這個文字藝術效果呈現的文字。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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
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()
preconcatenateTransform(transform)
將提供的轉換預先串連至網頁元素的現有轉換。
newTransform = argument * existingTransform;
舉例來說,如要將頁面元素向左移動 36 點:
const element = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0]; element.preconcatenateTransform( SlidesApp.newAffineTransformBuilder().setTranslateX(-36.0).build(), );
您也可以使用 setTransform(transform) 替換頁面元素的轉換。
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
transform | Affine | 要預先串連至這個頁面元素轉換的轉換。 |
回攻員
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
removeLink()
移除 Link。
const slides = SlidesApp.getActivePresentation().getSlides(); slides[1].getShapes()[0].removeLink();
scaleHeight(ratio)
scaleWidth(ratio)
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 參數選取網頁元素時,必須符合下列條件:
PageElement物件的父項Page必須是current page selection。- 選取的
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); }
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
replace | Boolean | 如果 true,選取項目會取代先前的選取項目;否則選取項目會新增至先前的選取項目。 |
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly -
https://www.googleapis.com/auth/presentations
sendBackward()
sendToBack()
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());
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
description | String | 要設定的替代文字說明字串。 |
回攻員
WordArt:這個網頁元素。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly -
https://www.googleapis.com/auth/presentations
setHeight(height)
setLeft(left)
setLinkSlide(slideIndex)
使用投影片的索引 (從零開始計算),將 Link 設為指定 Slide。
// Set a link to the first slide of the presentation. const slides = SlidesApp.getActivePresentation().getSlides(); const shape = slides[1].getShapes()[0]; const link = shape.setLinkSlide(0);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
slide | Integer | 投影片的索引,從零開始。 |
回攻員
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly -
https://www.googleapis.com/auth/presentations
setLinkSlide(slide)
將指定 Slide 的 Link 設為指定投影片 ID 的連結。
// Set a link to the first slide of the presentation. const slides = SlidesApp.getActivePresentation().getSlides(); const shape = slides[1].getShapes()[0]; const link = shape.setLinkSlide(slides[0]);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
slide | Slide | 要連結的 Slide。 |
回攻員
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly -
https://www.googleapis.com/auth/presentations
setLinkSlide(slidePosition)
// Set a link to the first slide of the presentation. const slides = SlidesApp.getActivePresentation().getSlides(); const shape = slides[1].getShapes()[0]; const link = shape.setLinkSlide(SlidesApp.SlidePosition.FIRST_SLIDE);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
slide | Slide | 相對 Slide。 |
回攻員
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly -
https://www.googleapis.com/auth/presentations
setLinkUrl(url)
將 Link 設為指定的非空白網址字串。
// Set a link to the URL. const slides = SlidesApp.getActivePresentation().getSlides(); const shape = slides[1].getShapes()[0]; const link = shape.setLinkUrl('https://slides.google.com');
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
url | String | 網址字串。 |
回攻員
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly -
https://www.googleapis.com/auth/presentations
setRotation(angle)
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());
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
title | String | 用來設定替代文字標題的字串。 |
回攻員
WordArt:這個網頁元素。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly -
https://www.googleapis.com/auth/presentations
setTop(top)
setTransform(transform)
使用提供的轉換設定網頁元素的轉換。
更新群組的變形會變更該群組中網頁元素的絕對變形,這可能會改變這些元素的外觀。
更新群組中網頁元素的轉換作業時,只會變更該網頁元素的轉換作業,不會影響群組或群組中其他網頁元素的轉換作業。
如要瞭解轉換如何影響網頁元素的視覺外觀,請參閱 getTransform()。
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
transform | Affine | 為這個網頁元素設定的轉換。 |
回攻員
WordArt - 這個元素用於串連。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly -
https://www.googleapis.com/auth/presentations