Excel.Shape class

ワークシートの標準図形オブジェクトを表します。Represents a generic shape object in the worksheet. 図形とは、幾何学的な図形、線、図形のグループなどのことです。A shape could be a geometric shape, a line, a group of shapes, etc.

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

Extends

プロパティ

altTextDescription

Shape オブジェクトの代替説明テキストを取得または設定します。Returns or sets the alternative description text for a Shape object.

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

altTextTitle

Shape オブジェクトの代替タイトル テキストを取得または設定します。Returns or sets the alternative title text for a Shape object.

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

connectionSiteCount

この図形の結合点の数を返します。Returns the number of connection sites on this shape. 読み取り専用です。Read-only.

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

context

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

fill

この図形の塗りつぶしの書式設定を返します。Returns the fill formatting of this shape. 読み取り専用です。Read-only.

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

geometricShape

図形に関連付けられた幾何学的図形を返します。Returns the geometric shape associated with the shape. 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。An error will be thrown if the shape type is not "GeometricShape".

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

geometricShapeType

この幾何学的図形の種類を表します。Represents the geometric shape type of this geometric shape. 詳細については、Excel.GeometricShapeType をご覧ください。See Excel.GeometricShapeType for details. 図形の種類が "GeometricShape" ではない場合は、null を返します。Returns null if the shape type is not "GeometricShape".

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

group

図形に関連付けられた図形グループを返します。Returns the shape group associated with the shape. 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。An error will be thrown if the shape type is not "GroupShape".

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

height

図形の高さをポイント数で表します。Represents the height, in points, of the shape. 負の値を設定した場合、または入力に0を指定した場合、無効な引数の例外がスローされます。Throws an invalid argument exception when set with a negative value or zero as input.

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

id

図形 ID を表します。Represents the shape identifier. 読み取り専用です。Read-only.

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

image

図形に関連付けられた画像を返します。Returns the image associated with the shape. 図形の種類が "Image" ではない場合は、エラーがスローされます。An error will be thrown if the shape type is not "Image".

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

left

図形の左側からワークシートの左側までの距離 (ポイント数) です。The distance, in points, from the left side of the shape to the left side of the worksheet. 入力として負の値を設定すると、無効な引数の例外がスローされます。Throws an invalid argument exception when set with a negative value as input.

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

level

指定された図形のレベルを表します。Represents the level of the specified shape. たとえば、レベル 0 は図形がどのグループの一部でもないことを意味し、レベル 1 は図形が最上位グループの一部であることを意味し、レベル 2 は図形が最上位レベルのサブグループの一部であることを意味します。For example, a level of 0 means that the shape is not part of any groups, a level of 1 means the shape is part of a top-level group, and a level of 2 means the shape is part of a sub-group of the top level.

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

line

図形に関連付けられた線を返します。Returns the line associated with the shape. 図形の種類が "Line" ではない場合は、エラーがスローされます。An error will be thrown if the shape type is not "Line".

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

lineFormat

この図形の線の書式設定を返します。Returns the line formatting of this shape. 読み取り専用です。Read-only.

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

lockAspectRatio

この図形の縦横比をロックするかどうかを指定します。Specifies whether or not the aspect ratio of this shape is locked.

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

name

図形の名前を表します。Represents the name of the shape.

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

parentGroup

この図形の親グループを表します。Represents the parent group of this shape.

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

placement

オブジェクトがその下のセルに接続されている方法を表します。Represents how the object is attached to the cells below it.

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

rotation

図形の回転を角度で表します。Represents the rotation, in degrees, of the shape.

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

textFrame

この図形のテキスト フレーム オブジェクトを返します。Returns the text frame object of this shape. 読み取り専用です。Read only.

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

top

図形の上端からワークシートの上までのポイント単位の距離です。The distance, in points, from the top edge of the shape to the top edge of the worksheet. 入力として負の値を設定すると、無効な引数の例外がスローされます。Throws an invalid argument exception when set with a negative value as input.

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

