Class ScrollEvent

An event that is fired when a scrollable widget such as ScrollableViewportWidget is scrolled.

Hierarchy (view full)

Constructors

Properties

deltaX: number

How many pixels has the scroll offset changed by, horizontally?

deltaY: number

How many pixels has the scroll offset changed by, vertically?

offsetX: number

The new horizontal offset

offsetY: number

The new vertical offset

origin: Widget

The origin of this event; where it was dispatched

propagation: Bubbling

Which event propagation model is this event type using?

type

The type of this event instance. Compare this against the static WidgetEvent."type" in the class or a known string value. Comparing this value and doing an instanceof check must be equivalent.

userCapturable

Is this event capturable by user event handlers?

Note that if the event does not propagate, capturing the event still has an effect; events are handled in the order for which the handlers were added, meaning that if a handler captures the event, the other handlers won't be called.

type: "scroll" = 'scroll'

The type of this event class. Each event type should be unique, and have a unique class.

Due to Typescript limitations, no compile error is thrown when this static field is not set at a sub-class. Despite this, the type must be set to a unique string value.

Methods

  • Check if the type of this event instance matches the type of a given event class, asserting that the instance is of the class' type.

    Type Parameters

    Parameters

    • clazz: (new (...args: any[]) => E)
        • new (...args): E
        • Parameters

          • Rest...args: any[]

          Returns E

    Returns this is E