pCon.basket - Plugin Development
    Preparing search index...

    Interface ItemTree

    ItemList created by the ItemListPlugin.

    interface ItemTree {
        isActive?: boolean;
        onEditSelection: (() => void) | undefined;
        onShowSelectionContextMenu:
            | (
                (
                    pPosition: { x: number; y: number },
                    pAdditionalActions?: readonly MenuAction[],
                ) => void
            )
            | undefined;
        dispose(): Promise<void>;
        renameItem(pItem: BasketItem): void;
        scrollToItem(pItem: BasketItem): void;
        setActive?(pActive: boolean): Promise<void>;
        update(): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    isActive?: boolean

    Optional activity state of this component. Initial component state should be inactive (false or undefined).

    onEditSelection: (() => void) | undefined
    onShowSelectionContextMenu:
        | (
            (
                pPosition: { x: number; y: number },
                pAdditionalActions?: readonly MenuAction[],
            ) => void
        )
        | undefined
    • Called if this instance is no longer in use. Should be used to clean-up resources.

      Returns Promise<void>

    • Parameters

      • pItem: BasketItem

      Returns void

    • Parameters

      • pItem: BasketItem

      Returns void

    • Optional activity state handling for this component. E.g. can be used to disable/enable event handling. Will be set from the component host to activate or deactivate the component. Initial component state should be inactive (false or undefined).

      Parameters

      • pActive: boolean

      Returns Promise<void>

    • Returns Promise<void>