type

この図形の種類を返します。Returns the type of this shape. 詳細については、Excel.ShapeType をご覧ください。See Excel.ShapeType for details. 読み取り専用です。Read-only.

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

visible

この図形の可視性を表します。Represents the visibility of this shape.

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

width

図形の幅 (ポイント数) を表します。Represents the width, in points, of the shape. 負の値を設定した場合、または入力に0を指定した場合、無効な引数の例外がスローされます。Throws an invalid argument exception when set with a negative value or zero as input.

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

zOrderPosition

指定された図形の z オーダーでの位置を返します。0 はオーダー スタックの一番下を表します。Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack. 読み取り専用です。Read-only.

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

メソッド

copyTo(destinationSheet)

Shape オブジェクトをコピーして貼り付けます。Copies and pastes a Shape object. 貼り付けられた図形は、この図形と同じピクセル位置にコピーされます。The pasted shape is copied to the same pixel location as this shape.

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

delete()

ワークシートから図形を削除します。Removes the shape from the worksheet.

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

getAsImage(format)

図形を画像に変換し、base 64 でエンコードされた文字列として画像を返します。Converts the shape to an image and returns the image as a base64-encoded string. DPI は 96 です。The DPI is 96. サポートされている形式は、Excel.PictureFormat.BMPThe only supported formats are Excel.PictureFormat.BMP, Excel.PictureFormat.PNG, Excel.PictureFormat.JPEGそしてExcel.PictureFormat.GIF, and Excel.PictureFormat.GIF.

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

getAsImage(formatString)

図形を画像に変換し、base 64 でエンコードされた文字列として画像を返します。Converts the shape to an image and returns the image as a base64-encoded string. DPI は 96 です。The DPI is 96. サポートされている形式は、Excel.PictureFormat.BMPThe only supported formats are Excel.PictureFormat.BMP, Excel.PictureFormat.PNG, Excel.PictureFormat.JPEGそしてExcel.PictureFormat.GIF, and Excel.PictureFormat.GIF.

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

incrementLeft(increment)

指定したポイント数だけ水平方向に図形を移動します。Moves the shape horizontally by the specified number of points.

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

incrementRotation(increment)

z 軸を中心に、指定された度数だけ、図形を時計回りに回転します。Rotates the shape clockwise around the z-axis by the specified number of degrees. 図形のrotation絶対回転角度を設定するには、プロパティを使用します。Use the rotation property to set the absolute rotation of the shape.

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

incrementTop(increment)

指定したポイント数だけ垂直方向に図形を移動します。Moves the shape vertically by the specified number of points.

