ページ上にレンダリングされた視覚要素。
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
alignOnPage(alignmentPosition) | PageElement | ページ上の指定された配置位置に要素を揃えます。 |
asGroup() | Group | ページ要素をグループとして返します。 |
asImage() | Image | ページ要素を画像として返します。 |
asLine() | Line | ページ要素を行として返します。 |
asShape() | Shape | ページ要素をシェイプとして返します。 |
asSheetsChart() | SheetsChart | ページ要素を、Google スプレッドシートから埋め込まれたリンクされたグラフとして返します。 |
asTable() | Table | ページ要素をテーブルとして返します。 |
asVideo() | Video | ページ要素を動画として返します。 |
asWordArt() | WordArt | ページ要素をワードアートとして返します。 |
bringForward() | PageElement | ページ上のページ要素を 1 つ前の要素に移動します。 |
bringToFront() | PageElement | ページ要素をページの前面に移動します。 |
duplicate() | PageElement | ページ要素を複製します。 |
getConnectionSites() | ConnectionSite[] | ページ要素に含まれる ConnectionSite のリストを返します。ページ要素に接続サイトがない場合は空のリストを返します。 |
getDescription() | String | ページ要素の代替テキストの説明を返します。 |
getHeight() | Number | 要素の高さ(ポイント単位)を取得します。これは、要素が回転していない場合の要素の境界ボックスの高さです。 |
getInherentHeight() | Number | 要素固有の高さをポイント単位で返します。 |
getInherentWidth() | Number | 要素固有の幅をポイント数で返します。 |
getLeft() | Number | 要素の水平方向の位置をポイント数で返します。要素が回転していない場合に、ページの左上隅から測定されます。 |
getObjectId() | String | このオブジェクトの一意の ID を返します。 |
getPageElementType() | PageElementType | ページ要素のタイプを PageElementType 列挙型で返します。 |
getParentGroup() | Group | このページ要素が属するグループを返します。要素がグループ内にない場合は null を返します。 |
getParentPage() | Page | このページ要素が配置されているページを返します。 |
getRotation() | Number | 要素の中心を中心とする時計回りの回転角度を度数で返します。0 度は回転していないことを意味します。 |
getTitle() | String | ページ要素の代替テキストのタイトルを返します。 |
getTop() | Number | 要素が回転していないときに、ページの左上隅から測定したポイント単位で要素の垂直位置を取得します。 |
getTransform() | AffineTransform | ページ要素の変換を返します。 |
getWidth() | Number | 要素の幅をポイント単位で返します。これは、要素が回転していない場合の要素の境界ボックスの幅です。 |
preconcatenateTransform(transform) | PageElement | 指定された変換をページ要素の既存の変換に事前連結します。 |
remove() | void | ページ要素を削除します。 |
scaleHeight(ratio) | PageElement | 指定された比率で要素の高さをスケーリングします。 |
scaleWidth(ratio) | PageElement | 指定された比率で要素の幅を拡大縮小します。 |
select() | void | アクティブなプレゼンテーション内の PageElement のみを選択し、以前の選択を削除します。 |
select(replace) | void | アクティブなプレゼンテーションの PageElement を選択します。 |
sendBackward() | PageElement | ページ要素を 1 つ分、ページの後方に移動します。 |
sendToBack() | PageElement | ページ要素をページの裏側に移動します。 |
setDescription(description) | PageElement | ページ要素の代替テキストの説明を設定します。 |
setHeight(height) | PageElement | 要素の高さをポイント単位で設定します。これは、要素が回転していない場合の要素の境界ボックスの高さです。 |
setLeft(left) | PageElement | 要素が回転していない場合に、ページの左上隅から測定して、要素の水平方向の位置をポイント単位で設定します。 |
setRotation(angle) | PageElement | 要素の中心を中心とする時計回りの回転角度を度単位で設定します。 |
setTitle(title) | PageElement | ページ要素の代替テキストのタイトルを設定します。 |
setTop(top) | PageElement | 要素が回転していないときに、ページの左上隅から測定したポイント単位で要素の垂直位置を設定します。 |
setTransform(transform) | PageElement | 指定された変換でページ要素の変換を設定します。 |
setWidth(width) | PageElement | 要素の幅をポイント単位で設定します。これは、要素が回転していない場合の要素の境界ボックスの幅です。 |
詳細なドキュメント
alignOnPage(alignmentPosition)
ページ上の指定された配置位置に要素を揃えます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
alignmentPosition | AlignmentPosition | ページ上のこのページ要素を配置する位置。 |
リターン
PageElement
- このページ要素(チェーン用)。
asGroup()
asImage()
asLine()
asShape()
asSheetsChart()
ページ要素を、Google スプレッドシートから埋め込まれたリンクされたグラフとして返します。
リターン
SheetsChart
- グラフとしてのページ要素。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
asTable()
asVideo()
asWordArt()
bringForward()
ページ上のページ要素を 1 つ前の要素に移動します。
ページ要素をグループに含めることはできません。
リターン
PageElement
- このページ要素(チェーン用)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
bringToFront()
ページ要素をページの前面に移動します。
ページ要素をグループに含めることはできません。
リターン
PageElement
- このページ要素(チェーン用)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
duplicate()
ページ要素を複製します。
複製したページ要素は、同じページのオリジナルと同じ位置に配置されます。
リターン
PageElement
- このページ要素の新しい重複。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getConnectionSites()
ページ要素に含まれる ConnectionSite
のリストを返します。ページ要素に接続サイトがない場合は空のリストを返します。
リターン
ConnectionSite[]
- 接続サイトのリスト。この要素に接続サイトがない場合は空になることがあります。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getDescription()
ページ要素の代替テキストの説明を返します。description はタイトルと組み合わされ、代替テキストの表示と読み上げを行います。
リターン
String
- ページ要素の代替テキストの説明。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getHeight()
要素の高さ(ポイント単位)を取得します。これは、要素が回転していない場合の要素の境界ボックスの高さです。
この方法は、すべてのページ要素に対応していません。このメソッドに対応していないページ要素については、 サイズと配置の制限をご覧ください。
リターン
Number
- ページ要素に固有の高さ(ポイント単位)。ページ要素に高さがない場合は null
。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getInherentHeight()
要素固有の高さをポイント数で返します。
ページ要素の変換は、その固有のサイズに対応して行われます。固有のサイズを要素の変換と組み合わせて、要素の最終的な外観を判断します。
リターン
Number
- ページ要素に固有の高さ(ポイント単位)。ページ要素に高さがない場合は null
。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getInherentWidth()
要素固有の幅(ポイント数)を返します。
ページ要素の変換は、その固有のサイズに対応して行われます。固有のサイズを要素の変換と組み合わせて、要素の最終的な外観を判断します。
リターン
Number
- ページ要素固有の幅(ポイント単位)。ページ要素に幅がない場合は null
。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getLeft()
要素の水平方向の位置をポイント数で返します。要素が回転していない場合に、ページの左上隅から測定されます。
リターン
Number
- この要素の水平位置(ページの左上隅からのポイント数)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getObjectId()
このオブジェクトの一意の ID を返します。ページとページ要素で使用されるオブジェクト ID は同じ名前空間を共有します。
リターン
String
- このオブジェクトの一意の ID。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getPageElementType()
ページ要素のタイプを PageElementType
列挙型で返します。
リターン
PageElementType
- ページ要素のタイプ。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getParentGroup()
getParentPage()
getRotation()
要素の中心を中心とする時計回りの回転角度を度数で返します。0 度は回転していないことを意味します。
リターン
Number
- 回転角度(0 度以上 360 度未満)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getTitle()
ページ要素の代替テキストのタイトルを返します。タイトルは説明と組み合わされて、代替テキストが表示され、読み上げられます。
リターン
String
- ページ要素の代替テキストのタイトル。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getTop()
要素が回転していないときに、ページの左上隅から測定したポイント単位で要素の垂直位置を取得します。
リターン
Number
- この要素の垂直位置(ページの左上からのポイント数)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getTransform()
ページ要素の変換を返します。
ページ要素の外観は、その絶対的な変換によって決まります。絶対変換を計算するには、ページ要素の変換とそのすべての親グループの変換を事前連結します。ページ要素がグループにない場合、その絶対変換はこのフィールドの値と同じです。
リターン
AffineTransform
- ページ要素の変換。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getWidth()
要素の幅をポイント単位で返します。これは、要素が回転していない場合の要素の境界ボックスの幅です。
この方法は、すべてのページ要素に対応していません。このメソッドに対応していないページ要素については、 サイズと配置の制限をご覧ください。
リターン
Number
- ページ要素固有の幅(ポイント単位)。ページ要素に幅がない場合は null
。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
preconcatenateTransform(transform)
指定された変換をページ要素の既存の変換に事前連結します。
newTransform = argument * existingTransform
たとえば、ページ要素を 36 ポイント左に移動するには:
element.preconcatenateTransform(SlidesApp.newAffineTransformBuilder() .setTranslateX(-36.0) .build());
ページ要素の変換を setTransform(transform)
に置き換えることもできます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
transform | AffineTransform | このページ要素の変換に事前連結する変換。 |
リターン
PageElement
- このページ要素(チェーン用)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
remove()
ページ要素を削除します。
削除操作の後、Group
にページ要素が 1 つだけ含まれているか、まったく含まれていない場合、グループ自体も削除されます。
プレースホルダ PageElement
がマスターまたはレイアウトから削除されると、空の継承プレースホルダも削除されます。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
scaleHeight(ratio)
指定された比率で要素の高さをスケーリングします。要素の高さは、要素が回転していない場合の境界ボックスの高さです。
この方法は、すべてのページ要素に対応していません。このメソッドに対応していないページ要素については、 サイズと配置の制限をご覧ください。
パラメータ
名前 | 型 | 説明 |
---|---|---|
ratio | Number | このページ要素の高さをスケーリングする比率。 |
リターン
PageElement
- このページ要素(チェーン用)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
scaleWidth(ratio)
指定された比率で要素の幅を拡大縮小します。要素の幅は、要素に回転がない場合の境界ボックスの幅です。
この方法は、すべてのページ要素に対応していません。このメソッドに対応していないページ要素については、 サイズと配置の制限をご覧ください。
パラメータ
名前 | 型 | 説明 |
---|---|---|
ratio | Number | このページ要素の幅をスケーリングする比率。 |
リターン
PageElement
- このページ要素(チェーン用)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
select()
アクティブなプレゼンテーション内の PageElement
のみを選択し、以前の選択を削除します。これは、true
を指定して select(replace)
を呼び出す場合と同じです。
スクリプトがアクセスできるのは、スクリプトを実行しているユーザーの選択で、かつスクリプトがプレゼンテーションにバインドされている場合のみです。
これにより、PageElement
の親 Page
が current page selection
に設定されます。
var slide = SlidesApp.getActivePresentation().getSlides()[0]; var pageElement = slide.getPageElements()[0]; // Only select this page element and replace any previous selection. pageElement.select();
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
select(replace)
アクティブなプレゼンテーションの PageElement
を選択します。
スクリプトがアクセスできるのは、スクリプトを実行しているユーザーの選択で、かつスクリプトがプレゼンテーションにバインドされている場合のみです。
このメソッドに true
を渡すと、PageElement
のみが選択され、以前の選択は削除されます。これにより、PageElement
の親 Page
も current page selection
に設定されます。
false
を渡して、複数の PageElement
オブジェクトを選択します。PageElement
オブジェクトは同じ Page
に存在する必要があります。
false
パラメータを使用してページ要素を選択する際は、次の条件を満たす必要があります。
PageElement
オブジェクトの親Page
は、current page selection
である必要があります。- 複数の
Page
オブジェクトを選択しないでください。
これを確認するには、最初に Page.selectAsCurrentPage()
を使用して親 Page
を選択し、次にそのページのページ要素を選択することをおすすめします。
var slide = SlidesApp.getActivePresentation().getSlides()[0]; // First select the slide page, as the current page selection. slide.selectAsCurrentPage(); // Then select all the page elements in the selected slide page. var pageElements = slide.getPageElements(); for (var i = 0; i < pageElements.length; i++) { pageElements[i].select(false); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
replace | Boolean | true の場合、選択内容は前の選択を置き換えます。それ以外の場合、選択は前の選択に追加されます。 |
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
sendBackward()
ページ要素をページ上で 1 要素分、後方に移動します。
ページ要素をグループに含めることはできません。
リターン
PageElement
- このページ要素(チェーン用)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
sendToBack()
ページ要素をページの背面に移動します。
ページ要素をグループに含めることはできません。
リターン
PageElement
- このページ要素(チェーン用)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setDescription(description)
ページ要素の代替テキストの説明を設定します。
このメソッドは、Group
要素ではサポートされていません。
// Set the first page element's alt text description to "new alt text description". var pageElement = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0]; pageElement.setDescription('new alt text description'); Logger.log(pageElement.getDescription());
パラメータ
名前 | 型 | 説明 |
---|---|---|
description | String | 代替テキストの説明を設定する文字列。 |
リターン
PageElement
- このページの要素。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setHeight(height)
要素の高さをポイント単位で設定します。これは、要素が回転していない場合の要素の境界ボックスの高さです。
この方法は、すべてのページ要素に対応していません。このメソッドに対応していないページ要素については、 サイズと配置の制限をご覧ください。
パラメータ
名前 | 型 | 説明 |
---|---|---|
height | Number | 設定するこのページ要素の新しい高さ(ポイント単位)。 |
リターン
PageElement
- このページ要素(チェーン用)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setLeft(left)
要素が回転していない場合に、ページの左上隅から測定して、要素の水平方向の位置をポイント単位で設定します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
left | Number | 設定する新しい水平位置(ポイント単位)。 |
リターン
PageElement
- このページ要素(チェーン用)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setRotation(angle)
要素の中心を中心とする時計回りの回転角度を度単位で設定します。
この方法は、すべてのページ要素に対応していません。このメソッドに対応していないページ要素については、 サイズと配置の制限をご覧ください。
パラメータ
名前 | 型 | 説明 |
---|---|---|
angle | Number | 新たに設定する時計回りの回転角度(度数)。 |
リターン
PageElement
- このページ要素(チェーン用)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setTitle(title)
ページ要素の代替テキストのタイトルを設定します。
このメソッドは、Group
要素ではサポートされていません。
// Set the first page element's alt text title to "new alt text title". var pageElement = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0]; pageElement.setTitle('new alt text title'); Logger.log(pageElement.getTitle());
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | 代替テキストのタイトルを設定する文字列。 |
リターン
PageElement
- このページの要素。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setTop(top)
要素が回転していないときに、ページの左上隅から測定したポイント単位で要素の垂直位置を設定します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
top | Number | 設定する新しい垂直位置(ポイント単位)。 |
リターン
PageElement
- このページ要素(チェーン用)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setTransform(transform)
指定された変換でページ要素の変換を設定します。
グループの変換を更新すると、そのグループ内のページ要素の絶対変換が変更され、視覚的外観が変わる可能性があります。
グループ内のページ要素の変換を更新しても、そのページ要素の変換のみが変更され、グループまたはグループ内の他のページ要素の変換には影響しません。
変換がページ要素の外観に与える影響について詳しくは、getTransform()
をご覧ください。
パラメータ
名前 | 型 | 説明 |
---|---|---|
transform | AffineTransform | このページ要素に設定されている変換。 |
リターン
PageElement
- チェーン用のこの要素。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setWidth(width)
要素の幅をポイント単位で設定します。これは、要素が回転していない場合の要素の境界ボックスの幅です。
この方法は、すべてのページ要素に対応していません。このメソッドに対応していないページ要素については、 サイズと配置の制限をご覧ください。
パラメータ
名前 | 型 | 説明 |
---|---|---|
width | Number | 設定するこのページ要素の新しい幅(ポイント単位)。 |
リターン
PageElement
- このページ要素(チェーン用)。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations