Excel.ShapeCollection class

ワークシート内のすべての図形のコレクションを表します。Represents a collection of all the shapes in the worksheet.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

Extends

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

items

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

メソッド

addGeometricShape(geometricShapeType)

幾何学的図形をワークシートに追加します。Adds a geometric shape to the worksheet. 新しい図形を表す Shape オブジェクトを返します。Returns a Shape object that represents the new shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addGeometricShape(geometricShapeTypeString)

幾何学的図形をワークシートに追加します。Adds a geometric shape to the worksheet. 新しい図形を表す Shape オブジェクトを返します。Returns a Shape object that represents the new shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addGroup(values)

このコレクションのワークシート内の図形のサブセットをグループ化します。Groups a subset of shapes in this collection's worksheet. 図形の新しいグループを表す Shape オブジェクトを返します。Returns a Shape object that represents the new group of shapes.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addImage(base64ImageString)

base64 エンコード文字列から画像を作成し、それをワークシートに追加します。Creates an image from a base64-encoded string and adds it to the worksheet. 新しい画像を表す Shape オブジェクトを返します。Returns the Shape object that represents the new image.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addLine(startLeft, startTop, endLeft, endTop, connectorType)

ワークシートに行を追加します。Adds a line to worksheet. 新しい行を表す Shape オブジェクトを返します。Returns a Shape object that represents the new line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addLine(startLeft, startTop, endLeft, endTop, connectorTypeString)

ワークシートに行を追加します。Adds a line to worksheet. 新しい行を表す Shape オブジェクトを返します。Returns a Shape object that represents the new line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addSvg(xml)

XML 文字列からスケーラブルなベクター グラフィックス (SVG) を作成し、それをワークシートに追加します。Creates a scalable vector graphic (SVG) from an XML string and adds it to the worksheet. 新しい画像を表す Shape オブジェクトを返します。Returns a Shape object that represents the new image.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

addTextBox(text)

指定されたテキストを含むテキスト ボックスをワークシートに追加します。Adds a text box to the worksheet with the provided text as the content. 新しいテキスト ボックスを表す Shape オブジェクトを返します。Returns a Shape object that represents the new text box.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getCount()

ワークシートの図形数を返します。Returns the number of shapes in the worksheet. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getItem(key)

名前または ID を使用して図形を取得します。Gets a shape using its Name or ID.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getItemAt(index)

コレクション内の位置を使用して図形を取得します。Gets a shape using its position in the collection.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(option)
toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元Excel.ShapeCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.ShapeCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ShapeCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

items

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

readonly items: Excel.Shape[];

プロパティ値

Excel.Shape[]

メソッドの詳細

addGeometricShape(geometricShapeType)

幾何学的図形をワークシートに追加します。Adds a geometric shape to the worksheet. 新しい図形を表す Shape オブジェクトを返します。Returns a Shape object that represents the new shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addGeometricShape(geometricShapeType: Excel.GeometricShapeType): Excel.Shape;

パラメーター

geometricShapeType
Excel.GeometricShapeType

ジオメトリック図形の種類を表します。Represents the type of the geometric shape. 詳細については、Excel.GeometricShapeType をご覧ください。See Excel.GeometricShapeType for details.

戻り値

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.hexagon);
    shape.left = 5;
    shape.top = 5;
    shape.height = 175;
    shape.width = 200;
    await context.sync();
});

addGeometricShape(geometricShapeTypeString)

幾何学的図形をワークシートに追加します。Adds a geometric shape to the worksheet. 新しい図形を表す Shape オブジェクトを返します。Returns a Shape object that represents the new shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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"): Excel.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"

ジオメトリック図形の種類を表します。Represents the type of the geometric shape. 詳細については、Excel.GeometricShapeType をご覧ください。See Excel.GeometricShapeType for details.

戻り値

addGroup(values)

このコレクションのワークシート内の図形のサブセットをグループ化します。Groups a subset of shapes in this collection's worksheet. 図形の新しいグループを表す Shape オブジェクトを返します。Returns a Shape object that represents the new group of shapes.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addGroup(values: Array<string | Shape>): Excel.Shape;

パラメーター

values
Array<string | Shape>

図形 ID または図形オブジェクトの配列。An array of shape ID or shape objects.

戻り値

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const square = sheet.shapes.getItem("Square");
    const pentagon = sheet.shapes.getItem("Pentagon");
    const octagon = sheet.shapes.getItem("Octagon");

    const shapeGroup = sheet.shapes.addGroup([square, pentagon, octagon]);
    shapeGroup.name = "Group";
    console.log("Shapes grouped");

    await context.sync();
});

addImage(base64ImageString)

base64 エンコード文字列から画像を作成し、それをワークシートに追加します。Creates an image from a base64-encoded string and adds it to the worksheet. 新しい画像を表す Shape オブジェクトを返します。Returns the Shape object that represents the new image.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addImage(base64ImageString: string): Excel.Shape;

パラメーター

base64ImageString
string

JPEG または PNG 形式のイメージを表す、base64 でエンコードされた文字列。A base64-encoded string representing an image in either JPEG or PNG format.

戻り値

Examples

