Class WordArt

WordArt

代表文字藝術的 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如果沒有連結,則傳回 Linknull
getObjectId()String傳回此物件的專屬 ID。
getPageElementType()PageElementType傳回頁面元素的類型,以 PageElementType 列舉表示。
getParentGroup()Group傳回此頁面元素所屬的群組;如果元素不在群組中,則傳回 null
getParentPage()Page傳回這個網頁元素所在的頁面。
getRenderedText()String取得顯示為文字藝術的文字。
getRotation()Number傳回元素中心點周圍的順時針旋轉角度,0 度代表不旋轉。
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)LinkLink 設為指定的 Slide,連結是由指定的投影片 ID 設定。
setLinkSlide(slidePosition)Link使用投影片的相對位置,將 Link 設為指定的 Slide
setLinkUrl(url)LinkLink 設為指定的非空白網址字串。
setRotation(angle)WordArt設定元素在中心點周圍的順時針旋轉角度。
setTitle(title)WordArt設定網頁元素的替代文字標題。
setTop(top)WordArt設定元素的垂直位置,在元素未旋轉時從頁面左上角測量。
setTransform(transform)WordArt使用提供的轉換設定頁面元素的轉換。
setWidth(width)WordArt設定元素在點的寬度,當元素未旋轉時,元素定界框的寬度。

內容詳盡的說明文件

alignOnPage(alignmentPosition)

將元素與網頁上的指定對齊位置對齊。

參數

名稱類型說明
alignmentPositionAlignmentPosition網頁元素與網頁上對齊的位置。

回攻員

WordArt — 此頁面元素,用於鏈結。


bringForward()

將網頁元素往前顯示一個元素。

網頁元素不可位於群組中。

回攻員

WordArt — 此頁面元素,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

bringToFront()

將網頁元素移到網頁中。

網頁元素不可位於群組中。

回攻員

WordArt — 此頁面元素,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • 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

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

如果沒有連結,則傳回 Linknull

var link = shape.getLink();
if (link != null) {
  Logger.log('Shape has a link of type: ' + link.getLinkType());
}

回攻員

Link

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • 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

getRenderedText()

取得顯示為文字藝術的文字。

回攻員

String — 顯示為此文字藝術的文字。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getRotation()

傳回元素中心點周圍的順時針旋轉角度,0 度代表不旋轉。

回攻員

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

傳回元素的寬度,且當元素未旋轉時,元素定界框的寬度。

這個方法不支援所有網頁元素。如要瞭解哪些頁面元素與這個方法不相容,請參閱 大小和位置限制

回攻員

Number:網頁元素的原點寬度;如果網頁元素沒有寬度,則為 null

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

preconcatenateTransform(transform)

預先整合提供的轉換與頁面元素的現有轉換。

newTransform = argument * existingTransform

舉例來說,如要將網頁元素移動到左側 36:

element.preconcatenateTransform(SlidesApp.newAffineTransformBuilder()
    .setTranslateX(-36.0)
    .build());

此外,您也可以將頁面元素的轉換取代為 setTransform(transform)

參數

名稱類型說明
transformAffineTransform要預先串連到這個頁面元素的轉換。

回攻員

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

移除 Link

shape.removeLink();

scaleHeight(ratio)

以指定比例縮放元素高度。元素的高度是指元素未旋轉時,邊框的高度。

這個方法不支援所有網頁元素。如要瞭解哪些頁面元素與這個方法不相容,請參閱 大小和位置限制

參數

名稱類型說明
ratioNumber此頁面元素高度縮放比例的比例。

回攻員

WordArt — 此頁面元素,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

scaleWidth(ratio)

以指定比例縮放元素的寬度。元素的寬度是指元素未旋轉時的定界框寬度。

這個方法不支援所有網頁元素。如要瞭解哪些頁面元素與這個方法不相容,請參閱 大小和位置限制

參數

名稱類型說明
ratioNumber此頁面元素寬度縮放比例的比例。

回攻員

