Hierarchy

  • ProjectEditorOptions

Properties

additionalActions?: ActionProvider

Additional actions for the editor

additionalRestrictions?: UserRestrictionsProvider | ReadonlySet<UserRestriction>

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

container: HTMLElement

Html container for the editor ui.

eaiwsSession: EaiwsSession

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.

lockedItems?: ReadonlyMap<string, number>

Optional list of locked items (map from basket item id to lock flag) 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. (default: false) Should be used when loading obk files of older applications.

projectInfo?: ProjectInfo

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

projectMetaData?: ProjectMetaData

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

Generated using TypeDoc