WebExtensionShape

WebExtensionShape class

Represents the shape of web extension.

class WebExtensionShape extends Shape;

Constructors

Constructor	Description
constructor(Shape)	Constructs from a parent object convertible to this.

Properties

Property	Type	Description
webExtension	WebExtension	Gets and set the web extension.
macroName	string	Gets and sets the name of macro.
isEquation	boolean	Readonly. Indicates whether the shape only contains an equation.
isSmartArt	boolean	Readonly. Indicates whether the shape is a smart art.
zOrderPosition	number	Returns the position of a shape in the z-order.
name	string	Gets and sets the name of the shape.
alternativeText	string	Returns or sets the descriptive (alternative) text string of the Shape object.
title	string	Specifies the title (caption) of the current shape object.
line	LineFormat	Readonly. Gets line style
fill	FillFormat	Readonly. Returns a FillFormat object that contains fill formatting properties for the specified shape.
shadowEffect	ShadowEffect	Readonly. Represents a Drawing.ShadowEffect object that specifies shadow effect for the chart element or shape.
reflection	ReflectionEffect	Readonly. Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
glow	GlowEffect	Readonly. Represents a GlowEffect object that specifies glow effect for the chart element or shape.
softEdges	number	Gets and sets the radius of blur to apply to the edges, in unit of points.
threeDFormat	ThreeDFormat	Readonly. Gets and sets 3d format of the shape.
formatPicture	MsoFormatPicture	Readonly. Gets and sets the options of the picture format.
isHidden	boolean	Indicates whether the object is visible.
isLockAspectRatio	boolean	True means that aspect ratio of the shape is locked.
isAspectRatioLocked	boolean	True means that aspect ratio of the shape is locked.
rotationAngle	number	Gets and sets the rotation of the shape.
hyperlink	Hyperlink	Readonly. Gets the hyperlink of the shape.
id	number	Readonly. Gets the identifier of this shape.
spid	string	Readonly. Specifies an optional string identifier that an application can use to identify the particular shape.
spt	number	Readonly. Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
worksheet	Worksheet	Readonly. Gets the Worksheet object which contains this shape.
isGroup	boolean	Readonly. Indicates whether this shape is a group shape.
isInGroup	boolean	Readonly. Indicates whether the shape is grouped.
isWordArt	boolean	Readonly. Indicates whether this shape is a word art.
textEffect	TextEffectFormat	Readonly. Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.
isLocked	boolean	True means the object can not be modified when the sheet is protected. Note that this value is meaningful only if the worksheet or objects in the worksheet are protected.
isPrintable	boolean	Indicates whether the object is printable. If False, this shape will not be printed when printing.
msoDrawingType	MsoDrawingType	Readonly. Gets drawing type.
autoShapeType	AutoShapeType	Gets and sets the auto shape type.
anchorType	ShapeAnchorType	Gets and set the type of the shape anchor placeholder.
placement	PlacementType	Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet.
upperLeftRow	number	Represents the top row index.
upperDeltaY	number	Gets or sets the shape’s vertical offset from its upper left corner row.
upperLeftColumn	number	Represents upper left corner column index.
upperDeltaX	number	Gets or sets the shape’s horizontal offset from its upper left corner column.
lowerRightRow	number	Represents lower right corner row index.
lowerDeltaY	number	Gets or sets the shape’s vertical offset from its lower right corner row.
lowerRightColumn	number	Represents lower right corner column index.
lowerDeltaX	number	Gets or sets the shape’s horizontal offset from its lower right corner column.
right	number	Represents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels.
bottom	number	Represents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels.
width	number	Represents the width of shape, in unit of pixels.
widthInch	number	Represents the width of the shape, in unit of inch.
widthPt	number	Represents the width of the shape, in unit of point.
widthCM	number	Represents the width of the shape, in unit of centimeters.
height	number	Represents the height of shape, in unit of pixel.
heightInch	number	Represents the height of the shape, in unit of inches.
heightPt	number	Represents the height of the shape, in unit of points.
heightCM	number	Represents the height of the shape, in unit of centimeters.
left	number	Represents the horizontal offset of shape from its left column, in unit of pixels.
leftInch	number	Represents the horizontal offset of shape from its left column, in unit of inches.
leftCM	number	Represents the horizontal offset of shape from its left column, in unit of centimeters.
top	number	Represents the vertical offset of shape from its top row, in unit of pixels.
topInch	number	Represents the vertical offset of shape from its top row, in unit of inches.
topCM	number	Represents the vertical offset of shape from its top row, in unit of centimeters.
topToCorner	number	Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
leftToCorner	number	Gets and sets the horizonal offset of shape from worksheet left border.
x	number	Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
y	number	Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
widthScale	number	Gets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthScale property only returns 100;
heightScale	number	Gets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the HeightScale property only returns 100;
topInShape	number	Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
leftInShape	number	Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
widthInShape	number	Represents the width of the shape, in unit of 1/4000 of the parent shape.
heightInShape	number	Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
group	GroupShape	Readonly. Gets the group shape which contains this shape.
type	AutoShapeType	Readonly. Gets the auto shape type.
hasLine	boolean	Gets and sets the line border of the shape is visible.
isFilled	boolean	Indicates whether the fill format is visible.
isFlippedHorizontally	boolean	Gets and sets whether shape is horizontally flipped .
isFlippedVertically	boolean	Gets and sets whether shape is vertically flipped .
actualLowerRightRow	number	Readonly. Get the actual bottom row.
relativeToOriginalPictureSize	boolean	Indicates whether shape is relative to original picture size.
linkedCell	string	Gets or sets the worksheet range linked to the control’s value.
inputRange	string	Gets or sets the worksheet range used to fill the specified combo box.
textShapeType	AutoShapeType	Gets and sets the preset text shape type.
textBody	FontSettingCollection	Readonly. Gets and sets the setting of the shape’s text.
font	Font	Represents the font of shape.
textOptions	TextOptions	Represents the text options of the shape.
text	string	Gets and sets the text of this shape.
isRichText	boolean	Readonly. Whether or not the text is rich text.
htmlText	string	Gets and sets the html string which contains data and some formats in this textbox.
textVerticalOverflow	TextOverflowType	Gets and sets the text vertical overflow type of the shape which contains text.
textHorizontalOverflow	TextOverflowType	Gets and sets the text horizontal overflow type of the shape which contains text.
isTextWrapped	boolean	Gets and sets the text wrapped type of the shape which contains text.
textOrientationType	TextOrientationType	Gets and sets the text orientation type of the shape.
textHorizontalAlignment	TextAlignmentType	Gets and sets the text horizontal alignment type of the shape.
textVerticalAlignment	TextAlignmentType	Gets and sets the text vertical alignment type of the shape.
textDirection	TextDirectionType	Gets/Sets the direction of the text flow for this object.
textBoxOptions	TextBoxOptions	Readonly. Gets the text information in the shape
controlData	Uint8Array	Readonly. Gets the data of control.
activeXControl	ActiveXControl	Readonly. Gets the ActiveX control.
paths	ShapePathCollection	Readonly. Gets the paths of a custom geometric shape.
geometry	Geometry	Readonly. Gets the geometry
isDecorative	boolean	Indicates whether the object is decorative.

Methods

Method	Description
getWebExtension()	@deprecated. Please use the ‘webExtension’ property instead. Gets and set the web extension.
setWebExtension(WebExtension)	@deprecated. Please use the ‘webExtension’ property instead. Gets and set the web extension.
isNull()	Checks whether the implementation object is null.
getMacroName()	@deprecated. Please use the ‘macroName’ property instead. Gets and sets the name of macro.
setMacroName(string)	@deprecated. Please use the ‘macroName’ property instead. Gets and sets the name of macro.
isEquation()	@deprecated. Please use the ‘isEquation’ property instead. Indicates whether the shape only contains an equation.
isSmartArt()	@deprecated. Please use the ‘isSmartArt’ property instead. Indicates whether the shape is a smart art.
getZOrderPosition()	@deprecated. Please use the ‘zOrderPosition’ property instead. Returns the position of a shape in the z-order.
setZOrderPosition(number)	@deprecated. Please use the ‘zOrderPosition’ property instead. Returns the position of a shape in the z-order.
getName()	@deprecated. Please use the ’name’ property instead. Gets and sets the name of the shape.
setName(string)	@deprecated. Please use the ’name’ property instead. Gets and sets the name of the shape.
getAlternativeText()	@deprecated. Please use the ‘alternativeText’ property instead. Returns or sets the descriptive (alternative) text string of the Shape object.
setAlternativeText(string)	@deprecated. Please use the ‘alternativeText’ property instead. Returns or sets the descriptive (alternative) text string of the Shape object.
getTitle()	@deprecated. Please use the ’title’ property instead. Specifies the title (caption) of the current shape object.
setTitle(string)	@deprecated. Please use the ’title’ property instead. Specifies the title (caption) of the current shape object.
getLine()	@deprecated. Please use the ’line’ property instead. Gets line style
getFill()	@deprecated. Please use the ‘fill’ property instead. Returns a FillFormat object that contains fill formatting properties for the specified shape.
getShadowEffect()	@deprecated. Please use the ‘shadowEffect’ property instead. Represents a Drawing.ShadowEffect object that specifies shadow effect for the chart element or shape.
getReflection()	@deprecated. Please use the ‘reflection’ property instead. Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
getGlow()	@deprecated. Please use the ‘glow’ property instead. Represents a GlowEffect object that specifies glow effect for the chart element or shape.
getSoftEdges()	@deprecated. Please use the ‘softEdges’ property instead. Gets and sets the radius of blur to apply to the edges, in unit of points.
setSoftEdges(number)	@deprecated. Please use the ‘softEdges’ property instead. Gets and sets the radius of blur to apply to the edges, in unit of points.
getThreeDFormat()	@deprecated. Please use the ’threeDFormat’ property instead. Gets and sets 3d format of the shape.
getFormatPicture()	@deprecated. Please use the ‘formatPicture’ property instead. Gets and sets the options of the picture format.
isHidden()	@deprecated. Please use the ‘isHidden’ property instead. Indicates whether the object is visible.
setIsHidden(boolean)	@deprecated. Please use the ‘isHidden’ property instead. Indicates whether the object is visible.
isLockAspectRatio()	@deprecated. Please use the ‘isLockAspectRatio’ property instead. True means that aspect ratio of the shape is locked.
setIsLockAspectRatio(boolean)	@deprecated. Please use the ‘isLockAspectRatio’ property instead. True means that aspect ratio of the shape is locked.
isAspectRatioLocked()	@deprecated. Please use the ‘isAspectRatioLocked’ property instead. True means that aspect ratio of the shape is locked.
setIsAspectRatioLocked(boolean)	@deprecated. Please use the ‘isAspectRatioLocked’ property instead. True means that aspect ratio of the shape is locked.
getRotationAngle()	@deprecated. Please use the ‘rotationAngle’ property instead. Gets and sets the rotation of the shape.
setRotationAngle(number)	@deprecated. Please use the ‘rotationAngle’ property instead. Gets and sets the rotation of the shape.
getHyperlink()	@deprecated. Please use the ‘hyperlink’ property instead. Gets the hyperlink of the shape.
getId()	@deprecated. Please use the ‘id’ property instead. Gets the identifier of this shape.
getSpid()	@deprecated. Please use the ‘spid’ property instead. Specifies an optional string identifier that an application can use to identify the particular shape.
getSpt()	@deprecated. Please use the ‘spt’ property instead. Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
getWorksheet()	@deprecated. Please use the ‘worksheet’ property instead. Gets the Worksheet object which contains this shape.
isGroup()	@deprecated. Please use the ‘isGroup’ property instead. Indicates whether this shape is a group shape.
isInGroup()	@deprecated. Please use the ‘isInGroup’ property instead. Indicates whether the shape is grouped.
isWordArt()	@deprecated. Please use the ‘isWordArt’ property instead. Indicates whether this shape is a word art.
getTextEffect()	@deprecated. Please use the ’textEffect’ property instead. Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.
isLocked()	@deprecated. Please use the ‘isLocked’ property instead. True means the object can not be modified when the sheet is protected. Note that this value is meaningful only if the worksheet or objects in the worksheet are protected.
setIsLocked(boolean)	@deprecated. Please use the ‘isLocked’ property instead. True means the object can not be modified when the sheet is protected. Note that this value is meaningful only if the worksheet or objects in the worksheet are protected.
isPrintable()	@deprecated. Please use the ‘isPrintable’ property instead. Indicates whether the object is printable. If False, this shape will not be printed when printing.
setIsPrintable(boolean)	@deprecated. Please use the ‘isPrintable’ property instead. Indicates whether the object is printable. If False, this shape will not be printed when printing.
getMsoDrawingType()	@deprecated. Please use the ‘msoDrawingType’ property instead. Gets drawing type.
getAutoShapeType()	@deprecated. Please use the ‘autoShapeType’ property instead. Gets and sets the auto shape type.
setAutoShapeType(AutoShapeType)	@deprecated. Please use the ‘autoShapeType’ property instead. Gets and sets the auto shape type.
getAnchorType()	@deprecated. Please use the ‘anchorType’ property instead. Gets and set the type of the shape anchor placeholder.
setAnchorType(ShapeAnchorType)	@deprecated. Please use the ‘anchorType’ property instead. Gets and set the type of the shape anchor placeholder.
getPlacement()	@deprecated. Please use the ‘placement’ property instead. Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet.
setPlacement(PlacementType)	@deprecated. Please use the ‘placement’ property instead. Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet.
getUpperLeftRow()	@deprecated. Please use the ‘upperLeftRow’ property instead. Represents the top row index.
setUpperLeftRow(number)	@deprecated. Please use the ‘upperLeftRow’ property instead. Represents the top row index.
getUpperDeltaY()	@deprecated. Please use the ‘upperDeltaY’ property instead. Gets or sets the shape’s vertical offset from its upper left corner row.
setUpperDeltaY(number)	@deprecated. Please use the ‘upperDeltaY’ property instead. Gets or sets the shape’s vertical offset from its upper left corner row.
getUpperLeftColumn()	@deprecated. Please use the ‘upperLeftColumn’ property instead. Represents upper left corner column index.
setUpperLeftColumn(number)	@deprecated. Please use the ‘upperLeftColumn’ property instead. Represents upper left corner column index.
getUpperDeltaX()	@deprecated. Please use the ‘upperDeltaX’ property instead. Gets or sets the shape’s horizontal offset from its upper left corner column.
setUpperDeltaX(number)	@deprecated. Please use the ‘upperDeltaX’ property instead. Gets or sets the shape’s horizontal offset from its upper left corner column.
getLowerRightRow()	@deprecated. Please use the ’lowerRightRow’ property instead. Represents lower right corner row index.
setLowerRightRow(number)	@deprecated. Please use the ’lowerRightRow’ property instead. Represents lower right corner row index.
getLowerDeltaY()	@deprecated. Please use the ’lowerDeltaY’ property instead. Gets or sets the shape’s vertical offset from its lower right corner row.
setLowerDeltaY(number)	@deprecated. Please use the ’lowerDeltaY’ property instead. Gets or sets the shape’s vertical offset from its lower right corner row.
getLowerRightColumn()	@deprecated. Please use the ’lowerRightColumn’ property instead. Represents lower right corner column index.
setLowerRightColumn(number)	@deprecated. Please use the ’lowerRightColumn’ property instead. Represents lower right corner column index.
getLowerDeltaX()	@deprecated. Please use the ’lowerDeltaX’ property instead. Gets or sets the shape’s horizontal offset from its lower right corner column.
setLowerDeltaX(number)	@deprecated. Please use the ’lowerDeltaX’ property instead. Gets or sets the shape’s horizontal offset from its lower right corner column.
getRight()	@deprecated. Please use the ‘right’ property instead. Represents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels.
setRight(number)	@deprecated. Please use the ‘right’ property instead. Represents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels.
getBottom()	@deprecated. Please use the ‘bottom’ property instead. Represents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels.
setBottom(number)	@deprecated. Please use the ‘bottom’ property instead. Represents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels.
getWidth()	@deprecated. Please use the ‘width’ property instead. Represents the width of shape, in unit of pixels.
setWidth(number)	@deprecated. Please use the ‘width’ property instead. Represents the width of shape, in unit of pixels.
getWidthInch()	@deprecated. Please use the ‘widthInch’ property instead. Represents the width of the shape, in unit of inch.
setWidthInch(number)	@deprecated. Please use the ‘widthInch’ property instead. Represents the width of the shape, in unit of inch.
getWidthPt()	@deprecated. Please use the ‘widthPt’ property instead. Represents the width of the shape, in unit of point.
setWidthPt(number)	@deprecated. Please use the ‘widthPt’ property instead. Represents the width of the shape, in unit of point.
getWidthCM()	@deprecated. Please use the ‘widthCM’ property instead. Represents the width of the shape, in unit of centimeters.
setWidthCM(number)	@deprecated. Please use the ‘widthCM’ property instead. Represents the width of the shape, in unit of centimeters.
getHeight()	@deprecated. Please use the ‘height’ property instead. Represents the height of shape, in unit of pixel.
setHeight(number)	@deprecated. Please use the ‘height’ property instead. Represents the height of shape, in unit of pixel.
getHeightInch()	@deprecated. Please use the ‘heightInch’ property instead. Represents the height of the shape, in unit of inches.
setHeightInch(number)	@deprecated. Please use the ‘heightInch’ property instead. Represents the height of the shape, in unit of inches.
getHeightPt()	@deprecated. Please use the ‘heightPt’ property instead. Represents the height of the shape, in unit of points.
setHeightPt(number)	@deprecated. Please use the ‘heightPt’ property instead. Represents the height of the shape, in unit of points.
getHeightCM()	@deprecated. Please use the ‘heightCM’ property instead. Represents the height of the shape, in unit of centimeters.
setHeightCM(number)	@deprecated. Please use the ‘heightCM’ property instead. Represents the height of the shape, in unit of centimeters.
getLeft()	@deprecated. Please use the ’left’ property instead. Represents the horizontal offset of shape from its left column, in unit of pixels.
setLeft(number)	@deprecated. Please use the ’left’ property instead. Represents the horizontal offset of shape from its left column, in unit of pixels.
getLeftInch()	@deprecated. Please use the ’leftInch’ property instead. Represents the horizontal offset of shape from its left column, in unit of inches.
setLeftInch(number)	@deprecated. Please use the ’leftInch’ property instead. Represents the horizontal offset of shape from its left column, in unit of inches.
getLeftCM()	@deprecated. Please use the ’leftCM’ property instead. Represents the horizontal offset of shape from its left column, in unit of centimeters.
setLeftCM(number)	@deprecated. Please use the ’leftCM’ property instead. Represents the horizontal offset of shape from its left column, in unit of centimeters.
getTop()	@deprecated. Please use the ’top’ property instead. Represents the vertical offset of shape from its top row, in unit of pixels.
setTop(number)	@deprecated. Please use the ’top’ property instead. Represents the vertical offset of shape from its top row, in unit of pixels.
getTopInch()	@deprecated. Please use the ’topInch’ property instead. Represents the vertical offset of shape from its top row, in unit of inches.
setTopInch(number)	@deprecated. Please use the ’topInch’ property instead. Represents the vertical offset of shape from its top row, in unit of inches.
getTopCM()	@deprecated. Please use the ’topCM’ property instead. Represents the vertical offset of shape from its top row, in unit of centimeters.
setTopCM(number)	@deprecated. Please use the ’topCM’ property instead. Represents the vertical offset of shape from its top row, in unit of centimeters.
getTopToCorner()	@deprecated. Please use the ’topToCorner’ property instead. Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
setTopToCorner(number)	@deprecated. Please use the ’topToCorner’ property instead. Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
getLeftToCorner()	@deprecated. Please use the ’leftToCorner’ property instead. Gets and sets the horizonal offset of shape from worksheet left border.
setLeftToCorner(number)	@deprecated. Please use the ’leftToCorner’ property instead. Gets and sets the horizonal offset of shape from worksheet left border.
getX()	@deprecated. Please use the ‘x’ property instead. Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
setX(number)	@deprecated. Please use the ‘x’ property instead. Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
getY()	@deprecated. Please use the ‘y’ property instead. Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
setY(number)	@deprecated. Please use the ‘y’ property instead. Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
getWidthScale()	@deprecated. Please use the ‘widthScale’ property instead. Gets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthScale property only returns 100;
setWidthScale(number)	@deprecated. Please use the ‘widthScale’ property instead. Gets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthScale property only returns 100;
getHeightScale()	@deprecated. Please use the ‘heightScale’ property instead. Gets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the HeightScale property only returns 100;
setHeightScale(number)	@deprecated. Please use the ‘heightScale’ property instead. Gets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the HeightScale property only returns 100;
getTopInShape()	@deprecated. Please use the ’topInShape’ property instead. Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
setTopInShape(number)	@deprecated. Please use the ’topInShape’ property instead. Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
getLeftInShape()	@deprecated. Please use the ’leftInShape’ property instead. Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
setLeftInShape(number)	@deprecated. Please use the ’leftInShape’ property instead. Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
getWidthInShape()	@deprecated. Please use the ‘widthInShape’ property instead. Represents the width of the shape, in unit of 1/4000 of the parent shape.
setWidthInShape(number)	@deprecated. Please use the ‘widthInShape’ property instead. Represents the width of the shape, in unit of 1/4000 of the parent shape.
getHeightInShape()	@deprecated. Please use the ‘heightInShape’ property instead. Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
setHeightInShape(number)	@deprecated. Please use the ‘heightInShape’ property instead. Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
getGroup()	@deprecated. Please use the ‘group’ property instead. Gets the group shape which contains this shape.
getType()	@deprecated. Please use the ’type’ property instead. Gets the auto shape type.
getHasLine()	@deprecated. Please use the ‘hasLine’ property instead. Gets and sets the line border of the shape is visible.
setHasLine(boolean)	@deprecated. Please use the ‘hasLine’ property instead. Gets and sets the line border of the shape is visible.
isFilled()	@deprecated. Please use the ‘isFilled’ property instead. Indicates whether the fill format is visible.
setIsFilled(boolean)	@deprecated. Please use the ‘isFilled’ property instead. Indicates whether the fill format is visible.
isFlippedHorizontally()	@deprecated. Please use the ‘isFlippedHorizontally’ property instead. Gets and sets whether shape is horizontally flipped .
setIsFlippedHorizontally(boolean)	@deprecated. Please use the ‘isFlippedHorizontally’ property instead. Gets and sets whether shape is horizontally flipped .
isFlippedVertically()	@deprecated. Please use the ‘isFlippedVertically’ property instead. Gets and sets whether shape is vertically flipped .
setIsFlippedVertically(boolean)	@deprecated. Please use the ‘isFlippedVertically’ property instead. Gets and sets whether shape is vertically flipped .
getActualLowerRightRow()	@deprecated. Please use the ‘actualLowerRightRow’ property instead. Get the actual bottom row.
getRelativeToOriginalPictureSize()	@deprecated. Please use the ‘relativeToOriginalPictureSize’ property instead. Indicates whether shape is relative to original picture size.
setRelativeToOriginalPictureSize(boolean)	@deprecated. Please use the ‘relativeToOriginalPictureSize’ property instead. Indicates whether shape is relative to original picture size.
getLinkedCell()	@deprecated. Please use the ’linkedCell’ property instead. Gets or sets the worksheet range linked to the control’s value.
setLinkedCell(string)	@deprecated. Please use the ’linkedCell’ property instead. Gets or sets the worksheet range linked to the control’s value.
getInputRange()	@deprecated. Please use the ‘inputRange’ property instead. Gets or sets the worksheet range used to fill the specified combo box.
setInputRange(string)	@deprecated. Please use the ‘inputRange’ property instead. Gets or sets the worksheet range used to fill the specified combo box.
getTextShapeType()	@deprecated. Please use the ’textShapeType’ property instead. Gets and sets the preset text shape type.
setTextShapeType(AutoShapeType)	@deprecated. Please use the ’textShapeType’ property instead. Gets and sets the preset text shape type.
getTextBody()	@deprecated. Please use the ’textBody’ property instead. Gets and sets the setting of the shape’s text.
getFont()	@deprecated. Please use the ‘font’ property instead. Represents the font of shape.
setFont(Font)	@deprecated. Please use the ‘font’ property instead. Represents the font of shape.
getTextOptions()	@deprecated. Please use the ’textOptions’ property instead. Represents the text options of the shape.
setTextOptions(TextOptions)	@deprecated. Please use the ’textOptions’ property instead. Represents the text options of the shape.
getText()	@deprecated. Please use the ’text’ property instead. Gets and sets the text of this shape.
setText(string)	@deprecated. Please use the ’text’ property instead. Gets and sets the text of this shape.
isRichText()	@deprecated. Please use the ‘isRichText’ property instead. Whether or not the text is rich text.
getHtmlText()	@deprecated. Please use the ‘htmlText’ property instead. Gets and sets the html string which contains data and some formats in this textbox.
setHtmlText(string)	@deprecated. Please use the ‘htmlText’ property instead. Gets and sets the html string which contains data and some formats in this textbox.
getTextVerticalOverflow()	@deprecated. Please use the ’textVerticalOverflow’ property instead. Gets and sets the text vertical overflow type of the shape which contains text.
setTextVerticalOverflow(TextOverflowType)	@deprecated. Please use the ’textVerticalOverflow’ property instead. Gets and sets the text vertical overflow type of the shape which contains text.
getTextHorizontalOverflow()	@deprecated. Please use the ’textHorizontalOverflow’ property instead. Gets and sets the text horizontal overflow type of the shape which contains text.
setTextHorizontalOverflow(TextOverflowType)	@deprecated. Please use the ’textHorizontalOverflow’ property instead. Gets and sets the text horizontal overflow type of the shape which contains text.
isTextWrapped()	@deprecated. Please use the ‘isTextWrapped’ property instead. Gets and sets the text wrapped type of the shape which contains text.
setIsTextWrapped(boolean)	@deprecated. Please use the ‘isTextWrapped’ property instead. Gets and sets the text wrapped type of the shape which contains text.
getTextOrientationType()	@deprecated. Please use the ’textOrientationType’ property instead. Gets and sets the text orientation type of the shape.
setTextOrientationType(TextOrientationType)	@deprecated. Please use the ’textOrientationType’ property instead. Gets and sets the text orientation type of the shape.
getTextHorizontalAlignment()	@deprecated. Please use the ’textHorizontalAlignment’ property instead. Gets and sets the text horizontal alignment type of the shape.
setTextHorizontalAlignment(TextAlignmentType)	@deprecated. Please use the ’textHorizontalAlignment’ property instead. Gets and sets the text horizontal alignment type of the shape.
getTextVerticalAlignment()	@deprecated. Please use the ’textVerticalAlignment’ property instead. Gets and sets the text vertical alignment type of the shape.
setTextVerticalAlignment(TextAlignmentType)	@deprecated. Please use the ’textVerticalAlignment’ property instead. Gets and sets the text vertical alignment type of the shape.
getTextDirection()	@deprecated. Please use the ’textDirection’ property instead. Gets/Sets the direction of the text flow for this object.
setTextDirection(TextDirectionType)	@deprecated. Please use the ’textDirection’ property instead. Gets/Sets the direction of the text flow for this object.
getTextBoxOptions()	@deprecated. Please use the ’textBoxOptions’ property instead. Gets the text information in the shape
getControlData()	@deprecated. Please use the ‘controlData’ property instead. Gets the data of control.
getActiveXControl()	@deprecated. Please use the ‘activeXControl’ property instead. Gets the ActiveX control.
getPaths()	@deprecated. Please use the ‘paths’ property instead. Gets the paths of a custom geometric shape.
getGeometry()	@deprecated. Please use the ‘geometry’ property instead. Gets the geometry
isDecorative()	@deprecated. Please use the ‘isDecorative’ property instead. Indicates whether the object is decorative.
setIsDecorative(boolean)	@deprecated. Please use the ‘isDecorative’ property instead. Indicates whether the object is decorative.
toFrontOrBack(number)	Brings the shape to the front or sends the shape to back.
getLockedProperty(ShapeLockType)	Gets the value of locked property.
setLockedProperty(ShapeLockType, boolean)	Set the locked property.
addHyperlink(string)	Adds a hyperlink to the shape.
removeHyperlink()	Removes the hyperlink of the shape.
moveToRange(number, number, number, number)	Moves the shape to a specified range.
alignTopRightCorner(number, number)	Moves the picture to the top-right corner.
getConnectionPoints()	Get the connection points
toImage(ImageType)	Creates the shape image and saves it to a stream in the specified format.
toImage(string, ImageOrPrintOptions)	Saves the shape to a file.
toImage(ImageOrPrintOptions)	Saves the shape to a stream.
toImageAsync(ImageType)	Creates the shape image and saves it to a stream in the specified format.
toImageAsync(string, ImageOrPrintOptions)	Saves the shape to a file.
toImageAsync(ImageOrPrintOptions)	Saves the shape to a stream.
getLinkedCell(boolean, boolean)	Gets the range linked to the control’s value.
setLinkedCell(string, boolean, boolean)	Sets the range linked to the control’s value.
getInputRange(boolean, boolean)	Gets the range used to fill the control.
setInputRange(string, boolean, boolean)	Sets the range used to fill the control.
updateSelectedValue()	Update the selected value by the value of the linked cell.
calculateTextSize()	Recalculate the text area
formatCharacters(number, number, Font, StyleFlag)	Formats some characters with the font setting.
characters(number, number)	Returns a Characters object that represents a range of characters within the text.
getRichFormattings()	Returns all Characters objects that represents a range of characters within the text .
removeActiveXControl()	Remove activeX control.
getActualBox()	Get the actual position and size of the shape (after applying rotation, flip, etc.)
fitToTextSize()	Recalculate a text area suitable for displaying all text content.
getResultOfSmartArt()	Converting smart art to grouped shapes.
isSameSetting(Object)	Returns whether the shape is same.

