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

承認

このメソッドを使用するスクリプトには、次のスコープの 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 - この図面に関連付けられているマクロ名。

承認

このメソッドを使用するスクリプトには、次のスコープの 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 インデックスを返します。

// 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図面の上部がこの col に固定されます。
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 - チェーン用のこの描画。