ApiShape
ApiShape is a subclass of ApiDrawing.
Methods
| Method | Returns | Description |
|---|---|---|
| Fill | boolean | Sets the fill formatting properties to the current graphic object. |
| GetClassType | "shape" | Returns a type of the ApiShape class. |
| GetContent | ApiDocumentContent | Returns the shape inner contents where a paragraph or text runs can be inserted. |
| GetDocContent | ApiDocumentContent | Returns the shape inner contents where a paragraph or text runs can be inserted. |
| GetFill | ApiFill | null | Gets the fill properties from the current shape. |
| 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. |
| GetLine | ApiStroke | null | Gets the outline properties from the current shape. |
| 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 | Returns the parent sheet of the current drawing. |
| GetRotation | number | Returns the rotation angle of the current drawing object. |
| GetWidth | EMU | Returns the width of the current drawing. |
| Select | None | Selects the current graphic object. |
| SetFill | boolean | Sets the fill properties to the current shape. |
| 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. |
| SetLockValue | boolean | Sets the lock value to the specified lock type of the current drawing. |
| SetName | boolean | Sets the name of the current drawing. If another drawing with the same name already exists, that drawing's name will be reset to a default auto-generated name. |
| 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. 💡 Please note that the horizontal and vertical offsets are calculated within the limits of the specified column and row cells only. If this value exceeds the cell width or height, another vertical/horizontal position will be set. |
| SetRotation | boolean | Sets the rotation angle to the current drawing object. |
| SetSize | None | Sets a size of the object (image, shape, chart) bounding box. |
| 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. |