Skip to content

Commit

Permalink
Add links to docs in all the samples (#10308)
Browse files Browse the repository at this point in the history
  • Loading branch information
linkviii committed May 21, 2022
1 parent 4eb65c0 commit 4183b7f
Show file tree
Hide file tree
Showing 75 changed files with 502 additions and 8 deletions.
5 changes: 5 additions & 0 deletions docs/samples/advanced/data-decimation.md
Expand Up @@ -111,3 +111,8 @@ module.exports = {
config: config,
};
```
## Docs
* [Data Decimation](../../configuration/decimation.html)
* [Line](../../charts/line.html)
* [Time Scale](../../axes/cartesian/time.html)

5 changes: 5 additions & 0 deletions docs/samples/advanced/derived-axis-type.md
Expand Up @@ -48,3 +48,8 @@ module.exports = {
## Log2 axis implementation

<<< @/docs/scripts/log2.js

## Docs
* [Data structures (`labels`)](../../general/data-structures.html)
* [Line](../../charts/line.html)
* [New Axes](../../developers/axes.html)
4 changes: 4 additions & 0 deletions docs/samples/advanced/derived-chart-type.md
Expand Up @@ -44,3 +44,7 @@ module.exports = {
## DerivedBubble Implementation

<<< @/docs/scripts/derived-bubble.js

## Docs
* [Bubble Chart](../../charts/bubble.html)
* [New Charts](../../developers/charts.html)
8 changes: 8 additions & 0 deletions docs/samples/advanced/linear-gradient.md
Expand Up @@ -108,3 +108,11 @@ module.exports = {
config: config,
};
```

## Docs
* [Colors](../../general/colors.html)
* [Patterns and Gradients](../../general/colors.html#patterns-and-gradients)
* [Data structures (`labels`)](../../general/data-structures.html)
* [Options](../../general/options.html)
* [Scriptable Options](../../general/options.html#scriptable-options)
* [Line](../../charts/line.html)
12 changes: 12 additions & 0 deletions docs/samples/advanced/programmatic-events.md
Expand Up @@ -101,3 +101,15 @@ module.exports = {
config: config,
};
```

## API
* [Chart](../../api/classes/Chart.md)
* [`setActiveElements`](../../api/classes/Chart.md#setactiveelements)
* [TooltipModel](../../api/interfaces/TooltipModel.html)
* [`setActiveElements`](../../api/interfaces/TooltipModel.html#setactiveelements)

## Docs
* [Bar](../../charts/bar.html)
* [Interactions (`hoverBorderColor`)](../../charts/bar.html#interactions)
* [Interactions](../../configuration/interactions.html)
* [Tooltip](../../configuration/tooltip.html)
8 changes: 8 additions & 0 deletions docs/samples/advanced/progress-bar.md
Expand Up @@ -142,3 +142,11 @@ module.exports = {
output: 'console.log output is displayed here'
};
```

## Docs
* [Animations](../../configuration/animations.html)
* [Animation Callbacks](../../configuration/animations.html#animation-callbacks)
* [Data structures (`labels`)](../../general/data-structures.html)
* [Line](../../charts/line.html)
* [Options](../../general/options.html)
* [Scriptable Options](../../general/options.html#scriptable-options)
6 changes: 6 additions & 0 deletions docs/samples/advanced/radial-gradient.md
Expand Up @@ -114,3 +114,9 @@ module.exports = {
config,
};
```

## Docs
* [Polar Area Chart](../../charts/polar.md)
* [Styling](../../charts/polar.md#styling)
* [Options](../../general/options.html)
* [Scriptable Options](../../general/options.html#scriptable-options)
8 changes: 8 additions & 0 deletions docs/samples/animations/delay.md
Expand Up @@ -77,3 +77,11 @@ module.exports = {
config: config,
};
```
## Docs
* [Animations](../../configuration/animations.html)
* [animation (`delay`)](../../configuration/animations.html#animation)
* [Animation Callbacks](../../configuration/animations.html#animation-callbacks)
* [Bar](../../charts/bar.html)
* [Stacked Bar Chart](../../charts/bar.html#stacked-bar-chart)
* [Options](../../general/options.html)
* [Scriptable Options](../../general/options.html#scriptable-options)
11 changes: 11 additions & 0 deletions docs/samples/animations/drop.md
Expand Up @@ -123,3 +123,14 @@ module.exports = {
config: config,
};
```
## Docs
* [Area](../../charts/area.html)
* [Animations](../../configuration/animations.html)
* [animation (`easing`)](../../configuration/animations.html#animation)
* [animations (`from`)](../../configuration/animations.html#animations-2)
* [Line](../../charts/line.html)
* [Line Styling](../../charts/line.html#line-styling)
* `fill`
* `tension`
* [Options](../../general/options.html)
* [Scriptable Options](../../general/options.html#scriptable-options)
16 changes: 16 additions & 0 deletions docs/samples/animations/loop.md
Expand Up @@ -123,3 +123,19 @@ module.exports = {
config: config,
};
```
## Docs
* [Animations](../../configuration/animations.html)
* [animation](../../configuration/animations.html#animation)
* `duration`
* `easing`
* **`loop`**
* [Default animations (`radius`)](../../configuration/animations.html#default-animations)
* [Data structures (`labels`)](../../general/data-structures.html)
* [Elements](../../configuration/elements.html)
* [Point Configuration](../../configuration/elements.html#point-configuration)
* `hoverRadius`
* `hoverBackgroundColor`
* [Line](../../charts/line.html)
* [Options](../../general/options.html)
* [Scriptable Options](../../general/options.html#scriptable-options)
* [Tooltip (`enabled`)](../../configuration/tooltip.html)
17 changes: 17 additions & 0 deletions docs/samples/animations/progressive-line-easing.md
Expand Up @@ -170,3 +170,20 @@ module.exports = {
};

```
## Api
* [Chart](../../api/classes/Chart.md)
* [`getDatasetMeta`](../../api/classes/Chart.md#getdatasetmeta)
* [Scale](../../api/classes/Scale.html)
* [`getPixelForValue`](../../api/classes/Scale.html#getpixelforvalue)
## Docs
* [Animations](../../configuration/animations.html)
* [animation](../../configuration/animations.html#animation)
* `delay`
* `duration`
* `easing`
* `loop`
* [Easing](../../configuration/animations.html#easing)
* [Line](../../charts/line.html)
* [Options](../../general/options.html)
* [Scriptable Options](../../general/options.html#scriptable-options)
* [Data Context](../../general/options.html#data)
17 changes: 17 additions & 0 deletions docs/samples/animations/progressive-line.md
Expand Up @@ -88,3 +88,20 @@ module.exports = {
};

```

## Api
* [Chart](../../api/classes/Chart.md)
* [`getDatasetMeta`](../../api/classes/Chart.md#getdatasetmeta)
* [Scale](../../api/classes/Scale.html)
* [`getPixelForValue`](../../api/classes/Scale.html#getpixelforvalue)
## Docs
* [Animations](../../configuration/animations.html)
* [animation](../../configuration/animations.html#animation)
* `delay`
* `duration`
* `easing`
* `loop`
* [Line](../../charts/line.html)
* [Options](../../general/options.html)
* [Scriptable Options](../../general/options.html#scriptable-options)
* [Data Context](../../general/options.html#data)
7 changes: 7 additions & 0 deletions docs/samples/area/line-boundaries.md
Expand Up @@ -118,3 +118,10 @@ module.exports = {
config: config,
};
```

## Docs
* [Area](../../charts/area.html)
* [Filling modes](../../charts/area.htmll#filling-modes)
* Boundary: `'start'`, `'end'`, `'origin'`
* [Line](../../charts/line.html)
* [Data structures (`labels`)](../../general/data-structures.html)
8 changes: 8 additions & 0 deletions docs/samples/area/line-datasets.md
Expand Up @@ -164,3 +164,11 @@ module.exports = {
```

<div id="chart-analyser" class="analyser"></div>

## Docs
* [Area](../../charts/area.html)
* [Filling modes](../../charts/area.htmll#filling-modes)
* [Line](../../charts/line.html)
* [Data structures (`labels`)](../../general/data-structures.html)
* [Axes scales](../../axes/)
* [Common options to all axes (`stacked`)](../../axes/#common-options-to-all-axes)
6 changes: 6 additions & 0 deletions docs/samples/area/line-drawtime.md
Expand Up @@ -113,3 +113,9 @@ module.exports = {
config: config,
};
```
## Docs
* [Area](../../charts/area.html)
* [Configuration (`drawTime`)](../../charts/area.html#configuration)
* [Line](../../charts/line.html)
* [Line Styling (`tension`)](../../charts/line.html#line-styling)
* [Data structures (`labels`)](../../general/data-structures.html)
8 changes: 8 additions & 0 deletions docs/samples/area/line-stacked.md
Expand Up @@ -170,3 +170,11 @@ module.exports = {
config: config
};
```

## Docs
* [Area](../../charts/area.html)
* [Filling modes](../../charts/area.htmll#filling-modes)
* [Line](../../charts/line.html)
* [Data structures (`labels`)](../../general/data-structures.html)
* [Axes scales](../../axes/)
* [Common options to all axes (`stacked`)](../../axes/#common-options-to-all-axes)
7 changes: 7 additions & 0 deletions docs/samples/area/radar.md
Expand Up @@ -139,3 +139,10 @@ module.exports = {
```

<div id="chart-analyser" class="analyser"></div>

## Docs
* [Area](../../charts/area.html)
* [Filling modes](../../charts/area.htmll#filling-modes)
* [`propagate`](../../charts/area.html#propagate)
* [Radar](../../charts/radar.html)
* [Data structures (`labels`)](../../general/data-structures.html)
5 changes: 5 additions & 0 deletions docs/samples/bar/border-radius.md
Expand Up @@ -69,3 +69,8 @@ module.exports = {
config: config,
};
```

## Docs
* [Bar](../../charts/bar.html)
* [`borderRadius`](../../charts/bar.html#borderradius)
* [Data structures (`labels`)](../../general/data-structures.html)
5 changes: 5 additions & 0 deletions docs/samples/bar/floating.md
@@ -1,5 +1,7 @@
# Floating Bars

Using `[number, number][]` as the type for `data` to define the beginning and end value for each bar. This is instead of having every bar start at 0.

```js chart-editor
// <block:actions:2>
const actions = [
Expand Down Expand Up @@ -67,3 +69,6 @@ module.exports = {
config: config,
};
```
## Docs
* [Bar](../../charts/bar.html)
* [Data structures (`labels`)](../../general/data-structures.html)
5 changes: 5 additions & 0 deletions docs/samples/bar/horizontal.md
Expand Up @@ -121,3 +121,8 @@ module.exports = {
config: config,
};
```

## Docs
* [Bar](../../charts/bar.html)
* [Horizontal Bar Chart](../../charts/bar.html#horizontal-bar-chart)

9 changes: 9 additions & 0 deletions docs/samples/bar/stacked-groups.md
@@ -1,5 +1,7 @@
# Stacked Bar Chart with Groups

Using the `stack` property to divide datasets into multiple stacks.

```js chart-editor
// <block:actions:2>
const actions = [
Expand Down Expand Up @@ -77,3 +79,10 @@ module.exports = {
config: config,
};
```

## Docs
* [Bar](../../charts/bar.html)
* [Stacked Bar Chart](../../charts/bar.html#stacked-bar-chart)
* [Data structures (`labels`)](../../general/data-structures.html)
* [Dataset Configuration (`stack`)](../../general/data-structures.html#dataset-configuration)

4 changes: 4 additions & 0 deletions docs/samples/bar/stacked.md
Expand Up @@ -71,3 +71,7 @@ module.exports = {
config: config,
};
```
## Docs
* [Bar](../../charts/bar.html)
* [Stacked Bar Chart](../../charts/bar.html#stacked-bar-chart)

4 changes: 4 additions & 0 deletions docs/samples/bar/vertical.md
Expand Up @@ -113,3 +113,7 @@ module.exports = {
config: config,
};
```

## Docs
* [Bar](../../charts/bar.html)
* [Data structures (`labels`)](../../general/data-structures.html)
6 changes: 6 additions & 0 deletions docs/samples/legend/events.md
Expand Up @@ -55,3 +55,9 @@ module.exports = {
config
};
```

## Docs
* [Doughnut and Pie Charts](../../charts/doughnut.html)
* [Legend](../../configuration/legend.html)
* `onHover`
* `onLeave`
7 changes: 7 additions & 0 deletions docs/samples/legend/html.md
Expand Up @@ -131,3 +131,10 @@ module.exports = {
config: config,
};
```

## Docs
* [Data structures (`labels`)](../../general/data-structures.html)
* [Line](../../charts/line.html)
* [Legend](../../configuration/legend.html)
* `display: false`
* [Plugins](../../developers/plugins.html)
12 changes: 11 additions & 1 deletion docs/samples/legend/point-style.md
Expand Up @@ -56,4 +56,14 @@ module.exports = {
actions: actions,
config: config,
};
```
```

## Docs
* [Data structures (`labels`)](../../general/data-structures.html)
* [Line](../../charts/line.html)
* [Legend](../../configuration/legend.html)
* [Legend Label Configuration](../../configuration/legend.html#legend-label-configuration)
* `usePointStyle`
* [Elements](../../configuration/elements.html)
* [Point Configuration](../../configuration/elements.html#point-configuration)
* [Point Styles](../../configuration/elements.html#point-styles)
8 changes: 7 additions & 1 deletion docs/samples/legend/position.md
Expand Up @@ -65,4 +65,10 @@ module.exports = {
actions: actions,
config: config,
};
```
```

## Docs
* [Data structures (`labels`)](../../general/data-structures.html)
* [Line](../../charts/line.html)
* [Legend](../../configuration/legend.html)
* [Position](../../configuration/legend.html#position)
7 changes: 6 additions & 1 deletion docs/samples/legend/title.md
Expand Up @@ -71,4 +71,9 @@ module.exports = {
actions: actions,
config: config,
};
```
```

## Docs
* [Data structures (`labels`)](../../general/data-structures.html)
* [Line](../../charts/line.html)
* [Legend](../../configuration/legend.html)
6 changes: 6 additions & 0 deletions docs/samples/line/interpolation.md
Expand Up @@ -75,3 +75,9 @@ module.exports = {
config: config,
};
```

## Docs
* [Line](../../charts/line.html)
* [`cubicInterpolationMode`](../../charts/line.html#cubicinterpolationmode)
* [Line Styling (`tension`)](../../charts/line.html#line-styling)

4 changes: 4 additions & 0 deletions docs/samples/line/line.md
Expand Up @@ -112,3 +112,7 @@ module.exports = {
config: config,
};
```

## Docs
* [Line](../../charts/line.html)
* [Data structures (`labels`)](../../general/data-structures.html)
8 changes: 8 additions & 0 deletions docs/samples/line/multi-axis.md
Expand Up @@ -84,3 +84,11 @@ module.exports = {
config: config,
};
```

## Docs
* [Axes scales](../../axes/)
* [Cartesian Axes](../../axes/cartesian/)
* [Axis Position](../../axes/cartesian/#axis-position)
* [Data structures (`labels`)](../../general/data-structures.html)
* [Line](../../charts/line.html)

5 changes: 5 additions & 0 deletions docs/samples/line/point-styling.md
Expand Up @@ -134,3 +134,8 @@ module.exports = {
config: config,
};
```

## Docs
* [Data structures (`labels`)](../../general/data-structures.html)
* [Line](../../charts/line.html)
* [Point Styling](../../charts/line.html#point-styling)

0 comments on commit 4183b7f

Please sign in to comment.