@vtj

---

@vtj / designer / Engine

Class: Engine

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

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

Extends

• Base

Constructors

Constructor

new Engine(options): Engine

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

Parameters

options

EngineOptions

Returns

Engine

Overrides

Base.constructor

Properties

access?

optional access: Access

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

---

adapter?

optional adapter: Partial<ProvideAdapter>

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

---

app?

optional app: App<any>

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

---

assets

assets: Assets

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

---

changed

changed: Ref<symbol>

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

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

---

checkVersion

checkVersion: boolean

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

---

container

container: MaybeRef<HTMLElement | undefined>

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

---

context

context: Ref<Context | null>

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

---

current

current: Ref<BlockModel | null>

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

---

emitter

emitter: Emitter

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

---

history

history: Ref<HistoryModel | null>

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

---

isEmptyCurrent

isEmptyCurrent: Ref<boolean>

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

---

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:127

---

options

options: EngineOptions

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

---

project

project: Ref<ProjectModel | null>

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

---

projectHistory

projectHistory: Ref<HistoryModel | null>

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

---

provider

provider: Provider

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

---

remote?

optional remote: string | null

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

---

report

report: Report

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

---

service

service: Service

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

---

simulator

simulator: Simulator

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

---

skeleton?

optional skeleton: 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: 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>; }, { }, { }, { }, { }> | undefined; 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: 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>; }, { }, { }, { }, { }> | undefined; 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; }, { }> | null

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

---

state

state: State

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

---

toolRegistry

toolRegistry: ToolRegistry

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

Methods

applyAI()

applyAI(dsl): Promise<boolean>

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

应用AI生成的DSL

Parameters

dsl

BlockSchema

区块Schema

Returns

Promise<boolean>

是否成功应用（项目被锁定或非本人锁定时返回 false）

---

dispose()

dispose(): void

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

销毁引擎，清理资源

Returns

void

---

genSource()

genSource(): Promise<string | undefined>

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

生成源代码

Returns

Promise<string | undefined>

生成的源代码

---

onSaveBlockFileFinish()

onSaveBlockFileFinish(callback): void

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

Parameters

callback

(e) => void

Returns

void

---

openFile()

openFile(fileId?): Promise<void>

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

打开指定文件

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