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.

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets an integer that represents the canvas identifier.

id?: number;

number

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the Shape object associated with the canvas.

shape?: Word.Interfaces.ShapeData;

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported.

shapes?: Word.Interfaces.ShapeData[];