Autoscroll functions
Properties:
| Name | Type | Description |
|---|---|---|
speed |
integer | Current scroll speed |
reversed |
boolean | Current scroll direction |
scrolling |
boolean | Currently animating |
paused |
boolean | Currently paused |
Requires
Methods
faster(multiplier) → {number}
Speed up scrolling
Parameters:
| Name | Type | Description |
|---|---|---|
multiplier |
Number | Multiple by which to increase speed |
Returns:
new speed
- Type
- number
Example
Marked.autoscroll.faster()init() → {object}
Initialize and set up DOM objects for autoscroll
Returns:
Autoscroll object
- Type
- object
Example
Marked.autoscroll.init()pause()
Toggle pause
Example
Marked.autoscroll.pause()reverse()
Toggle reverse scroll
Example
Marked.autoscroll.reverse()setSpeed(scrollSpeed) → {boolean|number}
Slow down scrolling
Parameters:
| Name | Type | Description |
|---|---|---|
scrollSpeed |
Number | to set between 1 and 25 |
Returns:
new speed
- Type
- boolean | number
Example
Marked.autoscroll.setSpeed()slower(multiplier) → {number}
Slow down scrolling
Parameters:
| Name | Type | Description |
|---|---|---|
multiplier |
Number | Multiple by which to decrease speed |
Returns:
new speed
- Type
- number
Example
Marked.autoscroll.slower()start(scrollSpeed) → {boolean}
Start Scrolling
Parameters:
| Name | Type | Description |
|---|---|---|
scrollSpeed |
number | The speed at which to scroll |
Returns:
success result
- Type
- boolean
Example
Marked.autoscroll.start()stop(pause)
Stop scrolling
Parameters:
| Name | Type | Description |
|---|---|---|
pause |
Boolean | Pause instead of stop if true |
Example
Marked.autoscroll.stop()toggle(force) → {boolean}
Toggle scrolling, clear timer If scroll is at a boundary when called, toggle "scrollstuck" and reverse direction if "scrollstuck" is already set
Parameters:
| Name | Type | Description |
|---|---|---|
force |
boolean | Skip checking for boundaries, force toggle |
Returns:
success result
- Type
- boolean
Example
Marked.autoscroll.toggle()