代表講者鏡頭畫面的 PageElement
。
const speakerSpotlight = slide.getPageElements()[0]; console.log(`Page element is of type: ${speakerSpotlight.getPageElementType().toString()}`);
方法
內容詳盡的說明文件
alignOnPage(alignmentPosition)
將元素對齊頁面指定的對齊位置。
參數
名稱 | 類型 | 說明 |
---|---|---|
alignmentPosition | AlignmentPosition | 此頁面元素在網頁上的對齊位置。 |
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
bringForward()
將頁面元素往前移動一個元素。
網頁元素不得位於群組中。
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
bringToFront()
將網頁元素移至網頁前方。
網頁元素不得位於群組中。
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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
getBorder()
傳回講者鏡頭畫面的 Border
。
// Gets the first element on the page, which in // this example is of type speaker spotlight. const speakerSpotlight = slide.getPageElements()[0]; // Gets the border of the speaker spotlight. const border = speakerSpotlight.getBorder();
回攻員
Border
:講者鏡頭畫面的框線。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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
getMaskShapeType()
傳回用於講者鏡頭畫面的遮罩的 ShapeType
;如果沒有遮罩,則傳回 null
。
// Gets the first element on the page, which in // this example is of type speaker spotlight. const speakerSpotlight = slide.getPageElements()[0]; // Gets the shape type of the mask on the speaker spotlight. const maskShapeType = speakerSpotlight.getMaskShapeType();
回攻員
ShapeType
:講者鏡頭畫面遮罩的形狀類型。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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()
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 點,請按照下列步驟操作:
element.preconcatenateTransform(SlidesApp.newAffineTransformBuilder() .setTranslateX(-36.0) .build());
您也可以使用 setTransform(transform)
取代頁面元素的轉換。
參數
名稱 | 類型 | 說明 |
---|---|---|
transform | AffineTransform | 轉換至此頁面元素轉換的轉換。 |
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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)
根據指定的比例縮放元素的高度。當元素未旋轉時,元素的高度是指其定界框的高度。
這個方法不適用於所有網頁元素。如要瞭解哪些網頁元素與這個方法不相容,請參閱 大小和位置限制。
參數
名稱 | 類型 | 說明 |
---|---|---|
ratio | Number | 此頁面元素高度的縮放比例。 |
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
scaleWidth(ratio)
根據指定的比例縮放元素的寬度。當元素未旋轉時,元素的寬度即為定界框的寬度。
這個方法不適用於所有網頁元素。如要瞭解哪些網頁元素與這個方法不相容,請參閱 大小和位置限制。
參數
名稱 | 類型 | 說明 |
---|---|---|
ratio | Number | 此頁面元素寬度的縮放比例。 |
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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
參數選取網頁元素時,必須符合下列條件:
PageElement
物件的父項Page
必須是current page selection
。- 請勿選取多個
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); }
參數
名稱 | 類型 | 說明 |
---|---|---|
replace | Boolean | 如果設為 true ,所選項目會取代先前選取的項目;否則,系統會將其新增至任何先前選取的項目。 |
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
sendBackward()
讓網頁元素回到網頁上一個元素。
網頁元素不得位於群組中。
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
sendToBack()
將網頁元素傳送至網頁背面。
網頁元素不得位於群組中。
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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());
參數
名稱 | 類型 | 說明 |
---|---|---|
description | String | 用來設定替代文字說明的字串。 |
回攻員
SpeakerSpotlight
:這個網頁元素。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setHeight(height)
設定元素的高度 (以點為單位),也就是元素未旋轉時,元素的定界框高度。
這個方法不適用於所有網頁元素。如要瞭解哪些網頁元素與這個方法不相容,請參閱 大小和位置限制。
參數
名稱 | 類型 | 說明 |
---|---|---|
height | Number | 此頁面元素要設定的新高度 (以點表示)。 |
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setLeft(left)
設定元素的水平位置 (以點為單位)。當元素沒有旋轉時,從頁面左上角測量。
參數
名稱 | 類型 | 說明 |
---|---|---|
left | Number | 要設定的新水平位置,以點表示。 |
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setRotation(angle)
設定元素的順時針旋轉角度,以度為單位。
這個方法不適用於所有網頁元素。如要瞭解哪些網頁元素與這個方法不相容,請參閱 大小和位置限制。
參數
名稱 | 類型 | 說明 |
---|---|---|
angle | Number | 要設定的新順時針旋轉角度,以度為單位。 |
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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());
參數
名稱 | 類型 | 說明 |
---|---|---|
title | String | 要設定替代文字標題的字串。 |
回攻員
SpeakerSpotlight
:這個網頁元素。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setTop(top)
設定元素的垂直位置 (在元素未旋轉時從頁面左上角測量)。
參數
名稱 | 類型 | 說明 |
---|---|---|
top | Number | 要設定的新垂直位置 (以點為單位)。 |
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setTransform(transform)
使用提供的轉換設定頁面元素的轉換。
更新群組的轉換會變更群組中網頁元素的絕對轉換,進而變更外觀外觀。
如果更新群組中的網頁元素,則只會變更該頁面元素的轉換,不會影響群組或群組中的其他頁面元素轉換。
如要進一步瞭解轉換如何影響頁面元素的視覺外觀,請參閱 getTransform()
。
參數
名稱 | 類型 | 說明 |
---|---|---|
transform | AffineTransform | 為這個頁面元素設定的轉換。 |
回攻員
SpeakerSpotlight
:這個元素是用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setWidth(width)
設定元素的寬度 (以點表示,在元素未旋轉時,元素的定界框寬度)。
這個方法不適用於所有網頁元素。如要瞭解哪些網頁元素與這個方法不相容,請參閱 大小和位置限制。
參數
名稱 | 類型 | 說明 |
---|---|---|
width | Number | 此頁面元素要設定的新寬度 (以點表示)。 |
回攻員
SpeakerSpotlight
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations