Skip to content

Commit

Permalink
Merge branch 'master' into api-polish
Browse files Browse the repository at this point in the history
  • Loading branch information
kurkle authored Apr 30, 2021
2 parents 07aaeb1 + a1609d5 commit 8ece0c5
Show file tree
Hide file tree
Showing 23 changed files with 752 additions and 35 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ coverage/*

nbproject/*
dist/

# generated typedocs
docs/api
13 changes: 13 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,18 @@ module.exports = {
{base: '/samples', alternative: ['basic']},
],
}],
[
'vuepress-plugin-typedoc',
{
entryPoints: ['../../types/index.d.ts'],
hideInPageTOC: true,
tsconfig: '../../tsconfig.json',
sidebar: {
fullNames: true,
parentCategory: 'API',
},
},
],
],
chainWebpack: (config) => {
config.merge({
Expand Down Expand Up @@ -46,6 +58,7 @@ module.exports = {
nav: [
{text: 'Home', link: '/'},
{text: 'Guide', link: '/guide/'},
{text: 'API', link: '/api/'},
{text: 'Samples', link: `/samples/`},
{
text: 'Ecosystem',
Expand Down
1 change: 0 additions & 1 deletion docs/guide/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ const chart = new Chart('id', {
| `mode` | `'x'`\|`'y'`\|`'xy'` | `'xy'` | Allowed panning directions
| `modifierKey` | `'ctrl'`\|`'alt'`\|`'shift'`\|`'meta'` | `null` | Modifier key required for panning with mouse
| `overScaleMode` | `'x'`\|`'y'`\|`'xy'` | `undefined` | Which of the enabled panning directions should only be available when the mouse cursor is over a scale for that axis
| `speed` | `number` | `20` | Factor for pan velocity on **category scale**
| `threshold` | `number` | `10` | Mimimal pan distance required before actually applying pan

### Pan Events
Expand Down
Loading

0 comments on commit 8ece0c5

Please sign in to comment.