@vtj / Modules / designer / Engine
Class: Engine
designer.Engine
Hierarchy
Base↳
Engine
Table of contents
Constructors
Properties
- activeFile
- app
- assets
- bindEvents
- changeCurrentFile
- changeFile
- changed
- container
- context
- current
- emitter
- history
- init
- initHistory
- isEmptyCurrent
- isReady
- listeners
- loadHistory
- project
- provider
- publish
- publishCurrent
- render
- saveBlockFile
- saveCurrentFile
- saveHistory
- saveMaterials
- saveProject
- service
- simulator
- skeleton
- updateCurrent
Methods
Constructors
constructor
• new Engine(options): Engine
Parameters
| Name | Type |
|---|---|
options | EngineOptions |
Returns
Overrides
Base.constructor
Defined in
packages/designer/types/framework/engine.d.ts:37
Properties
activeFile
• Private activeFile: any
Defined in
packages/designer/types/framework/engine.d.ts:41
app
• Optional app: App<any>
Defined in
packages/designer/types/framework/engine.d.ts:20
assets
• assets: Assets
Defined in
packages/designer/types/framework/engine.d.ts:24
bindEvents
• Private bindEvents: any
Defined in
packages/designer/types/framework/engine.d.ts:40
changeCurrentFile
• Private changeCurrentFile: any
Defined in
packages/designer/types/framework/engine.d.ts:43
changeFile
• Private changeFile: any
Defined in
packages/designer/types/framework/engine.d.ts:42
changed
• changed: Ref<symbol>
当current变化时，更新该值，用于通知组件更新
Defined in
packages/designer/types/framework/engine.d.ts:36
container
• container: MaybeRef<undefined | HTMLElement>
Defined in
packages/designer/types/framework/engine.d.ts:22
context
• context: Ref<null | Context>
Defined in
packages/designer/types/framework/engine.d.ts:29
current
• current: Ref<null | BlockModel>
Defined in
packages/designer/types/framework/engine.d.ts:28
emitter
• emitter: Emitter
Defined in
packages/designer/types/framework/engine.d.ts:26
history
• history: Ref<null | HistoryModel>
Defined in
packages/designer/types/framework/engine.d.ts:31
init
• Private init: any
Defined in
packages/designer/types/framework/engine.d.ts:38
initHistory
• Private initHistory: any
Defined in
packages/designer/types/framework/engine.d.ts:49
isEmptyCurrent
• isEmptyCurrent: Ref<boolean>
Defined in
packages/designer/types/framework/engine.d.ts:30
isReady
• Protected isReady: boolean
Inherited from
Base.isReady
Defined in
packages/core/types/models/base.d.ts:3
listeners
• Protected listeners: () => void[]
Inherited from
Base.listeners
Defined in
packages/core/types/models/base.d.ts:2
loadHistory
• Private loadHistory: any
Defined in
packages/designer/types/framework/engine.d.ts:51
project
• project: Ref<null | ProjectModel>
Defined in
packages/designer/types/framework/engine.d.ts:27
provider
• provider: Provider
Defined in
packages/designer/types/framework/engine.d.ts:32
publish
• Private publish: any
Defined in
packages/designer/types/framework/engine.d.ts:52
publishCurrent
• Private publishCurrent: any
Defined in
packages/designer/types/framework/engine.d.ts:53
render
• Private render: any
Defined in
packages/designer/types/framework/engine.d.ts:39
saveBlockFile
• Private saveBlockFile: any
Defined in
packages/designer/types/framework/engine.d.ts:46
saveCurrentFile
• Private saveCurrentFile: any
Defined in
packages/designer/types/framework/engine.d.ts:48
saveHistory
• Private saveHistory: any
Defined in
packages/designer/types/framework/engine.d.ts:50
saveMaterials
• Private saveMaterials: any
Defined in
packages/designer/types/framework/engine.d.ts:47
saveProject
• Private saveProject: any
Defined in
packages/designer/types/framework/engine.d.ts:45
service
• service: Service
Defined in
packages/designer/types/framework/engine.d.ts:23
simulator
• simulator: Simulator
Defined in
packages/designer/types/framework/engine.d.ts:25
skeleton
• Optional skeleton: null | CreateComponentPublicInstance<Readonly<ExtractPropTypes<{}>>, { engine: ShallowReactive<Engine> ; skeletonRef: Ref<any> ; widgets: Ref<Record<string, CreateComponentPublicInstance<Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<...> } ; widget: { required: true ; type: PropType<...> } }>>, { widgetRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{ region: { required: ... ; type: ... } ; widget: { required: ... ; type: ... } }>>, {}, true, {}, {}, { B: {} ; C: {} ; D: {} ; Defaults: {} ; M: {} ; P: {} }, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<...> } ; widget: { required: true ; type: PropType<...> } }>>, { widgetRef: Ref<any> }, {}, {}, {}, {}>>> }, {}, {}, { closePreview: () => void ; getRegion: (region: "Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview") => CreateComponentPublicInstance<Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<"Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview"> } }>>, { regionRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<... | ... | ... | ... | ... | ... | ... | ...> } }>>, {}, true, {}, {}, OptionTypesType<{}, {}, {}, {}, {}, {}>, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<"Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview"> } }>>, { regionRef: Ref<any> }, {}, {}, {}, {}> ; getWidget: (name: string) => undefined | CreateComponentPublicInstance<Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<...> } ; widget: { required: true ; type: PropType<...> } }>>, {}, true, {}, {}, OptionTypesType<{}, {}, {}, {}, {}, {}>, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, {}, {}, {}, {}> ; getWidgets: (region: "Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview") => CreateComponentPublicInstance<Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<...> } ; widget: { required: true ; type: PropType<...> } }>>, {}, true, {}, {}, OptionTypesType<{}, {}, {}, {}, {}, {}>, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, {}, {}, {}, {}>[] ; openPreview: (_id: string) => void ; settable: (val: boolean) => void ; toggleCollapse: (value?: boolean) => void }, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{}>>, {}, true, {}, {}, OptionTypesType<{}, {}, {}, {}, {}, {}>, Readonly<ExtractPropTypes<{}>>, { engine: ShallowReactive<Engine> ; skeletonRef: Ref<any> ; widgets: Ref<Record<string, CreateComponentPublicInstance<Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<...> } ; widget: { required: true ; type: PropType<...> } }>>, { widgetRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{ region: { required: ... ; type: ... } ; widget: { required: ... ; type: ... } }>>, {}, true, {}, {}, { B: {} ; C: {} ; D: {} ; Defaults: {} ; M: {} ; P: {} }, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<...> } ; widget: { required: true ; type: PropType<...> } }>>, { widgetRef: Ref<any> }, {}, {}, {}, {}>>> }, {}, {}, { closePreview: () => void ; getRegion: (region: "Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview") => CreateComponentPublicInstance<Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<"Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview"> } }>>, { regionRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<... | ... | ... | ... | ... | ... | ... | ...> } }>>, {}, true, {}, {}, OptionTypesType<{}, {}, {}, {}, {}, {}>, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<"Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview"> } }>>, { regionRef: Ref<any> }, {}, {}, {}, {}> ; getWidget: (name: string) => undefined | CreateComponentPublicInstance<Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<...> } ; widget: { required: true ; type: PropType<...> } }>>, {}, true, {}, {}, OptionTypesType<{}, {}, {}, {}, {}, {}>, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, {}, {}, {}, {}> ; getWidgets: (region: "Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview") => CreateComponentPublicInstance<Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<...> } ; widget: { required: true ; type: PropType<...> } }>>, {}, true, {}, {}, OptionTypesType<{}, {}, {}, {}, {}, {}>, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, {}, {}, {}, {}>[] ; openPreview: (_id: string) => void ; settable: (val: boolean) => void ; toggleCollapse: (value?: boolean) => void }, {}>
Defined in
packages/designer/types/framework/engine.d.ts:21
updateCurrent
• Private updateCurrent: any
Defined in
packages/designer/types/framework/engine.d.ts:44
Methods
dispose
▸ dispose(): void
Returns
void
Defined in
packages/designer/types/framework/engine.d.ts:54
openFile
▸ openFile(fileId?): Promise<void>
Parameters
| Name | Type |
|---|---|
fileId? | string |
Returns
Promise<void>
Defined in
packages/designer/types/framework/engine.d.ts:55
ready
▸ ready(callback): void
Parameters
| Name | Type |
|---|---|
callback | () => void |
Returns
void
Inherited from
Base.ready
Defined in
packages/core/types/models/base.d.ts:5
resetReady
▸ resetReady(): void
Returns
void
Inherited from
Base.resetReady
Defined in
packages/core/types/models/base.d.ts:6
triggerReady
▸ triggerReady(): void
Returns
void
Inherited from
Base.triggerReady
Defined in
packages/core/types/models/base.d.ts:4