Class Drawing

繪圖

代表 Google 試算表中工作表的繪圖。

方法

方法傳回類型簡短說明
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)

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

參數

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

回攻員

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