constructor(Shape)

Constructs from a parent object convertible to this.

constructor(obj: Shape);

Parameters:

Parameter	Type	Description
obj	Shape	The parent object.

webExtension

Gets and set the web extension.

webExtension : WebExtension;

macroName

Gets and sets the name of macro.

macroName : string;

isEquation

Readonly. Indicates whether the shape only contains an equation.

isEquation : boolean;

isSmartArt

Readonly. Indicates whether the shape is a smart art.

isSmartArt : boolean;

Remarks

Only for ooxml file.

zOrderPosition

Returns the position of a shape in the z-order.

zOrderPosition : number;

name

Gets and sets the name of the shape.

name : string;

alternativeText

Returns or sets the descriptive (alternative) text string of the Shape object.

alternativeText : string;

title

Specifies the title (caption) of the current shape object.

title : string;

line

Readonly. Gets line style

line : LineFormat;

fill

Readonly. Returns a FillFormat object that contains fill formatting properties for the specified shape.

fill : FillFormat;

shadowEffect

Readonly. Represents a Drawing.ShadowEffect object that specifies shadow effect for the chart element or shape.

shadowEffect : ShadowEffect;

reflection

Readonly. Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.

reflection : ReflectionEffect;

glow

Readonly. Represents a GlowEffect object that specifies glow effect for the chart element or shape.

