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 - 図形のコンテナの位置を含むオブジェクト。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • 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 - 描画の高さ(ピクセル単位)。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • 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 - この図面に適用されているマクロ名。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • 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 - 図面が表示されるシート。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • 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 - 描画の幅(ピクセル単位)。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setHeight(height)

この図形の実際の高さをピクセル単位で設定します。

パラメータ

名前説明
heightInteger目的の高さ(ピクセル単位)。

戻る

Drawing - この図形描画(チェーン用)。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • 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 - この図形描画(チェーン用)。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setWidth(width)

この図形の実際の幅をピクセル単位で設定します。

パラメータ

名前説明
widthInteger希望する幅(ピクセル単位)。

戻る

Drawing - この図形描画(チェーン用)。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setZIndex(zIndex)

この図形の z-index を設定します。

パラメータ

名前説明
zIndexNumberこの図形の Z インデックス。

戻る

Drawing - この図形描画(チェーン用)。