Class Shape

シェイプ

より具体的な分類を持たない汎用的なシェイプを表す PageElement。テキスト ボックス、長方形、その他の定義済みの図形が含まれます。

メソッド

メソッド戻り値の型概要
alignOnPage(alignmentPosition)Shapeページ上の指定された配置位置に要素を整列します。
bringForward()Shapeページ要素を 1 つ分だけページ上に移動します。
bringToFront()Shapeページ要素をページの最前面に移動します。
duplicate()PageElementページ要素を複製します。
getAutofit()Autofitこのシェイプ内のテキストの Autofit を返します。
getBorder()Borderシェイプの Border を返します。
getConnectionSites()ConnectionSite[]ページ要素の ConnectionSite のリストを返します。ページ要素に接続サイトがない場合は空のリストを返します。
getContentAlignment()ContentAlignmentシェイプ内のテキストの ContentAlignment を返します。
getDescription()Stringページ要素の代替テキストの説明を返します。
getFill()Fillシェイプの Fill を返します。
getHeight()Number要素の高さをポイント単位で取得します。これは、要素に回転がない場合の要素の境界ボックスの高さです。
getInherentHeight()Number要素固有の高さをポイント単位で返します。
getInherentWidth()Number要素固有の幅をポイント単位で返します。
getLeft()Number要素が回転していない場合にページの左上隅から測定された、要素の水平方向の位置をポイント単位で返します。
getLink()Linkリンクがない場合は Link または null を返します。
getObjectId()Stringこのオブジェクトの一意の ID を返します。
getPageElementType()PageElementTypeページ要素のタイプを PageElementType 列挙型として返します。
getParentGroup()Groupこのページ要素が属するグループを返します。要素がグループに含まれていない場合は null を返します。
getParentPage()Pageこのページ要素があるページを返します。
getParentPlaceholder()PageElementプレースホルダの親ページ要素を返します。
getPlaceholderIndex()Integerシェイプのプレースホルダ インデックスを返します。
getPlaceholderType()PlaceholderTypeシェイプのプレースホルダ タイプを返します。シェイプがプレースホルダでない場合は PlaceholderType.NONE を返します。
getRotation()Number中心からの要素の時計回りの回転角度を度数で返します。0 度は回転しないことを意味します。
getShapeType()ShapeTypeシェイプのタイプを返します。
getText()TextRangeシェイプのテキスト コンテンツを返します。
getTitle()Stringページ要素の代替テキストのタイトルを返します。
getTop()Number要素が回転していない場合にページの左上隅から測定された、要素の垂直方向の位置をポイント単位で取得します。
getTransform()AffineTransformページ要素の変換を返します。
getWidth()Number要素の幅をポイント単位で返します。これは、要素の回転がない場合の要素の境界ボックスの幅です。
preconcatenateTransform(transform)Shape指定された変換をページ要素の既存の変換に事前連結します。
remove()voidページ要素を削除します。
removeLink()voidLink を削除します。
replaceWithImage(blobSource)Imageこのシェイプを、BlobSource が提供する画像に置き換えます。
replaceWithImage(blobSource, crop)Imageこのシェイプを、BlobSource が提供する画像に置き換えます。
replaceWithImage(imageUrl)Imageこの図形を画像に置き換えます。
replaceWithImage(imageUrl, crop)Imageこの図形を画像に置き換えます。
replaceWithSheetsChart(sourceChart)SheetsChartこの図形を Google スプレッドシートのグラフに置き換えます。
replaceWithSheetsChartAsImage(sourceChart)Imageこの図形を Google スプレッドシートのグラフの画像に置き換えます。
scaleHeight(ratio)Shape指定された比率で要素の高さをスケーリングします。
scaleWidth(ratio)Shape指定した比率で要素の幅をスケーリングします。
select()voidアクティブなプレゼンテーションの PageElement のみを選択し、以前の選択を削除します。
select(replace)voidアクティブなプレゼンテーションの PageElement を選択します。
sendBackward()Shapeページ要素を 1 要素分ページ上に移動します。
sendToBack()Shapeページ要素をページの背面に送信します。
setContentAlignment(contentAlignment)Shapeシェイプ内のテキストの ContentAlignment を設定します。
setDescription(description)Shapeページ要素の代替テキストの説明を設定します。
setHeight(height)Shape要素の高さをポイント単位で設定します。これは、要素が回転しない場合の要素の境界ボックスの高さです。
setLeft(left)Shape要素の水平位置をポイント単位で設定します。要素が回転しない場合のページの左上隅が基準となります。
setLinkSlide(slideIndex)Linkスライドのゼロベースのインデックスを使用して、Link を指定された Slide に設定します。
setLinkSlide(slide)LinkLink を指定された Slide に設定します。リンクは指定されたスライド ID で設定されます。
setLinkSlide(slidePosition)Linkスライドの相対位置を使用して、Link を指定された Slide に設定します。
setLinkUrl(url)LinkLink を指定された空でない URL 文字列に設定します。
setRotation(angle)Shape中心を中心とした要素の時計回りの回転角度を度単位で設定します。
setTitle(title)Shapeページ要素の代替テキストのタイトルを設定します。
setTop(top)Shape要素の垂直位置をポイント単位で設定します。要素が回転しない場合のページの左上隅が基準となります。
setTransform(transform)Shape指定された変換を使用してページ要素の変換を設定します。
setWidth(width)Shape要素の幅をポイント単位で設定します。これは、要素が回転しない場合の要素の境界ボックスの幅です。

