pancanvastool.md

andculturecode-javascript-react-components › PanCanvasTool

Class: PanCanvasTool

Hierarchy

• PanCanvasTool

Index

Constructors

• constructor

Properties

• _config
• _isPointerActive
• _lastPosition
• toolType

Methods

• _addCursor
• _addEventListeners
• _finishPan
• _onMouseDownCanvas
• _onMouseMoveCanvas
• _onMouseUpWindow
• _onTouchEndWindow
• _onTouchMoveCanvas
• _onTouchStartCanvas
• _pan
• _removeCursor
• _removeEventListeners
• _startPan
• dispose
• initialize

Constructors

constructor

+ new PanCanvasTool(panConfig: PanConfig): PanCanvasTool

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:23

Parameters:

Name	Type
panConfig	PanConfig

Returns: PanCanvasTool

Properties

Private _config

• _config: PanConfig

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:21

---

Private _isPointerActive

• _isPointerActive: boolean

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:22

---

Private _lastPosition

• _lastPosition: PointerPosition

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:23

---

toolType

• toolType: CanvasToolType

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:19

Methods

Private _addCursor

▸ _addCursor(): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:54

Returns: void

---

Private _addEventListeners

▸ _addEventListeners(): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:61

Binds the necessary mouse and touch events

Returns: void

---

Private _finishPan

▸ _finishPan(): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:90

Completes the panning interaction

Returns: void

---

Private _onMouseDownCanvas

▸ _onMouseDownCanvas(e: MouseEvent): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:161

Parameters:

Name	Type
e	MouseEvent

Returns: void

---

Private _onMouseMoveCanvas

▸ _onMouseMoveCanvas(e: MouseEvent): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:168

Parameters:

Name	Type
e	MouseEvent

Returns: void

---

Private _onMouseUpWindow

▸ _onMouseUpWindow(): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:175

Returns: void

---

Private _onTouchEndWindow

▸ _onTouchEndWindow(e: TouchEvent): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:179

Parameters:

Name	Type
e	TouchEvent

Returns: void

---

Private _onTouchMoveCanvas

▸ _onTouchMoveCanvas(e: TouchEvent): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:183

Parameters:

Name	Type
e	TouchEvent

Returns: void

---

Private _onTouchStartCanvas

▸ _onTouchStartCanvas(e: TouchEvent): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:196

Parameters:

Name	Type
e	TouchEvent

Returns: void

---

Private _pan

▸ _pan(newCurrentPosition: PointerPosition): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:101

Tracks the point of interaction and moves to it

Parameters:

Name	Type	Description
newCurrentPosition	PointerPosition

Returns: void

---

Private _removeCursor

▸ _removeCursor(): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:111

Returns: void

---

Private _removeEventListeners

▸ _removeEventListeners(): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:118

Removed the bound mouse and touch events

Returns: void

---

Private _startPan

▸ _startPan(startingPosition: PointerPosition): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:149

Captures the starting position and begins the entire interaction

Parameters:

Name	Type	Description
startingPosition	PointerPosition

Returns: void

---

dispose

▸ dispose(): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:38

Returns: void

---

initialize

▸ initialize(): void

Defined in src/atoms/forms/canvas-sketch/tools/pan-canvas-tool.ts:43

Returns: void