@vtj / Modules / designer / Designer

Class: Designer

designer.Designer

Table of contents

Constructors

• constructor

Properties

• bind
• bindEvents
• contentWindow
• createNodeDsl
• dependencies
• document
• dragging
• draggingNode
• dropping
• engine
• findPathByNode
• findVtjElement
• getDropType
• getElmenetByModel
• getNodeByElement
• getNodePath
• hover
• isVtjElement
• onActiveChange
• onDragOver
• onDrop
• onLeave
• onMouseOver
• onSelected
• onViewChange
• proxied
• selected
• setDslFrom
• unbindEvents

Methods

• allowDrop
• cleanHelper
• dispose
• getDropSlot
• getHelper
• setDragging
• setDraggingNode
• setDropping
• setHover
• setSelected
• updateRect

Constructors

constructor

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

Parameters

Name	Type
engine	Engine
contentWindow	Window
dependencies	Ref<Dependencie[]>

Returns

Designer

Defined in

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

Properties

bind

• Private bind: any

Defined in

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

---

bindEvents

• Private bindEvents: any

Defined in

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

---

contentWindow

• contentWindow: Window

Defined in

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

---

createNodeDsl

• Private createNodeDsl: any

Defined in

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

---

dependencies

• dependencies: Ref<Dependencie[]>

Defined in

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

---

document

• document: null | Document

Defined in

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

---

dragging

• dragging: null | MaterialDescription

Defined in

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

---

draggingNode

• draggingNode: null | NodeModel

Defined in

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

---

dropping

• dropping: ShallowRef<null | DesignHelper>

Defined in

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

---

engine

• engine: Engine

Defined in

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

---

findPathByNode

• Private findPathByNode: any

Defined in

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

---

findVtjElement

• Private findVtjElement: any

Defined in

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

---

getDropType

• Private getDropType: any

Defined in

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

---

getElmenetByModel

• Private getElmenetByModel: any

Defined in

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

---

getNodeByElement

• Private getNodeByElement: any

Defined in

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

---

getNodePath

• Private getNodePath: any

Defined in

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

---

hover

• hover: ShallowRef<null | DesignHelper>

Defined in

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

---

isVtjElement

• Private isVtjElement: any

Defined in

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

---

onActiveChange

• Private onActiveChange: any

Defined in

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

---

onDragOver

• Private onDragOver: any

Defined in

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

---

onDrop

• Private onDrop: any

Defined in

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

---

onLeave

• Private onLeave: any

Defined in

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

---

onMouseOver

• Private onMouseOver: any

Defined in

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

---

onSelected

• Private onSelected: any

Defined in

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

---

onViewChange

• Private onViewChange: any

Defined in

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

---

proxied

• Private proxied: any

Defined in

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

---

selected

• selected: Ref<null | DesignHelper>

Defined in

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

---

setDslFrom

• Private setDslFrom: any

Defined in

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

---

unbindEvents

• Private unbindEvents: any

Defined in

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

Methods

allowDrop

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

Parameters

Name	Type
target	BlockModel | NodeModel
type?	DropPosition

Returns

Promise<boolean>

Defined in

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

---

cleanHelper

▸ cleanHelper(): void

Returns

void

Defined in

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

---

dispose

▸ dispose(): void

Returns

void

Defined in

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

---

getDropSlot

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

Parameters

Name	Type
to	null | NodeModel

Returns

Promise<undefined | null | MaterialSlot>

Defined in

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

---

getHelper

▸ getHelper(e): null | DesignHelper

Parameters

Name	Type
e	DragEvent | MouseEvent

Returns

null | DesignHelper

Defined in

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

---

setDragging

▸ setDragging(desc): void

Parameters

Name	Type
desc	null | MaterialDescription

Returns

void

Defined in

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

---

setDraggingNode

▸ setDraggingNode(node): void

Parameters

Name	Type
node	null | NodeModel

Returns

void

Defined in

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

---

setDropping

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

Parameters

Name	Type
model	null | BlockModel | NodeModel
type?	DropPosition

Returns

Promise<void>

Defined in

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

---

setHover

▸ setHover(model): Promise<void>

Parameters

Name	Type
model	null | BlockModel | NodeModel

Returns

Promise<void>

Defined in

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

---

setSelected

▸ setSelected(model): Promise<void>

Parameters

Name	Type
model	null | BlockModel | NodeModel

Returns

Promise<void>

Defined in

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

---

updateRect

▸ updateRect(): Promise<void>

Returns

Promise<void>

Defined in

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