詳細なドキュメント

alignOnPage(alignmentPosition)

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

パラメータ

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

リターン

Shape - このページ要素（チェーンに使用します）。

bringForward()

ページ要素を 1 つ分だけページ上に移動します。

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

リターン

Shape - このページ要素（チェーンに使用します）。

認可

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

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

bringToFront()

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

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

リターン

Shape - このページ要素（チェーンに使用します）。

認可

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

getAutofit()

このシェイプ内のテキストの Autofit を返します。シェイプがテキストを許可しない場合は null です。

リターン

Autofit - このシェイプ内のテキストの自動調整。

認可

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

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

getBorder()

シェイプの Border を返します。

リターン

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

getContentAlignment()

シェイプ内のテキストの ContentAlignment を返します。

リターン

ContentAlignment - このシェイプ内のテキストの配置。

認可

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

getFill()

シェイプの Fill を返します。

リターン

Fill - このシェイプの塗りつぶし設定。

認可

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

リンクがない場合は Link または null を返します。 

var link = shape.getLink();
if (link != null) {
  Logger.log('Shape has a link of type: ' + link.getLinkType());
}

リターン

Link

認可

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

getParentPlaceholder()

プレースホルダの親ページ要素を返します。シェイプがプレースホルダでない場合、または親がない場合、null を返します。

リターン

PageElement - このシェイプ プレースホルダの親ページ要素。シェイプがプレースホルダでない、または親を持たない場合は、null。

認可

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

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

getPlaceholderIndex()

シェイプのプレースホルダ インデックスを返します。同じページに同じプレースホルダ タイプのインスタンスが 2 つ以上存在する場合、それぞれに一意のインデックス値が割り当てられます。シェイプがプレースホルダでない場合、null を返します。

リターン

Integer - このシェイプのプレースホルダ インデックス。シェイプがプレースホルダでない場合は null。

認可

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

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

getPlaceholderType()

シェイプのプレースホルダ タイプを返します。シェイプがプレースホルダでない場合は PlaceholderType.NONE を返します。

リターン

PlaceholderType - このシェイプのプレースホルダ タイプ。

認可

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

getShapeType()

シェイプのタイプを返します。

リターン

ShapeType - このシェイプのタイプ。

getText()

シェイプのテキスト コンテンツを返します。

シェイプ内のテキストは、常に改行文字で終わります。

リターン

TextRange - このシェイプのテキスト コンテンツ。

認可

このメソッドを使用するスクリプトには、次のスコープの 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このページ要素の変換に事前連結する変換。

リターン

Shape - このページ要素（チェーンに使用します）。

認可

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

Link を削除します。

shape.removeLink();

replaceWithImage(blobSource)

このシェイプを、BlobSource が提供する画像に置き換えます。