[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(propertyNamesAndPaths)

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

scaleHeight(scaleFactor, scaleType, scaleFrom)

指定した係数分だけ図形の高さを変更します。Scales the height of the shape by a specified factor. 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。For images, you can indicate whether you want to scale the shape relative to the original or the current size. 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。Shapes other than pictures are always scaled relative to their current height.

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

scaleHeight(scaleFactor, scaleTypeString, scaleFrom)

指定した係数分だけ図形の高さを変更します。Scales the height of the shape by a specified factor. 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。For images, you can indicate whether you want to scale the shape relative to the original or the current size. 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。Shapes other than pictures are always scaled relative to their current height.

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

scaleWidth(scaleFactor, scaleType, scaleFrom)

指定した係数分だけ図形の幅を変更します。Scales the width of the shape by a specified factor. 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。For images, you can indicate whether you want to scale the shape relative to the original or the current size. 画像以外の図形の場合は、常に現在の幅に対して拡大または縮小されます。Shapes other than pictures are always scaled relative to their current width.

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

scaleWidth(scaleFactor, scaleTypeString, scaleFrom)

指定した係数分だけ図形の幅を変更します。Scales the width of the shape by a specified factor. 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。For images, you can indicate whether you want to scale the shape relative to the original or the current size. 画像以外の図形の場合は、常に現在の幅に対して拡大または縮小されます。Shapes other than pictures are always scaled relative to their current width.

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

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

setZOrder(position)

指定された図形をコレクションの z オーダーで上または下に移動します。他の図形の手前または奥に移動します。Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.

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

setZOrder(positionString)

指定された図形をコレクションの z オーダーで上または下に移動します。他の図形の手前または奥に移動します。Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.

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

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オブジェクトのメソッドを呼び出します。元の Shape オブジェクトは API オブジェクトであるのに対してtoJSON 、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.ShapeData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Shape object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

イベント

onActivated

図形がアクティブになったときに発生します。Occurs when the shape is activated.

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

onDeactivated

図形が非アクティブになると発生します。Occurs when the shape is deactivated.

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

プロパティの詳細

altTextDescription

Shape オブジェクトの代替説明テキストを取得または設定します。Returns or sets the alternative description text for a Shape object.

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

altTextDescription: string;

プロパティ値

string

altTextTitle

Shape オブジェクトの代替タイトル テキストを取得または設定します。Returns or sets the alternative title text for a Shape object.

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

altTextTitle: string;

プロパティ値

string

connectionSiteCount

この図形の結合点の数を返します。Returns the number of connection sites on this shape. 読み取り専用です。Read-only.

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

readonly connectionSiteCount: number;

プロパティ値

number

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

fill

この図形の塗りつぶしの書式設定を返します。Returns the fill formatting of this shape. 読み取り専用です。Read-only.

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

readonly fill: Excel.ShapeFill;

プロパティ値

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.smileyFace);
    shape.left = 300;
    shape.top = 100;
    shape.height = 100;
    shape.width = 100;
    shape.fill.foregroundColor = "yellow"
    await context.sync();
});

geometricShape

図形に関連付けられた幾何学的図形を返します。Returns the geometric shape associated with the shape. 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。An error will be thrown if the shape type is not "GeometricShape".

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

readonly geometricShape: Excel.GeometricShape;

プロパティ値

geometricShapeType

この幾何学的図形の種類を表します。Represents the geometric shape type of this geometric shape. 詳細については、Excel.GeometricShapeType をご覧ください。See Excel.GeometricShapeType for details. 図形の種類が "GeometricShape" ではない場合は、null を返します。Returns null if the shape type is not "GeometricShape".

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

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

group

図形に関連付けられた図形グループを返します。Returns the shape group associated with the shape. 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。An error will be thrown if the shape type is not "GroupShape".

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

readonly group: Excel.ShapeGroup;

プロパティ値

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");

    const shapeGroup = sheet.shapes.getItem("Group").group;
    shapeGroup.ungroup();
    console.log("Shapes ungrouped");

    await context.sync();
});

height

図形の高さをポイント数で表します。Represents the height, in points, of the shape. 負の値を設定した場合、または入力に0を指定した場合、無効な引数の例外がスローされます。Throws an invalid argument exception when set with a negative value or zero as input.

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

height: number;

プロパティ値

number

id

図形 ID を表します。Represents the shape identifier. 読み取り専用です。Read-only.

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

readonly id: string;

プロパティ値

string

image

図形に関連付けられた画像を返します。Returns the image associated with the shape. 図形の種類が "Image" ではない場合は、エラーがスローされます。An error will be thrown if the shape type is not "Image".

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

readonly image: Excel.Image;

プロパティ値

left

図形の左側からワークシートの左側までの距離 (ポイント数) です。The distance, in points, from the left side of the shape to the left side of the worksheet. 入力として負の値を設定すると、無効な引数の例外がスローされます。Throws an invalid argument exception when set with a negative value as input.

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

left: number;

プロパティ値

number

level

指定された図形のレベルを表します。Represents the level of the specified shape. たとえば、レベル 0 は図形がどのグループの一部でもないことを意味し、レベル 1 は図形が最上位グループの一部であることを意味し、レベル 2 は図形が最上位レベルのサブグループの一部であることを意味します。For example, a level of 0 means that the shape is not part of any groups, a level of 1 means the shape is part of a top-level group, and a level of 2 means the shape is part of a sub-group of the top level.

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

