PowerPoint.ShapeCollection class

リファレンス

パッケージ:: powerpoint

図形のコレクションを表します。

Extends: OfficeExtension.ClientObject

注釈

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml

// Changes the transparency of every geometric shape in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the shape transparency to be halfway transparent.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.geometricShape) {
      shape.fill.transparency = 0.5;
    }
  });
  await context.sync();
});

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
items	このコレクション内に読み込まれた子アイテムを取得します。

メソッド

addGeometricShape(geometricShapeType, options)	図形をスライドに追加します。新しい図形を表す `Shape` オブジェクトを返します。
addGeometricShape(geometricShapeTypeString, options)	図形をスライドに追加します。新しい図形を表す `Shape` オブジェクトを返します。
addLine(connectorType, options)	スライドに線を追加します。新しい行を表す `Shape` オブジェクトを返します。
addLine(connectorTypeString, options)	スライドに線を追加します。新しい行を表す `Shape` オブジェクトを返します。
addTextBox(text, options)	指定したテキストをコンテンツとして含むテキストボックスをスライドに追加します。新しいテキストボックスを表す `Shape` オブジェクトを返します。
getCount()	コレクション内の図形の数を取得します。
getItem(key)	一意の ID を使用して図形を取得します。図形が存在しない場合は、エラーがスローされます。
getItemAt(index)	コレクション内の 0 から始まるインデックスを使用して図形を取得します。インデックスが範囲外の場合、エラーがスローされます。
getItemOrNullObject(id)	一意の ID を使用して図形を取得します。このような図形が存在しない場合は、 `isNullObject` プロパティが true に設定されたオブジェクトが返されます。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
toJSON()	API オブジェクトが`JSON.stringify()`に渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (`JSON.stringify`、それに渡されるオブジェクトの `toJSON` メソッドを呼び出します)。元の `PowerPoint.ShapeCollection` オブジェクトは API オブジェクトですが、 `toJSON` メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( `PowerPoint.Interfaces.ShapeCollectionData`として型指定) を返します。

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

PowerPoint.RequestContext

items

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: PowerPoint.Shape[];

プロパティ値

PowerPoint.Shape[]

メソッドの詳細

addGeometricShape(geometricShapeType, options)

図形をスライドに追加します。新しい図形を表す Shape オブジェクトを返します。

addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;

パラメーター

geometricShapeType: PowerPoint.GeometricShapeType

ジオメトリ図形の種類を指定します。詳細については、「 PowerPoint.GeometrShapeType 」を参照してください。

options: PowerPoint.ShapeAddOptions

図形の位置などの追加オプションを指定する省略可能なパラメーター。

戻り値

PowerPoint.Shape

新しく挿入された図形。

注釈

[ API セット: PowerPointApi 1.4 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml

// This function gets the collection of shapes on the first slide,
// and adds a hexagon shape to the collection, while specifying its
// location and size. Then it names the shape.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  const shapeOptions: PowerPoint.ShapeAddOptions = {
    left: 100,
    top: 100,
    height: 150,
    width: 150
  };
  const hexagon: PowerPoint.Shape = shapes.addGeometricShape(PowerPoint.GeometricShapeType.hexagon, shapeOptions);
  hexagon.name = "Hexagon";

  await context.sync();
});

addGeometricShape(geometricShapeTypeString, options)

図形をスライドに追加します。新しい図形を表す Shape オブジェクトを返します。

addGeometricShape(geometricShapeTypeString: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;

パラメーター

geometricShapeTypeString: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"

ジオメトリ図形の種類を指定します。詳細については、「 PowerPoint.GeometrShapeType 」を参照してください。

options: PowerPoint.ShapeAddOptions

図形の位置などの追加オプションを指定する省略可能なパラメーター。

戻り値

PowerPoint.Shape

新しく挿入された図形。

注釈

[ API セット: PowerPointApi 1.4 ]

addLine(connectorType, options)

スライドに線を追加します。新しい行を表す Shape オブジェクトを返します。

addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;

パラメーター

connectorType: PowerPoint.ConnectorType

線のコネクタの種類を指定します。指定しない場合は、コネクタの種類 straight 使用されます。詳細については、「PowerPoint.ConnectorType 」を参照してください。

options: PowerPoint.ShapeAddOptions

行を含む図形オブジェクトの位置などの追加オプションを指定する省略可能なパラメーター。

戻り値

PowerPoint.Shape

新しく挿入された図形。

注釈

[ API セット: PowerPointApi 1.4 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml

// This function gets the collection of shapes on the first slide,
// and adds a line to the collection, while specifying its
// start and end points. Then it names the shape.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;

  // For a line, left and top are the coordinates of the start point,
  // while height and width are the coordinates of the end point.
  const line: PowerPoint.Shape = shapes.addLine(PowerPoint.ConnectorType.straight, 
      { 
        left: 400, 
        top: 200, 
        height: 20, 
        width: 150 
      });
  line.name = "StraightLine";

  await context.sync();
});

