Skip to main content

workspace - Application-level API

@experimental
> @types IPublicApiWorkspace
> @since v1.1.0

Module Overview​

Use this module to build application-level low-code designers.

Variables​

isActive​

Whether workspace mode is enabled

window​

Current designer window model

get window(): IPublicModelWindow

Related model: IPublicModelWindow

plugins​

Application-level plugin registration

get plugins(): IPublicApiPlugins

Related model: IPublicApiPlugins

skeleton​

Application-level panel management

get skeleton(): IPublicApiSkeleton

Related model: IPublicApiSkeleton

windows​

Editor windows in the current designer

get window(): IPublicModelWindow[]

Related model: IPublicModelWindow

resourceList​

Resource list data for the current designer

get resourceList(): IPublicModelResource;

Related model: IPublicModelResource

Methods​

registerResourceType​

Register a resource type

/** Register a resource type */
registerResourceType(resourceTypeModel: IPublicTypeResourceType): void;

Related type: IPublicTypeResourceType

setResourceList​

Set designer resource list data

setResourceList(resourceList: IPublicResourceList) {}

Related type: IPublicResourceData

openEditorWindow​

Open an editor window

/**
 * Open an editor window
 * @deprecated
 */
openEditorWindow(resourceName: string, id: string, extra: Object, viewName?: string, sleep?: boolean): Promise<void>;

/** Open an editor window */
openEditorWindow(resource: Resource, sleep?: boolean): Promise<void>;

openEditorWindowById​

Open a window by view id

openEditorWindowById(id: string): void;

removeEditorWindow​

Remove an editor window

/**
 * Remove an editor window
 * @deprecated
 */
removeEditorWindow(resourceName: string, id: string): void;

/**
 * Remove an editor window
 */
removeEditorWindow(resource: Resource): void;

removeEditorWindowById​

Remove a window by view id

removeEditorWindowById(id: string): void;

Events​

onChangeWindows​

Window add/remove event

function onChangeWindows(fn: () => void): IPublicTypeDisposable;

Related type: IPublicTypeDisposable

onChangeActiveWindow​

Active window change event

function onChangeActiveWindow(fn: () => void): IPublicTypeDisposable;

Related type: IPublicTypeDisposable

onResourceListChange​

Designer resource list change event

onResourceListChange(fn: (resourceList: IPublicResourceList): void): (): IPublicTypeDisposable;