代表文字美工的 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 | 如果沒有連結,則會傳回 Link 或 null 。 |
getObjectId() | String | 傳回此物件的專屬 ID。 |
getPageElementType() | PageElementType | 傳回頁面元素的類型,以 PageElementType 列舉項目表示。 |
getParentGroup() | Group | 傳回此頁面元素所屬的群組,如果元素不在群組中,則傳回 null 。 |
getParentPage() | Page | 傳回這個頁面元素所在的頁面。 |
getRenderedText() | String | 取得以文字圖案呈現的文字。 |
getRotation() | Number | 以度數為單位,傳回元素以順時針方向從中心旋轉的角度,其中零度代表沒有旋轉。 |
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) | Link | 將 Link 設為指定的 Slide ,連結會由指定的幻燈片 ID 設定。 |
setLinkSlide(slidePosition) | Link | 使用簡報的相對位置,將 Link 設為指定的 Slide 。 |
setLinkUrl(url) | Link | 將 Link 設為指定的非空白網址字串。 |
setRotation(angle) | WordArt | 以度為單位,設定元素以順時針方向從中心旋轉的角度。 |
setTitle(title) | WordArt | 設定網頁元素的替代文字標題。 |
setTop(top) | WordArt | 在元素未旋轉時,以點為單位設定元素的垂直位置,從頁面左上角開始測量。 |
setTransform(transform) | WordArt | 使用提供的轉換,設定網頁元素的轉換。 |
setWidth(width) | WordArt | 以點為單位設定元素的寬度,也就是元素未旋轉時的邊界框寬度。 |
內容詳盡的說明文件
alignOnPage(alignmentPosition)
將元素對齊頁面上指定的對齊位置。
參數
名稱 | 類型 | 說明 |
---|---|---|
alignmentPosition | AlignmentPosition | 這個頁面元素在頁面上對齊的位置。 |
回攻員
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
。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
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
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()}`); }
回攻員
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
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 (含 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 | AffineTransform | 要預先連接至此頁面元素轉換的轉換。 |
回攻員
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);
參數
名稱 | 類型 | 說明 |
---|---|---|
slideIndex | Integer | 投影片的索引,從零開始。 |
回攻員
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
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. 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);
參數
名稱 | 類型 | 說明 |
---|---|---|
slidePosition | SlidePosition | 相對 SlidePosition 。 |
回攻員
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
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 | AffineTransform | 為此網頁元素設定的轉換。 |
回攻員
WordArt
:這個元素用於鏈結。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations