Skip to main content

Window

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

Overview

Low-code designer window model

Properties

id

Unique window id

@type {string}

title

Window title

@type {string}

icon

@type {ReactElement}

resource

Resource associated with the window

@type {IPublicModelResource}

Related model: IPublicModelResource

currentEditorView

Current view of the window

@type {IPublicModelEditorView}

Related model: IPublicModelEditorView

@since v1.1.7

editorViews

All views of the window

@type {IPublicModelEditorView[]}

Related model: IPublicModelEditorView

@since v1.1.7

Methods

importSchema

Import schema into the current window; invokes the import hook of the resource associated with the window

function importSchema(schema: IPublicTypeNodeSchema): void;

Related types: IPublicTypeNodeSchema

changeViewType

Change the current window view type

function changeViewType(viewName: string): void;

save

Save the current window; invokes the save hook of the resource associated with the window

function save(): Promise(void)

Events

onChangeViewType

Window view change event

onChangeViewType(fn: (viewName: string) => void): IPublicTypeDisposable;

Related types: IPublicTypeDisposable

onSave

Window save event

onSave(fn: () => void): IPublicTypeDisposable;

Related types: IPublicTypeDisposable

@since v1.1.7