ApiShape

Class representing a shape.

ApiShape is a subclass of ApiDrawing.

Methods

The following table lists the available methods.

Method	Returns	Description
AddBreak	boolean	Inserts a break at the specified location in the main document.
Copy	ApiShape | null	Creates a copy of the current shape.
Delete	boolean	Deletes the current graphic object.
Fill	boolean	Sets the fill formatting properties to the current graphic object.
GetAllowOverlap	boolean	Returns whether the drawing object is allowed to overlap other drawing objects.
GetClassType	"shape"	Returns a type of the ApiShape class.
GetContent	ApiDocumentContent | null | undefined	Returns the drawing inner contents where a paragraph or text runs can be inserted if it exists.
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 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.
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.
GetNextDrawing	ApiDrawing | null	Returns the next inline drawing object if exists.
GetNextShape	ApiShape | null	Returns the next inline shape if exists.
GetParentContentControl	ApiBlockLvlSdt | null	Returns a parent content control that contains the graphic object.
GetParentParagraph	ApiParagraph | null	Returns a parent paragraph that contains the graphic object.
GetParentTable	ApiTable | null	Returns a parent table that contains the graphic object.
GetParentTableCell	ApiTableCell | null	Returns a parent table cell that contains the graphic object.
GetPrevDrawing	ApiDrawing | null	Returns the previous inline drawing object if exists.
GetPrevShape	ApiShape | null	Returns the previous inline shape if exists.
GetRotation	number	Returns the rotation angle of the current drawing object.
GetShadow	ApiShadow | null	Returns the shadow of the current graphic object.
GetTextRange	ApiRange | null	Returns a 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 drawing has an associated text body.
InsertInContentControl	ApiDrawing | ApiBlockLvlSdt	Wraps the graphic object with a rich text content control.
InsertParagraph	ApiParagraph | ApiDrawing	Inserts a paragraph at the specified position.
ScaleHeight	boolean	Scales the height of the figure using the specified coefficient.
ScaleWidth	boolean	Scales the width of the figure using the specified coefficient.
Select	boolean	Selects the current graphic object.
SetAllowOverlap	void	Sets whether the drawing object is allowed to overlap other drawing objects.
SetDescription	boolean	Sets the description of the current drawing.
SetDistances	boolean	Specifies the minimum distance which will be maintained between the edges of the current drawing object and any subsequent text.
SetDrawingPrFromDrawing	boolean	Sets the properties from another drawing to the current drawing.
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.
SetHorAlign	boolean	Specifies how the floating object will be horizontally aligned.
SetHorFlip	boolean	Flips the current drawing horizontally.
SetHorPosition	boolean	Sets the absolute measurement for the horizontal positioning of the floating object.
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.
SetRelativeHeight	boolean	Sets the relative height of the object (image, shape, chart) bounding box.
SetRelativeWidth	boolean	Sets the relative width of the object (image, shape, chart) bounding box.
SetRotation	boolean	Sets the rotation angle to the current drawing object.
SetShadow	boolean	Sets the shadow to the current graphic object.
SetSize	boolean	Sets the size of the object (image, shape, chart) bounding box.
SetTitle	boolean	Sets the title of the current drawing.
SetVerAlign	boolean	Specifies how the floating object will be vertically aligned.
SetVerPosition	boolean	Sets the absolute measurement for the vertical positioning of the floating object.
SetVertFlip	boolean	Flips the current drawing vertically.
SetVerticalTextAlign	boolean	Sets the vertical alignment to the shape content where a paragraph or text runs can be inserted.
SetWrappingStyle	boolean	Sets the wrapping type of the current object (image, shape, chart).
ToJSON	JSON	Converts the ApiDrawing object into the JSON object.
Unselect	boolean	Removes the current graphic object from the selection.