Class Drawing

繪圖

代表試算表工作表上的繪圖。

方法

方法傳回類型簡短說明
getContainerInfo()ContainerInfo取得繪圖在工作表中的位置資訊。
getHeight()Integer傳回這個繪圖的實際高度 (以像素為單位)。
getOnAction()String|null傳回附加至此繪圖的巨集名稱。
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
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|null:附加至此繪圖的巨集名稱。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

  • 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-index。

// 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-Index。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權:

  • 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-index。

回攻員

Drawing:用於鏈結的繪圖。