readonly level: number;

プロパティ値

number

line

図形に関連付けられた線を返します。Returns the line associated with the shape. 図形の種類が "Line" ではない場合は、エラーがスローされます。An error will be thrown if the shape type is not "Line".

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

readonly line: Excel.Line;

プロパティ値

Examples

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const line = shapes.getItem("StraightLine").line;
    line.beginArrowheadLength = Excel.ArrowheadLength.long;
    line.beginArrowheadWidth = Excel.ArrowheadWidth.wide;
    line.beginArrowheadStyle = Excel.ArrowheadStyle.oval;

    line.endArrowheadLength = Excel.ArrowheadLength.long;
    line.endArrowheadWidth = Excel.ArrowheadWidth.wide;
    line.endArrowheadStyle = Excel.ArrowheadStyle.triangle;

    await context.sync();
});

lineFormat

この図形の線の書式設定を返します。Returns the line formatting of this shape. 読み取り専用です。Read-only.

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

readonly lineFormat: Excel.ShapeLineFormat;

プロパティ値

lockAspectRatio

この図形の縦横比をロックするかどうかを指定します。Specifies whether or not the aspect ratio of this shape is locked.

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

lockAspectRatio: boolean;

プロパティ値

boolean

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Octagon")
    shape.lockAspectRatio = true;
    shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize);
    await context.sync();
});

name

図形の名前を表します。Represents the name of the shape.

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

name: string;

プロパティ値

string

parentGroup

この図形の親グループを表します。Represents the parent group of this shape.

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

readonly parentGroup: Excel.Shape;

プロパティ値

placement

注意

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

オブジェクトがその下のセルに接続されている方法を表します。Represents how the object is attached to the cells below it.

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

placement: Excel.Placement | "TwoCell" | "OneCell" | "Absolute";

プロパティ値

Excel.Placement | "TwoCell" | "OneCell" | "Absolute"

rotation

図形の回転を角度で表します。Represents the rotation, in degrees, of the shape.

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

rotation: number;

プロパティ値

number

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.triangle);
    shape.left = 100;
    shape.top = 300;
    shape.height = 150;
    shape.width = 200;
    shape.rotation = 45;
    shape.fill.clear();
    await context.sync();
});

textFrame

この図形のテキスト フレーム オブジェクトを返します。Returns the text frame object of this shape. 読み取り専用です。Read only.

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

readonly textFrame: Excel.TextFrame;

プロパティ値

top

図形の上端からワークシートの上までのポイント単位の距離です。The distance, in points, from the top edge of the shape to the top edge of the worksheet. 入力として負の値を設定すると、無効な引数の例外がスローされます。Throws an invalid argument exception when set with a negative value as input.

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

top: number;

プロパティ値

number

type

この図形の種類を返します。Returns the type of this shape. 詳細については、Excel.ShapeType をご覧ください。See Excel.ShapeType for details. 読み取り専用です。Read-only.

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

readonly type: Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";

プロパティ値

Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line"

visible

この図形の可視性を表します。Represents the visibility of this shape.

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

visible: boolean;

プロパティ値

boolean

width

図形の幅 (ポイント数) を表します。Represents the width, in points, of the shape. 負の値を設定した場合、または入力に0を指定した場合、無効な引数の例外がスローされます。Throws an invalid argument exception when set with a negative value or zero as input.

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

width: number;

プロパティ値

number

zOrderPosition

指定された図形の z オーダーでの位置を返します。0 はオーダー スタックの一番下を表します。Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack. 読み取り専用です。Read-only.

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

readonly zOrderPosition: number;

プロパティ値

number

メソッドの詳細

copyTo(destinationSheet)

注意

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

Shape オブジェクトをコピーして貼り付けます。Copies and pastes a Shape object. 貼り付けられた図形は、この図形と同じピクセル位置にコピーされます。The pasted shape is copied to the same pixel location as this shape.

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

