turbodombuilder - v0.9.5
    Preparing search index...

    Class TurboWheelEvent

    TurboWheelEvent

    Custom wheel event

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    eventManager toolName eventName clickMode keys position authorizeScaling scalePosition delta

    Accessors

    tool target scaledPosition scalingAuthorized

    Methods

    closest

    Constructors

    Properties

    eventManager: TurboEventManager

    The event manager that fired this event.

    toolName: string

    The name of the tool (if any) associated with this event.

    eventName: TurboEventNameEntry

    The name of the event.

    clickMode: ClickMode

    The click mode of the fired event

    keys: string[]

    The keys pressed when the event was fired

    position: Point

    The screen position from where the event was fired

    authorizeScaling: boolean | (() => boolean)

    Callback function (or boolean) to be overridden to specify when to allow transformation and/or scaling.

    scalePosition: (position: Point) => Point

    Callback function to be overridden to specify how to transform a position from screen to document space.

    delta: Point

    The delta amount of scrolling

    Accessors

    • get tool(): Node

      Returns Node

      The tool (if any) associated with this event.

    • get target(): Element | Document

      Returns Element | Document

      The target of the event (as an Element - or the document)

    • get scaledPosition(): Point

      Returns Point

      The position of the fired event transformed and/or scaled using the class's scalePosition().

    • get scalingAuthorized(): boolean

      Returns boolean

      Specifies whether to allow transformation and/or scaling.

    Methods

    • Type Parameters

      Parameters

      • type: new (...args: any[]) => T
      • strict: boolean | Element = true
      • from: ClosestOrigin = ClosestOrigin.target

      Returns T

      Returns the closest element of the provided type to the target (Searches through the element and all its parents to find one of matching type).

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods