Interface: EdgeScrollOptions
Defined in: plugins/scroll-options/src/ScrollBlockDragger.ts:15
Properties index
| Property | Description |
|---|---|
| fastBlockSpeed | Pixels per ms to scroll when the block is far past the edge of the workspace. |
| fastBlockStartDistance | Same as above, for fast speed. Must be larger than slowBlockStartDistance. |
| fastMouseSpeed | Pixels per ms to scroll when the mouse is far past the edge of the workspace. |
| fastMouseStartDistance | Same as above, for fast speed. Must be larger than slowMouseStartDistance. |
| oversizeBlockMargin | Cursor margin to use for oversized blocks. A bigger value will cause the workspace to scroll sooner, i.e., the mouse can be further inward from the edge when scrolling begins. |
| oversizeBlockThreshold | If a block takes up this percentage of the viewport or more, it will be considered oversized. Rather than using the block edge, we use the mouse cursor plus the given margin size to activate block-based scrolling. |
| slowBlockSpeed | Pixels per ms to scroll when the block is near the edge of the workspace. |
| slowBlockStartDistance | Distance in workspace units that the edge of the block is from the edge of the viewport before the corresponding scroll speed will be used. Can be negative to start scrolling before the block extends over the edge. |
| slowMouseSpeed | Pixels per ms to scroll when the mouse is near the edge of the workspace. |
| slowMouseStartDistance | Distance in workspace units that the mouse is from the edge of the viewport before the corresponding scroll speed will be used. Can be negative to start scrolling before the mouse extends over the edge. |
Properties
fastBlockSpeed
fastBlockSpeed: number;
Defined in: plugins/scroll-options/src/ScrollBlockDragger.ts:22
Pixels per ms to scroll when the block is far past the edge of the workspace.
fastBlockStartDistance
fastBlockStartDistance: number;
Defined in: plugins/scroll-options/src/ScrollBlockDragger.ts:34
Same as above, for fast speed.
Must be larger than slowBlockStartDistance.
fastMouseSpeed
fastMouseSpeed: number;
Defined in: plugins/scroll-options/src/ScrollBlockDragger.ts:57
Pixels per ms to scroll when the mouse is far past the edge of the workspace.
fastMouseStartDistance
fastMouseStartDistance: number;
Defined in: plugins/scroll-options/src/ScrollBlockDragger.ts:69
Same as above, for fast speed.
Must be larger than slowMouseStartDistance.
oversizeBlockMargin
oversizeBlockMargin: number;
Defined in: plugins/scroll-options/src/ScrollBlockDragger.ts:47
Cursor margin to use for oversized blocks. A bigger value will cause the workspace to scroll sooner, i.e., the mouse can be further inward from the edge when scrolling begins.
oversizeBlockThreshold
oversizeBlockThreshold: number;
Defined in: plugins/scroll-options/src/ScrollBlockDragger.ts:41
If a block takes up this percentage of the viewport or more, it will be considered oversized. Rather than using the block edge, we use the mouse cursor plus the given margin size to activate block-based scrolling.
slowBlockSpeed
slowBlockSpeed: number;
Defined in: plugins/scroll-options/src/ScrollBlockDragger.ts:17
Pixels per ms to scroll when the block is near the edge of the workspace.
slowBlockStartDistance
slowBlockStartDistance: number;
Defined in: plugins/scroll-options/src/ScrollBlockDragger.ts:29
Distance in workspace units that the edge of the block is from the edge of the viewport before the corresponding scroll speed will be used. Can be negative to start scrolling before the block extends over the edge.
slowMouseSpeed
slowMouseSpeed: number;
Defined in: plugins/scroll-options/src/ScrollBlockDragger.ts:52
Pixels per ms to scroll when the mouse is near the edge of the workspace.
slowMouseStartDistance
slowMouseStartDistance: number;
Defined in: plugins/scroll-options/src/ScrollBlockDragger.ts:64
Distance in workspace units that the mouse is from the edge of the viewport before the corresponding scroll speed will be used. Can be negative to start scrolling before the mouse extends over the edge.