Edit

Share via

PowerPoint.Interfaces.ShapeData interface

  • Reference
Package:
powerpoint

An interface describing the data returned by calling shape.toJSON().

Properties

height

Specifies the height, in points, of the shape. Throws an InvalidArgument exception when set with a negative value.
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.
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 InvalidArgument exception when set with a negative value.

Property Details

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

[ API set: PowerPointApi 1.4 ]

id

Gets the unique ID of the shape.

id?: string;

Property Value

string

Remarks

[ API set: PowerPointApi 1.3 ]

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

[ API set: PowerPointApi 1.4 ]

name

Specifies the name of this shape.

name?: string;

Property Value

string

Remarks

[ API set: PowerPointApi 1.4 ]

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

[ API set: PowerPointApi 1.4 ]

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

[ API set: PowerPointApi 1.4 ]

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

[ API set: PowerPointApi 1.4 ]