@univerjs/engine-render v0.1.17 • Docs

Class: ScrollTimer

Constructors

new ScrollTimer()

new ScrollTimer(
   _scene, 
   _scrollTimerType, 
   _padding?, 
   _smoothRatioX?, 
   _smoothRatioY?): ScrollTimer

Parameters

Parameter	Type	Default value
`_scene`	`Scene`	`undefined`
`_scrollTimerType`	`ScrollTimerType`	`ScrollTimerType.ALL`
`_padding`?	`IPaddingData`	`undefined`
`_smoothRatioX`?	`number`	`0.4`
`_smoothRatioY`?	`number`	`0.1`

Returns

ScrollTimer

Defined in

submodules/univer/packages/engine-render/src/scroll-timer.ts:52 (opens in a new tab)

Accessors

scrollTimerType

get scrollTimerType(): ScrollTimerType

set scrollTimerType(type): void

Parameters

Parameter	Type
`type`	`ScrollTimerType`

Returns

ScrollTimerType

Defined in

submodules/univer/packages/engine-render/src/scroll-timer.ts:72 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/scroll-timer.ts:170 (opens in a new tab)

getActiveViewport()

getActiveViewport(): any

Returns

any

Defined in

submodules/univer/packages/engine-render/src/scroll-timer.ts:80 (opens in a new tab)

getScene()

getScene(): Scene

Returns

Scene

Defined in

submodules/univer/packages/engine-render/src/scroll-timer.ts:181 (opens in a new tab)

getViewportByCoord()

getViewportByCoord(scene?): undefined | Viewport

Parameters

Parameter	Type
`scene`?	`Scene`

Returns

undefined | Viewport

Defined in

submodules/univer/packages/engine-render/src/scroll-timer.ts:175 (opens in a new tab)

scrolling()

scrolling(
   offsetX, 
   offsetY, 
   scrollFunction): void

Parameters

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

Returns

void

Defined in

submodules/univer/packages/engine-render/src/scroll-timer.ts:160 (opens in a new tab)

setActiveViewport()

setActiveViewport(viewport): void

Parameters

Parameter	Type
`viewport`	`Viewport`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/scroll-timer.ts:76 (opens in a new tab)

startScroll()

startScroll(
   offsetX, 
   offsetY, 
   targetViewport?): void

Parameters

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

Returns

void

Defined in

submodules/univer/packages/engine-render/src/scroll-timer.ts:84 (opens in a new tab)

stopScroll()

stopScroll(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/scroll-timer.ts:166 (opens in a new tab)

create()

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

Parameters

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

Returns

ScrollTimer

Defined in

submodules/univer/packages/engine-render/src/scroll-timer.ts:64 (opens in a new tab)

Scrollbar Shape