Type alias CanvasChangeEventData

CanvasChangeEventData: {
    canvasId: string;
    maintainFieldSize: boolean;
    pageId: null | string;
    selection: {
        dynamicHeight: number;
        dynamicWidth: number;
    };
    sizeId: string;
}

The Event data for the BeforeEditorCanvasChanged and AfterEditorCanvasChanged events. Holds information about the canvas which is about to be changed.

Type declaration

  • canvasId: string

    The canvas id of the new canvas.

  • maintainFieldSize: boolean

    Flag indicating if the field sizes should be maintained when changing the canvas.

  • pageId: null | string

    The page id of the page which should be changed.

  • selection: {
        dynamicHeight: number;
        dynamicWidth: number;
    }

    Additional information about the selected sizes for dynamic canvas sizes.

    • dynamicHeight: number

      If applicable, the selected height of the dynamic canvas.

    • dynamicWidth: number

      If applicable, the selected width of the dynamic canvas.

  • sizeId: string

    The size id of the new canvas.

Settings

Member Visibility

Theme

Generated using TypeDoc