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