Class SpeakerSpotlight

SpeakerSpotlight

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

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 を返します。 

// 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 を返します。 マスクはありません。 

// 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 は、 Namespace があります。

戻る

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

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 として設定されます。 

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。

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

false を使用してページ要素を選択する場合は、次の条件を満たす必要があります parameter:

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

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

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);
}

パラメータ

名前型説明
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".
var 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".
var 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