addLine(connectorTypeString, options)

スライドに線を追加します。新しい行を表す Shape オブジェクトを返します。

addLine(connectorTypeString?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;

パラメーター

connectorTypeString: "Straight" | "Elbow" | "Curve"

options: PowerPoint.ShapeAddOptions

行を含む図形オブジェクトの位置などの追加オプションを指定する省略可能なパラメーター。

戻り値

PowerPoint.Shape

新しく挿入された図形。

注釈

[ API セット: PowerPointApi 1.4 ]

addTextBox(text, options)

指定したテキストをコンテンツとして含むテキストボックスをスライドに追加します。新しいテキストボックスを表す Shape オブジェクトを返します。

addTextBox(text: string, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;

パラメーター

text: string

作成したテキストボックスに表示されるテキストを指定します。

options: PowerPoint.ShapeAddOptions

テキストボックスの位置などの追加オプションを指定する省略可能なパラメーター。

戻り値

PowerPoint.Shape

新しく挿入された図形。

注釈

[ API セット: PowerPointApi 1.4 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml

// This function gets the collection of shapes on the first slide,
// and adds a text box to the collection, while specifying its text,
// location, and size. Then it names the text box.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  const textbox: PowerPoint.Shape = shapes.addTextBox("Hello!", 
      { 
        left: 100, 
        top: 300, 
        height: 300, 
        width: 450 
      });
  textbox.name = "Textbox";

  return context.sync();
});

getCount()

コレクション内の図形の数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

コレクション内の図形の数。

注釈

[ API セット: PowerPointApi 1.3 ]

getItem(key)

一意の ID を使用して図形を取得します。図形が存在しない場合は、エラーがスローされます。

getItem(key: string): PowerPoint.Shape;

パラメーター

key: string

図形の ID。

戻り値

PowerPoint.Shape

一意の ID を持つ図形。このような図形が存在しない場合は、エラーがスローされます。

注釈

[ API セット: PowerPointApi 1.3 ]

getItemAt(index)

コレクション内の 0 から始まるインデックスを使用して図形を取得します。インデックスが範囲外の場合、エラーがスローされます。

getItemAt(index: number): PowerPoint.Shape;

パラメーター

index: number

コレクション内の図形のインデックス。

戻り値

PowerPoint.Shape

指定したインデックス位置の図形。インデックスが範囲外の場合、エラーがスローされます。

注釈

[ API セット: PowerPointApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/tags/tags.yaml

await PowerPoint.run(async function(context) {
  const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(0);
  const shape: PowerPoint.Shape = slide.shapes.getItemAt(0);
  shape.tags.add("MOUNTAIN", "Denali");

  await context.sync();

  const myShapeTag: PowerPoint.Tag = shape.tags.getItem("MOUNTAIN");
  myShapeTag.load("key, value");

  await context.sync();

  console.log("Added key " + JSON.stringify(myShapeTag.key) + " with value " + JSON.stringify(myShapeTag.value));
});

getItemOrNullObject(id)

一意の ID を使用して図形を取得します。このような図形が存在しない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。

getItemOrNullObject(id: string): PowerPoint.Shape;

パラメーター

id: string

図形の ID。

戻り値

PowerPoint.Shape

一意の ID を持つ図形。このような図形が存在しない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。

注釈

[ API セット: PowerPointApi 1.3 ]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;

パラメーター

options: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

PowerPoint.ShapeCollection

load(propertyNames)

load(propertyNames?: string | string[]): PowerPoint.ShapeCollection;

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

PowerPoint.ShapeCollection

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml

// Changes the transparency of every geometric shape in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the shape transparency to be halfway transparent.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.geometricShape) {
      shape.fill.transparency = 0.5;
    }
  });
  await context.sync();
});

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;

パラメーター

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

PowerPoint.ShapeCollection

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の PowerPoint.ShapeCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.ShapeCollectionDataとして型指定) を返します。

toJSON(): PowerPoint.Interfaces.ShapeCollectionData;

戻り値

PowerPoint.Interfaces.ShapeCollectionData

次の方法で共有

PowerPoint.ShapeCollection class

注釈

例

プロパティ

メソッド

プロパティの詳細

context

プロパティ値

items

プロパティ値

メソッドの詳細

addGeometricShape(geometricShapeType, options)

パラメーター

戻り値

注釈

例

addGeometricShape(geometricShapeTypeString, options)

パラメーター

戻り値

注釈

addLine(connectorType, options)

パラメーター

戻り値

注釈

例

addLine(connectorTypeString, options)

パラメーター

戻り値

注釈

addTextBox(text, options)

パラメーター

戻り値

注釈

例

getCount()

戻り値

注釈

getItem(key)

パラメーター

戻り値

注釈

getItemAt(index)

パラメーター

戻り値

注釈

例

getItemOrNullObject(id)

パラメーター

戻り値

注釈

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

例

load(propertyNamesAndPaths)

パラメーター

戻り値

toJSON()

戻り値

その他のリソース