const myFile = <HTMLInputElement>document.getElementById("selectedFile");
const reader = new FileReader();

reader.onload = (event) => {
    Excel.run((context) => {
        const startIndex = (<string>(<FileReader>event.target).result).indexOf("base64,");
        const mybase64 = (<string>(<FileReader>event.target).result).substr(startIndex + 7);
        const sheet = context.workbook.worksheets.getItem("Shapes");
        const image = sheet.shapes.addImage(mybase64);
        image.name = "Image";
        return context.sync();
    });
};

// Read in the image file as a data URL.
reader.readAsDataURL(myFile.files[0]);

addLine(startLeft, startTop, endLeft, endTop, connectorType)

ワークシートに行を追加します。Adds a line to worksheet. 新しい行を表す Shape オブジェクトを返します。Returns a Shape object that represents the new line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: Excel.ConnectorType): Excel.Shape;

パラメーター

startLeft
number

ワークシートの左端から左端までの距離をポイント単位で指定します。The distance, in points, from the start of the line to the left side of the worksheet.

startTop
number

ワークシートの上端から、行の先頭までの距離をポイント単位で指定します。The distance, in points, from the start of the line to the top of the worksheet.

endLeft
number

ワークシートの左端の線の終点からの距離をポイント単位で指定します。The distance, in points, from the end of the line to the left of the worksheet.

endTop
number

ワークシートの上端から、行の末尾までの距離をポイント単位で指定します。The distance, in points, from the end of the line to the top of the worksheet.

connectorType
Excel.ConnectorType

コネクタの種類を表します。Represents the connector type. 詳細については、「ConnectorType」を参照してください。See Excel.ConnectorType for details.

戻り値

Examples

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const line = shapes.addLine(200, 50, 300, 150, Excel.ConnectorType.straight);
    line.name = "StraightLine";
    await context.sync();
});

addLine(startLeft, startTop, endLeft, endTop, connectorTypeString)

ワークシートに行を追加します。Adds a line to worksheet. 新しい行を表す Shape オブジェクトを返します。Returns a Shape object that represents the new line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorTypeString?: "Straight" | "Elbow" | "Curve"): Excel.Shape;

パラメーター

startLeft
number

ワークシートの左端から左端までの距離をポイント単位で指定します。The distance, in points, from the start of the line to the left side of the worksheet.

startTop
number

ワークシートの上端から、行の先頭までの距離をポイント単位で指定します。The distance, in points, from the start of the line to the top of the worksheet.

endLeft
number

ワークシートの左端の線の終点からの距離をポイント単位で指定します。The distance, in points, from the end of the line to the left of the worksheet.

endTop
number

ワークシートの上端から、行の末尾までの距離をポイント単位で指定します。The distance, in points, from the end of the line to the top of the worksheet.

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

コネクタの種類を表します。Represents the connector type. 詳細については、「ConnectorType」を参照してください。See Excel.ConnectorType for details.

戻り値

addSvg(xml)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

XML 文字列からスケーラブルなベクター グラフィックス (SVG) を作成し、それをワークシートに追加します。Creates a scalable vector graphic (SVG) from an XML string and adds it to the worksheet. 新しい画像を表す Shape オブジェクトを返します。Returns a Shape object that represents the new image.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

addSvg(xml: string): Excel.Shape;

パラメーター

xml
string

SVG を表す XML 文字列。An XML string that represents the SVG.

戻り値

addTextBox(text)

指定されたテキストを含むテキスト ボックスをワークシートに追加します。Adds a text box to the worksheet with the provided text as the content. 新しいテキスト ボックスを表す Shape オブジェクトを返します。Returns a Shape object that represents the new text box.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addTextBox(text?: string): Excel.Shape;

パラメーター

text
string

[作成済み] テキストボックスに表示されるテキストを表します。Represents the text that will be shown in the created text box.

戻り値

Examples

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const textbox = shapes.addTextBox("A box with text");
    textbox.left = 100;
    textbox.top = 100;
    textbox.height = 20;
    textbox.width = 175;
    textbox.name = "Textbox";
    await context.sync();
});

getCount()

ワークシートの図形数を返します。Returns the number of shapes in the worksheet. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

getItem(key)

名前または ID を使用して図形を取得します。Gets a shape using its Name or ID.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getItem(key: string): Excel.Shape;

パラメーター

key
string

取得する図形の名前または ID を指定します。Name or ID of the shape to be retrieved.

戻り値

getItemAt(index)

コレクション内の位置を使用して図形を取得します。Gets a shape using its position in the collection.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getItemAt(index: number): Excel.Shape;

パラメーター

index
number

取得する図形の0から始まるインデックスを指定します。The zero-based index of the shape to be retrieved.

戻り値

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.ShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ShapeCollection;

パラメーター

option
Excel.Interfaces.ShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.ShapeCollection-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.ShapeCollection - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.ShapeCollection-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.ShapeCollection - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeCollection-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeCollection - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(option)

load(option?: OfficeExtension.LoadOption): Excel.ShapeCollection;

パラメーター

戻り値

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元Excel.ShapeCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.ShapeCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ShapeCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.ShapeCollectionData;

戻り値