Class Drawing

繪圖

代表在試算表中覆蓋工作表的繪圖。

方法

方法傳回類型簡短說明
getContainerInfo()ContainerInfo取得繪圖在工作表中的位置資訊。
getHeight()Integer以像素為單位，傳回此繪圖的實際高度。
getOnAction()String傳回附加至此圖表的巨集名稱。
getSheet()Sheet傳回這張圖表所屬的試算表。
getWidth()Integer以像素為單位，傳回此繪圖的實際寬度。
getZIndex()Number傳回此繪圖的 z 索引。
remove()void從試算表中刪除這張圖片。
setHeight(height)Drawing以像素為單位，設定此圖表的實際高度。
setOnAction(macroName)Drawing將巨集函式指派給這張圖表。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)Drawing設定繪圖在工作表中顯示的位置。
setWidth(width)Drawing以像素為單位，設定此繪圖的實際寬度。
setZIndex(zIndex)Drawing設定此繪圖的 z-index。

內容詳盡的說明文件

getContainerInfo()

取得繪圖在工作表中的位置資訊。

回攻員

ContainerInfo：包含繪圖容器位置的物件。

授權

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

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

getHeight()

以像素為單位，傳回此繪圖的實際高度。

// Logs the height of all drawings in a sheet
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getHeight());
}

回攻員

Integer：繪圖的高度 (以像素為單位)。

授權

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

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

getOnAction()

傳回附加至此圖表的巨集名稱。

// Logs the macro name of all drawings on the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getOnAction());
}

回攻員

String：附加至此圖表的巨集名稱。

授權

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

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

getSheet()

傳回這張圖表顯示的試算表。

// Logs the parent sheet of all drawings on the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getSheet());
}

回攻員

Sheet：繪圖顯示的試算表。

授權

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

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

getWidth()

以像素為單位，傳回此繪圖的實際寬度。

// Logs the width of all drawings in a sheet
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getWidth());
}

回攻員

Integer：繪圖的寬度 (以像素為單位)。

授權

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

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

getZIndex()

傳回此繪圖的 z 索引。

// Logs the z-index of all drawings on the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getZIndex());
}

回攻員

Number：此繪圖的 Z 索引。

授權

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

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

remove()

從試算表中刪除這張圖片。對繪圖執行任何後續作業都會導致指令碼錯誤。

// Deletes all drawings from the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  drawings[i].remove();
}

授權

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

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

setHeight(height)

以像素為單位，設定此圖表的實際高度。

參數

名稱類型說明
heightInteger所需高度 (以像素為單位)。

回攻員

Drawing：這個繪圖，用於鏈結。

授權

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

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

setOnAction(macroName)

將巨集函式指派給這張圖表。

參數

名稱類型說明
macroNameString巨集函式的名稱。

回攻員

Drawing：這個繪圖，用於鏈結。

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

設定繪圖在工作表上顯示的位置。錨定資料列和資料欄位置的索引為 1。

參數

名稱類型說明
anchorRowPosInteger繪圖的頂端會固定在這個列中。
anchorColPosInteger繪圖的頂端會固定在這個欄中。
offsetXInteger以像素為單位的單元格角落水平偏移。
offsetYInteger以像素為單位的單元格角落垂直偏移。

回攻員

Drawing：這個繪圖，用於鏈結。

授權

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

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

setWidth(width)

以像素為單位，設定此繪圖的實際寬度。

參數

名稱類型說明
widthInteger所需寬度 (以像素為單位)。

回攻員

Drawing：這個繪圖，用於鏈結。

授權

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

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

setZIndex(zIndex)

設定此繪圖的 z-index。

參數

名稱類型說明
zIndexNumber此繪圖的 Z 索引。

回攻員

Drawing：這個繪圖，用於鏈結。