WordArt — 此頁面元素,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • 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 參數選取網頁元素時,必須符合下列條件:

  1. PageElement 物件的父項 Page 必須是 current page selection
  2. 請勿選取多個 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);
}

參數

名稱類型說明
replaceBoolean如為 true,選取會取代先前的所有選取項目,否則就會新增至先前的任何選取項目。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

sendBackward()

以一個元素向後傳送網頁元素。

網頁元素不可位於群組中。

回攻員

WordArt — 此頁面元素,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

sendToBack()

將網頁元素傳送到網頁背面。

網頁元素不可位於群組中。

回攻員

WordArt — 此頁面元素,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • 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());

參數

名稱類型說明
descriptionString用來設定替代文字說明的字串。

回攻員

WordArt - 這個網頁元素。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setHeight(height)

設定元素的高度,以點為單位,當元素未旋轉時,該元素定界框的高度。

這個方法不支援所有網頁元素。如要瞭解哪些頁面元素與這個方法不相容,請參閱 大小和位置限制

參數

名稱類型說明
heightNumber要設定的網頁元素新高度,以點為單位。

回攻員

WordArt — 此頁面元素,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setLeft(left)

設定元素的水平位置,在元素未旋轉時從頁面左上角測量。

參數

名稱類型說明
leftNumber要設定的新水平位置,以點表示。

回攻員

WordArt — 此頁面元素,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setLinkSlide(slideIndex)

使用投影片的索引從零開始,將 Link 設為指定的 Slide

// Set a link to the first slide of the presentation.
shape.setLinkSlide(0);

參數

名稱類型說明
slideIndexInteger投影片的索引值 (從零開始)。

回攻員

Link:設定的 Link

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • 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.
var slide = presentation.getSlides()[0];
shape.setLinkSlide(slide);

參數

名稱類型說明
slideSlide要連結的「Slide」。

回攻員

Link:設定的 Link

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • 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);

參數

名稱類型說明
slidePositionSlidePosition相對 SlidePosition

回攻員

Link:設定的 Link

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setLinkUrl(url)

Link 設為指定的非空白網址字串。

// Set a link to the URL.
shape.setLinkUrl("https://slides.google.com");

參數

名稱類型說明
urlString網址字串。

回攻員

Link:設定的 Link

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setRotation(angle)

設定元素的順時針旋轉角度 (以度為單位)。

這個方法不支援所有網頁元素。如要瞭解哪些頁面元素與這個方法不相容,請參閱 大小和位置限制

參數

名稱類型說明
angleNumber要設定的新順時針旋轉角度 (以度為單位)。

回攻員

WordArt — 此頁面元素,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • 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());

參數

名稱類型說明
titleString用來設定替代文字標題的字串。

回攻員

WordArt - 這個網頁元素。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setTop(top)

設定元素的垂直位置,在元素未旋轉時從頁面左上角測量。

參數

名稱類型說明
topNumber要設定的新垂直位置,以點表示。

回攻員

WordArt — 此頁面元素,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setTransform(transform)

使用提供的轉換設定頁面元素轉換。

更新群組轉換時,系統會變更該群組中頁面元素的絕對轉換,而轉換外觀可能會因此改變。

更新群組中某個頁面元素的轉換,只會變更該頁面元素的轉換;並不會影響群組或群組中其他網頁元素的轉換作業。

如要進一步瞭解轉換作業如何影響網頁元素的視覺外觀,請參閱 getTransform()

參數

名稱類型說明
transformAffineTransform為這個網頁元素設定的轉換。

回攻員

WordArt — 用於鏈結的元素。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setWidth(width)

設定元素在點的寬度,當元素未旋轉時,元素定界框的寬度。

這個方法不支援所有網頁元素。如要瞭解哪些頁面元素與這個方法不相容,請參閱 大小和位置限制

參數

名稱類型說明
widthNumber設定此頁面元素的新寬度 (以點為單位)。

回攻員

WordArt — 此頁面元素,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations