ApiShape
ApiShape is a subclass of ApiDrawing.
Methods
| Method | Returns | Description |
|---|---|---|
| Copy | ApiDrawing | Creates a copy of the specified drawing object. |
| Delete | boolean | Deletes the specified drawing object from the parent. |
| Fill | boolean | Sets the fill formatting properties to the current graphic object. |
| GetClassType | "shape" | Returns the type of the ApiShape class. |
| GetContent | ApiDocumentContent | Returns the shape inner contents where a paragraph or text runs can be inserted. |
| GetDocContent | ApiDocumentContent | Deprecated in 6.2. 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. |
| GetHyperlink | ApiHyperlink | null | Returns the hyperlink from the current drawing object (shape or image). |
| GetInternalId | string | Returns an internal ID of the current drawing object. |
| 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. |
| GetParent | ApiSlide | ApiLayout | ApiMaster | null | Returns the drawing parent object. |
| GetParentLayout | ApiLayout | null | Returns the drawing parent slide layout. |
| GetParentMaster | ApiMaster | null | Returns the drawing parent slide master. |
| GetParentSlide | ApiSlide | null | Returns the drawing parent slide. |
| GetPlaceholder | ApiPlaceholder | null | Returns a placeholder from the current drawing object. |
| GetPosX | EMU | Gets the x position of the drawing on the slide. |
| GetPosY | EMU | Gets the y position of the drawing on the slide. |
| GetRotation | number | Returns the rotation angle of the current drawing object. |
| GetWidth | EMU | Returns the width of the current drawing. |
| ReplacePlaceholder | boolean | Replaces the placeholder by a drawing on the slide. |
| Select | boolean | 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. |
| SetHyperlink | boolean | Sets a hyperlink to the current drawing object (shape or image). Pass null to remove the hyperlink. |
| 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. |
| SetPlaceholder | boolean | Sets the specified placeholder to the current drawing object. |
| SetPosX | boolean | Sets the x position of the drawing on the slide. |
| SetPosY | boolean | Sets the y position of the drawing on the slide. |
| SetPosition | None | Sets the position of the drawing on the slide. |
| SetRotation | boolean | Sets the rotation angle to the current drawing object. |
| SetSize | None | Sets the size of the object (image, shape, chart) bounding box. |
| SetVerticalTextAlign | None | Sets the vertical alignment to the shape content where a paragraph or text runs can be inserted. |
| ToJSON | JSON | Converts the ApiDrawing object into the JSON object. |
| Unselect | boolean | Removes the current graphic object from the selection. |