Word.Interfaces.CanvasData interface
An interface describing the data returned by calling canvas.toJSON()
.
Properties
id | Gets an integer that represents the canvas identifier. |
shape | Gets the Shape object associated with the canvas. |
shapes | Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. |
Property Details
id
Gets an integer that represents the canvas identifier.
id?: number;
Property Value
number
Remarks
shape
Gets the Shape object associated with the canvas.
shape?: Word.Interfaces.ShapeData;
Property Value
Remarks
shapes
Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported.
shapes?: Word.Interfaces.ShapeData[];
Property Value
Remarks
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Office Add-ins