glow : GlowEffect;

softEdges

Gets and sets the radius of blur to apply to the edges, in unit of points.

softEdges : number;

threeDFormat

Readonly. Gets and sets 3d format of the shape.

threeDFormat : ThreeDFormat;

formatPicture

Readonly. Gets and sets the options of the picture format.

formatPicture : MsoFormatPicture;

isHidden

Indicates whether the object is visible.

isHidden : boolean;

isLockAspectRatio

True means that aspect ratio of the shape is locked.

isLockAspectRatio : boolean;

Remarks

Only for pictures and Ole Objects. NOTE: This member is now obsolete. Instead, please use Shape.IsAspectRatioLocked property. This property will be removed 12 months later since July 2024. Aspose apologizes for any inconvenience you may have experienced.

isAspectRatioLocked

True means that aspect ratio of the shape is locked.

isAspectRatioLocked : boolean;

Remarks

Only for pictures and Ole Objects.

rotationAngle

Gets and sets the rotation of the shape.

rotationAngle : number;

hyperlink

Readonly. Gets the hyperlink of the shape.

hyperlink : Hyperlink;

id

Readonly. Gets the identifier of this shape.

id : number;

spid

Readonly. Specifies an optional string identifier that an application can use to identify the particular shape.

spid : string;

spt

Readonly. Specifies an optional number that an application can use to associate the particular shape with a defined shape type.

spt : number;

worksheet

Readonly. Gets the Worksheet object which contains this shape.

worksheet : Worksheet;

isGroup

Readonly. Indicates whether this shape is a group shape.

isGroup : boolean;

isInGroup

Readonly. Indicates whether the shape is grouped.

isInGroup : boolean;

isWordArt

Readonly. Indicates whether this shape is a word art.

isWordArt : boolean;

Remarks

Only for the Legacy Shape of xls file.

textEffect

Readonly. Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.

textEffect : TextEffectFormat;

isLocked

True means the object can not be modified when the sheet is protected. Note that this value is meaningful only if the worksheet or objects in the worksheet are protected.

isLocked : boolean;

isPrintable

Indicates whether the object is printable. If False, this shape will not be printed when printing.

isPrintable : boolean;

msoDrawingType

Readonly. Gets drawing type.

msoDrawingType : MsoDrawingType;

autoShapeType

Gets and sets the auto shape type.

autoShapeType : AutoShapeType;

anchorType

Gets and set the type of the shape anchor placeholder.

anchorType : ShapeAnchorType;

placement

Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet.

placement : PlacementType;

upperLeftRow

Represents the top row index.

upperLeftRow : number;

Remarks

If the shape is in the shape or in the group , UpperLeftRow will be ignored.

upperDeltaY

Gets or sets the shape’s vertical offset from its upper left corner row.

upperDeltaY : number;

Remarks

The range of value is 0 to 256.

upperLeftColumn

Represents upper left corner column index.

upperLeftColumn : number;

upperDeltaX

Gets or sets the shape’s horizontal offset from its upper left corner column.

upperDeltaX : number;

Remarks

The range of value is 0 to 1024.

lowerRightRow

Represents lower right corner row index.

lowerRightRow : number;

lowerDeltaY

Gets or sets the shape’s vertical offset from its lower right corner row.

lowerDeltaY : number;

Remarks

The range of value is 0 to 256.

lowerRightColumn

Represents lower right corner column index.

lowerRightColumn : number;

lowerDeltaX

Gets or sets the shape’s horizontal offset from its lower right corner column.

lowerDeltaX : number;

Remarks

The range of value is 0 to 1024.

right

Represents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels.

right : number;

bottom

Represents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels.

bottom : number;

width

Represents the width of shape, in unit of pixels.

width : number;

widthInch

Represents the width of the shape, in unit of inch.

widthInch : number;

widthPt

Represents the width of the shape, in unit of point.

widthPt : number;

widthCM

Represents the width of the shape, in unit of centimeters.

widthCM : number;

height

Represents the height of shape, in unit of pixel.

height : number;

heightInch

Represents the height of the shape, in unit of inches.

heightInch : number;

heightPt

Represents the height of the shape, in unit of points.

heightPt : number;

heightCM

Represents the height of the shape, in unit of centimeters.

heightCM : number;

left

Represents the horizontal offset of shape from its left column, in unit of pixels.

left : number;

leftInch

Represents the horizontal offset of shape from its left column, in unit of inches.

leftInch : number;

leftCM

Represents the horizontal offset of shape from its left column, in unit of centimeters.

leftCM : number;

top

Represents the vertical offset of shape from its top row, in unit of pixels.

top : number;

Remarks

If the shape is in the chart, represents the vertical offset of shape from its top border.

topInch

Represents the vertical offset of shape from its top row, in unit of inches.

topInch : number;

topCM

Represents the vertical offset of shape from its top row, in unit of centimeters.

topCM : number;

topToCorner

Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.

topToCorner : number;

leftToCorner

Gets and sets the horizonal offset of shape from worksheet left border.

leftToCorner : number;

x

Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.

x : number;

y

Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.

y : number;

widthScale

Gets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthScale property only returns 100;

widthScale : number;

heightScale

Gets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the HeightScale property only returns 100;

heightScale : number;

topInShape

Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.

topInShape : number;

Remarks

Only Applies when this shape in the group or chart.

leftInShape

Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.

leftInShape : number;

Remarks

Only Applies when this shape in the group or chart.

widthInShape

Represents the width of the shape, in unit of 1/4000 of the parent shape.

widthInShape : number;

Remarks

Only Applies when this shape in the group or chart.

heightInShape

Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..

heightInShape : number;

Remarks

Only Applies when this shape in the group or chart.

group

Readonly. Gets the group shape which contains this shape.

group : GroupShape;

type

Readonly. Gets the auto shape type.

type : AutoShapeType;

hasLine

Gets and sets the line border of the shape is visible.

hasLine : boolean;

isFilled

Indicates whether the fill format is visible.

isFilled : boolean;

isFlippedHorizontally

Gets and sets whether shape is horizontally flipped .

isFlippedHorizontally : boolean;

isFlippedVertically

Gets and sets whether shape is vertically flipped .

isFlippedVertically : boolean;

actualLowerRightRow

Readonly. Get the actual bottom row.

actualLowerRightRow : number;

relativeToOriginalPictureSize

Indicates whether shape is relative to original picture size.

