スプレッドシートのシート上に描画された図形を表します。
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
get | Container | シート内の描画の位置に関する情報を取得します。 |
get | Integer | この描画の実際の高さをピクセル単位で返します。 |
get | String | この図面に適用されているマクロの名前を返します。 |
get | Sheet | この描画が表示されているシートを返します。 |
get | Integer | この描画の実際の幅をピクセル単位で返します。 |
get | Number | この描画の z インデックスを返します。 |
remove() | void | この描画がスプレッドシートから削除されます。 |
set | Drawing | この描画の実際の高さをピクセル単位で設定します。 |
set | Drawing | この図面にマクロ関数を割り当てます。 |
set | Drawing | シート上に描画が表示される位置を設定します。 |
set | Drawing | この描画の実際の幅をピクセル単位で設定します。 |
set | Drawing | この描画の Z-Index を設定します。 |
詳細なドキュメント
get Container Info()
シート内の描画の位置に関する情報を取得します。
戻る
Container
- 図面のコンテナの位置を含むオブジェクト。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
get Height()
この描画の実際の高さをピクセル単位で返します。
// 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
get On Action()
この図面に適用されているマクロの名前を返します。
// 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
get Sheet()
この描画が表示されているシートを返します。
// 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
get Width()
この描画の実際の幅をピクセル単位で返します。
// 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
get ZIndex()
この描画の 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
set Height(height)
set On Action(macroName)
set Position(anchorRowPos, anchorColPos, offsetX, offsetY)
シート上に描画が表示される位置を設定します。アンカーの行と列の位置のインデックスは 1 から始まります。
パラメータ
名前 | 型 | 説明 |
---|---|---|
anchor | Integer | 図面の上部がこの行に固定されます。 |
anchor | Integer | 図面の上部がこの col に固定されます。 |
offsetX | Integer | セルの角からの水平方向のオフセット(ピクセル単位)。 |
offsetY | Integer | セルの角からの垂直オフセット(ピクセル単位)。 |
戻る
Drawing
- チェーン用のこの描画。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets