Sprotty
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

Class. Scroll Mouse Listener

scrollbar

protected scrollbar: undefined | HTMLElement

Defined in: packages/sprotty/src/features/viewport/scroll.ts:41


scrollbarMouseDownDelay

protected scrollbarMouseDownDelay: number = 200

Defined in: packages/sprotty/src/features/viewport/scroll.ts:43


scrollbarMouseDownTimeout

protected scrollbarMouseDownTimeout: undefined | number

Defined in: packages/sprotty/src/features/viewport/scroll.ts:42


viewerOptions

protected viewerOptions: ViewerOptions

Defined in: packages/sprotty/src/features/viewport/scroll.ts:36

Methods

calculateDistance()

protected calculateDistance(touches): number

Defined in: packages/sprotty/src/features/viewport/scroll.ts:305

Parameters

touches

TouchList

Returns

number


calculateMidpoint()

protected calculateMidpoint(touches, canvasBounds): Point

Defined in: packages/sprotty/src/features/viewport/scroll.ts:311

Parameters

touches

TouchList

canvasBounds

Bounds

Returns

Point


contextMenu()

contextMenu(target, event): (Action | Promise<Action>)[]

Defined in: packages/sprotty/src/base/views/mouse-tool.ts:206

Parameters

target

SModelElementImpl

event

MouseEvent

Returns

(Action | Promise<Action>)[]

Inherited from

MouseListener.contextMenu


decorate()

decorate(vnode, element): VNode

Defined in: packages/sprotty/src/base/views/mouse-tool.ts:218

Parameters

vnode

VNode

element

SModelElementImpl

Returns

VNode

Inherited from

MouseListener.decorate


doubleClick()

doubleClick(target, event): Action[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:79

Parameters

target

SModelElementImpl

event

MouseEvent

Returns

Action[]

Overrides

MouseListener.doubleClick


dragCanvas()

protected dragCanvas(model, event, lastScrollPosition): Action[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:201

Parameters

model

SModelRootImpl & Viewport

event

MouseEvent | Touch

lastScrollPosition

Point

Returns

Action[]


dragOver()

dragOver(target, event): (Action | Promise<Action>)[]

Defined in: packages/sprotty/src/base/views/mouse-tool.ts:210

Parameters

target

SModelElementImpl

event

MouseEvent

Returns

(Action | Promise<Action>)[]

Inherited from

MouseListener.dragOver


drop()

drop(target, event): (Action | Promise<Action>)[]

Defined in: packages/sprotty/src/base/views/mouse-tool.ts:214

Parameters

target

SModelElementImpl

event

MouseEvent

Returns

(Action | Promise<Action>)[]

Inherited from

MouseListener.drop


findClickTarget()

protected findClickTarget(scrollbar, event): undefined | HTMLElement

Defined in: packages/sprotty/src/features/viewport/scroll.ts:295

Parameters

scrollbar

HTMLElement

event

MouseEvent

Returns

undefined | HTMLElement


getScrollbar()

protected getScrollbar(event): undefined | HTMLElement

Defined in: packages/sprotty/src/features/viewport/scroll.ts:283

Parameters

event

MouseEvent | Touch

Returns

undefined | HTMLElement


getScrollbarOrientation()

protected getScrollbarOrientation(scrollbar): "horizontal" | "vertical"

Defined in: packages/sprotty/src/features/viewport/scroll.ts:287

Parameters

scrollbar

HTMLElement

Returns

"horizontal" | "vertical"


mouseDown()

mouseDown(target, event): (Action | Promise<Action>)[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:45

Parameters

target

SModelElementImpl

event

MouseEvent

Returns

(Action | Promise<Action>)[]

Overrides

MouseListener.mouseDown


mouseDownOrSingleTouchStart()

protected mouseDownOrSingleTouchStart(event, viewport): (Action | Promise<Action>)[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:128

Parameters

event

MouseEvent | Touch

viewport

SModelRootImpl & Viewport

Returns

(Action | Promise<Action>)[]


mouseEnter()

mouseEnter(target, event): Action[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:66

Parameters

target

SModelElementImpl

event

MouseEvent

Returns

Action[]

Overrides

MouseListener.mouseEnter


mouseLeave()

mouseLeave(target, event): (Action | Promise<Action>)[]

Defined in: packages/sprotty/src/base/views/mouse-tool.ts:182

Parameters

target

SModelElementImpl

event

MouseEvent

Returns

(Action | Promise<Action>)[]

Inherited from

MouseListener.mouseLeave


mouseMove()

mouseMove(target, event): Action[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:59

Parameters

target

SModelElementImpl

event

MouseEvent

Returns

Action[]

Overrides

MouseListener.mouseMove


mouseOrSingleTouchMove()

protected mouseOrSingleTouchMove(target, event): Action[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:141

Parameters

target

SModelElementImpl

event

MouseEvent | Touch

Returns

Action[]


mouseOut()

mouseOut(target, event): (Action | Promise<Action>)[]

Defined in: packages/sprotty/src/base/views/mouse-tool.ts:174

Parameters

target

SModelElementImpl

event

MouseEvent

Returns

(Action | Promise<Action>)[]

Inherited from

MouseListener.mouseOut


mouseOver()

mouseOver(target, event): (Action | Promise<Action>)[]

Defined in: packages/sprotty/src/base/views/mouse-tool.ts:170

Parameters

target

SModelElementImpl

event

MouseEvent

Returns

(Action | Promise<Action>)[]

Inherited from

MouseListener.mouseOver


mouseUp()

mouseUp(target, event): Action[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:73

Parameters

target

SModelElementImpl

event

MouseEvent

Returns

Action[]

Overrides

MouseListener.mouseUp


moveScrollBar()

protected moveScrollBar(model, event, scrollbar, animate): Action[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:226

Parameters

model

SModelRootImpl & Viewport

event

MouseEvent | Touch

scrollbar

HTMLElement

animate

boolean = false

Returns

Action[]


touchEnd()

touchEnd(target, event): Action[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:185

Parameters

target

SModelElementImpl

event

TouchEvent

Returns

Action[]

Implementation of

ITouchListener.touchEnd


touchMove()

touchMove(target, event): Action[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:117

Parameters

target

SModelElementImpl

event

TouchEvent

Returns

Action[]

Implementation of

ITouchListener.touchMove


touchStart()

touchStart(target, event): (Action | Promise<Action>)[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:100

Parameters

target

SModelElementImpl

event

TouchEvent

Returns

(Action | Promise<Action>)[]

Implementation of

ITouchListener.touchStart


twoTouchMove()

protected twoTouchMove(target, touches): Action[]

Defined in: packages/sprotty/src/features/viewport/scroll.ts:158

Parameters

target

SModelElementImpl

touches

TouchList

Returns

Action[]


wheel()

wheel(target, event): (Action | Promise<Action>)[]

Defined in: packages/sprotty/src/base/views/mouse-tool.ts:198

Parameters

target

SModelElementImpl

event

WheelEvent

Returns

(Action | Promise<Action>)[]

Inherited from

MouseListener.wheel