pixi-viewport
    Preparing search index...

    Interface IViewportOptions

    Options for Viewport.

    interface IViewportOptions {
        allowPreserveDragOutside?: boolean;
        disableOnContextMenu?: boolean;
        events: EventSystem;
        forceHitArea?: Rectangle | null;
        ignoreWheelFromOtherElements?: boolean;
        noTicker?: boolean;
        passiveWheel?: boolean;
        screenHeight?: number;
        screenWidth?: number;
        stopPropagation?: boolean;
        threshold?: number;
        ticker?: Ticker;
        worldHeight?: number | null;
        worldWidth?: number | null;
    }

    Hierarchy (View Summary)

    Index
    allowPreserveDragOutside? disableOnContextMenu? events forceHitArea? ignoreWheelFromOtherElements? noTicker? passiveWheel? screenHeight? screenWidth? stopPropagation? threshold? ticker? worldHeight? worldWidth?
    allowPreserveDragOutside?: boolean

    Whether to stop drag when the pointer is out of the viewport

    disableOnContextMenu?: boolean

    Remove oncontextmenu=() => {} from options.events.domElement

    events: EventSystem

    EventSystem is required now

    forceHitArea?: Rectangle | null

    Change the default hitArea from world size to a new value

    ignoreWheelFromOtherElements?: boolean

    Ignore wheel events that bubble up from other elements (e.g., an HTML modal inside the element pixi listens on). Only wheel events whose target is options.events.domElement or the renderer's canvas reach the viewport.

    false
    noTicker?: boolean

    Set this if you want to manually call update() function on each frame

    false
    passiveWheel?: boolean

    Whether the 'wheel' event is set to passive (note: if false, e.preventDefault() will be called when wheel is used over the viewport)

    true
    screenHeight?: number
    window.innerHeight
    screenWidth?: number
    window.innerWidth
    stopPropagation?: boolean

    Whether to stopPropagation of events that impact the viewport (except wheel events, see options.passiveWheel)

    threshold?: number

    Number of pixels to move to trigger an input event (e.g., drag, pinch) or disable a clicked event

    5
    ticker?: Ticker

    Use this PIXI.ticker for updates

    PIXI.Ticker.shared
    worldHeight?: number | null
    this.height
    worldWidth?: number | null
    this.width

    Settings
    Member Visibility

    On This Page
    Properties