Skip to content

@vtj


@vtj / designer / Engine

Class: Engine

Defined in: packages/designer/types/framework/engine.d.ts:88

设计器引擎核心类,负责管理设计器的整体生命周期和状态 包括项目管理、文件操作、历史记录、渲染等核心功能

Extends

  • Base

Constructors

Constructor

new Engine(options): Engine

Defined in: packages/designer/types/framework/engine.d.ts:113

Parameters

options

EngineOptions

Returns

Engine

Overrides

Base.constructor

Properties

access?

optional access: Access

Defined in: packages/designer/types/framework/engine.d.ts:108


adapter?

optional adapter: Partial<ProvideAdapter>

Defined in: packages/designer/types/framework/engine.d.ts:103


app?

optional app: App<any>

Defined in: packages/designer/types/framework/engine.d.ts:90


assets

assets: Assets

Defined in: packages/designer/types/framework/engine.d.ts:94


changed

changed: Ref<symbol>

Defined in: packages/designer/types/framework/engine.d.ts:107

当current变化时,更新该值,用于通知组件更新


checkVersion

checkVersion: boolean

Defined in: packages/designer/types/framework/engine.d.ts:111


container

container: MaybeRef<undefined | HTMLElement>

Defined in: packages/designer/types/framework/engine.d.ts:92


context

context: Ref<null | Context>

Defined in: packages/designer/types/framework/engine.d.ts:99


current

current: Ref<null | BlockModel>

Defined in: packages/designer/types/framework/engine.d.ts:98


emitter

emitter: Emitter

Defined in: packages/designer/types/framework/engine.d.ts:96


history

history: Ref<null | HistoryModel>

Defined in: packages/designer/types/framework/engine.d.ts:101


isEmptyCurrent

isEmptyCurrent: Ref<boolean>

Defined in: packages/designer/types/framework/engine.d.ts:100


isReady

isReady: boolean

Defined in: packages/core/types/models/base.d.ts:3

Inherited from

Base.isReady


listeners

protected listeners: () => void[]

Defined in: packages/core/types/models/base.d.ts:2

Returns

void

Inherited from

Base.listeners


openApi?

optional openApi: OpenApi

Defined in: packages/designer/types/framework/engine.d.ts:112


options

options: EngineOptions

Defined in: packages/designer/types/framework/engine.d.ts:89


project

project: Ref<null | ProjectModel>

Defined in: packages/designer/types/framework/engine.d.ts:97


provider

provider: Provider

Defined in: packages/designer/types/framework/engine.d.ts:102


remote?

optional remote: null | string

Defined in: packages/designer/types/framework/engine.d.ts:109


report

report: Report

Defined in: packages/designer/types/framework/engine.d.ts:110


service

service: Service

Defined in: packages/designer/types/framework/engine.d.ts:93


simulator

simulator: Simulator

Defined in: packages/designer/types/framework/engine.d.ts:95


skeleton?

