Excel.Interfaces.ShapeLoadOptions interface

ワークシート内のジェネリック図形オブジェクトを表します。 図形には、幾何学的図形、線、図形のグループなどがあります。図形オブジェクト モデルの詳細については、「 Excel JavaScript API を使用した図形の操作」を参照してください。

注釈

[ API セット: ExcelApi 1.9 ]

プロパティ

$all

LoadOptions を指定すると $all 、すべてのスカラー プロパティ (例: Range.address) が読み込まれますが、ナビゲーション プロパティ (例: Range.format.fill.color) は読み込まれません。

altTextDescription

オブジェクトの代替説明テキストを Shape 指定します。

altTextTitle

オブジェクトの代替タイトル テキストを Shape 指定します。

connectionSiteCount

この図形の結合点の数を返します。

displayName

図形の表示名を取得します。 新しく作成された図形には、ローカライズされ、その nameと一致しない可能性がある生成された名前があります。 このシナリオでは、この API を使用して、UI に表示される名前を取得できます。

fill

この図形の塗りつぶしの書式設定を返します。

geometricShape

図形に関連付けられた幾何学的図形を返します。 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。

geometricShapeType

このジオメトリ シェイプのジオメトリ シェイプ タイプを指定します。 詳細は「Excel.GeometricShapeType」をご覧ください。 図形の null 種類が "GeometrShape" でない場合は を返します。

group

図形に関連付けられた図形グループを返します。 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。

height

図形の高さをポイント単位で指定します。 負の InvalidArgument 値または 0 を入力として設定すると、例外がスローされます。

id

図形識別子を指定します。

image

図形に関連付けられた画像を返します。 図形の種類が "Image" ではない場合は、エラーがスローされます。

left

図形の左側からワークシートの左側までの距離 (ポイント数) です。 負の値を InvalidArgument 入力として設定すると、例外がスローされます。

level

指定した図形のレベルを指定します。 たとえば、レベル 0 は図形がどのグループの一部でもないことを意味し、レベル 1 は図形が最上位グループの一部であることを意味し、レベル 2 は図形が最上位レベルのサブグループの一部であることを意味します。

line

図形に関連付けられた線を返します。 図形の種類が "Line" ではない場合は、エラーがスローされます。

lineFormat

この図形の線の書式設定を返します。

lockAspectRatio

この図形の縦横比がロックされているかどうかを指定します。

name

図形の名前を指定します。

parentGroup

この図形の親グループを指定します。

placement

オブジェクトがその下のセルに接続されている方法を表します。

rotation

図形の回転を度単位で指定します。

textFrame

この図形のテキスト フレーム オブジェクトを返します。

top

図形の上端からワークシートの上までのポイント単位の距離です。 負の値を InvalidArgument 入力として設定すると、例外がスローされます。

type

この図形の種類を返します。 詳細は「Excel.ShapeType」をご覧ください。

visible

図形を表示するかどうかを指定します。

width

図形の幅をポイント単位で指定します。 負の InvalidArgument 値または 0 を入力として設定すると、例外がスローされます。

zOrderPosition

指定された図形の z オーダーでの位置を返します。0 はオーダー スタックの一番下を表します。

プロパティの詳細

$all

LoadOptions を指定すると $all 、すべてのスカラー プロパティ (例: Range.address) が読み込まれますが、ナビゲーション プロパティ (例: Range.format.fill.color) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

altTextDescription

オブジェクトの代替説明テキストを Shape 指定します。

altTextDescription?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

altTextTitle

オブジェクトの代替タイトル テキストを Shape 指定します。

altTextTitle?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

connectionSiteCount

この図形の結合点の数を返します。

connectionSiteCount?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

displayName

図形の表示名を取得します。 新しく作成された図形には、ローカライズされ、その nameと一致しない可能性がある生成された名前があります。 このシナリオでは、この API を使用して、UI に表示される名前を取得できます。

displayName?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.15 ]

fill

この図形の塗りつぶしの書式設定を返します。

fill?: Excel.Interfaces.ShapeFillLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

geometricShape

図形に関連付けられた幾何学的図形を返します。 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。

geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

geometricShapeType

このジオメトリ シェイプのジオメトリ シェイプ タイプを指定します。 詳細は「Excel.GeometricShapeType」をご覧ください。 図形の null 種類が "GeometrShape" でない場合は を返します。

geometricShapeType?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

group

図形に関連付けられた図形グループを返します。 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。

group?: Excel.Interfaces.ShapeGroupLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

height

図形の高さをポイント単位で指定します。 負の InvalidArgument 値または 0 を入力として設定すると、例外がスローされます。

height?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

id

図形識別子を指定します。

id?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

image

図形に関連付けられた画像を返します。 図形の種類が "Image" ではない場合は、エラーがスローされます。

image?: Excel.Interfaces.ImageLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

left

図形の左側からワークシートの左側までの距離 (ポイント数) です。 負の値を InvalidArgument 入力として設定すると、例外がスローされます。

left?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

level

指定した図形のレベルを指定します。 たとえば、レベル 0 は図形がどのグループの一部でもないことを意味し、レベル 1 は図形が最上位グループの一部であることを意味し、レベル 2 は図形が最上位レベルのサブグループの一部であることを意味します。

level?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

line

図形に関連付けられた線を返します。 図形の種類が "Line" ではない場合は、エラーがスローされます。

line?: Excel.Interfaces.LineLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

lineFormat

この図形の線の書式設定を返します。

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

lockAspectRatio

この図形の縦横比がロックされているかどうかを指定します。

lockAspectRatio?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

name

図形の名前を指定します。

name?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

parentGroup

この図形の親グループを指定します。

parentGroup?: Excel.Interfaces.ShapeLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

placement

オブジェクトがその下のセルに接続されている方法を表します。

placement?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.10 ]

rotation

図形の回転を度単位で指定します。

rotation?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

textFrame

この図形のテキスト フレーム オブジェクトを返します。

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

top

図形の上端からワークシートの上までのポイント単位の距離です。 負の値を InvalidArgument 入力として設定すると、例外がスローされます。

top?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

type

この図形の種類を返します。 詳細は「Excel.ShapeType」をご覧ください。

type?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

visible

図形を表示するかどうかを指定します。

visible?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

width

図形の幅をポイント単位で指定します。 負の InvalidArgument 値または 0 を入力として設定すると、例外がスローされます。

width?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

zOrderPosition

指定された図形の z オーダーでの位置を返します。0 はオーダー スタックの一番下を表します。

zOrderPosition?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]