meo-skia-canvas
    Preparing search index...

    Type Alias WindowOptions

    WindowOptions: {
        background?: string;
        borderless?: boolean;
        canvas?: Canvas;
        cursor?: CursorStyle;
        fit?: FitStyle;
        fullscreen?: boolean;
        height?: number;
        left?: number;
        page?: number;
        resizable?: boolean;
        title?: string;
        top?: number;
        visible?: boolean;
        width?: number;
    } & CanvasOptions

    Initial state for a Window. Every field is also a property on the window itself and can be changed after it opens.

    The CanvasOptions it extends apply when the window creates a canvas of its own, and are ignored when canvas hands it one that already exists.

    🧪 Not in the HTML Canvas standard.

    Type Declaration

    • Optionalbackground?: string

      Color drawn where the canvas does not cover the window.

    • Optionalborderless?: boolean

      Open without a title bar or frame.

    • Optionalcanvas?: Canvas

      An existing canvas to display, instead of creating one.

    • Optionalcursor?: CursorStyle

      Pointer shape over the window.

    • Optionalfit?: FitStyle

      How the canvas is scaled into the window. Defaults to "contain".

    • Optionalfullscreen?: boolean

      Open occupying the whole screen.

    • Optionalheight?: number

      Height of the window, in points, defaulting to the canvas's.

    • Optionalleft?: number

      Position of the window's left edge on screen, in points.

    • Optionalpage?: number

      Which canvas page to display, numbered from 1.

    • Optionalresizable?: boolean

      Whether the user may resize the window.

    • Optionaltitle?: string

      Title-bar text.

    • Optionaltop?: number

      Position of the window's top edge on screen, in points.

    • Optionalvisible?: boolean

      Open hidden, to be shown later by setting visible.

    • Optionalwidth?: number

      Width of the window, in points, defaulting to the canvas's.