copyTo(destinationSheet?: Worksheet | string): Excel.Shape;

パラメーター

destinationSheet
Worksheet | string

Shape オブジェクトの貼り付け先となるシートを指定します。The sheet to which the shape object will be pasted. 既定値は、コピーされた図形のワークシートです。The default value is the copied Shape's worksheet.

戻り値

delete()

ワークシートから図形を削除します。Removes the shape from the worksheet.

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

delete(): void;

戻り値

void

Examples

await Excel.run(async (context) => {
    context.workbook.worksheets.getItemOrNullObject("Shapes").delete();
    const sheet = context.workbook.worksheets.add("Shapes");

    const shapes = sheet.shapes;

    // load all the shapes in the collection without loading their properties
    shapes.load("items/$none");
    await context.sync();

    shapes.items.forEach((shape) => shape.delete());
    await context.sync();
});

getAsImage(format)

図形を画像に変換し、base 64 でエンコードされた文字列として画像を返します。Converts the shape to an image and returns the image as a base64-encoded string. DPI は 96 です。The DPI is 96. サポートされている形式は、Excel.PictureFormat.BMPThe only supported formats are Excel.PictureFormat.BMP, Excel.PictureFormat.PNG, Excel.PictureFormat.JPEGそしてExcel.PictureFormat.GIF, and Excel.PictureFormat.GIF.

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

getAsImage(format: Excel.PictureFormat): OfficeExtension.ClientResult<string>;

パラメーター

format
Excel.PictureFormat

画像の形式を指定します。Specifies the format of the image.

戻り値

OfficeExtension.ClientResult<string>

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Image");
    const result = shape.getAsImage(Excel.PictureFormat.png);
    await context.sync();

    const imageString = result.value;
    // Your add-in would save this string as a .png file.
    console.log("The image's base64-encoded string: " + imageString);
});

getAsImage(formatString)

図形を画像に変換し、base 64 でエンコードされた文字列として画像を返します。Converts the shape to an image and returns the image as a base64-encoded string. DPI は 96 です。The DPI is 96. サポートされている形式は、Excel.PictureFormat.BMPThe only supported formats are Excel.PictureFormat.BMP, Excel.PictureFormat.PNG, Excel.PictureFormat.JPEGそしてExcel.PictureFormat.GIF, and Excel.PictureFormat.GIF.

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

getAsImage(formatString: "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"): OfficeExtension.ClientResult<string>;

パラメーター

formatString
"UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"

画像の形式を指定します。Specifies the format of the image.

戻り値

OfficeExtension.ClientResult<string>

incrementLeft(increment)

指定したポイント数だけ水平方向に図形を移動します。Moves the shape horizontally by the specified number of points.

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

incrementLeft(increment: number): void;

パラメーター

increment
number

図形を水平方向に移動するには、ポイント単位で指定します。The increment, in points, the shape will be horizontally moved. 正の値を指定すると図形は右に移動し、負の値を指定すると左に移動します。A positive value moves the shape to the right and a negative value moves it to the left. シートの方向が右から左の場合、正の値を指定すると、図形は左に移動し、負の値を指定すると右に移動します。If the sheet is right-to-left oriented, this is reversed: positive values will move the shape to the left and negative values will move it to the right.

戻り値

void

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Square")
    shape.incrementLeft(-25);
    await context.sync();
});

incrementRotation(increment)

z 軸を中心に、指定された度数だけ、図形を時計回りに回転します。Rotates the shape clockwise around the z-axis by the specified number of degrees. 図形のrotation絶対回転角度を設定するには、プロパティを使用します。Use the rotation property to set the absolute rotation of the shape.

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

incrementRotation(increment: number): void;

パラメーター

increment
number

図形を回転する角度を指定します。How many degrees the shape will be rotated. 正の値を指定すると図形は時計回りに回転し、負の値を指定すると反時計回りに回転します。A positive value rotates the shape clockwise; a negative value rotates it counterclockwise.

