Class Group

グループ

単一の単位として結合された PageElement のコレクション。

メソッド

メソッド戻り値の型概要
alignOnPage(alignmentPosition)Group要素をページの指定された配置位置に配置します。
bringForward()Groupページ要素を 1 つ手前に移動します。
bringToFront()Groupページ要素をページの最前面に移動します。
duplicate()PageElementページ要素を複製します。
getChildren()PageElement[]グループ内のページ要素のコレクションを取得します。
getConnectionSites()ConnectionSite[]ページ要素の ConnectionSite のリストを返します。ページ要素に接続サイトがない場合は、空のリストを返します。
getDescription()Stringページ要素の代替テキストの説明を返します。
getHeight()Number|null要素の高さ（ポイント単位）を取得します。これは、要素に回転がない場合の要素の境界ボックスの高さです。
getInherentHeight()Number|null要素の固有の高さをポイント単位で返します。
getInherentWidth()Number|null要素の固有の幅をポイント単位で返します。
getLeft()Number要素が回転していない場合、ページの左上隅から測定された要素の水平位置をポイント単位で返します。
getObjectId()Stringこのオブジェクトの一意の ID を返します。
getPageElementType()PageElementTypeページ要素の型を PageElementType 列挙型で返します。
getParentGroup()Group|nullこのページ要素が属するグループを返します。要素がグループに属していない場合は null を返します。
getParentPage()Pageこのページ要素があるページを返します。
getRotation()Number要素の中心を軸とした時計回りの回転角度を度数で返します。0 度は回転がないことを意味します。
getTitle()Stringページ要素の代替テキストのタイトルを返します。
getTop()Number要素が回転していない場合、ページの左上隅から測定した要素の垂直方向の位置をポイント単位で取得します。
getTransform()AffineTransformページ要素の変換を取得します。
getWidth()Number|null要素の幅をポイント単位で返します。要素が回転していない場合、これは要素の境界ボックスの幅です。
preconcatenateTransform(transform)Group指定された変換をページ要素の既存の変換に事前連結します。
remove()voidページ要素を削除します。
scaleHeight(ratio)Group指定された比率で要素の高さを拡大縮小します。
scaleWidth(ratio)Group要素の幅を指定された比率で拡大縮小します。
select()voidアクティブなプレゼンテーションの PageElement のみを選択し、以前の選択をすべて削除します。
select(replace)voidアクティブなプレゼンテーションで PageElement を選択します。
sendBackward()Groupページ要素を 1 つの要素分、ページ上で後方に移動します。
sendToBack()Groupページ要素をページの背面に移動します。
setDescription(description)Groupページ要素の代替テキストの説明を設定します。
setHeight(height)Group要素の高さ（ポイント単位）を設定します。これは、要素が回転していない場合の要素の境界ボックスの高さです。
setLeft(left)Group要素が回転していない場合、ページの左上隅から測定した要素の水平位置をポイント単位で設定します。
setRotation(angle)Group要素の中心を軸とした時計回りの回転角度を度単位で設定します。
setTitle(title)Groupページ要素の代替テキストのタイトルを設定します。
setTop(top)Group要素が回転していない場合、ページの左上隅から測定した要素の垂直方向をポイント単位で設定します。
setTransform(transform)Group指定された変換を使用して、ページ要素の変換を設定します。
setWidth(width)Group要素の幅をポイント単位で設定します。これは、要素が回転していない場合の要素の境界ボックスの幅です。
ungroup()voidグループの要素をグループ解除します。

詳細なドキュメント

alignOnPage(alignmentPosition)

要素をページの指定された配置位置に配置します。

パラメータ

名前タイプ説明
alignmentPositionAlignmentPositionページ上のこのページ要素を配置する位置。

戻る

Group - チェーン用のこのページ要素。

bringForward()

ページ要素を 1 つの要素分、ページの手前に移動します。

ページ要素はグループに属していてはなりません。

戻る

Group - チェーン用のこのページ要素。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

bringToFront()

ページ要素をページの最前面に移動します。

ページ要素はグループに属していてはなりません。

戻る

Group - チェーン用のこのページ要素。

承認

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

getChildren()

グループ内のページ要素のコレクションを取得します。グループの最小サイズは 2 です。

戻る

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

