pixi-viewport
    Preparing search index...

    Interface IDragOptions

    Options for Drag.

    interface IDragOptions {
        clampWheel?: string | boolean;
        direction?: string;
        disableOneFingerDrag?: boolean;
        factor?: number;
        ignoreKeyToPressOnTouch?: boolean;
        keyToPress?: string[] | null;
        lineHeight?: number;
        mouseButtons?: string;
        pressDrag?: boolean;
        reverse?: boolean;
        underflow?: string;
        wheel?: boolean;
        wheelScroll?: number;
        wheelSwapAxes?: boolean;
    }
    Index
    clampWheel? direction? disableOneFingerDrag? factor? ignoreKeyToPressOnTouch? keyToPress? lineHeight? mouseButtons? pressDrag? reverse? underflow? wheel? wheelScroll? wheelSwapAxes?
    clampWheel?: string | boolean

    clamp wheel(to avoid weird bounce with mouse wheel). Can be 'x' or 'y' or true.

    false
    direction?: string

    direction to drag

    "all"
    disableOneFingerDrag?: boolean

    Ignore single-finger touch drags so the page can still scroll normally. Two-finger drags still move the viewport when the pinch plugin is not active.

    false
    factor?: number

    factor to multiply drag to increase the speed of movement

    1
    ignoreKeyToPressOnTouch?: boolean

    Ignore keyToPress for touch events.

    false
    keyToPress?: string[] | null

    Array containing KeyboardEvent.code values of keys that can be pressed for the drag to be triggered, e.g.: ['ShiftLeft', 'ShiftRight'}.

    null
    lineHeight?: number

    Scaling factor for non-DOM_DELTA_PIXEL scrolling events.

    20
    mouseButtons?: string

    Changes which mouse buttons trigger drag.

    Use: 'all', 'left', right' 'middle', or some combination, like, 'middle-right'; you may want to set viewport.options.disableOnContextMenu if you want to use right-click dragging.

    "all"
    pressDrag?: boolean

    whether click to drag is active

    true
    reverse?: boolean

    reverse the direction of the wheel scroll

    false
    underflow?: string

    where to place world if too small for screen

    "center"
    wheel?: boolean

    Use wheel to scroll in direction (unless wheel plugin is active)

    true
    wheelScroll?: number

    number of pixels to scroll with each wheel spin

    1
    wheelSwapAxes?: boolean

    Swap x and y axes when scrolling.

    false

    Settings
    Member Visibility

    On This Page
    Properties