@vtj

---

@vtj / designer / Engine

Class: Engine

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

Extends

• Base

Constructors

Constructor

new Engine(options): Engine

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

Parameters

options

EngineOptions

Returns

Engine

Overrides

Base.constructor

Properties

access?

optional access: Access

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

---

adapter?

optional adapter: Partial<ProvideAdapter>

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

---

app?

optional app: App<any>

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

---

assets

assets: Assets

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

---

changed

changed: Ref<symbol>

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

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

---

checkVersion

checkVersion: boolean

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

---

container

container: MaybeRef<undefined | HTMLElement>

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

---

context

context: Ref<null | Context>

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

---

current

current: Ref<null | BlockModel>

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

---

emitter

emitter: Emitter

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

---

history

history: Ref<null | HistoryModel>

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

---

isEmptyCurrent

isEmptyCurrent: Ref<boolean>

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

---

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

---

options

options: EngineOptions

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

---

project

project: Ref<null | ProjectModel>

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

---

provider

provider: Provider

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

---

remote?

optional remote: null | string

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

---

report

report: Report

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

---

service

service: Service

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

---

simulator

simulator: Simulator

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

---

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

Methods

applyAI()

applyAI(dsl): Promise<void>

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

Parameters

dsl

BlockSchema

Returns

Promise<void>

---

dispose()

dispose(): void

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

Returns

void

---

genSource()

genSource(): Promise<undefined | string>

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

Returns

Promise<undefined | string>

---

onSaveBlockFileFinish()

onSaveBlockFileFinish(callback): void

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

Parameters

callback

(e) => void

Returns

void

---

openFile()

openFile(fileId?): Promise<void>

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

Parameters

fileId?

string

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