Class OverGridImage

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

メソッド

メソッド	戻り値の型	概要
`assignScript(functionName)`	`OverGridImage`	指定された関数名を持つ関数をこのイメージに割り当てます。
`getAltTextDescription()`	`String`	この画像の代替テキストの説明を返します。
`getAltTextTitle()`	`String`	この画像の代替テキストのタイトルを返します。
`getAnchorCell()`	`Range`	画像が固定されているセルを返します。
`getAnchorCellXOffset()`	`Integer`	アンカーセルからの水平方向のピクセルオフセットを返します。
`getAnchorCellYOffset()`	`Integer`	アンカーセルからの垂直方向のピクセルオフセットを返します。
`getHeight()`	`Integer`	この画像の実際の高さ（ピクセル単位）を返します。
`getInherentHeight()`	`Integer`	この画像の固有の高さをピクセル単位で返します。
`getInherentWidth()`	`Integer`	この画像の固有の高さをピクセル単位で返します。
`getScript()`	`String`	このイメージに割り当てられた関数の名前を返します。
`getSheet()`	`Sheet`	この画像が表示されているシートを返します。
`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`	この画像の実際の幅をピクセル単位で設定します。

サポート終了のメソッド

メソッド	戻り値の型	概要
`getUrl()`	`String`	画像のソース URL を取得します。

詳細なドキュメント

`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()`

画像が固定されているセルを返します。

戻る

Range - アンカーセル。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`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
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let 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
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let 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

`getWidth()`

この画像の実際の幅（ピクセル単位）を返します。

// Logs the width of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let 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
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let 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

サポート終了のメソッド

`getUrl()`

非推奨。新しく挿入された画像のほとんどで、ソース URL は利用できません。

画像のソース URL を取得します。URL が使用できない場合は、空の文字列を返します。ほとんどの新規挿入画像では、画像の挿入方法に関係なく、ソース URL は使用できません。

戻る

String - 画像のソース URL（使用可能な場合）。使用できない場合は空の文字列を返します。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

Class OverGridImage コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

メソッド

サポート終了のメソッド

詳細なドキュメント

assignScript(functionName)

パラメータ

戻る

承認

getAltTextDescription()

戻る

承認

getAltTextTitle()

戻る

承認

getAnchorCell()

戻る

承認

getAnchorCellXOffset()

戻る

承認

getAnchorCellYOffset()

戻る

承認

getHeight()

戻る

承認

getInherentHeight()

戻る

承認

getInherentWidth()

戻る

承認

getScript()

戻る

承認

getSheet()

戻る

承認

getWidth()

戻る

承認

remove()

承認

replace(blob)

パラメータ

戻る

承認

replace(url)

パラメータ

戻る

承認

resetSize()

戻る

承認

setAltTextDescription(description)

パラメータ

戻る

承認

setAltTextTitle(title)

パラメータ

戻る

承認

setAnchorCell(cell)

パラメータ

戻る

承認

setAnchorCellXOffset(offset)

パラメータ

戻る

承認

setAnchorCellYOffset(offset)

パラメータ

戻る

承認

setHeight(height)

パラメータ

戻る

承認

setWidth(width)

パラメータ

Class OverGridImage

`assignScript(functionName)`

`getAltTextDescription()`

`getAltTextTitle()`

`getAnchorCell()`

`getAnchorCellXOffset()`

`getAnchorCellYOffset()`

`getHeight()`

`getInherentHeight()`

`getInherentWidth()`

`getScript()`

`getSheet()`

`getWidth()`

`remove()`

`replace(blob)`

`replace(url)`

`resetSize()`

`setAltTextDescription(description)`

`setAltTextTitle(title)`

`setAnchorCell(cell)`

`setAnchorCellXOffset(offset)`

`setAnchorCellYOffset(offset)`

`setHeight(height)`

`setWidth(width)`

`getUrl()`