ページ要素の代替テキストの説明を返します。説明はタイトルと組み合わされて、代替テキストの表示と読み上げに使用されます。

戻る

String - ページ要素の代替テキストの説明。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getHeight()

要素の高さ（ポイント単位）を取得します。これは、要素に回転がない場合の要素の境界ボックスの高さです。

この方法は、すべてのページ要素に対応しているわけではありません。このメソッドと互換性のないページ要素については、 サイズと位置の制限事項をご覧ください。

戻る

Number|null - ページ要素の固有の高さ（ポイント単位）。ページ要素に高さがない場合は null。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getInherentHeight()

要素の固有の高さをポイント単位で返します。

ページ要素の変換は、その固有のサイズを基準として行われます。要素の最終的な外観を決定するには、要素の変換と組み合わせて固有のサイズを使用します。

戻る

Number|null - ページ要素の固有の高さ（ポイント単位）。ページ要素に高さがない場合は null。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getInherentWidth()

要素の固有の幅をポイント単位で返します。

ページ要素の変換は、その固有のサイズを基準として行われます。要素の最終的な外観を決定するには、要素の変換と組み合わせて固有のサイズを使用します。

戻る

Number|null - ページ要素の固有の幅（ポイント単位）。ページ要素に幅がない場合は 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()

このページ要素が属するグループを返します。要素がグループに属していない場合は null を返します。

戻る

Group|null - このページ要素が属するグループ、または null。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getParentPage()

このページ要素があるページを返します。

戻る

Page - この要素が存在するページ。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

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

ページ要素の変換を取得します。

新しく作成された Group の初期変換は、常に単位変換です。つまり、スケール パラメータは 1.0、せん断と変換のパラメータは 0.0 です。

戻る

AffineTransform - ページ要素の変換。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getWidth()

要素の幅をポイント単位で返します。これは、要素に回転がない場合の要素の境界ボックスの幅です。

この方法は、すべてのページ要素に対応しているわけではありません。このメソッドと互換性のないページ要素については、 サイズと位置の制限事項をご覧ください。

戻る

Number|null - ページ要素の固有の幅（ポイント単位）。ページ要素に幅がない場合は null。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

preconcatenateTransform(transform)

指定された変換をページ要素の既存の変換に事前連結します。

newTransform = argument * existingTransform;

たとえば、ページ要素を左に 36 ポイント移動するには:

const element = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0];
element.preconcatenateTransform(
    SlidesApp.newAffineTransformBuilder().setTranslateX(-36.0).build(),
);

ページ要素の変換を setTransform(transform) に置き換えることもできます。

パラメータ

名前タイプ説明
transformAffineTransformこのページ要素の変換に事前連結する変換。

戻る

Group - チェーン用のこのページ要素。

承認

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

指定された比率で要素の高さを拡大縮小します。要素の高さは、要素に回転がない場合の境界ボックスの高さです。

この方法は、すべてのページ要素に対応しているわけではありません。このメソッドと互換性のないページ要素については、 サイズと位置の制限事項をご覧ください。

パラメータ

名前タイプ説明
ratioNumberこのページ要素の高さをスケーリングする比率。

戻る

Group - チェーン用のこのページ要素。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

scaleWidth(ratio)

要素の幅を指定された比率で拡大縮小します。要素の幅は、要素が回転していない場合の境界ボックスの幅です。

この方法は、すべてのページ要素に対応しているわけではありません。このメソッドと互換性のないページ要素については、 サイズと位置の制限事項をご覧ください。

パラメータ

名前タイプ説明
ratioNumberこのページ要素の幅をスケーリングする比率。

戻る

Group - チェーン用のこのページ要素。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

select()

アクティブなプレゼンテーションの PageElement のみを選択し、以前の選択をすべて削除します。これは、true を指定して select(replace) を呼び出すのと同じです。

スクリプトがプレゼンテーションにバインドされている場合にのみ、スクリプトを実行しているユーザーの選択にアクセスできます。

これにより、PageElement の親 Page が current page selection として設定されます。

const slide = SlidesApp.getActivePresentation().getSlides()[0];
const 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 として設定します。

複数の PageElement オブジェクトを選択するには、false を渡します。PageElement オブジェクトは同じ Page に存在する必要があります。

