スプレッドシートのグリッド上にある画像を表します。
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
assignScript(functionName) | OverGridImage | 指定された関数名を持つ関数をこの画像に割り当てます。 |
getAltTextDescription() | String | この画像の代替テキストの説明を返します。 |
getAltTextTitle() | String | この画像の代替テキストのタイトルを返します。 |
getAnchorCell() | Range | 画像が固定されているセルを返します。 |
getAnchorCellXOffset() | Integer | アンカーセルからの水平ピクセル オフセットを返します。 |
getAnchorCellYOffset() | Integer | アンカーセルからの垂直ピクセル オフセットを返します。 |
getHeight() | Integer | この画像の実際の高さをピクセル単位で返します。 |
getInherentHeight() | Integer | この画像固有の高さをピクセル単位で返します。 |
getInherentWidth() | Integer | この画像固有の高さをピクセル単位で返します。 |
getScript() | String | この画像に割り当てられた関数の名前を返します。 |
getSheet() | Sheet | この画像が表示されるシートを返します。 |
getUrl() | String | 画像のソース URL を取得します。URL を使用できない場合は null を返します。 |
getWidth() | Integer | この画像の実際の幅をピクセル単位で返します。 |
remove() | void | スプレッドシートからこの画像を削除します。 |
replace(blob) | OverGridImage | この画像を、指定された BlobSource で指定された画像に置き換えます。 |
replace(url) | OverGridImage | この画像を、指定された URL の画像に置き換えます。 |
resetSize() | OverGridImage | この画像を固有のサイズにリセットします。 |
setAltTextDescription(description) | OverGridImage | この画像の代替テキストの説明を設定します。 |
setAltTextTitle(title) | OverGridImage | この画像の代替テキストのタイトルを設定します。 |
setAnchorCell(cell) | OverGridImage | 画像を固定するセルを設定します。 |
setAnchorCellXOffset(offset) | OverGridImage | アンカーセルからの水平ピクセル オフセットを設定します。 |
setAnchorCellYOffset(offset) | OverGridImage | アンカーセルからの垂直ピクセル オフセットを設定します。 |
setHeight(height) | OverGridImage | この画像の実際の高さをピクセル単位で設定します。 |
setWidth(width) | OverGridImage | この画像の実際の幅をピクセル単位で設定します。 |
詳細なドキュメント
assignScript(functionName)
指定された関数名を持つ関数をこの画像に割り当てます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
functionName | String | 指定された関数の名前。これは、privateFunction_ のようにアンダースコアで終わる関数ではなく、パブリック トップレベルの関数にする必要があります。 |
リターン
OverGridImage
- チェーン用のこの画像。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAltTextDescription()
この画像の代替テキストの説明を返します。
リターン
String
- 代替テキストの説明。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAltTextTitle()
この画像の代替テキストのタイトルを返します。
リターン
String
- 代替テキストのタイトル。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAnchorCell()
getAnchorCellXOffset()
アンカーセルからの水平ピクセル オフセットを返します。
リターン
Integer
- 水平方向のピクセル オフセット。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAnchorCellYOffset()
アンカーセルからの垂直ピクセル オフセットを返します。
リターン
Integer
- 垂直ピクセル オフセット。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getHeight()
この画像の実際の高さをピクセル単位で返します。
// Logs the height of all images in a spreadsheet var images = SpreadsheetApp.getActiveSpreadsheet().getImages(); for (var i = 0; i < images.length; i++) { Logger.log(images[i].getHeight()); }
リターン
Integer
- 画像の高さ(ピクセル単位)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getInherentHeight()
この画像固有の高さをピクセル単位で返します。
リターン
Integer
- 固有の高さ(ピクセル単位)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getInherentWidth()
この画像固有の高さをピクセル単位で返します。
リターン
Integer
- 固有の幅(ピクセル単位)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getScript()
この画像に割り当てられた関数の名前を返します。
リターン
String
- 関数の名前。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheet()
この画像が表示されるシートを返します。
// Logs the parent sheet of all images in a spreadsheet var images = SpreadsheetApp.getActiveSpreadsheet().getImages(); for (var i = 0; i < images.length; i++) { Logger.log(images[i].getSheet()); }
リターン
Sheet
- 画像が表示されるシート。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getUrl()
画像のソース URL を取得します。URL を使用できない場合は null
を返します。API を使用して URL によって画像が挿入された場合、このメソッドは画像の挿入時に提供された URL を返します。
リターン
String
- 画像の URL(利用可能な場合)。画像を使用できない場合やソース URL がない場合は、null
を返します。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getWidth()
この画像の実際の幅をピクセル単位で返します。
// Logs the width of all images in a spreadsheet var images = SpreadsheetApp.getActiveSpreadsheet().getImages(); for (var i = 0; i < images.length; i++) { Logger.log(images[i].getWidth()); }
リターン
Integer
- 画像の幅(ピクセル単位)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
remove()
スプレッドシートからこの画像を削除します。イメージに対してさらに操作を行うと、スクリプト エラーが発生します。
// Deletes all images in a spreadsheet var images = SpreadsheetApp.getActiveSpreadsheet().getImages(); for (var i = 0; i < images.length; i++) { images[i].remove(); }
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
replace(blob)
この画像を、指定された BlobSource
で指定された画像に置き換えます。サポートされている blob の最大サイズは 2 MB です。
パラメータ
名前 | 型 | 説明 |
---|---|---|
blob | BlobSource | Blob としての新しい画像。 |
リターン
OverGridImage
- チェーン用のこの画像。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
replace(url)
この画像を、指定された URL の画像に置き換えます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
url | String | 新しい画像の URL です。 |
リターン
OverGridImage
- チェーン用のこの画像。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
resetSize()
この画像を固有のサイズにリセットします。
リターン
OverGridImage
- チェーン用のこの画像。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAltTextDescription(description)
この画像の代替テキストの説明を設定します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
description | String | 画像の新しい代替テキストの説明。 |
リターン
OverGridImage
- チェーン用のこの画像。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAltTextTitle(title)
この画像の代替テキストのタイトルを設定します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | 画像の新しい代替テキストのタイトル。 |
リターン
OverGridImage
- チェーン用のこの画像。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAnchorCell(cell)
画像を固定するセルを設定します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
cell | Range | 新しいアンカーセル。 |
リターン
OverGridImage
- チェーン用のこの画像。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAnchorCellXOffset(offset)
アンカーセルからの水平ピクセル オフセットを設定します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 新しい水平ピクセル オフセット。 |
リターン
OverGridImage
- チェーン用のこの画像。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAnchorCellYOffset(offset)
アンカーセルからの垂直ピクセル オフセットを設定します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 新しい垂直ピクセル オフセット。 |
リターン
OverGridImage
- チェーン用のこの画像。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setHeight(height)
この画像の実際の高さをピクセル単位で設定します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
height | Integer | ピクセル単位の高さです。 |
リターン
OverGridImage
- チェーン用の画像。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setWidth(width)
この画像の実際の幅をピクセル単位で設定します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
width | Integer | ピクセル単位の幅です。 |
リターン
OverGridImage
- チェーン用の画像。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets