pixi.js
    Preparing search index...

    Interface ContainerEvents<C>

    Events that can be emitted by a Container. These events provide lifecycle hooks and notifications for container state changes.

    import { Container, Sprite } from 'pixi.js';

    // Setup container with event listeners
    const container = new Container();

    // Listen for child additions
    container.on('childAdded', (child, container, index) => {
    console.log(`Child added at index ${index}:`, child);
    });

    // Listen for child removals
    container.on('childRemoved', (child, container, index) => {
    console.log(`Child removed from index ${index}:`, child);
    });

    // Listen for when container is added to parent
    container.on('added', (parent) => {
    console.log('Added to parent:', parent);
    });

    // Listen for when container is removed from parent
    container.on('removed', (parent) => {
    console.log('Removed from parent:', parent);
    });

    // Listen for container destruction
    container.on('destroyed', (container) => {
    console.log('Container destroyed:', container);
    });
    interface ContainerEvents<C extends ContainerChild> {
        added: [container: Container<ContainerChild>];
        childAdded: [child: C, container: Container<ContainerChild>, index: number];
        childRemoved: [
            child: C,
            container: Container<ContainerChild>,
            index: number,
        ];
        click: [event: FederatedPointerEvent];
        clickcapture: [event: FederatedPointerEvent];
        destroyed: [container: Container<ContainerChild>];
        globalmousemove: [event: FederatedPointerEvent];
        globalpointermove: [event: FederatedPointerEvent];
        globaltouchmove: [event: FederatedPointerEvent];
        mousedown: [event: FederatedPointerEvent];
        mousedowncapture: [event: FederatedPointerEvent];
        mouseenter: [event: FederatedPointerEvent];
        mouseentercapture: [event: FederatedPointerEvent];
        mouseleave: [event: FederatedPointerEvent];
        mouseleavecapture: [event: FederatedPointerEvent];
        mousemove: [event: FederatedPointerEvent];
        mousemovecapture: [event: FederatedPointerEvent];
        mouseout: [event: FederatedPointerEvent];
        mouseoutcapture: [event: FederatedPointerEvent];
        mouseover: [event: FederatedPointerEvent];
        mouseovercapture: [event: FederatedPointerEvent];
        mouseup: [event: FederatedPointerEvent];
        mouseupcapture: [event: FederatedPointerEvent];
        mouseupoutside: [event: FederatedPointerEvent];
        mouseupoutsidecapture: [event: FederatedPointerEvent];
        pointercancel: [event: FederatedPointerEvent];
        pointercancelcapture: [event: FederatedPointerEvent];
        pointerdown: [event: FederatedPointerEvent];
        pointerdowncapture: [event: FederatedPointerEvent];
        pointerenter: [event: FederatedPointerEvent];
        pointerentercapture: [event: FederatedPointerEvent];
        pointerleave: [event: FederatedPointerEvent];
        pointerleavecapture: [event: FederatedPointerEvent];
        pointermove: [event: FederatedPointerEvent];
        pointermovecapture: [event: FederatedPointerEvent];
        pointerout: [event: FederatedPointerEvent];
        pointeroutcapture: [event: FederatedPointerEvent];
        pointerover: [event: FederatedPointerEvent];
        pointerovercapture: [event: FederatedPointerEvent];
        pointertap: [event: FederatedPointerEvent];
        pointertapcapture: [event: FederatedPointerEvent];
        pointerup: [event: FederatedPointerEvent];
        pointerupcapture: [event: FederatedPointerEvent];
        pointerupoutside: [event: FederatedPointerEvent];
        pointerupoutsidecapture: [event: FederatedPointerEvent];
        removed: [container: Container<ContainerChild>];
        rightclick: [event: FederatedPointerEvent];
        rightclickcapture: [event: FederatedPointerEvent];
        rightdown: [event: FederatedPointerEvent];
        rightdowncapture: [event: FederatedPointerEvent];
        rightup: [event: FederatedPointerEvent];
        rightupcapture: [event: FederatedPointerEvent];
        rightupoutside: [event: FederatedPointerEvent];
        rightupoutsidecapture: [event: FederatedPointerEvent];
        tap: [event: FederatedPointerEvent];
        tapcapture: [event: FederatedPointerEvent];
        touchcancel: [event: FederatedPointerEvent];
        touchcancelcapture: [event: FederatedPointerEvent];
        touchend: [event: FederatedPointerEvent];
        touchendcapture: [event: FederatedPointerEvent];
        touchendoutside: [event: FederatedPointerEvent];
        touchendoutsidecapture: [event: FederatedPointerEvent];
        touchmove: [event: FederatedPointerEvent];
        touchmovecapture: [event: FederatedPointerEvent];
        touchstart: [event: FederatedPointerEvent];
        touchstartcapture: [event: FederatedPointerEvent];
        wheel: [event: FederatedWheelEvent];
        wheelcapture: [event: FederatedWheelEvent];
    }

    Type Parameters

    Hierarchy

    • ContainerEvents
      • ContainerEvents
    Index

    Properties

    added: [container: Container<ContainerChild>]

    Emitted when this container is added to a new container. Useful for setting up parent-specific behaviors.

    The parent container this was added to

    const child = new Container();
    child.on('added', (parent) => {
    console.log('Child added to parent:', parent.label);
    });
    parentContainer.addChild(child);
    childAdded: [child: C, container: Container<ContainerChild>, index: number]

    Emitted when a child is added to this container. Useful for tracking container composition changes.

    The child that was added

    The container the child was added to (this container)

    The index at which the child was added

    const parent = new Container();
    parent.on('childAdded', (child, container, index) => {
    console.log(`New child at index ${index}:`, child);
    });
    childRemoved: [child: C, container: Container<ContainerChild>, index: number]

    Emitted when a child is removed from this container. Useful for cleanup and maintaining container state.

    The child that was removed

    The container the child was removed from (this container)

    The index from which the child was removed

    const parent = new Container();
    parent.on('childRemoved', (child, container, index) => {
    console.log(`Child removed from index ${index}:`, child);
    });
    click: [event: FederatedPointerEvent]
    clickcapture: [event: FederatedPointerEvent]
    destroyed: [container: Container<ContainerChild>]

    Emitted when the container is destroyed. Useful for final cleanup and resource management.

    The container that was destroyed

    const container = new Container();
    container.on('destroyed', (container) => {
    console.log('Container destroyed:', container.label);
    });
    globalmousemove: [event: FederatedPointerEvent]
    globalpointermove: [event: FederatedPointerEvent]
    globaltouchmove: [event: FederatedPointerEvent]
    mousedown: [event: FederatedPointerEvent]
    mousedowncapture: [event: FederatedPointerEvent]
    mouseenter: [event: FederatedPointerEvent]
    mouseentercapture: [event: FederatedPointerEvent]
    mouseleave: [event: FederatedPointerEvent]
    mouseleavecapture: [event: FederatedPointerEvent]
    mousemove: [event: FederatedPointerEvent]
    mousemovecapture: [event: FederatedPointerEvent]
    mouseout: [event: FederatedPointerEvent]
    mouseoutcapture: [event: FederatedPointerEvent]
    mouseover: [event: FederatedPointerEvent]
    mouseovercapture: [event: FederatedPointerEvent]
    mouseup: [event: FederatedPointerEvent]
    mouseupcapture: [event: FederatedPointerEvent]
    mouseupoutside: [event: FederatedPointerEvent]
    mouseupoutsidecapture: [event: FederatedPointerEvent]
    pointercancel: [event: FederatedPointerEvent]
    pointercancelcapture: [event: FederatedPointerEvent]
    pointerdown: [event: FederatedPointerEvent]
    pointerdowncapture: [event: FederatedPointerEvent]
    pointerenter: [event: FederatedPointerEvent]
    pointerentercapture: [event: FederatedPointerEvent]
    pointerleave: [event: FederatedPointerEvent]
    pointerleavecapture: [event: FederatedPointerEvent]
    pointermove: [event: FederatedPointerEvent]
    pointermovecapture: [event: FederatedPointerEvent]
    pointerout: [event: FederatedPointerEvent]
    pointeroutcapture: [event: FederatedPointerEvent]
    pointerover: [event: FederatedPointerEvent]
    pointerovercapture: [event: FederatedPointerEvent]
    pointertap: [event: FederatedPointerEvent]
    pointertapcapture: [event: FederatedPointerEvent]
    pointerup: [event: FederatedPointerEvent]
    pointerupcapture: [event: FederatedPointerEvent]
    pointerupoutside: [event: FederatedPointerEvent]
    pointerupoutsidecapture: [event: FederatedPointerEvent]
    removed: [container: Container<ContainerChild>]

    Emitted when this container is removed from its parent. Useful for cleanup and state management.

    The parent container this was removed from

    const child = new Container();
    child.on('removed', (oldParent) => {
    console.log('Child removed from parent:', oldParent.label);
    });
    rightclick: [event: FederatedPointerEvent]
    rightclickcapture: [event: FederatedPointerEvent]
    rightdown: [event: FederatedPointerEvent]
    rightdowncapture: [event: FederatedPointerEvent]
    rightup: [event: FederatedPointerEvent]
    rightupcapture: [event: FederatedPointerEvent]
    rightupoutside: [event: FederatedPointerEvent]
    rightupoutsidecapture: [event: FederatedPointerEvent]
    tap: [event: FederatedPointerEvent]
    tapcapture: [event: FederatedPointerEvent]
    touchcancel: [event: FederatedPointerEvent]
    touchcancelcapture: [event: FederatedPointerEvent]
    touchend: [event: FederatedPointerEvent]
    touchendcapture: [event: FederatedPointerEvent]
    touchendoutside: [event: FederatedPointerEvent]
    touchendoutsidecapture: [event: FederatedPointerEvent]
    touchmove: [event: FederatedPointerEvent]
    touchmovecapture: [event: FederatedPointerEvent]
    touchstart: [event: FederatedPointerEvent]
    touchstartcapture: [event: FederatedPointerEvent]
    wheel: [event: FederatedWheelEvent]
    wheelcapture: [event: FederatedWheelEvent]