optional skeleton: null | CreateComponentPublicInstanceWithMixins<Readonly<{ }>, { engine: ShallowReactive<Engine>; skeletonRef: Ref<any, any>; widgets: Ref<Record<string, CreateComponentPublicInstanceWithMixins<Readonly<ExtractPropTypes<{ region: { required: ...; type: ...; }; widget: { required: ...; type: ...; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, ComponentOptionsMixin, ComponentOptionsMixin, { }, PublicProps, { }, true, { }, { }, GlobalComponents, GlobalDirectives, string, { }, any, ComponentProvideOptions, { B: { }; C: { }; D: { }; Defaults: { }; M: { }; P: { }; }, Readonly<ExtractPropTypes<{ region: { required: ...; type: ...; }; widget: { required: ...; type: ...; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, { }>>, Record<string, CreateComponentPublicInstanceWithMixins<Readonly<ExtractPropTypes<{ region: { required: ...; type: ...; }; widget: { required: ...; type: ...; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, ComponentOptionsMixin, ComponentOptionsMixin, { }, PublicProps, { }, true, { }, { }, GlobalComponents, GlobalDirectives, string, { }, any, ComponentProvideOptions, { B: { }; C: { }; D: { }; Defaults: { }; M: { }; P: { }; }, Readonly<ExtractPropTypes<{ region: { required: ...; type: ...; }; widget: { required: ...; type: ...; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, { }>>>; }, { }, { }, { closePreview: void; getRegion: CreateComponentPublicInstanceWithMixins; getWidget: undefined | CreateComponentPublicInstanceWithMixins<Readonly<ExtractPropTypes<{ region: { required: true; type: PropType<...>; }; widget: { required: true; type: PropType<...>; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, ComponentOptionsMixin, ComponentOptionsMixin, { }, PublicProps, { }, true, { }, { }, GlobalComponents, GlobalDirectives, string, { }, any, ComponentProvideOptions, OptionTypesType<{ }, { }, { }, { }, { }, { }>, Readonly<ExtractPropTypes<{ region: { required: true; type: PropType<...>; }; widget: { required: true; type: PropType<...>; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, { }>; getWidgets: CreateComponentPublicInstanceWithMixins<Readonly<ExtractPropTypes<{ region: { required: true; type: PropType<...>; }; widget: { required: true; type: PropType<...>; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, ComponentOptionsMixin, ComponentOptionsMixin, { }, PublicProps, { }, true, { }, { }, GlobalComponents, GlobalDirectives, string, { }, any, ComponentProvideOptions, OptionTypesType<{ }, { }, { }, { }, { }, { }>, Readonly<ExtractPropTypes<{ region: { required: true; type: PropType<...>; }; widget: { required: true; type: PropType<...>; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, { }>[]; openPreview: void; settable: void; toggleCollapse: void; }, ComponentOptionsMixin, ComponentOptionsMixin, { }, PublicProps, { }, true, { }, { }, GlobalComponents, GlobalDirectives, string, { }, any, ComponentProvideOptions, OptionTypesType<{ }, { }, { }, { }, { }, { }>, Readonly<{ }>, { engine: ShallowReactive<Engine>; skeletonRef: Ref<any, any>; widgets: Ref<Record<string, CreateComponentPublicInstanceWithMixins<Readonly<ExtractPropTypes<{ region: { required: ...; type: ...; }; widget: { required: ...; type: ...; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, ComponentOptionsMixin, ComponentOptionsMixin, { }, PublicProps, { }, true, { }, { }, GlobalComponents, GlobalDirectives, string, { }, any, ComponentProvideOptions, { B: { }; C: { }; D: { }; Defaults: { }; M: { }; P: { }; }, Readonly<ExtractPropTypes<{ region: { required: ...; type: ...; }; widget: { required: ...; type: ...; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, { }>>, Record<string, CreateComponentPublicInstanceWithMixins<Readonly<ExtractPropTypes<{ region: { required: ...; type: ...; }; widget: { required: ...; type: ...; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, ComponentOptionsMixin, ComponentOptionsMixin, { }, PublicProps, { }, true, { }, { }, GlobalComponents, GlobalDirectives, string, { }, any, ComponentProvideOptions, { B: { }; C: { }; D: { }; Defaults: { }; M: { }; P: { }; }, Readonly<ExtractPropTypes<{ region: { required: ...; type: ...; }; widget: { required: ...; type: ...; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, { }>>>; }, { }, { }, { closePreview: void; getRegion: CreateComponentPublicInstanceWithMixins; getWidget: undefined | CreateComponentPublicInstanceWithMixins<Readonly<ExtractPropTypes<{ region: { required: true; type: PropType<...>; }; widget: { required: true; type: PropType<...>; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, ComponentOptionsMixin, ComponentOptionsMixin, { }, PublicProps, { }, true, { }, { }, GlobalComponents, GlobalDirectives, string, { }, any, ComponentProvideOptions, OptionTypesType<{ }, { }, { }, { }, { }, { }>, Readonly<ExtractPropTypes<{ region: { required: true; type: PropType<...>; }; widget: { required: true; type: PropType<...>; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, { }>; getWidgets: CreateComponentPublicInstanceWithMixins<Readonly<ExtractPropTypes<{ region: { required: true; type: PropType<...>; }; widget: { required: true; type: PropType<...>; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, ComponentOptionsMixin, ComponentOptionsMixin, { }, PublicProps, { }, true, { }, { }, GlobalComponents, GlobalDirectives, string, { }, any, ComponentProvideOptions, OptionTypesType<{ }, { }, { }, { }, { }, { }>, Readonly<ExtractPropTypes<{ region: { required: true; type: PropType<...>; }; widget: { required: true; type: PropType<...>; }; }>> & Readonly<{ }>, { widgetRef: Ref<any, any>; }, { }, { }, { }, { }>[]; openPreview: void; settable: void; toggleCollapse: void; }, { }>

Defined in: packages/designer/types/framework/engine.d.ts:91

Methods

applyAI()

applyAI(dsl): Promise<void>

Defined in: packages/designer/types/framework/engine.d.ts:195

应用AI生成的DSL

Parameters

dsl

BlockSchema

区块Schema

Returns

Promise<void>


dispose()

dispose(): void

Defined in: packages/designer/types/framework/engine.d.ts:203

销毁引擎,清理资源

Returns

void


genSource()

genSource(): Promise<undefined | string>

Defined in: packages/designer/types/framework/engine.d.ts:190

生成源代码

Returns

Promise<undefined | string>

生成的源代码


onSaveBlockFileFinish()

onSaveBlockFileFinish(callback): void

Defined in: packages/designer/types/framework/engine.d.ts:161

Parameters

callback

(e) => void

Returns

void


openFile()

openFile(fileId?): Promise<void>

Defined in: packages/designer/types/framework/engine.d.ts:208

打开指定文件

Parameters

fileId?

string

文件ID

Returns

Promise<void>


ready()

ready(callback): void

Defined in: packages/core/types/models/base.d.ts:5

Parameters

callback

() => void

Returns

void

Inherited from

Base.ready


resetReady()

resetReady(): void

Defined in: packages/core/types/models/base.d.ts:6

Returns

void

Inherited from

Base.resetReady


triggerReady()

protected triggerReady(): void

Defined in: packages/core/types/models/base.d.ts:4

Returns

void

Inherited from

Base.triggerReady

Released under the MIT License.