PowerPoint.Interfaces.ShapeLoadOptions interface

スライド内の単一の図形を表します。

プロパティ

$all

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

adjustments

この図形のすべての調整の調整値を含む Adjustments オブジェクトを返します。

altTextDescription

図形の代替テキストの説明。

代替テキストは、図形に含まれる情報の代替テキスト ベースの表現を提供します。 この情報は、形を見たり理解したりできない視覚または認知障害のあるユーザーに役立ちます。

altTextTitle

図形の代替テキスト タイトル。

代替テキストは、図形に含まれる情報の代替テキスト ベースの表現を提供します。 この情報は、形を見たり理解したりできない視覚または認知障害のあるユーザーに役立ちます。 タイトルは障碍のある人に読み上げることができ、コンテンツの説明を聞くかどうかを判断するために使用されます。

creationId

図形の作成 ID を取得します。 図形に作成 ID がない場合は null を返します。

fill

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

group

図形に関連付けられている ShapeGroup を返します。 図形の種類が groupでない場合、このメソッドは GeneralException エラーを返します。

height

図形の高さをポイント単位で指定します。 負の値に設定されている場合は、 InvalidArgument 例外をスローします。

id

図形の一意の ID を取得します。

isDecorative

図形が装飾的かどうかを表します。

装飾的なオブジェクトは視覚的な興味をそそりますが、情報的ではありません (様式的な罫線など)。 スクリーン リーダーを使用している People は、これらが装飾用であると読み上げられるため、重要な情報を聞き逃しているわけではないことがわかります。

left

図形の左側からスライドの左側までの距離 (ポイント単位)。

level

指定された図形のレベルを返します。

  • レベル 0 は、図形がグループの一部ではないことを意味します。

  • レベル 1 は、図形が最上位グループの一部であることを意味します。

  • レベルが 1 より大きい場合、図形が入れ子になったグループであることを示します。

lineFormat

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

name

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

parentGroup

この図形の親グループを返します。 図形がグループに含まれていない場合、このメソッドは GeneralException エラーを返します。

placeholderFormat

特にこのプレースホルダーに適用されるプロパティを返します。 図形の種類が placeholderでない場合、このメソッドは GeneralException エラーを返します。

rotation

z 軸を中心とした図形の回転を度数で指定します。 正の値は時計回りの回転を示し、負の値は反時計回りの回転を示します。

textFrame

このShapePowerPoint.TextFrame オブジェクトを返します。 図形がTextFrameをサポートしていない場合は、InvalidArgument例外をスローします。

top

図形の上端からスライドの上端までの距離 (ポイント単位)。

type

この図形の種類を返します。 詳細については 、PowerPoint.ShapeType を参照してください。

visible

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

width

図形の幅をポイント単位で指定します。 負の値に設定されている場合は、 InvalidArgument 例外をスローします。

zOrderPosition

図形の z オーダー位置を返します。0 はスタックの下部を表します。 スライド上のすべての図形に一意の Z オーダーが設定されていますが、スライドごとに一意の Z オーダーのスタックもあるため、別々のスライド上の 2 つの図形に同じ Z オーダー番号を付けることができます。

プロパティの詳細

$all

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

$all?: boolean;

プロパティ値

boolean

adjustments

この図形のすべての調整の調整値を含む Adjustments オブジェクトを返します。

adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.10

altTextDescription

図形の代替テキストの説明。

代替テキストは、図形に含まれる情報の代替テキスト ベースの表現を提供します。 この情報は、形を見たり理解したりできない視覚または認知障害のあるユーザーに役立ちます。

altTextDescription?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.10

altTextTitle

図形の代替テキスト タイトル。

代替テキストは、図形に含まれる情報の代替テキスト ベースの表現を提供します。 この情報は、形を見たり理解したりできない視覚または認知障害のあるユーザーに役立ちます。 タイトルは障碍のある人に読み上げることができ、コンテンツの説明を聞くかどうかを判断するために使用されます。

altTextTitle?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.10

creationId

図形の作成 ID を取得します。 図形に作成 ID がない場合は null を返します。

creationId?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.10

fill

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

fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.4

group

図形に関連付けられている ShapeGroup を返します。 図形の種類が groupでない場合、このメソッドは GeneralException エラーを返します。

group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.8

height

図形の高さをポイント単位で指定します。 負の値に設定されている場合は、 InvalidArgument 例外をスローします。

height?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.4

id

図形の一意の ID を取得します。

id?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.3

isDecorative

図形が装飾的かどうかを表します。

装飾的なオブジェクトは視覚的な興味をそそりますが、情報的ではありません (様式的な罫線など)。 スクリーン リーダーを使用している People は、これらが装飾用であると読み上げられるため、重要な情報を聞き逃しているわけではないことがわかります。

isDecorative?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.10

left

図形の左側からスライドの左側までの距離 (ポイント単位)。

left?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.4

level

指定された図形のレベルを返します。

  • レベル 0 は、図形がグループの一部ではないことを意味します。

  • レベル 1 は、図形が最上位グループの一部であることを意味します。

  • レベルが 1 より大きい場合、図形が入れ子になったグループであることを示します。

level?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.8

lineFormat

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

lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.4

name

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

name?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.4

parentGroup

この図形の親グループを返します。 図形がグループに含まれていない場合、このメソッドは GeneralException エラーを返します。

parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.8

placeholderFormat

特にこのプレースホルダーに適用されるプロパティを返します。 図形の種類が placeholderでない場合、このメソッドは GeneralException エラーを返します。

placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.8

rotation

z 軸を中心とした図形の回転を度数で指定します。 正の値は時計回りの回転を示し、負の値は反時計回りの回転を示します。

rotation?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.10

textFrame

このShapePowerPoint.TextFrame オブジェクトを返します。 図形がTextFrameをサポートしていない場合は、InvalidArgument例外をスローします。

textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.4

top

図形の上端からスライドの上端までの距離 (ポイント単位)。

top?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.4

type

この図形の種類を返します。 詳細については 、PowerPoint.ShapeType を参照してください。

type?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.4

visible

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

visible?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.10

width

図形の幅をポイント単位で指定します。 負の値に設定されている場合は、 InvalidArgument 例外をスローします。

width?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.4

zOrderPosition

図形の z オーダー位置を返します。0 はスタックの下部を表します。 スライド上のすべての図形に一意の Z オーダーが設定されていますが、スライドごとに一意の Z オーダーのスタックもあるため、別々のスライド上の 2 つの図形に同じ Z オーダー番号を付けることができます。

zOrderPosition?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.8