画像は挿入時に指定された BlobSource から 1 回取得され、プレゼンテーション内に表示するためにコピーが保存されます。画像は、サイズが 50 MB 未満、25 メガピクセルを超えることはできません。形式は PNG、JPEG、GIF のいずれかにする必要があります。

画像のアスペクト比を維持するため、既存のシェイプのサイズを基準に画像が拡大および中央揃えされます。

var shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0];
// Get the Drive image file with the given ID.
var driveImage = DriveApp.getFileById(fileId);
shape.replaceWithImage(driveImage);

パラメータ

名前型説明
blobSourceBlobSource画像データ。

リターン

Image - シェイプを置き換えた Image。

認可

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

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

replaceWithImage(blobSource, crop)

このシェイプを、BlobSource が提供する画像に置き換えます。

画像を挿入すると、BlobSource から 1 回取得され、プレゼンテーション内に表示するためにコピーが保存されます。画像は、サイズが 50 MB 未満、25 メガピクセル以下で、PNG、JPEG、GIF 形式のいずれかである必要があります。

var shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0];
// Get the Drive image file with the given ID.
var driveImage = DriveApp.getFileById(fileId);
// Replace and crop the replaced image.
shape.replaceWithImage(driveImage, true);

パラメータ

名前型説明
blobSourceBlobSource画像データ。
cropBooleantrue の場合、既存のシェイプのサイズに合わせて画像を切り抜きます。それ以外の場合、画像はスケーリングされ、中央に配置されます。

リターン

Image - シェイプを置き換えた Image。

認可

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

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

replaceWithImage(imageUrl)

この図形を画像に置き換えます。

挿入すると、画像が URL から 1 回取得され、プレゼンテーション内に表示するためにコピーが保存されます。画像は、サイズが 50 MB 未満、25 メガピクセル以下で、PNG、JPEG、GIF 形式のいずれかである必要があります。

提出する URL は一般公開されていて、2 KB 以内である必要があります。URL 自体は画像とともに保存され、Image.getSourceUrl() を介して公開されます。

画像のアスペクト比を維持するため、既存のシェイプのサイズを基準に画像がスケーリングされ、中央揃えされます。

パラメータ

名前型説明
imageUrlString画像のダウンロード元となる画像の URL。

リターン

Image - シェイプを置き換えた Image。

認可

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

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

replaceWithImage(imageUrl, crop)

この図形を画像に置き換えます。

挿入すると、画像が URL から 1 回取得され、プレゼンテーション内に表示するためにコピーが保存されます。画像は、サイズが 50 MB 未満、25 メガピクセル以下で、PNG、JPEG、GIF 形式のいずれかである必要があります。

指定する URL は 2 KB 以下である必要があります。URL 自体は画像とともに保存され、Image.getSourceUrl() によって公開されます。

パラメータ

名前型説明
imageUrlString画像のダウンロード元となる画像の URL。
cropBooleantrue の場合、既存のシェイプのサイズに合わせて画像を切り抜きます。それ以外の場合、画像はスケーリングされ、中央に配置されます。

リターン

Image - シェイプを置き換えた Image。

認可

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

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

replaceWithSheetsChart(sourceChart)

このシェイプを Google スプレッドシートのグラフに置き換えます。

グラフは参照元の Google スプレッドシートのグラフにリンクされているため、グラフを更新できます。元のスプレッドシートへのリンクは他の共同編集者にも表示されます。 

var sheet = SpreadsheetApp.openById('spreadsheetId').getSheets()[0];
var chart = sheet.getCharts()[0];
// Replace the shape with the Sheets chart.
var shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0];
shape.replaceWithSheetsChart(chart);

パラメータ

名前型説明
sourceChartEmbeddedChart図形を置き換えるスプレッドシートのグラフ。

リターン

SheetsChart - シェイプを置き換えたグラフ。

認可

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

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

replaceWithSheetsChartAsImage(sourceChart)

この図形を Google スプレッドシートのグラフの画像に置き換えます。

Google スプレッドシートのグラフのアスペクト比を維持するため、既存の図形のサイズに合わせてグラフの画像が拡大縮小され、中央に配置されます。

グラフの画像は、コピー元の Google スプレッドシートのグラフにリンクされていません。 