relativeToOriginalPictureSize : boolean;

linkedCell

Gets or sets the worksheet range linked to the control’s value.

linkedCell : string;

inputRange

Gets or sets the worksheet range used to fill the specified combo box.

inputRange : string;

textShapeType

Gets and sets the preset text shape type.

textShapeType : AutoShapeType;

textBody

Readonly. Gets and sets the setting of the shape’s text.

textBody : FontSettingCollection;

font

Represents the font of shape.

font : Font;

textOptions

Represents the text options of the shape.

textOptions : TextOptions;

text

Gets and sets the text of this shape.

text : string;

isRichText

Readonly. Whether or not the text is rich text.

isRichText : boolean;

htmlText

Gets and sets the html string which contains data and some formats in this textbox.

htmlText : string;

textVerticalOverflow

Gets and sets the text vertical overflow type of the shape which contains text.

textVerticalOverflow : TextOverflowType;

textHorizontalOverflow

Gets and sets the text horizontal overflow type of the shape which contains text.

textHorizontalOverflow : TextOverflowType;

isTextWrapped

Gets and sets the text wrapped type of the shape which contains text.

isTextWrapped : boolean;

textOrientationType

Gets and sets the text orientation type of the shape.

textOrientationType : TextOrientationType;

textHorizontalAlignment

Gets and sets the text horizontal alignment type of the shape.

textHorizontalAlignment : TextAlignmentType;

textVerticalAlignment

Gets and sets the text vertical alignment type of the shape.

textVerticalAlignment : TextAlignmentType;

textDirection

Gets/Sets the direction of the text flow for this object.

textDirection : TextDirectionType;

textBoxOptions

Readonly. Gets the text information in the shape

textBoxOptions : TextBoxOptions;

controlData

Readonly. Gets the data of control.

controlData : Uint8Array;

activeXControl

Readonly. Gets the ActiveX control.

activeXControl : ActiveXControl;

paths

Readonly. Gets the paths of a custom geometric shape.

paths : ShapePathCollection;

geometry

Readonly. Gets the geometry

geometry : Geometry;

isDecorative

Indicates whether the object is decorative.

isDecorative : boolean;

getWebExtension()

@deprecated. Please use the ‘webExtension’ property instead. Gets and set the web extension.

getWebExtension() : WebExtension;

Returns

WebExtension

setWebExtension(WebExtension)

@deprecated. Please use the ‘webExtension’ property instead. Gets and set the web extension.

setWebExtension(value: WebExtension) : void;

Parameters:

Parameter	Type	Description
value	WebExtension	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getMacroName()

@deprecated. Please use the ‘macroName’ property instead. Gets and sets the name of macro.

getMacroName() : string;

setMacroName(string)

@deprecated. Please use the ‘macroName’ property instead. Gets and sets the name of macro.

setMacroName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

isEquation()

@deprecated. Please use the ‘isEquation’ property instead. Indicates whether the shape only contains an equation.

isEquation() : boolean;

isSmartArt()

@deprecated. Please use the ‘isSmartArt’ property instead. Indicates whether the shape is a smart art.

isSmartArt() : boolean;

Remarks

Only for ooxml file.

getZOrderPosition()

@deprecated. Please use the ‘zOrderPosition’ property instead. Returns the position of a shape in the z-order.

getZOrderPosition() : number;

setZOrderPosition(number)

@deprecated. Please use the ‘zOrderPosition’ property instead. Returns the position of a shape in the z-order.

