このページは Cloud Translation API によって翻訳されました。

Class Drawing

スプレッドシート内のシート上の描画を表します。

Methods

メソッド	戻り値の型	概要
`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 - 図形描画のコンテナの位置を含むオブジェクト。

承認

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

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 - 図形描画の高さ（ピクセル単位）。

承認

この方法を使用するスクリプトには、次の 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.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var 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.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var 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
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var 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.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getZIndex());
}

リターン

Number - この図形描画の Z インデックス。

承認

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

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

承認

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

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

`setHeight(height)`

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

パラメータ

名前	型	説明
`height`	`Integer`	ピクセル単位の高さです。

リターン

Drawing - チェーン用のこの描画。

承認

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

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

`setOnAction(macroName)`

この図形描画にマクロ関数を割り当てます。

パラメータ

名前	型	説明
`macroName`	`String`	マクロ関数の名前。

リターン

Drawing - チェーン用のこの描画。

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

図形描画がシート上で表示される位置を設定します。アンカーの行と列の位置のインデックスは、1 から始まります。

パラメータ

名前	型	説明
`anchorRowPos`	`Integer`	図形描画の上端はこの行に固定されています。
`anchorColPos`	`Integer`	図形描画の上端はこの列で固定されています。
`offsetX`	`Integer`	セルの角からの水平オフセット（ピクセル単位）。
`offsetY`	`Integer`	セルの角からの垂直オフセット（ピクセル単位）。

リターン

Drawing - チェーン用のこの描画。

承認

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

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

`setWidth(width)`

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

パラメータ

名前	型	説明
`width`	`Integer`	ピクセル単位の幅です。

リターン

Drawing - チェーン用のこの描画。

承認

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

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

`setZIndex(zIndex)`

この図形描画の Z-Index を設定します。

パラメータ

名前	型	説明
`zIndex`	`Number`	この図形描画の Z インデックス。

リターン

Drawing - チェーン用のこの描画。