@univerjs/engine-render v0.5.0-beta.1 • Docs

Class: ScrollTimer

Constructors

new ScrollTimer()

new ScrollTimer(
   _scene, 
   _scrollTimerType, 
   _thresholdAutoMove): ScrollTimer

Parameters

Parameter	Type	Default value
`_scene`	`Scene`	`undefined`
`_scrollTimerType`	`ScrollTimerType`	`ScrollTimerType.ALL`
`_thresholdAutoMove`	`IPaddingData`	`THRESHOLD_TO_AUTO_MOVE`

Returns

ScrollTimer

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scroll-timer.ts:47

Accessors

offsetX

Get Signature

get offsetX(): number

Returns

number

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scroll-timer.ts:59

offsetY

Get Signature

get offsetY(): number

Returns

number

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scroll-timer.ts:63

scrollTimerType

Get Signature

get scrollTimerType(): ScrollTimerType

Returns

ScrollTimerType

Set Signature

set scrollTimerType(type): void

Parameters

Parameter	Type
`type`	`ScrollTimerType`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scroll-timer.ts:71

Methods

dispose()

dispose(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scroll-timer.ts:162

getActiveViewport()

getActiveViewport(): any

Returns

any

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scroll-timer.ts:79

getScene()

getScene(): Scene

Returns

Scene

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scroll-timer.ts:167

scrolling()

scrolling(
   offsetX, 
   offsetY, 
   scrollFunction): void

Parameters

Parameter	Type
`offsetX`	`number`
`offsetY`	`number`
`scrollFunction`	(`x`?, `y`?) => `void`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scroll-timer.ts:152

setActiveViewport()

setActiveViewport(viewport): void

Parameters

Parameter	Type
`viewport`	`Viewport`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scroll-timer.ts:75

startScroll()

startScroll(
   offsetX, 
   offsetY, 
   targetViewport?): void

Parameters

Parameter	Type
`offsetX`	`number`
`offsetY`	`number`
`targetViewport`?	`any`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scroll-timer.ts:83

stopScroll()

stopScroll(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scroll-timer.ts:158

create()

static create(
   scene, 
   scrollTimerType, 
   padding?): ScrollTimer

Parameters

Parameter	Type	Default value
`scene`	`Scene`	`undefined`
`scrollTimerType`	`ScrollTimerType`	`ScrollTimerType.ALL`
`padding`?	`IPaddingData`	`undefined`

Returns

ScrollTimer

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scroll-timer.ts:55

Scrollbar Shape