Winter Cardinal UI - v0.457.0 / DDiagramCanvasEditorSnap

Class: DDiagramCanvasEditorSnap

Table of contents

Constructors

• constructor

Properties

• _container
• _controller
• _grid
• _gridParentHeight
• _gridParentScale
• _gridParentWidth
• _gridSize
• _isDirty
• _parent
• _target

Accessors

• container

Methods

• newGridSize
• onChange
• onRender
• onResize
• onScale
• serialize
• toGrid
• toGridMajor
• toGridMinor
• toTarget
• update
• updateAll
• updateGridSize

Constructors

constructor

• new DDiagramCanvasEditorSnap(parent, theme, options): DDiagramCanvasEditorSnap

Parameters

Name	Type
parent	DDiagramCanvasEditorSnapParent
theme	DThemeDiagramCanvasEditorSnap
options	DDiagramCanvasEditorSnapOptions

Returns

DDiagramCanvasEditorSnap

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:128

Properties

_container

• Protected _container: EShapeContainer

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:116

---

_controller

• Protected _controller: ESnapper

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:115

---

_grid

• Protected _grid: DDiagramCanvasEditorSnapGrid

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:120

---

_gridParentHeight

• Protected _gridParentHeight: number

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:122

---

_gridParentScale

• Protected _gridParentScale: number

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:123

---

_gridParentWidth

• Protected _gridParentWidth: number

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:121

---

_gridSize

• Protected _gridSize: number

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:124

---

_isDirty

• Protected _isDirty: boolean

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:118

---

_parent

• Protected _parent: DDiagramCanvasEditorSnapParent

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:114

---

_target

• Protected _target: DDiagramCanvasEditorSnapTarget

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:126

Accessors

container

• get container(): EShapeContainer

Returns

EShapeContainer

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:247

Methods

newGridSize

▸ newGridSize(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:279

---

onChange

▸ onChange(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:242

---

onRender

▸ onRender(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:288

---

onResize

▸ onResize(newWidth, newHeight, oldWidth, oldHeight): void

Parameters

Name	Type
newWidth	number
newHeight	number
oldWidth	number
oldHeight	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:255

---

onScale

▸ onScale(newX, newY, oldX, oldY): void

Parameters

Name	Type
newX	number
newY	number
oldX	number
oldY	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:264

---

serialize

▸ serialize(): DDiagramSerializedSnap

Returns

DDiagramSerializedSnap

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:251

---

toGrid

▸ toGrid(theme, options?): DDiagramCanvasEditorSnapGrid

Parameters

Name	Type
theme	DThemeDiagramCanvasEditorSnap
options?	DDiagramCanvasEditorSnapGridOptions

Returns

DDiagramCanvasEditorSnapGrid

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:162

---

toGridMajor

▸ toGridMajor(theme, options?): DDiagramCanvasEditorSnapGridMajor

Parameters

Name	Type
theme	DThemeDiagramCanvasEditorSnap
options?	DDiagramCanvasEditorSnapGridMajorOptions

Returns

DDiagramCanvasEditorSnapGridMajor

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:180

---

toGridMinor

▸ toGridMinor(theme, options?): DDiagramCanvasEditorSnapGridMinor

Parameters

Name	Type
theme	DThemeDiagramCanvasEditorSnap
options?	DDiagramCanvasEditorSnapGridMinorOptions

Returns

DDiagramCanvasEditorSnapGridMinor

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:202

---

toTarget

▸ toTarget(theme, options?): DDiagramCanvasEditorSnapTarget

Parameters

Name	Type
theme	DThemeDiagramCanvasEditorSnap
options?	DDiagramCanvasEditorSnapTargetOptions

Returns

DDiagramCanvasEditorSnapTarget

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:222

---

update

▸ update(container, shapes, index, x, y, position, w, h, style): void

Parameters

Name	Type
container	EShapeContainer
shapes	EShapeBar[]
index	number
x	number
y	number
position	EShapeBarPosition
w	number
h	number
style	DDiagramCanvasEditorSnapGridMajor | DDiagramCanvasEditorSnapGridMinor | DDiagramCanvasEditorSnapTarget

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:354

---

updateAll

▸ updateAll(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:295

---

updateGridSize

▸ updateGridSize(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:271

Edit this page.