UXP Toolkit
    Preparing search index...

    Interface PanelConfig

    interface PanelConfig {
        create?: (this: UxpPanelInfo) => Promise<void>;
        destroy?: (this: UxpPanelInfo) => Promise<void>;
        hide?: (this: UxpPanelInfo) => Promise<void>;
        invokeMenu?: (this: UxpPanelInfo, menuId: string) => Promise<void>;
        menuItems?: (MenuItem | "-")[];
        show?: (this: UxpPanelInfo) => Promise<void>;
    }
    Index

    Properties

    create? destroy? hide? invokeMenu? menuItems? show?

    Properties

    create?: (this: UxpPanelInfo) => Promise<void>

    This is called when a panel is created. 'this' can be used to access UxpPanelInfo object. This function can return a promise. To signal failure, throw an exception or return a rejected promise. This has a default Timeout of 300 MSec from manifest v5 onwards. Parameters : create(event) {}, till Manifest Version V4 create(rootNode) {}, from v5 onwards

    destroy?: (this: UxpPanelInfo) => Promise<void>

    This is called when a panel is going to be destroyed. 'this' can be used to access UxpPanelInfo object. To signal failure, throw an exception. Parameters : destroy(event) {}, till Manifest Version V4 destroy(rootNode) {}, from v5 onwards

    hide?: (this: UxpPanelInfo) => Promise<void>

    This is called when a panel is hidden. 'this' can be used to access UxpPanelInfo object. This function can return a promise. To signal failure, throw an exception or return a rejected promise. This has a default Timeout of 300 MSec from manifest v5 onwards. Parameters : hide(event) {}, till Manifest Version V4 hide(rootNode, data) {}, from v5 onwards

    invokeMenu?: (this: UxpPanelInfo, menuId: string) => Promise<void>

    This is called when a panel menu item is invoked. Menu id is passed as the first argument to this function. 'this' can be used to access UxpPanelInfo object. This function can return a promise. To signal failure, throw an exception or return a rejected promise.

    menuItems?: (MenuItem | "-")[]

    Array of menu items. Each menu item can be a string or an object with properties defined below. Menu items are displayed in the same order as specified in this array. For specifying a separator, a value of "-" or menu item with label "-" can be used at required place in the array.

    show?: (this: UxpPanelInfo) => Promise<void>

    This is called when a panel is shown. 'this' can be used to access UxpPanelInfo object. This function can return a promise. To signal failure, throw an exception or return a rejected promise. This has a default Timeout of 300 MSec from manifest v5 onwards. Parameters : show(event) {}, till Manifest Version V4 show(rootNode, data) {}, from v5 onwards

    Settings

    Member Visibility

    On This Page

    Properties