跳到主要内容

workspace - 应用级 API

@experimental
@types IPublicApiWorkspace
@since v1.1.0

模块简介

通过该模块可以开发应用级低代码设计器。

变量

isActive

是否启用 workspace 模式

window

当前设计器窗口模型

get window(): IPublicModelWindow

关联模型 IPublicModelWindow

plugins

应用级别的插件注册

get plugins(): IPublicApiPlugins

关联模型 IPublicApiPlugins

skeleton

应用级别的面板管理

get skeleton(): IPublicApiSkeleton

关联模型 IPublicApiSkeleton

windows

当前设计器的编辑窗口

get window(): IPublicModelWindow[]

关联模型 IPublicModelWindow

resourceList

当前设计器的资源列表数据

get resourceList(): IPublicModelResource;

关联模型 IPublicModelResource

方法

registerResourceType

注册资源

/** 注册资源 */
registerResourceType(resourceTypeModel: IPublicTypeResourceType): void;

相关类型:IPublicTypeResourceType

setResourceList

设置设计器资源列表数据

setResourceList(resourceList: IPublicResourceList) {}

相关类型:IPublicResourceData

openEditorWindow

打开视图窗口

/**
* 打开视图窗口
* @deprecated
*/
openEditorWindow(resourceName: string, id: string, extra: Object, viewName?: string, sleep?: boolean): Promise<void>;

/** 打开视图窗口 */
openEditorWindow(resource: Resource, sleep?: boolean): Promise<void>;

openEditorWindowById

通过视图 id 打开窗口

openEditorWindowById(id: string): void;

removeEditorWindow

移除视图窗口

/**
* 移除视图窗口
* @deprecated
*/
removeEditorWindow(resourceName: string, id: string): void;

/**
* 移除视图窗口
*/
removeEditorWindow(resource: Resource): void;

removeEditorWindowById

通过视图 id 移除窗口

removeEditorWindowById(id: string): void;

事件

onChangeWindows

窗口新增/删除的事件

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

相关类型:IPublicTypeDisposable

onChangeActiveWindow

active 窗口变更事件

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

相关类型:IPublicTypeDisposable

onResourceListChange

设计器资源列表数据变更事件

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