本頁面由 Cloud Translation API 翻譯而成。

Class SpeakerSpotlight

PageElement 代表講者鏡頭畫面。

const slide = SlidesApp.getActivePresentation().getSlides()[0];
const speakerSpotlight = slide.getPageElements()[0];
console.log(
    `Page element is of type: ${
        speakerSpotlight.getPageElementType().toString()}`,
);

方法

方法	傳回類型	簡短說明
`alignOnPage(alignmentPosition)`	`SpeakerSpotlight`	將元素對齊頁面上指定的對齊位置。
`bringForward()`	`SpeakerSpotlight`	將網頁元素在網頁上向前移動一個元素。
`bringToFront()`	`SpeakerSpotlight`	將頁面元素移至頁面前端。
`duplicate()`	`PageElement`	複製頁面元素。
`getBorder()`	`Border`	傳回講者焦點的 `Border`。
`getConnectionSites()`	`ConnectionSite[]`	傳回頁面元素上的 `ConnectionSite` 清單，如果頁面元素沒有任何連線網站，則傳回空白清單。
`getDescription()`	`String`	傳回網頁元素的替代文字說明。
`getHeight()`	`Number`	以點為單位取得元素的高度，也就是元素未旋轉時的邊界框高度。
`getInherentHeight()`	`Number`	以點為單位，傳回元素的固有高度。
`getInherentWidth()`	`Number`	以點為單位，傳回元素的固有寬度。
`getLeft()`	`Number`	傳回元素的水平位置 (以點為單位)，從元素未旋轉時的頁面左上角測量。
`getMaskShapeType()`	`ShapeType`	傳回套用至演講者直播畫面的遮罩的 `ShapeType`，如果沒有遮罩，則傳回 `null`。
`getObjectId()`	`String`	傳回此物件的專屬 ID。
`getPageElementType()`	`PageElementType`	傳回頁面元素的類型，以 `PageElementType` 列舉項目表示。
`getParentGroup()`	`Group`	傳回此頁面元素所屬的群組，如果元素不在群組中，則傳回 `null`。
`getParentPage()`	`Page`	傳回這個頁面元素所在的頁面。
`getRotation()`	`Number`	以度數為單位，傳回元素以順時針方向從中心旋轉的角度，其中零度代表沒有旋轉。
`getTitle()`	`String`	傳回網頁元素的替代文字標題。
`getTop()`	`Number`	取得元素的垂直位置 (以點為單位)，測量時從元素未旋轉的情況下，以頁面左上角為基準。
`getTransform()`	`AffineTransform`	傳回網頁元素的轉換。
`getWidth()`	`Number`	以點為單位傳回元素的寬度，也就是元素未旋轉時的邊界框寬度。
`preconcatenateTransform(transform)`	`SpeakerSpotlight`	將提供的轉換先連接至網頁元素的現有轉換。
`remove()`	`void`	移除網頁元素。
`scaleHeight(ratio)`	`SpeakerSpotlight`	以指定的比例縮放元素的高度。
`scaleWidth(ratio)`	`SpeakerSpotlight`	根據指定的比例縮放元素的寬度。
`select()`	`void`	只選取目前簡報中的 `PageElement`，並移除先前的選取項目。
`select(replace)`	`void`	選取有效簡報中的 `PageElement`。
`sendBackward()`	`SpeakerSpotlight`	將網頁元素往後移動一個元素。
`sendToBack()`	`SpeakerSpotlight`	將網頁元素移到頁面後方。
`setDescription(description)`	`SpeakerSpotlight`	設定網頁元素的替代文字說明。
`setHeight(height)`	`SpeakerSpotlight`	以點為單位設定元素的高度，也就是元素未旋轉時的邊界框架高度。
`setLeft(left)`	`SpeakerSpotlight`	以點為單位設定元素的水平位置，在元素未旋轉的情況下，從頁面左上角測量。
`setRotation(angle)`	`SpeakerSpotlight`	以度為單位，設定元素以順時針方向從中心旋轉的角度。
`setTitle(title)`	`SpeakerSpotlight`	設定網頁元素的替代文字標題。
`setTop(top)`	`SpeakerSpotlight`	在元素未旋轉時，以點為單位設定元素的垂直位置，從頁面左上角開始測量。
`setTransform(transform)`	`SpeakerSpotlight`	使用提供的轉換，設定網頁元素的轉換。
`setWidth(width)`	`SpeakerSpotlight`	以點為單位設定元素的寬度，也就是元素未旋轉時的邊界框寬度。

內容詳盡的說明文件

`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。

const slide = SlidesApp.getActivePresentation().getSlides()[0];
// 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()`

以點為單位取得元素的高度，也就是元素未旋轉時的邊界框高度。

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

回攻員

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

`getMaskShapeType()`

傳回套用至演講者直播畫面的遮罩的 ShapeType，如果沒有遮罩，則傳回 null。

const slide = SlidesApp.getActivePresentation().getSlides()[0];
// 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()`

傳回此頁面元素所屬的群組，如果元素不在群組中，則傳回 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 (含 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。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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)。

參數

名稱	類型	說明
`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。

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

將網頁元素往後移動一個元素。

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

回攻員

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".
const 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".
const 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