戻り値

void

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Image");
    shape.incrementRotation(180);
    await context.sync();
});

incrementTop(increment)

指定したポイント数だけ垂直方向に図形を移動します。Moves the shape vertically by the specified number of points.

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

incrementTop(increment: number): void;

パラメーター

increment
number

図形を垂直方向に移動するには、ポイント単位で指定します。The increment, in points, the shape will be vertically moved. をポイント単位で指定します。in points. 正の値を指定すると図形は下に移動し、負の値を指定すると上に移動します。A positive value moves the shape down and a negative value moves it up.

戻り値

void

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Pentagon")
    shape.incrementTop(25);
    await context.sync();
});

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.ShapeLoadOptions): Excel.Shape;

パラメーター

戻り値

注釈

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

load(option?: string | string[]): Excel.Shape-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.Shape - 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.Shape-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.Shape - 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.Shape-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Shape - 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.Shape;

パラメーター

propertyNames
string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Shape;

パラメーター

propertyNamesAndPaths
{ select?: string; expand?: string; }

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

戻り値

scaleHeight(scaleFactor, scaleType, scaleFrom)

指定した係数分だけ図形の高さを変更します。Scales the height of the shape by a specified factor. 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。For images, you can indicate whether you want to scale the shape relative to the original or the current size. 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。Shapes other than pictures are always scaled relative to their current height.

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

scaleHeight(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom): void;

パラメーター

scaleFactor
number

現在の高さと変更後の高さの比率、または元の高さと変更後の高さの比率を指定します。Specifies the ratio between the height of the shape after you resize it and the current or original height.

scaleType
Excel.ShapeScaleType

図形を元のサイズに対して拡大または縮小するかを指定します。Specifies whether the shape is scaled relative to its original or current size. 元のサイズスケーリングオプションは、イメージに対してのみ機能します。The original size scaling option only works for images.

scaleFrom
Excel.ShapeScaleFrom

省略可能。Optional. 図形を拡大縮小する場合、図形の位置を保持する部分を指定します。Specifies which part of the shape retains its position when the shape is scaled. 省略すると、図形の左上隅の位置を保持します。If omitted, it represents the shape's upper left corner retains its position.

戻り値

void

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Octagon")
    shape.lockAspectRatio = true;
    shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize);
    await context.sync();
});

scaleHeight(scaleFactor, scaleTypeString, scaleFrom)

指定した係数分だけ図形の高さを変更します。Scales the height of the shape by a specified factor. 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。For images, you can indicate whether you want to scale the shape relative to the original or the current size. 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。Shapes other than pictures are always scaled relative to their current height.

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

