Class SpeakerSpotlight

スピーカー スポットライト

スピーカー スポットライトを表す PageElement。

const slide = SlidesApp.getActivePresentation().getSlides()[0];
const speakerSpotlight = slide.getPageElements()[0];
console.log(
    `Page element is of type: ${
        speakerSpotlight.getPageElementType().toString()}`,
);

メソッド

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

詳細なドキュメント

alignOnPage(alignmentPosition)

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

パラメータ

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

戻る

SpeakerSpotlight - このページ要素（連結用）。

bringForward()

ページ要素をページ上で 1 つ前方に移動します。

ページ要素はグループに含めることはできません。

戻る

SpeakerSpotlight - このページ要素（連結用）。

承認

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

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

bringToFront()

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

ページ要素はグループに含めることはできません。

戻る

SpeakerSpotlight - このページ要素（連結用）。

承認

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

getBorder()

スピーカー スポットライトの Border を返します。

const slide = SlidesApp.getActivePresentation().getSlides()[0];
// Gets the first element on the page, which in
// this example is of type speaker spotlight.
const speakerSpotlight = slide.getPageElements()[0];
// Gets the border of the speaker spotlight.
const border = speakerSpotlight.getBorder();

戻る

Border - スピーカー スポットライトの枠線。

承認

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

承認

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

getMaskShapeType()

スピーカー スポットライトに適用されているマスクの ShapeType を返します。マスクがない場合は null を返します。

const slide = SlidesApp.getActivePresentation().getSlides()[0];
// Gets the first element on the page, which in
// this example is of type speaker spotlight.
const speakerSpotlight = slide.getPageElements()[0];
// Gets the shape type of the mask on the speaker spotlight.
const maskShapeType = speakerSpotlight.getMaskShapeType();

戻る

ShapeType - スピーカー スポットライト マスクの形状タイプ。

承認

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

承認

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

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

ページ要素の視覚的な外観は、その絶対変換によって決まります。絶対変換を計算するには、ページ要素の変換を、そのすべての親グループの変換と事前に連結します。ページ要素がグループにない場合、その絶対変換は、このフィールドの値と同じです。

戻る

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 ポイント左に移動するには、次のようにします。 

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

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

パラメータ

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

戻る

SpeakerSpotlight - このページ要素（連結用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 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このページ要素の高さをスケーリングする比率。

戻る

SpeakerSpotlight - このページ要素（連結用）。

承認

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

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

scaleWidth(ratio)

要素の幅を指定された比率でスケーリングします。要素の幅は、要素が回転していない場合の境界ボックスの幅です。

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

パラメータ

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

戻る

SpeakerSpotlight - このページ要素（連結用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 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 として設定されます。

false を渡して、複数の PageElement オブジェクトを選択します。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 つ後方に移動します。

ページ要素はグループに含めることはできません。

戻る

SpeakerSpotlight - このページ要素（連結用）。

承認

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

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

sendToBack()

ページ要素をページの一番後ろに移動します。

ページ要素はグループに含めることはできません。

戻る

SpeakerSpotlight - このページ要素（連結用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 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代替テキストの説明を設定する文字列。

戻る

SpeakerSpotlight - このページの要素。

承認

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

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

setHeight(height)

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

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

パラメータ

名前型説明
heightNumber設定するこのページ要素の新しい高さ（ポイント単位）。

戻る

SpeakerSpotlight - このページ要素（連結用）。

承認

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

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

setLeft(left)

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

パラメータ

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

戻る

SpeakerSpotlight - このページ要素（連結用）。

承認

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

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

setRotation(angle)

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

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

パラメータ

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

戻る

SpeakerSpotlight - このページ要素（連結用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 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代替テキストのタイトルに設定する文字列。

戻る

SpeakerSpotlight - このページの要素。

承認

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

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

setTop(top)

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

パラメータ

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

戻る

SpeakerSpotlight - このページ要素（連結用）。

承認

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

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

setTransform(transform)

指定された変換でページ要素の変換を設定します。

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

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

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

パラメータ

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

戻る

SpeakerSpotlight - チェーン用の要素。

承認

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

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

setWidth(width)

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

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

パラメータ

名前型説明
widthNumber設定するこのページ要素の新しい幅（ポイント単位）。

戻る

SpeakerSpotlight - このページ要素（連結用）。

承認

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

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