npm.nicfv.com
    Preparing search index...

    Interface Options

    Configuration Options for Canvas

    interface Options {
        background: string;
        border: string;
        borderBlur: string;
        debug: boolean;
        height: number;
        keydown: (key: string) => void;
        keyup: (key: string) => void;
        loop: (dt: number) => void;
        mousedown: (button: number) => void;
        mousemove: (x: number, y: number) => void;
        mouseup: (button: number) => void;
        numLayers: number;
        numTracks: number;
        parent: Node;
        scale: number;
        showMouse: boolean;
        width: number;
    }
    Index

    Properties

    background border borderBlur debug height keydown keyup loop mousedown mousemove mouseup numLayers numTracks parent scale showMouse width

    Properties

    background: string

    The background color of the canvas

    border: string

    The border color for the canvas (when focused)

    borderBlur: string

    The border color for the canvas (when not focused)

    debug: boolean

    Optionally print debug messages to the console

    height: number

    The height of the drawing area, in pixels

    keydown: (key: string) => void

    Event listener for when a key is pressed

    Type Declaration

      • (key: string): void

      • Parameters

        • key: string

          The key that was pressed

        Returns void

    keyup: (key: string) => void

    Event listener for when a key is released

    Type Declaration

      • (key: string): void

      • Parameters

        • key: string

          The key that was released

        Returns void

    loop: (dt: number) => void

    Event listener for a the main animation loop

    Type Declaration

      • (dt: number): void

      • Parameters

        • dt: number

          The number of milliseconds in between frames

        Returns void

        An array of Drawable to render on layer 0, or void

    mousedown: (button: number) => void

    Event listener for when a button on the mouse is pressed

    Type Declaration

      • (button: number): void

      • Parameters

        • button: number

          The button that was pressed

        Returns void

    mousemove: (x: number, y: number) => void

    Event listener for when the mouse is moved

    Type Declaration

      • (x: number, y: number): void

      • Parameters

        • x: number

          Cursor X-coordinate

        • y: number

          Cursor Y-coordinate

        Returns void

    mouseup: (button: number) => void

    Event listener for when a button on the mouse is released

    Type Declaration

      • (button: number): void

      • Parameters

        • button: number

          The button that was released

        Returns void

    numLayers: number

    The number of layers in this canvas

    numTracks: number

    The number of audio tracks

    parent: Node

    Appends the canvas onto the parent element

    scale: number

    The scale of the drawing area to the actual size of the canvas element

    showMouse: boolean

    Optionally show or hide the mouse when hovering over the canvas

    width: number

    The width of the drawing area, in pixels

    Settings

    Member Visibility

    On This Page

    Properties