Word.Interfaces.ShapeData interface
Интерфейс, описывающий данные, возвращаемые вызовом shape.toJSON().
Свойства
| allow |
Определяет, может ли заданная фигура перекрывать другие фигуры. |
| alt |
Строка, представляющая замещающий текст, связанный с фигурой. |
| body | Получает |
| canvas | Получает холст, связанный с фигурой. Объект со |
| fill | Возвращает форматирование заливки фигуры. |
| geometric |
Определяет тип геометрической фигуры. Она будет пустой, если это не геометрическая фигура. |
| height | Указывает высоту фигуры в точках. |
| height |
Задает процентное отношение высоты фигуры к относительному размеру фигуры по вертикали (то есть свойство |
| id | Получает целое число, представляющее идентификатор фигуры. |
| is |
Проверьте, является ли эта фигура дочерней фигурой группы или фигуры холста. |
| left | Определяет расстояние в точках от левой стороны фигуры до относительного горизонтального положения (то есть |
| left |
Задает относительное положение слева в процентах от левого края фигуры до относительного горизонтального положения (то есть |
| lock |
Пропорции фигуры заблокированы. |
| name | Указывает имя фигуры. |
| parent |
Получает родительский холст верхнего уровня для этой дочерней фигуры. Она будет иметь значение null, если не является дочерней фигурой холста. |
| parent |
Получает фигуру верхнего уровня родительской группы этой дочерней фигуры. Если эта фигура не является дочерней фигурой группы, она будет пустой. |
| relative |
Определяет относительное горизонтальное положение фигуры. Для встроенной фигуры ее задать невозможно. Дополнительные сведения см. в статье Word. ОтносительнаяГоризонтальнаяПозиция. |
| relative |
Определяет относительный размер фигуры по горизонтали. Использование со свойством |
| relative |
Указывает относительное положение фигуры по вертикали. Для встроенной фигуры ее задать невозможно. Дополнительные сведения см. в статье Word. ОтносительнаяВертикальнаяПозиция. |
| relative |
Определяет относительный размер фигуры по вертикали. Использование со свойством |
| rotation | Угол поворота фигуры (в градусах). Неприменимо к фигуре "Холст". |
| 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
Определяет тип геометрической фигуры. Она будет пустой, если это не геометрическая фигура.
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
Указывает высоту фигуры в точках.
height?: number;
Значение свойства
number
Комментарии
heightRelative
Задает процентное отношение высоты фигуры к относительному размеру фигуры по вертикали (то есть свойство relativeVerticalSize ). Для встроенной или дочерней фигуры задать этот параметр невозможно.
heightRelative?: number;
Значение свойства
number
Комментарии
id
Получает целое число, представляющее идентификатор фигуры.
id?: number;
Значение свойства
number
Комментарии
isChild
Проверьте, является ли эта фигура дочерней фигурой группы или фигуры холста.
isChild?: boolean;
Значение свойства
boolean
Комментарии
left
Определяет расстояние в точках от левой стороны фигуры до относительного горизонтального положения (то есть relativeHorizontalPosition свойства). Для встроенной фигуры возвращается 0 и ее нельзя задать. Для дочерних фигур на холсте или в группе они определяются относительно левого верхнего угла.
left?: number;
Значение свойства
number
Комментарии
leftRelative
Задает относительное положение слева в процентах от левого края фигуры до относительного горизонтального положения (то есть relativeHorizontalalPosition свойства). Для встроенной или дочерней фигуры возвращается 0 и ее нельзя задать.
leftRelative?: number;
Значение свойства
number
Комментарии
lockAspectRatio
Пропорции фигуры заблокированы.
lockAspectRatio?: boolean;
Значение свойства
boolean
Комментарии
name
Указывает имя фигуры.
name?: string;
Значение свойства
string
Комментарии
parentCanvas
Получает родительский холст верхнего уровня для этой дочерней фигуры. Она будет иметь значение null, если не является дочерней фигурой холста.
parentCanvas?: Word.Interfaces.ShapeData;
Значение свойства
Комментарии
parentGroup
Получает фигуру верхнего уровня родительской группы этой дочерней фигуры. Если эта фигура не является дочерней фигурой группы, она будет пустой.
parentGroup?: Word.Interfaces.ShapeData;
Значение свойства
Комментарии
relativeHorizontalPosition
Определяет относительное горизонтальное положение фигуры. Для встроенной фигуры ее задать невозможно. Дополнительные сведения см. в статье Word. ОтносительнаяГоризонтальнаяПозиция.
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?: 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
Угол поворота фигуры (в градусах). Неприменимо к фигуре "Холст".
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
Определяет ширину фигуры (в точках).
width?: number;
Значение свойства
number
Комментарии
widthRelative
Задает процентное отношение ширины фигуры к относительному размеру по горизонтали (то есть свойство relativeHorizontalSize ). Для встроенной или дочерней фигуры задать этот параметр невозможно.
widthRelative?: number;
Значение свойства
number