var sheet = SpreadsheetApp.openById('spreadsheetId').getSheets()[0];
var chart = sheet.getCharts()[0];
// Replace the shape with the Sheets chart as an image.
var shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0];
shape.replaceWithSheetsChartAsImage(chart);

パラメータ

名前型説明
sourceChartEmbeddedChart図形を置き換えるスプレッドシートのグラフ。

リターン

Image - シェイプを置き換えたグラフの画像。

認可

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

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

scaleHeight(ratio)

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

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

パラメータ

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

リターン

Shape - このページ要素（チェーンに使用します）。

認可

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

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

scaleWidth(ratio)

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

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

パラメータ

名前型説明
ratioNumberこのページ要素の幅を拡大縮小する比率。

リターン

Shape - このページ要素（チェーンに使用します）。

認可

このメソッドを使用するスクリプトには、次のスコープの 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 パラメータを使用してページ要素を選択する場合は、次の条件を満たしている必要があります。

  1. PageElement オブジェクトの親 Page は current page selection にする必要があります。
  2. 複数の 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);
}

パラメータ

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

認可

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

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

sendBackward()

ページ要素を 1 要素分ページ上に移動します。

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

リターン

Shape - このページ要素（チェーンに使用します）。

認可

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

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

sendToBack()

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

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

リターン

Shape - このページ要素（チェーンに使用します）。

認可

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

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

setContentAlignment(contentAlignment)

シェイプ内のテキストの ContentAlignment を設定します。

このメソッドは、更新されたシェイプのテキストの自動調整のプロパティを自動的に無効にします。

パラメータ

名前型説明
contentAlignmentContentAlignment設定するアライメント。

リターン

Shape - チェーン用のシェイプ。

認可

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

リターン

Shape - このページ要素。

認可

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

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

setHeight(height)

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

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

パラメータ

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

リターン

Shape - このページ要素（チェーンに使用します）。

認可

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

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

setLeft(left)

要素の水平位置をポイント単位で設定します。要素が回転しない場合のページの左上隅が基準となります。

パラメータ

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

リターン

Shape - このページ要素（チェーンに使用します）。

認可

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

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

setLinkSlide(slideIndex)

スライドのゼロベースのインデックスを使用して、Link を指定された Slide に設定します。

// Set a link to the first slide of the presentation.
shape.setLinkSlide(0);

パラメータ

名前型説明
slideIndexIntegerスライドに対するゼロベースのインデックス。

リターン

Link - 設定された Link

認可

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

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

setLinkSlide(slide)

Link を指定された Slide に設定します。リンクは指定されたスライド ID で設定されます。 

// Set a link to the first slide of the presentation.
var slide = presentation.getSlides()[0];
shape.setLinkSlide(slide);

パラメータ

名前型説明
slideSlideリンクする Slide。

リターン

Link - 設定された Link

認可

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

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

setLinkSlide(slidePosition)

スライドの相対位置を使用して、Link を指定された Slide に設定します。 

// Set a link to the first slide of the presentation.
shape.setLinkSlide(SlideApp.SlidePosition.FIRST_SLIDE);

パラメータ

名前型説明
slidePositionSlidePosition相対的な SlidePosition。

リターン

Link - 設定された Link

認可

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

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

setLinkUrl(url)

指定された空でない URL 文字列に Link を設定します。 

// Set a link to the URL.
shape.setLinkUrl("https://slides.google.com");

パラメータ

名前型説明
urlStringURL 文字列。

リターン

Link - 設定された Link

認可

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

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

setRotation(angle)

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

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

パラメータ

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

リターン

Shape - このページ要素（チェーンに使用します）。

認可

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

リターン

Shape - このページ要素。

認可

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

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

setTop(top)

要素の垂直位置をポイント単位で設定します。要素が回転しない場合のページの左上隅が基準となります。

パラメータ

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

リターン

Shape - このページ要素（チェーンに使用します）。

認可

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

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

setTransform(transform)

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

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

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

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

パラメータ

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

リターン

Shape - この要素（チェーンに使用します）。

認可

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

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

setWidth(width)

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

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

パラメータ

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

リターン

Shape - このページ要素（チェーンに使用します）。

認可

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

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