代表圖片的 PageElement
。
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
alignOnPage(alignmentPosition) | Image | 將元素對齊頁面指定的對齊位置。 |
bringForward() | Image | 將頁面元素往前移動一個元素。 |
bringToFront() | Image | 將網頁元素移到網頁前方。 |
duplicate() | PageElement | 複製頁面元素。 |
getAs(contentType) | Blob | 以 blob 的形式傳回這個物件中的資料,做為轉換成指定內容類型的 blob。 |
getBlob() | Blob | 以 blob 形式傳回這張圖片中的資料。 |
getBorder() | Border | 傳回圖片的 Border 。 |
getConnectionSites() | ConnectionSite[] | 傳回網頁元素上的 ConnectionSite 清單;如果網頁元素沒有任何連線網站,則傳回空白清單。 |
getContentUrl() | String | 取得圖片的網址。 |
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 | 傳回這個頁面元素所在的頁面。 |
getParentPlaceholder() | PageElement | 傳回預留位置的父項頁面元素。 |
getPlaceholderIndex() | Integer | 傳回預留位置圖片的索引。 |
getPlaceholderType() | PlaceholderType | 傳回圖片的預留位置類型;如果形狀不是預留位置,則傳回 PlaceholderType.NONE 。 |
getRotation() | Number | 傳回元素中心以度為單位的順時針旋轉角度,零度表示不會旋轉。 |
getSourceUrl() | String | 取得圖片的來源網址 (如有)。 |
getTitle() | String | 傳回頁面元素的替代文字標題。 |
getTop() | Number | 取得元素的垂直位置 (在元素沒有旋轉時從頁面左上角測量)。 |
getTransform() | AffineTransform | 傳回頁面元素的轉換。 |
getWidth() | Number | 傳回元素的寬度 (以點為單位),也就是元素未旋轉時,元素的定界框寬度。 |
preconcatenateTransform(transform) | Image | 將提供的轉換預先串連成頁面元素的現有轉換。 |
remove() | void | 移除網頁元素。 |
removeLink() | void | 移除 Link 。 |
replace(blobSource) | Image | 將這張圖片替換為 BlobSource 物件描述的圖片。 |
replace(blobSource, crop) | Image | 將這張圖片替換為 Image 物件描述的圖片,並可選擇裁剪圖片以符合尺寸。 |
replace(imageUrl) | Image | 以指定網址下載的其他圖片取代這張圖片。 |
replace(imageUrl, crop) | Image | 將這張圖片取代為從提供網址下載的其他圖片,並視需要裁剪圖片以符合需求。 |
scaleHeight(ratio) | Image | 根據指定的比例縮放元素的高度。 |
scaleWidth(ratio) | Image | 根據指定的比例縮放元素的寬度。 |
select() | void | 僅選取使用中的簡報中的 PageElement ,並移除先前的所有選取項目。 |
select(replace) | void | 選取目前簡報中的PageElement 。 |
sendBackward() | Image | 讓頁面元素回到頁面中的一個元素。 |
sendToBack() | Image | 將網頁元素傳送至網頁背面。 |
setDescription(description) | Image | 設定頁面元素的替代文字說明。 |
setHeight(height) | Image | 設定元素的高度 (以點為單位),也就是元素未旋轉時,元素的定界框高度。 |
setLeft(left) | Image | 設定元素的水平位置 (以點為單位)。當元素沒有旋轉時,從頁面左上角測量。 |
setLinkSlide(slideIndex) | Link | 使用投影片的索引 (從零開始計算),將 Link 設為指定的 Slide 。 |
setLinkSlide(slide) | Link | 將 Link 設為指定的 Slide ,連結由指定的投影片 ID 設定。 |
setLinkSlide(slidePosition) | Link | 使用投影片的相對位置,將 Link 設為指定的 Slide 。 |
setLinkUrl(url) | Link | 將 Link 設為指定的非空白網址字串。 |
setRotation(angle) | Image | 設定元素的順時針旋轉角度,以度為單位。 |
setTitle(title) | Image | 設定頁面元素的替代文字標題。 |
setTop(top) | Image | 設定元素的垂直位置 (在元素未旋轉時從頁面左上角測量)。 |
setTransform(transform) | Image | 使用提供的轉換設定頁面元素的轉換。 |
setWidth(width) | Image | 設定元素的寬度 (以點表示,在元素未旋轉時,元素的定界框寬度)。 |
內容詳盡的說明文件
alignOnPage(alignmentPosition)
bringForward()
bringToFront()
duplicate()
複製頁面元素。
將重複的頁面元素放在與原始頁面位於相同位置的頁面。
回攻員
PageElement
:這個頁面元素的新副本。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getAs(contentType)
以 blob 的形式傳回這個物件中的資料,做為轉換成指定內容類型的 blob。這個方法會在檔案名稱中加入適當的副檔名,例如「myfile.pdf」。但我們假設檔案名稱中最後一個半形句號 (如果有) 後面的部分是應替換的現有副檔名。因此,「ShoppingList.12.25.2014」會變成「ShoppingList.12.25.pdf」。
如要查看每日轉換配額,請參閱 Google 服務配額。新建立的 Google Workspace 網域可能暫時適用更嚴格的配額。
參數
名稱 | 類型 | 說明 |
---|---|---|
contentType | String | 要轉換的 MIME 類型。對大多數 blob 來說,'application/pdf' 是唯一有效的選項。如為 BMP、GIF、JPEG 或 PNG 格式的圖片,任何一個 'image/bmp' 、'image/gif' 、'image/jpeg' 或 'image/png' 也都有效。 |
回攻員
Blob
- 做為 blob 的資料。
getBlob()
getBorder()
getConnectionSites()
傳回網頁元素上的 ConnectionSite
清單;如果網頁元素沒有任何連線網站,則傳回空白清單。
回攻員
ConnectionSite[]
:連線網站清單,如果這個元素沒有連線網站,則不會顯示任何內容。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getContentUrl()
取得圖片的網址。
系統會利用要求者的帳戶標記這個網址,讓任何知道網址的人都能以原始要求者的身分,有效地存取圖片。如果簡報的共用設定有所變更,可能會失去圖片存取權。傳回的網址會在一段時間後失效。
回攻員
String
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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()
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()
getParentPlaceholder()
傳回預留位置的父項頁面元素。如果圖片不是預留位置或沒有父項,則傳回 null
。
回攻員
PageElement
:這個圖片預留位置的上層頁面元素;如果這張圖片不是預留位置或沒有父項,則為 null
。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getPlaceholderIndex()
傳回預留位置圖片的索引。如果相同網頁上有兩個以上的預留位置圖片類型相同,則每個圖片都有專屬的索引值。如果圖片不是預留位置,則傳回 null
。
回攻員
Integer
:這張圖片的預留位置索引;如果圖片不是預留位置,則為 null
。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getPlaceholderType()
傳回圖片的預留位置類型;如果形狀不是預留位置,則傳回 PlaceholderType.NONE
。
回攻員
PlaceholderType
:這張圖片的預留位置類型。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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
getSourceUrl()
取得圖片的來源網址 (如有)。
使用網址插入圖片時,系統會傳回圖片插入時提供的網址。
回攻員
String
:圖片網址或 null
(如果圖片沒有來源網址)。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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 | 轉換至此頁面元素轉換的轉換。 |
回攻員
Image
:此頁面元素,用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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
。
shape.removeLink();
replace(blobSource)
將這張圖片替換為 BlobSource
物件描述的圖片。
插入圖片後,系統會從
BlobSource
擷取圖片一次,並儲存副本以供在簡報內顯示。圖片必須小於 50 MB、不得超過 2500 萬像素,且格式須為 PNG、JPEG 或 GIF。
為了維持圖片的顯示比例,圖片會根據現有圖片大小的縮放及置中。
var image = SlidesApp.getActivePresentation().getSlides()[0].getImages()[0]; // Get the Drive image file with the given ID. var driveImage = DriveApp.getFileById(fileId); image.replace(driveImage);
參數
名稱 | 類型 | 說明 |
---|---|---|
blobSource | BlobSource | 圖片資料。 |
回攻員
Image
:替換後的Image
。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
replace(blobSource, crop)
將這張圖片替換為 Image
物件描述的圖片,並可選擇裁剪圖片以符合尺寸。
插入圖片後,系統會從
BlobSource
擷取圖片一次,並儲存副本以供在簡報內顯示。圖片必須小於 50 MB、不得超過 2500 萬像素,且格式須為 PNG、JPEG 或 GIF。
var image = SlidesApp.getActivePresentation().getSlides()[0].getImages()[0]; // Get the Drive image file with the given ID. var driveImage = DriveApp.getFileById(fileId); // Replace and crop the drive image. image.replace(driveImage, true);
參數
名稱 | 類型 | 說明 |
---|---|---|
blobSource | BlobSource | 圖片資料。 |
crop | Boolean | 如果設為 true ,請根據現有圖片大小裁剪圖片。否則圖片會縮放並置中。 |
回攻員
Image
:替換後的Image
。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
replace(imageUrl)
以指定網址下載的其他圖片取代這張圖片。
插入圖片後,系統會從網址擷取圖片一次,並儲存副本,以供在簡報中顯示。圖片必須小於 50 MB、不得超過 2500 萬像素,且格式須為 PNG、JPEG 或 GIF。
提供的網址必須可公開存取,且大小不得超過 2 KB。網址本身會與圖片一併儲存,並透過 getSourceUrl()
公開。
為了維持圖片的顯示比例,圖片會根據現有圖片大小的縮放及置中。
參數
名稱 | 類型 | 說明 |
---|---|---|
imageUrl | String | 圖片的下載網址。 |
回攻員
Image
:替換後的Image
。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
replace(imageUrl, crop)
將這張圖片取代為從提供網址下載的其他圖片,並視需求裁剪圖片。
插入圖片後,系統會從網址擷取圖片一次,並儲存副本,以供在簡報中顯示。圖片必須小於 50 MB、不得超過 2500 萬像素,且格式須為 PNG、JPEG 或 GIF。
提供的網址不得超過 2 KB。
參數
名稱 | 類型 | 說明 |
---|---|---|
imageUrl | String | 圖片的下載網址。 |
crop | Boolean | 如果設為 true ,請根據現有圖片大小裁剪圖片。否則圖片會縮放並置中。 |
回攻員
Image
:替換後的Image
。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
scaleHeight(ratio)
scaleWidth(ratio)
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()
sendToBack()
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 | 用來設定替代文字說明的字串。 |
回攻員
Image
:這個網頁元素。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setHeight(height)
setLeft(left)
setLinkSlide(slideIndex)
setLinkSlide(slide)
將 Link
設為指定的 Slide
,連結由指定的投影片 ID 設定。
// Set a link to the first slide of the presentation. var slide = presentation.getSlides()[0]; shape.setLinkSlide(slide);
參數
名稱 | 類型 | 說明 |
---|---|---|
slide | Slide | 要連結的 Slide 。 |
回攻員
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setLinkSlide(slidePosition)
使用投影片的相對位置,將 Link
設為指定的 Slide
。
// Set a link to the first slide of the presentation. shape.setLinkSlide(SlideApp.SlidePosition.FIRST_SLIDE);
參數
名稱 | 類型 | 說明 |
---|---|---|
slidePosition | SlidePosition | 相對 SlidePosition 。 |
回攻員
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setLinkUrl(url)
setRotation(angle)
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 | 要設定替代文字標題的字串。 |
回攻員
Image
:這個網頁元素。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setTop(top)
setTransform(transform)
使用提供的轉換設定頁面元素的轉換。
更新群組的轉換會變更群組中網頁元素的絕對轉換,進而變更外觀外觀。
如果更新群組中的網頁元素,則只會變更該頁面元素的轉換,不會影響群組或群組中的其他頁面元素轉換。
如要進一步瞭解轉換如何影響頁面元素視覺外觀,請參閱 getTransform()
。
參數
名稱 | 類型 | 說明 |
---|---|---|
transform | AffineTransform | 為這個頁面元素設定的轉換。 |
回攻員
Image
:這個元素是用於鏈結。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations