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

Class Drawing

這個外掛程式代表試算表中工作表上方的繪圖。

方法

方法	傳回類型	簡短說明
`getContainerInfo()`	`ContainerInfo`	取得繪圖在工作表中位置的相關資訊。
`getHeight()`	`Integer`	傳回這個繪圖的實際高度 (以像素為單位)。
`getOnAction()`	`String`	傳回附加至這個繪圖的巨集名稱。
`getSheet()`	`Sheet`	傳回這個繪圖所在的工作表。
`getWidth()`	`Integer`	傳回這個繪圖的實際寬度 (以像素為單位)。
`getZIndex()`	`Number`	傳回這個繪圖的 Z-index。
`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
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var 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.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var 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.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var 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
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var 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-index。

// Logs the z-index of all drawings on the active sheet.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var 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.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  drawings[i].remove();
}

授權

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

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

`setHeight(height)`

設定這個繪圖的實際高度 (以像素為單位)。

參數

名稱	類型	說明
`height`	`Integer`	所需的高度 (以像素為單位)。

回攻員

Drawing — 此繪圖用於鏈結。

授權

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

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

`setOnAction(macroName)`

為這個繪圖指派巨集函式。

參數

名稱	類型	說明
`macroName`	`String`	巨集函式名稱。

回攻員

Drawing — 此繪圖用於鏈結。

`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`

設定繪圖在工作表上顯示的位置。錨定列和欄位置索引會編入索引。

參數

名稱	類型	說明
`anchorRowPos`	`Integer`	繪圖的頂端會固定在這一列中。
`anchorColPos`	`Integer`	繪圖的頂端位在這個顏色中。
`offsetX`	`Integer`	與儲存格角落的水平偏移 (以像素為單位)。
`offsetY`	`Integer`	與儲存格角落的垂直偏移 (以像素為單位)。

回攻員

Drawing — 此繪圖用於鏈結。

授權

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

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

`setWidth(width)`

設定這個繪圖的實際寬度 (以像素為單位)。

參數

名稱	類型	說明
`width`	`Integer`	所需的寬度 (以像素為單位)，

回攻員

Drawing — 此繪圖用於鏈結。

授權

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

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

`setZIndex(zIndex)`

設定這個繪圖的 Z-index。

參數

名稱	類型	說明
`zIndex`	`Number`	這個繪圖的 Z-index。

回攻員

Drawing — 此繪圖用於鏈結。