Excel.Interfaces.ShapeLoadOptions interface
ワークシート内のジェネリック図形オブジェクトを表します。 図形には、幾何学的図形、線、図形のグループなどがあります。図形オブジェクト モデルの詳細については、「 Excel JavaScript API を使用した図形の操作」を参照してください。
注釈
プロパティ
$all | 読み込みオプションに |
alt |
|
alt |
|
connection |
この図形の結合点の数を返します。 |
display |
図形の表示名を取得します。 新しく作成された図形には、ローカライズされた生成された名前があり、その |
fill | この図形の塗りつぶしの書式設定を返します。 |
geometric |
図形に関連付けられた幾何学的図形を返します。 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。 |
geometric |
このジオメトリ シェイプのジオメトリ シェイプ タイプを指定します。 詳細は「 |
group | 図形に関連付けられた図形グループを返します。 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。 |
height | 図形の高さをポイント単位で指定します。 負の値または 0 を入力として設定すると、 |
id | 図形識別子を指定します。 |
image | 図形に関連付けられた画像を返します。 図形の種類が "Image" ではない場合は、エラーがスローされます。 |
left | 図形の左側からワークシートの左側までの距離 (ポイント数) です。 負の値を入力として設定すると、 |
level | 指定した図形のレベルを指定します。 たとえば、レベル 0 は図形がどのグループの一部でもないことを意味し、レベル 1 は図形が最上位グループの一部であることを意味し、レベル 2 は図形が最上位レベルのサブグループの一部であることを意味します。 |
line | 図形に関連付けられた線を返します。 図形の種類が "Line" ではない場合は、エラーがスローされます。 |
line |
この図形の線の書式設定を返します。 |
lock |
この図形の縦横比がロックされているかどうかを指定します。 |
name | 図形の名前を指定します。 |
parent |
この図形の親グループを指定します。 |
placement | オブジェクトがその下のセルに接続されている方法を表します。 |
rotation | 図形の回転を度単位で指定します。 |
text |
この図形のテキスト フレーム オブジェクトを返します。 |
top | 図形の上端からワークシートの上までのポイント単位の距離です。 負の値を入力として設定すると、 |
type | この図形の種類を返します。 詳細は「 |
visible | 図形を表示するかどうかを指定します。 |
width | 図形の幅をポイント単位で指定します。 負の値または 0 を入力として設定すると、 |
z |
指定された図形の z オーダーでの位置を返します。0 はオーダー スタックの一番下を表します。 |
プロパティの詳細
$all
読み込みオプションに $all
を指定すると、すべてのスカラー プロパティ ( Range.address
など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color
など) は読み込まれません。
$all?: boolean;
プロパティ値
boolean
altTextDescription
Shape
オブジェクトの代替説明テキストを指定します。
altTextDescription?: boolean;
プロパティ値
boolean
注釈
altTextTitle
connectionSiteCount
displayName
図形の表示名を取得します。 新しく作成された図形には、ローカライズされた生成された名前があり、その name
と一致しない可能性があります。 このシナリオでは、この API を使用して、UI に表示される名前を取得できます。
displayName?: boolean;
プロパティ値
boolean
注釈
fill
この図形の塗りつぶしの書式設定を返します。
fill?: Excel.Interfaces.ShapeFillLoadOptions;
プロパティ値
注釈
geometricShape
図形に関連付けられた幾何学的図形を返します。 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。
geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;
プロパティ値
注釈
geometricShapeType
このジオメトリ シェイプのジオメトリ シェイプ タイプを指定します。 詳細は「Excel.GeometricShapeType
」をご覧ください。 図形の種類が "GeometrShape" でない場合は、 null
を返します。
geometricShapeType?: boolean;
プロパティ値
boolean
注釈
group
図形に関連付けられた図形グループを返します。 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。
group?: Excel.Interfaces.ShapeGroupLoadOptions;
プロパティ値
注釈
height
図形の高さをポイント単位で指定します。 負の値または 0 を入力として設定すると、 InvalidArgument
例外がスローされます。
height?: boolean;
プロパティ値
boolean
注釈
id
image
図形に関連付けられた画像を返します。 図形の種類が "Image" ではない場合は、エラーがスローされます。
image?: Excel.Interfaces.ImageLoadOptions;
プロパティ値
注釈
left
図形の左側からワークシートの左側までの距離 (ポイント数) です。 負の値を入力として設定すると、 InvalidArgument
例外がスローされます。
left?: boolean;
プロパティ値
boolean
注釈
level
指定した図形のレベルを指定します。 たとえば、レベル 0 は図形がどのグループの一部でもないことを意味し、レベル 1 は図形が最上位グループの一部であることを意味し、レベル 2 は図形が最上位レベルのサブグループの一部であることを意味します。
level?: boolean;
プロパティ値
boolean
注釈
line
図形に関連付けられた線を返します。 図形の種類が "Line" ではない場合は、エラーがスローされます。
line?: Excel.Interfaces.LineLoadOptions;
プロパティ値
注釈
lineFormat
この図形の線の書式設定を返します。
lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;
プロパティ値
注釈
lockAspectRatio
name
parentGroup
この図形の親グループを指定します。
parentGroup?: Excel.Interfaces.ShapeLoadOptions;
プロパティ値
注釈
placement
rotation
textFrame
この図形のテキスト フレーム オブジェクトを返します。
textFrame?: Excel.Interfaces.TextFrameLoadOptions;
プロパティ値
注釈
top
図形の上端からワークシートの上までのポイント単位の距離です。 負の値を入力として設定すると、 InvalidArgument
例外がスローされます。
top?: boolean;
プロパティ値
boolean
注釈
type
この図形の種類を返します。 詳細は「Excel.ShapeType
」をご覧ください。
type?: boolean;
プロパティ値
boolean
注釈
visible
width
図形の幅をポイント単位で指定します。 負の値または 0 を入力として設定すると、 InvalidArgument
例外がスローされます。
width?: boolean;
プロパティ値
boolean
注釈
zOrderPosition
指定された図形の z オーダーでの位置を返します。0 はオーダー スタックの一番下を表します。
zOrderPosition?: boolean;
プロパティ値
boolean
注釈
Office Add-ins