ApiShape
Class representing a shape.
ApiShape is a subclass of ApiDrawing.
Methods
The following table lists the available methods.
| Method | Returns | Description |
|---|---|---|
| Copy | ApiShape | Creates a copy of the current shape. |
| Delete | boolean | Deletes the specified drawing object. |
| Fill | boolean | Sets the fill formatting properties to the current graphic object. |
| GetClassType | "shape" | Returns a type of the ApiShape class. |
| GetContent | ApiDocumentContent | null | undefined | Returns the shape inner contents where a paragraph or text runs can be inserted. |
| GetDescription | string | null | Gets the description of the current drawing. |
| GetDocContent | ApiDocumentContent | null | undefined | Returns the shape inner contents where a paragraph or text runs can be inserted. |
| GetFill | ApiFill | null | Gets the fill formatting properties from the current graphic object. |
| GetFlipH | boolean | null | Get horizontal flip of current drawing. |
| GetFlipV | boolean | null | Get vertical flip of current drawing. |
| GetGeometry | ApiGeometry | Returns the geometry object from the current shape. |
| GetHeight | EMU | Returns the height of the current drawing. |
| GetInternalId | string | Returns an internal ID of the current drawing object. |
| GetLine | ApiStroke | null | Gets the outline properties from the current shape. |
| GetLockAspect | boolean | Returns whether the aspect ratio of the drawing is locked. |
| GetLockValue | boolean | Returns the lock value for the specified lock type of the current drawing. |
| GetName | string | Returns the name of the current drawing. |
| GetParentSheet | ApiWorksheet | null | undefined | Returns the parent sheet of the current drawing. |
| GetPosX | EMU | Returns the x position of the current drawing on the worksheet. |
| GetPosY | EMU | Returns the y position of the current drawing on the worksheet. |
| GetPosition | DrawingCellAnchor | null | Returns the cell anchor of the current drawing; the offsets are limited by the anchor cell. |
| GetRotation | number | Returns the rotation angle of the current drawing object. |
| GetShadow | ApiShadow | null | Returns the shadow of the current graphic object. |
| GetTextRange | ApiTextRange | null | Returns a text range that covers the whole text of the current drawing. Creates a text body if the drawing does not yet have one. |
| GetTitle | string | null | Gets the title of the current drawing. |
| GetVerticalTextAlign | VerticalTextAlign | Gets the vertical alignment from the shape content where a paragraph or text runs can be inserted. |
| GetWidth | EMU | Returns the width of the current drawing. |
| HasTextContent | boolean | Checks whether the current drawing has a text body. |
| Select | None | Selects the current graphic object. |
| SetDescription | boolean | Sets the description of the current drawing. |
| SetFill | boolean | Sets the fill formatting properties to the current graphic object. |
| SetFlipH | boolean | Sets the horizontal flip of the current drawing. |
| SetFlipV | boolean | Sets the vertical flip of the current drawing. |
| SetGeometry | boolean | Sets a custom geometry for the current shape. |
| SetLine | boolean | Sets the outline properties to the current shape. |
| SetLockAspect | boolean | Sets whether the aspect ratio of the drawing is locked. |
| SetLockValue | boolean | Sets the lock value to the specified lock type of the current drawing. |
| SetName | boolean | Sets the name of the current drawing. |
| SetOutLine | boolean | Sets the outline properties to the specified graphic object. |
| SetPaddings | boolean | Sets the text paddings to the current shape. |
| SetPosition | None | Changes the position for the drawing object. |
| SetRotation | boolean | Sets the rotation angle to the current drawing object. |
| SetShadow | boolean | Sets the shadow to the current graphic object. |
| SetSize | None | Sets a size of the object (image, shape, chart) bounding box. |
| SetTitle | boolean | Sets the title of the current drawing. |
| SetVerticalTextAlign | boolean | Sets the vertical alignment to the shape content where a paragraph or text runs can be inserted. |
| Unselect | boolean | Removes the current drawing from the selection. |