Excel.Interfaces.ShapeLoadOptions interface
Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc. To learn more about the shape object model, read Work with shapes using the Excel JavaScript API.
Remarks
Properties
| $all | Specifying |
| alt |
Specifies the alternative description text for a |
| alt |
Specifies the alternative title text for a |
| connection |
Returns the number of connection sites on this shape. |
| display |
Gets the display name of the shape. A newly created shape has a generated name that is localized and may not match its |
| fill | Returns the fill formatting of this shape. |
| geometric |
Returns the geometric shape associated with the shape. An error will be thrown if the shape type is not "GeometricShape". |
| geometric |
Specifies the geometric shape type of this geometric shape. See |
| group | Returns the shape group associated with the shape. An error will be thrown if the shape type is not "GroupShape". |
| height | Specifies the height, in points, of the shape. Throws an |
| id | Specifies the shape identifier. |
| image | Returns the image associated with the shape. An error will be thrown if the shape type is not "Image". |
| left | The distance, in points, from the left side of the shape to the left side of the worksheet. Throws an |
| level | Specifies the level of the specified shape. For example, a level of 0 means that the shape is not part of any groups, a level of 1 means the shape is part of a top-level group, and a level of 2 means the shape is part of a sub-group of the top level. |
| line | Returns the line associated with the shape. An error will be thrown if the shape type is not "Line". |
| line |
Returns the line formatting of this shape. |
| lock |
Specifies if the aspect ratio of this shape is locked. |
| name | Specifies the name of the shape. |
| parent |
Specifies the parent group of this shape. |
| placement | Represents how the object is attached to the cells below it. |
| rotation | Specifies the rotation, in degrees, of the shape. |
| text |
Returns the text frame object of this shape. |
| top | The distance, in points, from the top edge of the shape to the top edge of the worksheet. Throws an |
| type | Returns the type of this shape. See |
| visible | Specifies if the shape is visible. |
| width | Specifies the width, in points, of the shape. Throws an |
| z |
Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack. |
Property Details
$all
Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
$all?: boolean;Property Value
boolean
altTextDescription
Specifies the alternative description text for a Shape object.
altTextDescription?: boolean;Property Value
boolean
Remarks
altTextTitle
Specifies the alternative title text for a Shape object.
altTextTitle?: boolean;Property Value
boolean
Remarks
connectionSiteCount
Returns the number of connection sites on this shape.
connectionSiteCount?: boolean;Property Value
boolean
Remarks
displayName
Gets the display name of the shape. A newly created shape has a generated name that is localized and may not match its name. In this scenario, you can use this API to get the name that is displayed in the UI.
displayName?: boolean;Property Value
boolean
Remarks
fill
Returns the fill formatting of this shape.
fill?: Excel.Interfaces.ShapeFillLoadOptions;Property Value
Remarks
geometricShape
Returns the geometric shape associated with the shape. An error will be thrown if the shape type is not "GeometricShape".
geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;Property Value
Remarks
geometricShapeType
Specifies the geometric shape type of this geometric shape. See Excel.GeometricShapeType for details. Returns null if the shape type is not "GeometricShape".
geometricShapeType?: boolean;Property Value
boolean
Remarks
group
Returns the shape group associated with the shape. An error will be thrown if the shape type is not "GroupShape".
group?: Excel.Interfaces.ShapeGroupLoadOptions;Property Value
Remarks
height
Specifies the height, in points, of the shape. Throws an InvalidArgument exception when set with a negative value or zero as an input.
height?: boolean;Property Value
boolean
Remarks
id
Specifies the shape identifier.
id?: boolean;Property Value
boolean
Remarks
image
Returns the image associated with the shape. An error will be thrown if the shape type is not "Image".
image?: Excel.Interfaces.ImageLoadOptions;Property Value
Remarks
left
The distance, in points, from the left side of the shape to the left side of the worksheet. Throws an InvalidArgument exception when set with a negative value as an input.
left?: boolean;Property Value
boolean
Remarks
level
Specifies the level of the specified shape. For example, a level of 0 means that the shape is not part of any groups, a level of 1 means the shape is part of a top-level group, and a level of 2 means the shape is part of a sub-group of the top level.
level?: boolean;Property Value
boolean
Remarks
line
Returns the line associated with the shape. An error will be thrown if the shape type is not "Line".
line?: Excel.Interfaces.LineLoadOptions;Property Value
Remarks
lineFormat
Returns the line formatting of this shape.
lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;Property Value
Remarks
lockAspectRatio
Specifies if the aspect ratio of this shape is locked.
lockAspectRatio?: boolean;Property Value
boolean
Remarks
name
Specifies the name of the shape.
name?: boolean;Property Value
boolean
Remarks
parentGroup
Specifies the parent group of this shape.
parentGroup?: Excel.Interfaces.ShapeLoadOptions;Property Value
Remarks
placement
Represents how the object is attached to the cells below it.
placement?: boolean;Property Value
boolean
Remarks
rotation
Specifies the rotation, in degrees, of the shape.
rotation?: boolean;Property Value
boolean
Remarks
textFrame
Returns the text frame object of this shape.
textFrame?: Excel.Interfaces.TextFrameLoadOptions;Property Value
Remarks
top
The distance, in points, from the top edge of the shape to the top edge of the worksheet. Throws an InvalidArgument exception when set with a negative value as an input.
top?: boolean;Property Value
boolean
Remarks
type
Returns the type of this shape. See Excel.ShapeType for details.
type?: boolean;Property Value
boolean
Remarks
visible
Specifies if the shape is visible.
visible?: boolean;Property Value
boolean
Remarks
width
Specifies the width, in points, of the shape. Throws an InvalidArgument exception when set with a negative value or zero as an input.
width?: boolean;Property Value
boolean
Remarks
zOrderPosition
Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack.
zOrderPosition?: boolean;Property Value
boolean
Remarks
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for