gradum-kit - v0.1.0
    Preparing search index...

    Type Alias GradumRawEventProperties

    The fields every Gradum event is built from. The concrete property types (GradumEventProperties, GradumDragEventProperties, ...) extend this with whatever positional data their event carries.

    type GradumRawEventProperties = {
        clickMode?: ClickMode;
        inputDevice?: InputDevice;
        keys?: string[];
        eventName?: GradumEventNameEntry;
        eventManager?: GradumEventManager;
        toolName?: string;
        authorizeScaling?: boolean | (() => boolean);
        scalePosition?: (position: Point) => Point;
        eventInitDict?: EventInit;
    }
    Index
    clickMode? inputDevice? keys? eventName? eventManager? toolName? authorizeScaling? scalePosition? eventInitDict?
    clickMode?: ClickMode

    The pointer button or input mode the event belongs to. Defaults to the manager's current click mode.

    inputDevice?: InputDevice

    The device that produced the event. Defaults to InputDevice.unknown.

    keys?: string[]

    Keys held when the event fired. Defaults to the manager's current keys.

    eventName?: GradumEventNameEntry

    The name the event is dispatched under.

    eventManager?: GradumEventManager

    The manager firing the event. Defaults to GradumEventManager.instance.

    toolName?: string

    The tool the event is attributed to, if any.

    authorizeScaling?: boolean | (() => boolean)

    Whether scaled positions are computed. Pass a callback to decide per read.

    scalePosition?: (position: Point) => Point

    Converts a screen position into document space. Defaults to returning the position unchanged.

    eventInitDict?: EventInit

    Native event options, merged over the defaults of bubbles and cancelable set to true.

    Settings
    Member Visibility

    On This Page
    Properties