スプレッドシート内のシート上の図形描画を表します。
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
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)
setOnAction(macroName)
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