setZOrderPosition(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getName()

@deprecated. Please use the ’name’ property instead. Gets and sets the name of the shape.

getName() : string;

setName(string)

@deprecated. Please use the ’name’ property instead. Gets and sets the name of the shape.

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getAlternativeText()

@deprecated. Please use the ‘alternativeText’ property instead. Returns or sets the descriptive (alternative) text string of the Shape object.

getAlternativeText() : string;

setAlternativeText(string)

@deprecated. Please use the ‘alternativeText’ property instead. Returns or sets the descriptive (alternative) text string of the Shape object.

setAlternativeText(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getTitle()

@deprecated. Please use the ’title’ property instead. Specifies the title (caption) of the current shape object.

getTitle() : string;

setTitle(string)

@deprecated. Please use the ’title’ property instead. Specifies the title (caption) of the current shape object.

setTitle(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getLine()

@deprecated. Please use the ’line’ property instead. Gets line style

getLine() : LineFormat;

Returns

LineFormat

getFill()

@deprecated. Please use the ‘fill’ property instead. Returns a FillFormat object that contains fill formatting properties for the specified shape.

getFill() : FillFormat;

Returns

FillFormat

getShadowEffect()

@deprecated. Please use the ‘shadowEffect’ property instead. Represents a Drawing.ShadowEffect object that specifies shadow effect for the chart element or shape.

getShadowEffect() : ShadowEffect;

Returns

ShadowEffect

getReflection()

@deprecated. Please use the ‘reflection’ property instead. Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.

getReflection() : ReflectionEffect;

Returns

ReflectionEffect

getGlow()

@deprecated. Please use the ‘glow’ property instead. Represents a GlowEffect object that specifies glow effect for the chart element or shape.

getGlow() : GlowEffect;

Returns

GlowEffect

getSoftEdges()

@deprecated. Please use the ‘softEdges’ property instead. Gets and sets the radius of blur to apply to the edges, in unit of points.

getSoftEdges() : number;

setSoftEdges(number)

@deprecated. Please use the ‘softEdges’ property instead. Gets and sets the radius of blur to apply to the edges, in unit of points.

setSoftEdges(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getThreeDFormat()

@deprecated. Please use the ’threeDFormat’ property instead. Gets and sets 3d format of the shape.

getThreeDFormat() : ThreeDFormat;

Returns

ThreeDFormat

getFormatPicture()

@deprecated. Please use the ‘formatPicture’ property instead. Gets and sets the options of the picture format.

getFormatPicture() : MsoFormatPicture;

Returns

MsoFormatPicture

isHidden()

@deprecated. Please use the ‘isHidden’ property instead. Indicates whether the object is visible.

isHidden() : boolean;

setIsHidden(boolean)

@deprecated. Please use the ‘isHidden’ property instead. Indicates whether the object is visible.

setIsHidden(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isLockAspectRatio()

@deprecated. Please use the ‘isLockAspectRatio’ property instead. True means that aspect ratio of the shape is locked.

isLockAspectRatio() : boolean;

Remarks

setIsLockAspectRatio(boolean)

@deprecated. Please use the ‘isLockAspectRatio’ property instead. True means that aspect ratio of the shape is locked.

setIsLockAspectRatio(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

isAspectRatioLocked()

@deprecated. Please use the ‘isAspectRatioLocked’ property instead. True means that aspect ratio of the shape is locked.

isAspectRatioLocked() : boolean;

Remarks

Only for pictures and Ole Objects.

setIsAspectRatioLocked(boolean)

@deprecated. Please use the ‘isAspectRatioLocked’ property instead. True means that aspect ratio of the shape is locked.

setIsAspectRatioLocked(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for pictures and Ole Objects.

getRotationAngle()

@deprecated. Please use the ‘rotationAngle’ property instead. Gets and sets the rotation of the shape.

getRotationAngle() : number;

setRotationAngle(number)

@deprecated. Please use the ‘rotationAngle’ property instead. Gets and sets the rotation of the shape.

setRotationAngle(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getHyperlink()

@deprecated. Please use the ‘hyperlink’ property instead. Gets the hyperlink of the shape.

getHyperlink() : Hyperlink;

Returns

Hyperlink

getId()

@deprecated. Please use the ‘id’ property instead. Gets the identifier of this shape.

getId() : number;

getSpid()

@deprecated. Please use the ‘spid’ property instead. Specifies an optional string identifier that an application can use to identify the particular shape.

getSpid() : string;

getSpt()

@deprecated. Please use the ‘spt’ property instead. Specifies an optional number that an application can use to associate the particular shape with a defined shape type.

getSpt() : number;

getWorksheet()

@deprecated. Please use the ‘worksheet’ property instead. Gets the Worksheet object which contains this shape.

getWorksheet() : Worksheet;

Returns

Worksheet

isGroup()

@deprecated. Please use the ‘isGroup’ property instead. Indicates whether this shape is a group shape.

isGroup() : boolean;

isInGroup()

@deprecated. Please use the ‘isInGroup’ property instead. Indicates whether the shape is grouped.

isInGroup() : boolean;

isWordArt()

@deprecated. Please use the ‘isWordArt’ property instead. Indicates whether this shape is a word art.

isWordArt() : boolean;

Remarks

Only for the Legacy Shape of xls file.

getTextEffect()

@deprecated. Please use the ’textEffect’ property instead. Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.

getTextEffect() : TextEffectFormat;

Returns

TextEffectFormat

isLocked()

@deprecated. Please use the ‘isLocked’ property instead. True means the object can not be modified when the sheet is protected. Note that this value is meaningful only if the worksheet or objects in the worksheet are protected.

isLocked() : boolean;

setIsLocked(boolean)

setIsLocked(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isPrintable()

@deprecated. Please use the ‘isPrintable’ property instead. Indicates whether the object is printable. If False, this shape will not be printed when printing.

isPrintable() : boolean;

setIsPrintable(boolean)

@deprecated. Please use the ‘isPrintable’ property instead. Indicates whether the object is printable. If False, this shape will not be printed when printing.

setIsPrintable(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getMsoDrawingType()

@deprecated. Please use the ‘msoDrawingType’ property instead. Gets drawing type.

getMsoDrawingType() : MsoDrawingType;

Returns

MsoDrawingType

getAutoShapeType()

@deprecated. Please use the ‘autoShapeType’ property instead. Gets and sets the auto shape type.

getAutoShapeType() : AutoShapeType;

Returns

AutoShapeType

setAutoShapeType(AutoShapeType)

@deprecated. Please use the ‘autoShapeType’ property instead. Gets and sets the auto shape type.

setAutoShapeType(value: AutoShapeType) : void;

Parameters:

Parameter	Type	Description
value	AutoShapeType	The value to set.

getAnchorType()

@deprecated. Please use the ‘anchorType’ property instead. Gets and set the type of the shape anchor placeholder.

getAnchorType() : ShapeAnchorType;

Returns

ShapeAnchorType

setAnchorType(ShapeAnchorType)

@deprecated. Please use the ‘anchorType’ property instead. Gets and set the type of the shape anchor placeholder.

setAnchorType(value: ShapeAnchorType) : void;

Parameters:

Parameter	Type	Description
value	ShapeAnchorType	The value to set.

getPlacement()

@deprecated. Please use the ‘placement’ property instead. Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet.

getPlacement() : PlacementType;

Returns

PlacementType

setPlacement(PlacementType)

setPlacement(value: PlacementType) : void;

Parameters:

Parameter	Type	Description
value	PlacementType	The value to set.

getUpperLeftRow()

@deprecated. Please use the ‘upperLeftRow’ property instead. Represents the top row index.

getUpperLeftRow() : number;

Remarks

If the shape is in the shape or in the group , UpperLeftRow will be ignored.

setUpperLeftRow(number)

@deprecated. Please use the ‘upperLeftRow’ property instead. Represents the top row index.

setUpperLeftRow(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

If the shape is in the shape or in the group , UpperLeftRow will be ignored.

getUpperDeltaY()

@deprecated. Please use the ‘upperDeltaY’ property instead. Gets or sets the shape’s vertical offset from its upper left corner row.

getUpperDeltaY() : number;

Remarks

The range of value is 0 to 256.

setUpperDeltaY(number)

@deprecated. Please use the ‘upperDeltaY’ property instead. Gets or sets the shape’s vertical offset from its upper left corner row.

setUpperDeltaY(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

The range of value is 0 to 256.

getUpperLeftColumn()

@deprecated. Please use the ‘upperLeftColumn’ property instead. Represents upper left corner column index.

getUpperLeftColumn() : number;

setUpperLeftColumn(number)

@deprecated. Please use the ‘upperLeftColumn’ property instead. Represents upper left corner column index.

setUpperLeftColumn(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getUpperDeltaX()

@deprecated. Please use the ‘upperDeltaX’ property instead. Gets or sets the shape’s horizontal offset from its upper left corner column.

getUpperDeltaX() : number;

Remarks

The range of value is 0 to 1024.

setUpperDeltaX(number)

@deprecated. Please use the ‘upperDeltaX’ property instead. Gets or sets the shape’s horizontal offset from its upper left corner column.

setUpperDeltaX(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

The range of value is 0 to 1024.

getLowerRightRow()

@deprecated. Please use the ’lowerRightRow’ property instead. Represents lower right corner row index.

getLowerRightRow() : number;

setLowerRightRow(number)

@deprecated. Please use the ’lowerRightRow’ property instead. Represents lower right corner row index.

setLowerRightRow(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLowerDeltaY()

@deprecated. Please use the ’lowerDeltaY’ property instead. Gets or sets the shape’s vertical offset from its lower right corner row.

getLowerDeltaY() : number;

Remarks

The range of value is 0 to 256.

setLowerDeltaY(number)

@deprecated. Please use the ’lowerDeltaY’ property instead. Gets or sets the shape’s vertical offset from its lower right corner row.

setLowerDeltaY(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

The range of value is 0 to 256.

getLowerRightColumn()

@deprecated. Please use the ’lowerRightColumn’ property instead. Represents lower right corner column index.

getLowerRightColumn() : number;

setLowerRightColumn(number)

@deprecated. Please use the ’lowerRightColumn’ property instead. Represents lower right corner column index.

setLowerRightColumn(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLowerDeltaX()

@deprecated. Please use the ’lowerDeltaX’ property instead. Gets or sets the shape’s horizontal offset from its lower right corner column.

getLowerDeltaX() : number;

Remarks

The range of value is 0 to 1024.

setLowerDeltaX(number)

@deprecated. Please use the ’lowerDeltaX’ property instead. Gets or sets the shape’s horizontal offset from its lower right corner column.

setLowerDeltaX(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

The range of value is 0 to 1024.

getRight()

@deprecated. Please use the ‘right’ property instead. Represents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels.

getRight() : number;

setRight(number)

@deprecated. Please use the ‘right’ property instead. Represents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels.

setRight(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getBottom()

@deprecated. Please use the ‘bottom’ property instead. Represents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels.

getBottom() : number;

setBottom(number)

@deprecated. Please use the ‘bottom’ property instead. Represents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels.

setBottom(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getWidth()

@deprecated. Please use the ‘width’ property instead. Represents the width of shape, in unit of pixels.

getWidth() : number;

setWidth(number)

@deprecated. Please use the ‘width’ property instead. Represents the width of shape, in unit of pixels.

setWidth(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getWidthInch()

@deprecated. Please use the ‘widthInch’ property instead. Represents the width of the shape, in unit of inch.

getWidthInch() : number;

setWidthInch(number)

@deprecated. Please use the ‘widthInch’ property instead. Represents the width of the shape, in unit of inch.

setWidthInch(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getWidthPt()

@deprecated. Please use the ‘widthPt’ property instead. Represents the width of the shape, in unit of point.

getWidthPt() : number;

setWidthPt(number)

@deprecated. Please use the ‘widthPt’ property instead. Represents the width of the shape, in unit of point.

setWidthPt(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getWidthCM()

@deprecated. Please use the ‘widthCM’ property instead. Represents the width of the shape, in unit of centimeters.

getWidthCM() : number;

setWidthCM(number)

@deprecated. Please use the ‘widthCM’ property instead. Represents the width of the shape, in unit of centimeters.

setWidthCM(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getHeight()

@deprecated. Please use the ‘height’ property instead. Represents the height of shape, in unit of pixel.

getHeight() : number;

setHeight(number)

@deprecated. Please use the ‘height’ property instead. Represents the height of shape, in unit of pixel.

setHeight(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getHeightInch()

@deprecated. Please use the ‘heightInch’ property instead. Represents the height of the shape, in unit of inches.

getHeightInch() : number;

setHeightInch(number)

@deprecated. Please use the ‘heightInch’ property instead. Represents the height of the shape, in unit of inches.

setHeightInch(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getHeightPt()

@deprecated. Please use the ‘heightPt’ property instead. Represents the height of the shape, in unit of points.

getHeightPt() : number;

setHeightPt(number)

@deprecated. Please use the ‘heightPt’ property instead. Represents the height of the shape, in unit of points.

setHeightPt(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getHeightCM()

@deprecated. Please use the ‘heightCM’ property instead. Represents the height of the shape, in unit of centimeters.

getHeightCM() : number;

setHeightCM(number)

@deprecated. Please use the ‘heightCM’ property instead. Represents the height of the shape, in unit of centimeters.

setHeightCM(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLeft()

@deprecated. Please use the ’left’ property instead. Represents the horizontal offset of shape from its left column, in unit of pixels.

getLeft() : number;

setLeft(number)

@deprecated. Please use the ’left’ property instead. Represents the horizontal offset of shape from its left column, in unit of pixels.

setLeft(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLeftInch()

@deprecated. Please use the ’leftInch’ property instead. Represents the horizontal offset of shape from its left column, in unit of inches.

getLeftInch() : number;

setLeftInch(number)

@deprecated. Please use the ’leftInch’ property instead. Represents the horizontal offset of shape from its left column, in unit of inches.

setLeftInch(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLeftCM()

@deprecated. Please use the ’leftCM’ property instead. Represents the horizontal offset of shape from its left column, in unit of centimeters.

getLeftCM() : number;

setLeftCM(number)

@deprecated. Please use the ’leftCM’ property instead. Represents the horizontal offset of shape from its left column, in unit of centimeters.

setLeftCM(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTop()

@deprecated. Please use the ’top’ property instead. Represents the vertical offset of shape from its top row, in unit of pixels.

getTop() : number;

Remarks

If the shape is in the chart, represents the vertical offset of shape from its top border.

setTop(number)

@deprecated. Please use the ’top’ property instead. Represents the vertical offset of shape from its top row, in unit of pixels.

setTop(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

If the shape is in the chart, represents the vertical offset of shape from its top border.

getTopInch()

@deprecated. Please use the ’topInch’ property instead. Represents the vertical offset of shape from its top row, in unit of inches.

getTopInch() : number;

setTopInch(number)

@deprecated. Please use the ’topInch’ property instead. Represents the vertical offset of shape from its top row, in unit of inches.

setTopInch(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTopCM()

@deprecated. Please use the ’topCM’ property instead. Represents the vertical offset of shape from its top row, in unit of centimeters.

getTopCM() : number;

setTopCM(number)

@deprecated. Please use the ’topCM’ property instead. Represents the vertical offset of shape from its top row, in unit of centimeters.

setTopCM(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTopToCorner()

@deprecated. Please use the ’topToCorner’ property instead. Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.

getTopToCorner() : number;

setTopToCorner(number)

@deprecated. Please use the ’topToCorner’ property instead. Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.

setTopToCorner(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLeftToCorner()

@deprecated. Please use the ’leftToCorner’ property instead. Gets and sets the horizonal offset of shape from worksheet left border.

getLeftToCorner() : number;

setLeftToCorner(number)

@deprecated. Please use the ’leftToCorner’ property instead. Gets and sets the horizonal offset of shape from worksheet left border.

setLeftToCorner(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getX()

@deprecated. Please use the ‘x’ property instead. Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.

getX() : number;

setX(number)

@deprecated. Please use the ‘x’ property instead. Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.

setX(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getY()

@deprecated. Please use the ‘y’ property instead. Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.

getY() : number;

setY(number)

@deprecated. Please use the ‘y’ property instead. Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.

setY(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getWidthScale()

@deprecated. Please use the ‘widthScale’ property instead. Gets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthScale property only returns 100;

getWidthScale() : number;

setWidthScale(number)

setWidthScale(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getHeightScale()

@deprecated. Please use the ‘heightScale’ property instead. Gets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the HeightScale property only returns 100;

getHeightScale() : number;

setHeightScale(number)

setHeightScale(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTopInShape()

@deprecated. Please use the ’topInShape’ property instead. Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.

getTopInShape() : number;

Remarks

Only Applies when this shape in the group or chart.

setTopInShape(number)

@deprecated. Please use the ’topInShape’ property instead. Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.

setTopInShape(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

Only Applies when this shape in the group or chart.

getLeftInShape()

@deprecated. Please use the ’leftInShape’ property instead. Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.

getLeftInShape() : number;

Remarks

Only Applies when this shape in the group or chart.

setLeftInShape(number)

@deprecated. Please use the ’leftInShape’ property instead. Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.

setLeftInShape(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

Only Applies when this shape in the group or chart.

getWidthInShape()

@deprecated. Please use the ‘widthInShape’ property instead. Represents the width of the shape, in unit of 1/4000 of the parent shape.

getWidthInShape() : number;

Remarks

Only Applies when this shape in the group or chart.

setWidthInShape(number)

@deprecated. Please use the ‘widthInShape’ property instead. Represents the width of the shape, in unit of 1/4000 of the parent shape.

setWidthInShape(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

Only Applies when this shape in the group or chart.

getHeightInShape()

@deprecated. Please use the ‘heightInShape’ property instead. Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..

getHeightInShape() : number;

Remarks

Only Applies when this shape in the group or chart.

setHeightInShape(number)

setHeightInShape(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

Only Applies when this shape in the group or chart.

getGroup()

@deprecated. Please use the ‘group’ property instead. Gets the group shape which contains this shape.

getGroup() : GroupShape;

Returns

GroupShape

getType()

@deprecated. Please use the ’type’ property instead. Gets the auto shape type.

getType() : AutoShapeType;

Returns

AutoShapeType

getHasLine()

@deprecated. Please use the ‘hasLine’ property instead. Gets and sets the line border of the shape is visible.

getHasLine() : boolean;

setHasLine(boolean)

@deprecated. Please use the ‘hasLine’ property instead. Gets and sets the line border of the shape is visible.

setHasLine(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isFilled()

@deprecated. Please use the ‘isFilled’ property instead. Indicates whether the fill format is visible.

isFilled() : boolean;

setIsFilled(boolean)

@deprecated. Please use the ‘isFilled’ property instead. Indicates whether the fill format is visible.

setIsFilled(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isFlippedHorizontally()

@deprecated. Please use the ‘isFlippedHorizontally’ property instead. Gets and sets whether shape is horizontally flipped .

isFlippedHorizontally() : boolean;

setIsFlippedHorizontally(boolean)

@deprecated. Please use the ‘isFlippedHorizontally’ property instead. Gets and sets whether shape is horizontally flipped .

setIsFlippedHorizontally(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isFlippedVertically()

@deprecated. Please use the ‘isFlippedVertically’ property instead. Gets and sets whether shape is vertically flipped .

isFlippedVertically() : boolean;

setIsFlippedVertically(boolean)

@deprecated. Please use the ‘isFlippedVertically’ property instead. Gets and sets whether shape is vertically flipped .

setIsFlippedVertically(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getActualLowerRightRow()

@deprecated. Please use the ‘actualLowerRightRow’ property instead. Get the actual bottom row.

getActualLowerRightRow() : number;

getRelativeToOriginalPictureSize()

@deprecated. Please use the ‘relativeToOriginalPictureSize’ property instead. Indicates whether shape is relative to original picture size.

getRelativeToOriginalPictureSize() : boolean;

setRelativeToOriginalPictureSize(boolean)

@deprecated. Please use the ‘relativeToOriginalPictureSize’ property instead. Indicates whether shape is relative to original picture size.

setRelativeToOriginalPictureSize(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getLinkedCell()

@deprecated. Please use the ’linkedCell’ property instead. Gets or sets the worksheet range linked to the control’s value.

getLinkedCell() : string;

setLinkedCell(string)

@deprecated. Please use the ’linkedCell’ property instead. Gets or sets the worksheet range linked to the control’s value.

setLinkedCell(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getInputRange()

@deprecated. Please use the ‘inputRange’ property instead. Gets or sets the worksheet range used to fill the specified combo box.

getInputRange() : string;

setInputRange(string)

@deprecated. Please use the ‘inputRange’ property instead. Gets or sets the worksheet range used to fill the specified combo box.

setInputRange(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getTextShapeType()

@deprecated. Please use the ’textShapeType’ property instead. Gets and sets the preset text shape type.

getTextShapeType() : AutoShapeType;

Returns

AutoShapeType

setTextShapeType(AutoShapeType)

@deprecated. Please use the ’textShapeType’ property instead. Gets and sets the preset text shape type.

setTextShapeType(value: AutoShapeType) : void;

Parameters:

Parameter	Type	Description
value	AutoShapeType	The value to set.

getTextBody()

@deprecated. Please use the ’textBody’ property instead. Gets and sets the setting of the shape’s text.

getTextBody() : FontSettingCollection;

Returns

FontSettingCollection

getFont()

@deprecated. Please use the ‘font’ property instead. Represents the font of shape.

getFont() : Font;

Returns

Font

setFont(Font)

@deprecated. Please use the ‘font’ property instead. Represents the font of shape.

setFont(value: Font) : void;

Parameters:

Parameter	Type	Description
value	Font	The value to set.

getTextOptions()

@deprecated. Please use the ’textOptions’ property instead. Represents the text options of the shape.

getTextOptions() : TextOptions;

Returns

TextOptions

setTextOptions(TextOptions)

@deprecated. Please use the ’textOptions’ property instead. Represents the text options of the shape.

setTextOptions(value: TextOptions) : void;

Parameters:

Parameter	Type	Description
value	TextOptions	The value to set.

getText()

@deprecated. Please use the ’text’ property instead. Gets and sets the text of this shape.

getText() : string;

setText(string)

@deprecated. Please use the ’text’ property instead. Gets and sets the text of this shape.

setText(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

isRichText()

@deprecated. Please use the ‘isRichText’ property instead. Whether or not the text is rich text.

isRichText() : boolean;

getHtmlText()

@deprecated. Please use the ‘htmlText’ property instead. Gets and sets the html string which contains data and some formats in this textbox.

getHtmlText() : string;

setHtmlText(string)

@deprecated. Please use the ‘htmlText’ property instead. Gets and sets the html string which contains data and some formats in this textbox.

setHtmlText(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getTextVerticalOverflow()

@deprecated. Please use the ’textVerticalOverflow’ property instead. Gets and sets the text vertical overflow type of the shape which contains text.

getTextVerticalOverflow() : TextOverflowType;

Returns

TextOverflowType

setTextVerticalOverflow(TextOverflowType)

@deprecated. Please use the ’textVerticalOverflow’ property instead. Gets and sets the text vertical overflow type of the shape which contains text.

setTextVerticalOverflow(value: TextOverflowType) : void;

Parameters:

Parameter	Type	Description
value	TextOverflowType	The value to set.

getTextHorizontalOverflow()

@deprecated. Please use the ’textHorizontalOverflow’ property instead. Gets and sets the text horizontal overflow type of the shape which contains text.

getTextHorizontalOverflow() : TextOverflowType;

Returns

TextOverflowType

setTextHorizontalOverflow(TextOverflowType)

@deprecated. Please use the ’textHorizontalOverflow’ property instead. Gets and sets the text horizontal overflow type of the shape which contains text.

setTextHorizontalOverflow(value: TextOverflowType) : void;

Parameters:

Parameter	Type	Description
value	TextOverflowType	The value to set.

isTextWrapped()

@deprecated. Please use the ‘isTextWrapped’ property instead. Gets and sets the text wrapped type of the shape which contains text.

isTextWrapped() : boolean;

setIsTextWrapped(boolean)

@deprecated. Please use the ‘isTextWrapped’ property instead. Gets and sets the text wrapped type of the shape which contains text.

setIsTextWrapped(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getTextOrientationType()

@deprecated. Please use the ’textOrientationType’ property instead. Gets and sets the text orientation type of the shape.

getTextOrientationType() : TextOrientationType;

Returns

TextOrientationType

setTextOrientationType(TextOrientationType)

@deprecated. Please use the ’textOrientationType’ property instead. Gets and sets the text orientation type of the shape.

setTextOrientationType(value: TextOrientationType) : void;

Parameters:

Parameter	Type	Description
value	TextOrientationType	The value to set.

getTextHorizontalAlignment()

@deprecated. Please use the ’textHorizontalAlignment’ property instead. Gets and sets the text horizontal alignment type of the shape.

getTextHorizontalAlignment() : TextAlignmentType;

Returns

TextAlignmentType

setTextHorizontalAlignment(TextAlignmentType)

@deprecated. Please use the ’textHorizontalAlignment’ property instead. Gets and sets the text horizontal alignment type of the shape.

setTextHorizontalAlignment(value: TextAlignmentType) : void;

Parameters:

Parameter	Type	Description
value	TextAlignmentType	The value to set.

getTextVerticalAlignment()

@deprecated. Please use the ’textVerticalAlignment’ property instead. Gets and sets the text vertical alignment type of the shape.

getTextVerticalAlignment() : TextAlignmentType;

Returns

TextAlignmentType

setTextVerticalAlignment(TextAlignmentType)

@deprecated. Please use the ’textVerticalAlignment’ property instead. Gets and sets the text vertical alignment type of the shape.

setTextVerticalAlignment(value: TextAlignmentType) : void;

Parameters:

Parameter	Type	Description
value	TextAlignmentType	The value to set.

getTextDirection()

@deprecated. Please use the ’textDirection’ property instead. Gets/Sets the direction of the text flow for this object.

getTextDirection() : TextDirectionType;

Returns

TextDirectionType

setTextDirection(TextDirectionType)

@deprecated. Please use the ’textDirection’ property instead. Gets/Sets the direction of the text flow for this object.

setTextDirection(value: TextDirectionType) : void;

Parameters:

Parameter	Type	Description
value	TextDirectionType	The value to set.

getTextBoxOptions()

@deprecated. Please use the ’textBoxOptions’ property instead. Gets the text information in the shape

getTextBoxOptions() : TextBoxOptions;

Returns

TextBoxOptions

getControlData()

@deprecated. Please use the ‘controlData’ property instead. Gets the data of control.

getControlData() : Uint8Array;

getActiveXControl()

@deprecated. Please use the ‘activeXControl’ property instead. Gets the ActiveX control.

getActiveXControl() : ActiveXControl;

Returns

ActiveXControl

getPaths()

@deprecated. Please use the ‘paths’ property instead. Gets the paths of a custom geometric shape.

getPaths() : ShapePathCollection;

Returns

ShapePathCollection

getGeometry()

@deprecated. Please use the ‘geometry’ property instead. Gets the geometry

getGeometry() : Geometry;

Returns

Geometry

isDecorative()

@deprecated. Please use the ‘isDecorative’ property instead. Indicates whether the object is decorative.

isDecorative() : boolean;

setIsDecorative(boolean)

@deprecated. Please use the ‘isDecorative’ property instead. Indicates whether the object is decorative.

setIsDecorative(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

toFrontOrBack(number)

Brings the shape to the front or sends the shape to back.

toFrontOrBack(orders: number) : void;

Parameters:

Parameter	Type	Description
orders	number	If it’s less than zero, sets the shape to back. /// If it’s greater than zero, brings the shape to front.

getLockedProperty(ShapeLockType)

Gets the value of locked property.

getLockedProperty(type: ShapeLockType) : boolean;

Parameters:

Parameter	Type	Description
type	ShapeLockType	The type of the shape locked property.

Returns

Returns the value of locked property.

setLockedProperty(ShapeLockType, boolean)

Set the locked property.

setLockedProperty(type: ShapeLockType, value: boolean) : void;

Parameters:

Parameter	Type	Description
type	ShapeLockType	The locked type.
value	boolean	The value of the property.

addHyperlink(string)

Adds a hyperlink to the shape.

addHyperlink(address: string) : Hyperlink;

Parameters:

Parameter	Type	Description
address	string	Address of the hyperlink.

Returns

Return the new hyperlink object.

removeHyperlink()

Removes the hyperlink of the shape.

removeHyperlink() : void;

moveToRange(number, number, number, number)

Moves the shape to a specified range.

moveToRange(upperLeftRow: number, upperLeftColumn: number, lowerRightRow: number, lowerRightColumn: number) : void;

Parameters:

Parameter	Type	Description
upperLeftRow	number	Upper left row index.
upperLeftColumn	number	Upper left column index.
lowerRightRow	number	Lower right row index
lowerRightColumn	number	Lower right column index

alignTopRightCorner(number, number)

Moves the picture to the top-right corner.

alignTopRightCorner(topRow: number, rightColumn: number) : void;

Parameters:

Parameter	Type	Description
topRow	number	the row index.
rightColumn	number	the column index.

getConnectionPoints()

Get the connection points

getConnectionPoints() : number[][];

Returns

[X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.

toImage(ImageType)

Creates the shape image and saves it to a stream in the specified format.

toImage(imageType: ImageType) : Uint8Array;

Parameters:

Parameter	Type	Description
imageType	ImageType	The type in which to save the image.

Returns

The result stream

Remarks

The following formats are supported: .bmp, .gif, .jpg, .jpeg, .tiff, .emf.

toImage(string, ImageOrPrintOptions)

Saves the shape to a file.

toImage(imageFile: string, options: ImageOrPrintOptions) : void;

Parameters:

Parameter	Type	Description
imageFile	string
options	ImageOrPrintOptions

toImage(ImageOrPrintOptions)

Saves the shape to a stream.

toImage(options: ImageOrPrintOptions) : Uint8Array;

Parameters:

Parameter	Type	Description
options	ImageOrPrintOptions

Returns

The result stream

toImageAsync(ImageType)

Creates the shape image and saves it to a stream in the specified format.

toImageAsync(imageType: ImageType) : Promise<Uint8Array>;

Parameters:

Parameter	Type	Description
imageType	ImageType	The type in which to save the image.

Returns

The result stream

Remarks

The following formats are supported: .bmp, .gif, .jpg, .jpeg, .tiff, .emf.

toImageAsync(string, ImageOrPrintOptions)

Saves the shape to a file.

toImageAsync(imageFile: string, options: ImageOrPrintOptions) : Promise<void>;

Parameters:

Parameter	Type	Description
imageFile	string
options	ImageOrPrintOptions

Returns

Promise

toImageAsync(ImageOrPrintOptions)

Saves the shape to a stream.

toImageAsync(options: ImageOrPrintOptions) : Promise<Uint8Array>;

Parameters:

Parameter	Type	Description
options	ImageOrPrintOptions

Returns

The result stream

getLinkedCell(boolean, boolean)

Gets the range linked to the control’s value.

getLinkedCell(isR1C1: boolean, isLocal: boolean) : string;

Parameters:

Parameter	Type	Description
isR1C1	boolean	Whether the formula needs to be formatted as R1C1.
isLocal	boolean	Whether the formula needs to be formatted by locale.

Returns

The range linked to the control’s value.

setLinkedCell(string, boolean, boolean)

Sets the range linked to the control’s value.

setLinkedCell(formula: string, isR1C1: boolean, isLocal: boolean) : void;

Parameters:

Parameter	Type	Description
formula	string	The range linked to the control’s value.
isR1C1	boolean	Whether the formula needs to be formatted as R1C1.
isLocal	boolean	Whether the formula needs to be formatted by locale.

getInputRange(boolean, boolean)

Gets the range used to fill the control.

getInputRange(isR1C1: boolean, isLocal: boolean) : string;

Parameters:

Parameter	Type	Description
isR1C1	boolean	Whether the formula needs to be formatted as R1C1.
isLocal	boolean	Whether the formula needs to be formatted by locale.

Returns

The range used to fill the control.

setInputRange(string, boolean, boolean)

Sets the range used to fill the control.

setInputRange(formula: string, isR1C1: boolean, isLocal: boolean) : void;

Parameters:

Parameter	Type	Description
formula	string	The range used to fill the control.
isR1C1	boolean	Whether the formula needs to be formatted as R1C1.
isLocal	boolean	Whether the formula needs to be formatted by locale.

updateSelectedValue()

Update the selected value by the value of the linked cell.

updateSelectedValue() : void;

calculateTextSize()

Recalculate the text area

calculateTextSize() : number[];

Returns

Text’s Size in an array(width and height).

formatCharacters(number, number, Font, StyleFlag)

Formats some characters with the font setting.

formatCharacters(startIndex: number, length: number, font: Font, flag: StyleFlag) : void;

Parameters:

Parameter	Type	Description
startIndex	number	The start index.
length	number	The length.
font	Font	The font setting.
flag	StyleFlag	The flag of the font setting.

characters(number, number)

Returns a Characters object that represents a range of characters within the text.

characters(startIndex: number, length: number) : FontSetting;

Parameters:

Parameter	Type	Description
startIndex	number	The index of the start of the character.
length	number	The number of characters.

Returns

Characters object.

Remarks

This method only works on shape with title.

getRichFormattings()

Returns all Characters objects that represents a range of characters within the text .

getRichFormattings() : FontSetting[];

Returns

All Characters objects

removeActiveXControl()

Remove activeX control.

removeActiveXControl() : void;

getActualBox()

Get the actual position and size of the shape (after applying rotation, flip, etc.)

getActualBox() : number[];

Returns

Return the position and size in the order of x, y, w, h

Remarks

Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.

fitToTextSize()

Recalculate a text area suitable for displaying all text content.

fitToTextSize() : void;

getResultOfSmartArt()

Converting smart art to grouped shapes.

getResultOfSmartArt() : GroupShape;

Returns

GroupShape

isSameSetting(Object)

Returns whether the shape is same.

isSameSetting(obj: Object) : boolean;

Parameters:

Parameter	Type	Description
obj	Object