Class: ScrollTimer

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

Constructors

new ScrollTimer()

new ScrollTimer(
   _scene, 
   _scrollTimerType, 
   _thresholdAutoMove): ScrollTimer

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

Parameters

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

Returns

ScrollTimer

Accessors

offsetX

Get Signature

get offsetX(): number

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

Returns

number

offsetY

Get Signature

get offsetY(): number

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

Returns

number

scrollTimerType

Get Signature

get scrollTimerType(): ScrollTimerType

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

Returns

ScrollTimerType

Set Signature

set scrollTimerType(type): void

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

Parameters

Parameter	Type
`type`	`ScrollTimerType`

Returns

void

Methods

dispose()

dispose(): void

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

Returns

void

getActiveViewport()

getActiveViewport(): any

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

Returns

any

getScene()

getScene(): Scene

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

Returns

Scene

scrolling()

scrolling(
   offsetX, 
   offsetY, 
   scrollFunction): void

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

Parameters

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

Returns

void

setActiveViewport()

setActiveViewport(viewport): void

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

Parameters

Parameter	Type
`viewport`	`Viewport`

Returns

void

startScroll()

startScroll(
   offsetX, 
   offsetY, 
   targetViewport?): void

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

Parameters

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

Returns

void

stopScroll()

stopScroll(): void

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

Returns

void

create()

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

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

Parameters

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

Returns

ScrollTimer

Scrollbar Shape