@vtj • Docs

---

@vtj / designer / Designer

Class: Designer

Constructors

new Designer()

new Designer(engine, contentWindow, dependencies, devtools): Designer

Parameters

• engine: Engine

• contentWindow: Window

• dependencies: Ref<Dependencie[], Dependencie[]>

• devtools: DevTools

Returns

Designer

Defined in

packages/designer/types/framework/designer.d.ts:30

Properties

contentWindow

contentWindow: Window

Defined in

packages/designer/types/framework/designer.d.ts:20

---

dependencies

dependencies: Ref<Dependencie[], Dependencie[]>

Defined in

packages/designer/types/framework/designer.d.ts:21

---

devtools

devtools: DevTools

Defined in

packages/designer/types/framework/designer.d.ts:22

---

document

document: null | Document

Defined in

packages/designer/types/framework/designer.d.ts:24

---

dragging

dragging: null | MaterialDescription

Defined in

packages/designer/types/framework/designer.d.ts:28

---

draggingNode

draggingNode: null | NodeModel

Defined in

packages/designer/types/framework/designer.d.ts:29

---

dropping

dropping: ShallowRef<null | DesignHelper>

Defined in

packages/designer/types/framework/designer.d.ts:26

---

engine

engine: Engine

Defined in

packages/designer/types/framework/designer.d.ts:19

---

hover

hover: ShallowRef<null | DesignHelper>

Defined in

packages/designer/types/framework/designer.d.ts:25

---

selected

selected: Ref<null | DesignHelper, null | DesignHelper>

Defined in

packages/designer/types/framework/designer.d.ts:27

Methods

allowDrop()

allowDrop(target, type?): Promise<boolean>

Parameters

• target: BlockModel | NodeModel

• type?: DropPosition

Returns

Promise<boolean>

Defined in

packages/designer/types/framework/designer.d.ts:62

---

cleanHelper()

cleanHelper(): void

Returns

void

Defined in

packages/designer/types/framework/designer.d.ts:55

---

dispose()

dispose(): void

Returns

void

Defined in

packages/designer/types/framework/designer.d.ts:63

---

getDropSlot()

getDropSlot(to): Promise<undefined | null | MaterialSlot>

Parameters

• to: null | NodeModel

Returns

Promise<undefined | null | MaterialSlot>

Defined in

packages/designer/types/framework/designer.d.ts:38

---

getHelper()

getHelper(e): null | DesignHelper

Parameters

• e: DragEvent | MouseEvent

Returns

null | DesignHelper

Defined in

packages/designer/types/framework/designer.d.ts:54

---

getVueInstance()

getVueInstance(helper, id?): any

Parameters

• helper: DesignHelper

• id?: string

Returns

any

Defined in

packages/designer/types/framework/designer.d.ts:39

---

setDragging()

setDragging(desc): void

Parameters

• desc: null | MaterialDescription

Returns

void

Defined in

packages/designer/types/framework/designer.d.ts:57

---

setDraggingNode()

setDraggingNode(node): void

Parameters

• node: null | NodeModel

Returns

void

Defined in

packages/designer/types/framework/designer.d.ts:58

---

setDropping()

setDropping(model, type?): Promise<void>

Parameters

• model: null | BlockModel | NodeModel

• type?: DropPosition

Returns

Promise<void>

Defined in

packages/designer/types/framework/designer.d.ts:61

---

setHover()

setHover(model): Promise<void>

Parameters

• model: null | BlockModel | NodeModel

Returns

Promise<void>

Defined in

packages/designer/types/framework/designer.d.ts:59

---

setSelected()

setSelected(model): Promise<void>

Parameters

• model: null | BlockModel | NodeModel

Returns

Promise<void>

Defined in

packages/designer/types/framework/designer.d.ts:60

---

updateRect()

updateRect(): Promise<void>

Returns

Promise<void>

Defined in

packages/designer/types/framework/designer.d.ts:56