Type Alias IShapeCanvasOptions

IShapeCanvasOptions: DrawingLinkOptions & {
    altText?: DocPropertiesOptions;
    children: readonly IShapeCanvasChildOptions[];
    fallback?: boolean;
    fill?: ShapeFill;
    floating?: IFloating;
    layout?: ShapeLayout;
    line?: ShapeLine;
    run?: IRunPropertiesOptions;
    transformation?: { height: number; width: number };
}

Options for creating a drawing canvas.

Optional ReadonlyaltText?: DocPropertiesOptions

Name, description and title used by screen readers
Readonlychildren: readonly IShapeCanvasChildOptions[]

The shapes, pictures and groups on the canvas, and the connectors between them
Optional Readonlyfallback?: boolean

Whether to write the same diagram as a group too, for applications that can't draw canvases, such as Apple Pages. Default is true. Without it, the canvas takes up half as much of the document, and those applications draw nothing
Optional Readonlyfill?: ShapeFill

The canvas's background. Default is none
Optional Readonlyfloating?: IFloating

Floats the canvas on the page instead of placing it inline with text
Optional Readonlylayout?: ShapeLayout

Places the shapes, pictures and groups that have no offset: in levels along their connectors like a flowchart, as a tree like an org chart, or in a grid
Optional Readonlyline?: ShapeLine

The canvas's outline. Default is none
Optional Readonlyrun?: IRunPropertiesOptions

Formatting of the run the canvas is in, such as position to raise or lower it from the text's baseline
Optional Readonlytransformation?: { height: number; width: number }

Size of the canvas in pixels. Defaults to reaching from the top-left corner to the right and bottom of the shapes, including their lines and effects, so an offset leaves space above and to the left of a shape. The shapes are not scaled.