scaleHeight(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;

パラメーター

scaleFactor
number

現在の高さと変更後の高さの比率、または元の高さと変更後の高さの比率を指定します。Specifies the ratio between the height of the shape after you resize it and the current or original height.

scaleTypeString
"CurrentSize" | "OriginalSize"

図形を元のサイズに対して拡大または縮小するかを指定します。Specifies whether the shape is scaled relative to its original or current size. 元のサイズスケーリングオプションは、イメージに対してのみ機能します。The original size scaling option only works for images.

scaleFrom
"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"

省略可能。Optional. 図形を拡大縮小する場合、図形の位置を保持する部分を指定します。Specifies which part of the shape retains its position when the shape is scaled. 省略すると、図形の左上隅の位置を保持します。If omitted, it represents the shape's upper left corner retains its position.

戻り値

void

scaleWidth(scaleFactor, scaleType, scaleFrom)

指定した係数分だけ図形の幅を変更します。Scales the width of the shape by a specified factor. 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。For images, you can indicate whether you want to scale the shape relative to the original or the current size. 画像以外の図形の場合は、常に現在の幅に対して拡大または縮小されます。Shapes other than pictures are always scaled relative to their current width.

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

scaleWidth(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom): void;

パラメーター

scaleFactor
number

現在の幅と変更後の幅の比率、または元の幅と変更後の幅の比率を指定します。Specifies the ratio between the width of the shape after you resize it and the current or original width.

scaleType
Excel.ShapeScaleType

図形を元のサイズに対して拡大または縮小するかを指定します。Specifies whether the shape is scaled relative to its original or current size. 元のサイズスケーリングオプションは、イメージに対してのみ機能します。The original size scaling option only works for images.

scaleFrom
Excel.ShapeScaleFrom

省略可能。Optional. 図形を拡大縮小する場合、図形の位置を保持する部分を指定します。Specifies which part of the shape retains its position when the shape is scaled. 省略すると、図形の左上隅の位置を保持します。If omitted, it represents the shape's upper left corner retains its position.

戻り値

void

scaleWidth(scaleFactor, scaleTypeString, scaleFrom)

指定した係数分だけ図形の幅を変更します。Scales the width of the shape by a specified factor. 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。For images, you can indicate whether you want to scale the shape relative to the original or the current size. 画像以外の図形の場合は、常に現在の幅に対して拡大または縮小されます。Shapes other than pictures are always scaled relative to their current width.

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

scaleWidth(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;

パラメーター

scaleFactor
number

現在の幅と変更後の幅の比率、または元の幅と変更後の幅の比率を指定します。Specifies the ratio between the width of the shape after you resize it and the current or original width.

scaleTypeString
"CurrentSize" | "OriginalSize"

図形を元のサイズに対して拡大または縮小するかを指定します。Specifies whether the shape is scaled relative to its original or current size. 元のサイズスケーリングオプションは、イメージに対してのみ機能します。The original size scaling option only works for images.

scaleFrom
"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"

省略可能。Optional. 図形を拡大縮小する場合、図形の位置を保持する部分を指定します。Specifies which part of the shape retains its position when the shape is scaled. 省略すると、図形の左上隅の位置を保持します。If omitted, it represents the shape's upper left corner retains its position.

戻り値

void

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties
Interfaces.ShapeUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.Shape): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Shape): void;

パラメーター

properties
Excel.Shape

戻り値

void

setZOrder(position)

指定された図形をコレクションの z オーダーで上または下に移動します。他の図形の手前または奥に移動します。Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.

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

setZOrder(position: Excel.ShapeZOrder): void;

パラメーター

position
Excel.ShapeZOrder

他の図形を基準にして z オーダーのスタック内の図形を移動する位置を指定します。Where to move the shape in the z-order stack relative to the other shapes. 詳細については、「Excel のスナップショット注文」を参照してください。See Excel.ShapeZOrder for details.

戻り値

void

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Octagon")
    shape.setZOrder(Excel.ShapeZOrder.sendBackward);
    await context.sync();
});

setZOrder(positionString)

指定された図形をコレクションの z オーダーで上または下に移動します。他の図形の手前または奥に移動します。Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.

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

setZOrder(positionString: "BringToFront" | "BringForward" | "SendToBack" | "SendBackward"): void;

パラメーター

positionString
"BringToFront" | "BringForward" | "SendToBack" | "SendBackward"

他の図形を基準にして z オーダーのスタック内の図形を移動する位置を指定します。Where to move the shape in the z-order stack relative to the other shapes. 詳細については、「Excel のスナップショット注文」を参照してください。See Excel.ShapeZOrder for details.

戻り値

void

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オブジェクトのメソッドを呼び出します。元の Shape オブジェクトは API オブジェクトであるのに対してtoJSON 、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.ShapeData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Shape object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ShapeData;

戻り値

イベントの詳細

onActivated

図形がアクティブになったときに発生します。Occurs when the shape is activated.

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

readonly onActivated: OfficeExtension.EventHandlers<Excel.ShapeActivatedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.ShapeActivatedEventArgs>

onDeactivated

図形が非アクティブになると発生します。Occurs when the shape is deactivated.

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

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ShapeDeactivatedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.ShapeDeactivatedEventArgs>