false パラメータを使用してページ要素を選択する際は、次の条件を満たす必要があります。

  1. PageElement オブジェクトの親 Page は current page selection である必要があります。
  2. 複数の Page オブジェクトが選択されていないようにする必要があります。

これを確実にするには、まず Page.selectAsCurrentPage() を使用して親 Page を選択し、次にそのページのページ要素を選択することをおすすめします。

const 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.
const pageElements = slide.getPageElements();
for (let i = 0; i < pageElements.length; i++) {
  pageElements[i].select(false);
}

パラメータ

名前タイプ説明
replaceBooleantrue の場合、選択内容は以前の選択内容を置き換えます。それ以外の場合、選択内容は以前の選択内容に追加されます。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

sendBackward()

ページ要素をページ上で 1 つ後ろに送ります。

ページ要素はグループに属していてはなりません。

戻る

Group - チェーン用のこのページ要素。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

sendToBack()

ページ要素をページの背面に送信します。

ページ要素はグループに属していてはなりません。

戻る

Group - チェーン用のこのページ要素。

承認

このメソッドを使用するスクリプトには、次の 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".
const pageElement =
    SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0];
pageElement.setDescription('new alt text description');
Logger.log(pageElement.getDescription());

パラメータ

名前タイプ説明
descriptionString代替テキストの説明を設定する文字列。

戻る

Group - このページ要素。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setHeight(height)

要素の高さ（ポイント単位）を設定します。これは、要素が回転していない場合の要素の境界ボックスの高さです。

この方法は、すべてのページ要素に対応しているわけではありません。このメソッドと互換性のないページ要素については、 サイズと位置の制限事項をご覧ください。

パラメータ

名前タイプ説明
heightNumberこのページ要素の新しい高さをポイント単位で設定します。

戻る

Group - チェーン用のこのページ要素。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setLeft(left)

要素が回転していない場合、ページの左上隅から測定した要素の水平位置をポイント単位で設定します。

パラメータ

名前タイプ説明
leftNumber設定する新しい水平位置（ポイント単位）。

戻る

Group - チェーン用のこのページ要素。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setRotation(angle)

要素の中心を軸とした時計回りの回転角度を度単位で設定します。

この方法は、すべてのページ要素に対応しているわけではありません。このメソッドと互換性のないページ要素については、 サイズと位置の制限事項をご覧ください。

パラメータ

名前タイプ説明
angleNumber設定する新しい時計回りの回転角度（度）。

戻る

Group - チェーン用のこのページ要素。

承認

このメソッドを使用するスクリプトには、次の 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".
const pageElement =
    SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0];
pageElement.setTitle('new alt text title');
Logger.log(pageElement.getTitle());

パラメータ

名前タイプ説明
titleString代替テキストのタイトルを設定する文字列。

戻る

Group - このページ要素。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setTop(top)

要素が回転していない場合、ページの左上隅から測定した要素の垂直方向をポイント単位で設定します。

パラメータ

名前タイプ説明
topNumber設定する新しい垂直方向の位置（ポイント単位）。

戻る

Group - チェーン用のこのページ要素。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setTransform(transform)

指定された変換を使用して、ページ要素の変換を設定します。

グループの変換を更新すると、そのグループ内のページ要素の絶対変換が変更され、外観が変わる可能性があります。

グループ内のページ要素の変換を更新しても、そのページ要素の変換のみが変更され、グループの変換やグループ内の他のページ要素の変換には影響しません。

変換がページ要素の視覚的な外観に与える影響について詳しくは、getTransform() をご覧ください。

パラメータ

名前タイプ説明
transformAffineTransformこのページ要素に設定されている変換。

戻る

Group - チェーン用のこの要素。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setWidth(width)

要素の幅をポイント単位で設定します。これは、要素が回転していない場合の要素の境界ボックスの幅です。

この方法は、すべてのページ要素に対応しているわけではありません。このメソッドと互換性のないページ要素については、 サイズと位置の制限事項をご覧ください。

パラメータ

名前タイプ説明
widthNumberこのページ要素の新しい幅（ポイント単位）。

戻る

Group - チェーン用のこのページ要素。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

ungroup()

グループの要素をグループ解除します。

グループ自体が削除されます。

他のグループ内のグループはグループ化解除できません。

承認

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

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations