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

    Interface ProjectEditorOptions

    interface ProjectEditorOptions {
        additionalActions?: ActionProvider;
        additionalRestrictions?:
            | UserRestrictionsProvider
            | ReadonlySet<UserRestriction>;
        clipboardData?: ClipboardData;
        container: HTMLElement;
        eaiwsContext: EaiwsContext;
        editorMode?: ProjectEditorMode;
        importForeignCalculation?: boolean;
        lockedItems?: ReadonlyMap<string, ItemLockState>;
        migrateLegacyProjectData?: boolean;
        projectInfo?: ProjectInfo;
        projectMetaData?: ProjectMetaData;
        selectedItems?: string[];
        triggerOfmlArticleUpdate?: boolean;
    }
    Index
    additionalActions?: ActionProvider

    Additional actions for the editor

    additionalRestrictions?: UserRestrictionsProvider | ReadonlySet<UserRestriction>

    Additional restrictions for the current user. Effective only for this project editor.

    clipboardData?: ClipboardData

    Optional predefined clipboard data which can be used to fill the clipboard of the editor in advance.

    container: HTMLElement

    Html container for the editor ui.

    eaiwsContext: EaiwsContext

    An open eaiws session which will be used from the ui.

    editorMode?: ProjectEditorMode

    The editor mode defines the primary purpose of the project editor. If not defined Default will be used. The mode may be used by plugins to react to different use cases.

    importForeignCalculation?: boolean

    If true and the project was last edited using a different pricing procedure than the current default one, the user will be asked if he wants to import the calculation.

    false
    
    lockedItems?: ReadonlyMap<string, ItemLockState>

    Optional list of locked items (map from basket item id to lock state) which will be used to lock certain item related operations.

    migrateLegacyProjectData?: boolean

    If true, legacy data (e.g. header or address data) will be loaded and migrated. Should be used when loading obk files of older applications.

    false
    
    projectInfo?: ProjectInfo

    Optional pre-created ProjectInfo instance. Will be ignored if eaiwsContext and projectInfo.context are not equal.

    projectMetaData?: ProjectMetaData

    Optional project related meta data which may be used by certain operations (e.g. ordering)

    selectedItems?: string[]

    List of item ids for items which should be initially selected.

    triggerOfmlArticleUpdate?: boolean

    If true the user will be asked if he wants to update the OFML articles currently inside the basket

    false