Word.Interfaces.ShapeData interface
shape.toJSON()
を呼び出すことによって返されるデータを記述するインターフェイス。
プロパティ
| allow |
特定の図形が他の図形と重なることができるかどうかを指定します。 |
| alt |
図形に関連付けられている代替テキストを表す文字列を指定します。 |
| body | 図形の |
| canvas | 図形に関連付けられているキャンバスを取得します。
|
| fill | 図形の塗りつぶしの書式設定を返します。 |
| geometric |
図形の幾何学的図形の種類を指定します。 幾何学的図形でない場合は null になります。 |
| height | 図形の高さをポイント単位で指定します。 |
| height |
相対的な垂直サイズ (つまり、 |
| id | 図形識別子を表す整数を取得します。 |
| is |
この図形がグループ図形またはキャンバス図形の子であるかどうかを確認します。 |
| left | 図形の左側から相対的な水平方向の位置 (つまり、 |
| left |
図形の左側から相対的な水平方向の位置 (つまり、 |
| lock |
この図形の縦横比がロックされているかどうかを指定します。 |
| name | 図形の名前を指定します。 |
| parent |
この子図形の最上位の親キャンバス図形を取得します。 キャンバスの子図形でない場合は null になります。 |
| parent |
この子図形の最上位の親グループ図形を取得します。 グループの子図形でない場合は null になります。 |
| relative |
図形の相対的な水平位置を指定します。 インライン図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。 |
| relative |
図形の相対水平サイズを指定します。
|
| relative |
図形の相対的な垂直位置を指定します。 インライン図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeVerticalPosition。 |
| relative |
図形の相対的な垂直サイズを指定します。
|
| rotation | 図形の回転を度単位で指定します。 Canvas 図形には適用されません。 |
| shape |
図形に関連付けられている図形グループを取得します。
|
| text |
図形の |
| text |
図形のテキスト折り返し書式を返します。 |
| top | 図形の上端から相対的な垂直位置 (つまり、 |
| top |
図形の上端から相対的な垂直位置 (つまり、 |
| type | 図形の種類を取得します。 現在、サポートされている図形は、テキスト ボックス、幾何学的図形、グループ、図、キャンバスのみです。 |
| visible | 図形を表示するかどうかを指定します。 インライン図形には適用されません。 |
| width | 図形の幅をポイント単位で指定します。 |
| width |
相対的な水平方向のサイズ (つまり、 |
プロパティの詳細
allowOverlap
特定の図形が他の図形と重なることができるかどうかを指定します。
allowOverlap?: boolean;
プロパティ値
boolean
注釈
altTextDescription
図形に関連付けられている代替テキストを表す文字列を指定します。
altTextDescription?: string;
プロパティ値
string
注釈
body
図形の Body オブジェクトを取得します。 テキスト ボックスと幾何学的図形にのみ適用されます。
body?: Word.Interfaces.BodyData;
プロパティ値
注釈
canvas
図形に関連付けられているキャンバスを取得します。
isNullObject プロパティが true に設定されているオブジェクトは、図形の種類がcanvasされていない場合に返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
canvas?: Word.Interfaces.CanvasData;
プロパティ値
注釈
fill
図形の塗りつぶしの書式設定を返します。
fill?: Word.Interfaces.ShapeFillData;
プロパティ値
注釈
geometricShapeType
図形の幾何学的図形の種類を指定します。 幾何学的図形でない場合は null になります。
geometricShapeType?: Word.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";
プロパティ値
Word.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"
注釈
height
heightRelative
相対的な垂直サイズ (つまり、 relativeVerticalSize プロパティ) に対する図形の高さの割合を指定します。 インライン図形または子図形の場合は、設定できません。
heightRelative?: number;
プロパティ値
number
注釈
id
isChild
この図形がグループ図形またはキャンバス図形の子であるかどうかを確認します。
isChild?: boolean;
プロパティ値
boolean
注釈
left
図形の左側から相対的な水平方向の位置 (つまり、 relativeHorizontalPosition プロパティ) までの距離をポイント単位で指定します。 インライン図形の場合、0 が返され、設定できません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。
left?: number;
プロパティ値
number
注釈
leftRelative
図形の左側から相対的な水平方向の位置 (つまり、 relativeHorizontalalPosition プロパティ) に対する割合として、相対左の位置を指定します。 インライン図形または子図形の場合、0 が返され、設定できません。
leftRelative?: number;
プロパティ値
number
注釈
lockAspectRatio
この図形の縦横比がロックされているかどうかを指定します。
lockAspectRatio?: boolean;
プロパティ値
boolean
注釈
name
parentCanvas
この子図形の最上位の親キャンバス図形を取得します。 キャンバスの子図形でない場合は null になります。
parentCanvas?: Word.Interfaces.ShapeData;
プロパティ値
注釈
parentGroup
この子図形の最上位の親グループ図形を取得します。 グループの子図形でない場合は null になります。
parentGroup?: Word.Interfaces.ShapeData;
プロパティ値
注釈
relativeHorizontalPosition
図形の相対的な水平位置を指定します。 インライン図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
プロパティ値
Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"
注釈
relativeHorizontalSize
図形の相対水平サイズを指定します。
widthRelative プロパティで を使用します。 インライン図形または子図形の場合は、設定できません。
relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
プロパティ値
Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
注釈
relativeVerticalPosition
図形の相対的な垂直位置を指定します。 インライン図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeVerticalPosition。
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
プロパティ値
Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
注釈
relativeVerticalSize
図形の相対的な垂直サイズを指定します。
heightRelative プロパティで を使用します。 インライン図形または子図形の場合は、設定できません。
relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
プロパティ値
Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
注釈
rotation
図形の回転を度単位で指定します。 Canvas 図形には適用されません。
rotation?: number;
プロパティ値
number
注釈
shapeGroup
図形に関連付けられている図形グループを取得します。
isNullObject プロパティが true に設定されているオブジェクトは、図形の種類がgroupShapeされていない場合に返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
shapeGroup?: Word.Interfaces.ShapeGroupData;
プロパティ値
注釈
textFrame
図形の TextFrame オブジェクトを取得します。
textFrame?: Word.Interfaces.TextFrameData;
プロパティ値
注釈
textWrap
図形のテキスト折り返し書式を返します。
textWrap?: Word.Interfaces.ShapeTextWrapData;
プロパティ値
注釈
top
図形の上端から相対的な垂直位置 (つまり、 relativeVerticalPosition プロパティ) までの距離をポイント単位で指定します。 インライン図形の場合、0 が返され、設定できません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。
top?: number;
プロパティ値
number
注釈
topRelative
図形の上端から相対的な垂直位置 (つまり、 relativeVerticalPosition プロパティ) に対する相対的な上端の位置をパーセンテージで指定します。 インライン図形または子図形の場合、0 が返され、設定できません。
topRelative?: number;
プロパティ値
number
注釈
type
図形の種類を取得します。 現在、サポートされている図形は、テキスト ボックス、幾何学的図形、グループ、図、キャンバスのみです。
type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";
プロパティ値
Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"
注釈
visible
図形を表示するかどうかを指定します。 インライン図形には適用されません。
visible?: boolean;
プロパティ値
boolean
注釈
width
widthRelative
相対的な水平方向のサイズ (つまり、 relativeHorizontalSize プロパティ) に対する図形の幅の割合を指定します。 インライン図形または子図形の場合は、設定できません。
widthRelative?: number;
プロパティ値
number