Ask Learn
Preview
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign inPowerPoint.Interfaces.ShapeData interface
An interface describing the data returned by calling shape.toJSON().
Properties
| height | Specifies the height, in points, of the shape. Throws an |
| id | Gets the unique ID of the shape. |
| left | The distance, in points, from the left side of the shape to the left side of the slide. |
| level | Returns the level of the specified shape.
|
| name | Specifies the name of this shape. |
| top | The distance, in points, from the top edge of the shape to the top edge of the slide. |
| type | Returns the type of this shape. See PowerPoint.ShapeType for details. |
| width | Specifies the width, in points, of the shape. Throws an |
| z |
Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. |
height
Specifies the height, in points, of the shape. Throws an InvalidArgument exception when set with a negative value.
height?: number;Property Value
number
Remarks
id
Gets the unique ID of the shape.
id?: string;Property Value
string
Remarks
left
The distance, in points, from the left side of the shape to the left side of the slide.
left?: number;Property Value
number
Remarks
level
Returns the level of the specified shape.
A level of 0 means the shape isn't part of a group.
A level of 1 means the shape is part of a top-level group.
A level greater than 1 indicates the shape is a nested group.
level?: number;Property Value
number
Remarks
name
Specifies the name of this shape.
name?: string;Property Value
string
Remarks
top
The distance, in points, from the top edge of the shape to the top edge of the slide.
top?: number;Property Value
number
Remarks
type
Returns the type of this shape. See PowerPoint.ShapeType for details.
type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";Property Value
PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox"
Remarks
width
Specifies the width, in points, of the shape. Throws an InvalidArgument exception when set with a negative value.
width?: number;Property Value
number
Remarks
zOrderPosition
Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
zOrderPosition?: number;Property Value
number