Skip to content

Commit a8521ec

Browse files
authored
Adds drag effect options to the documentation (#497)
* Adds drag effect options to the documentation * Fixes the object type separator * Changes the MD header
1 parent 46926ee commit a8521ec

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/guide/options.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,21 @@ const chart = new Chart('id', {
5454
| Name | Type | Default | Description
5555
| ---- | ---- | ------- | ----------
5656
| `enabled` | `boolean` | `false` | Enable zooming
57-
| `drag` | `boolean` | `undefined` | Enable drag-to-zoom behavior (disables zooming by wheel)
57+
| `drag` | `boolean`\|[`DragEffectOptions`](#drag-effect-options) | `undefined` | Enable drag-to-zoom behavior (disables zooming by wheel)
5858
| `mode` | `'x'`\|`'y'`\|`'xy'` | `'xy'` | Allowed zoom directions
5959
| `overScaleMode` | `'x'`\|`'y'`\|`'xy'` | `undefined` | Which of the enabled zooming directions should only be available when the mouse cursor is over a scale for that axis
6060
| `speed` | `number` | `0.1` | Factor of zoom speed via mouse wheel.
6161
| `threshold` | `number` | `0` | Mimimal zoom distance required before actually applying zoom
6262
| `wheelModifierKey` | `'ctrl'`\|`'alt'`\|`'shift'`\|`'meta'` | `null` | Modifier key required for zooming with mouse
6363

64+
#### Drag effect options
65+
66+
| Name | Type | Description
67+
| ---- | -----| -----------
68+
| `backgroundColor` | `Color` | Fill color
69+
| `borderColor` | `Color` | Stroke color
70+
| `borderWidth` | `number` | Stroke width
71+
6472
### Zoom Events
6573

6674
| Name | Arguments | Description

0 commit comments

Comments
 (0)