Skip to content

Adds drag effect options to the documentation #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kurkle merged 3 commits into from
May 6, 2021
Merged

Adds drag effect options to the documentation #497

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42407a1
Adds drag effect options to the documentation
stockiNail May 6, 2021
a574b71
Fixes the object type separator
stockiNail May 6, 2021
472977d
Changes the MD header
stockiNail May 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/guide/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,21 @@ const chart = new Chart('id', {
| Name | Type | Default | Description
| ---- | ---- | ------- | ----------
| `enabled` | `boolean` | `false` | Enable zooming
| `drag` | `boolean` | `undefined` | Enable drag-to-zoom behavior (disables zooming by wheel)
| `drag` | `boolean`\|[`DragEffectOptions`](#drag-effect-options) | `undefined` | Enable drag-to-zoom behavior (disables zooming by wheel)
| `mode` | `'x'`\|`'y'`\|`'xy'` | `'xy'` | Allowed zoom directions
| `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
| `speed` | `number` | `0.1` | Factor of zoom speed via mouse wheel.
| `threshold` | `number` | `0` | Mimimal zoom distance required before actually applying zoom
| `wheelModifierKey` | `'ctrl'`\|`'alt'`\|`'shift'`\|`'meta'` | `null` | Modifier key required for zooming with mouse

#### Drag effect options

| Name | Type | Description
| ---- | -----| -----------
| `backgroundColor` | `Color` | Fill color
| `borderColor` | `Color` | Stroke color
| `borderWidth` | `number` | Stroke width

### Zoom Events

| Name | Arguments | Description
Expand Down