Class Drawing

図形描画

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

メソッド

メソッド	戻り値の型	概要
getContainerInfo()	ContainerInfo	描画がシート内のどこに配置されているかに関する情報を取得します。
getHeight()	Integer	この描画の実際の高さ（ピクセル単位）を返します。
getOnAction()	String|null	この図形描画に添付されているマクロの名前を返します。
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
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|null \- この描画に添付されているマクロ名。

承認

このメソッドを使用するスクリプトには、次のいずれか 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-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

---

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-Index。

戻る

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