Add links to docs in all the samples (#10308)

chartjs · May 21, 2022 · 4183b7f · 4183b7f
1 parent 4eb65c0
commit 4183b7f
Show file tree

Hide file tree

Showing 75 changed files with 502 additions and 8 deletions.
diff --git a/docs/samples/advanced/data-decimation.md b/docs/samples/advanced/data-decimation.md
@@ -111,3 +111,8 @@ module.exports = {
   config: config,
 };
 ```
+## Docs
+* [Data Decimation](../../configuration/decimation.html)
+* [Line](../../charts/line.html)
+* [Time Scale](../../axes/cartesian/time.html)
+
diff --git a/docs/samples/advanced/derived-axis-type.md b/docs/samples/advanced/derived-axis-type.md
@@ -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)
diff --git a/docs/samples/advanced/derived-chart-type.md b/docs/samples/advanced/derived-chart-type.md
@@ -44,3 +44,7 @@ module.exports = {
 ## DerivedBubble Implementation
 
 <<< @/docs/scripts/derived-bubble.js
+
+## Docs
+* [Bubble Chart](../../charts/bubble.html)
+* [New Charts](../../developers/charts.html)
diff --git a/docs/samples/advanced/linear-gradient.md b/docs/samples/advanced/linear-gradient.md
@@ -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)
diff --git a/docs/samples/advanced/programmatic-events.md b/docs/samples/advanced/programmatic-events.md
@@ -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)
diff --git a/docs/samples/advanced/progress-bar.md b/docs/samples/advanced/progress-bar.md
@@ -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)
diff --git a/docs/samples/advanced/radial-gradient.md b/docs/samples/advanced/radial-gradient.md
@@ -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)
diff --git a/docs/samples/animations/delay.md b/docs/samples/animations/delay.md
@@ -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)
diff --git a/docs/samples/animations/drop.md b/docs/samples/animations/drop.md
@@ -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)
diff --git a/docs/samples/animations/loop.md b/docs/samples/animations/loop.md
@@ -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)
diff --git a/docs/samples/animations/progressive-line-easing.md b/docs/samples/animations/progressive-line-easing.md
@@ -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)
diff --git a/docs/samples/animations/progressive-line.md b/docs/samples/animations/progressive-line.md
@@ -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)
diff --git a/docs/samples/area/line-boundaries.md b/docs/samples/area/line-boundaries.md
@@ -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)
diff --git a/docs/samples/area/line-datasets.md b/docs/samples/area/line-datasets.md
@@ -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)
diff --git a/docs/samples/area/line-drawtime.md b/docs/samples/area/line-drawtime.md
@@ -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)
diff --git a/docs/samples/area/line-stacked.md b/docs/samples/area/line-stacked.md
@@ -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)
diff --git a/docs/samples/area/radar.md b/docs/samples/area/radar.md
@@ -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)
diff --git a/docs/samples/bar/border-radius.md b/docs/samples/bar/border-radius.md
@@ -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)
diff --git a/docs/samples/bar/floating.md b/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 = [
@@ -67,3 +69,6 @@ module.exports = {
   config: config,
 };
 ```
+## Docs
+* [Bar](../../charts/bar.html)
+* [Data structures (`labels`)](../../general/data-structures.html)
diff --git a/docs/samples/bar/horizontal.md b/docs/samples/bar/horizontal.md
@@ -121,3 +121,8 @@ module.exports = {
   config: config,
 };
 ```
+
+## Docs
+* [Bar](../../charts/bar.html)
+  * [Horizontal Bar Chart](../../charts/bar.html#horizontal-bar-chart)
+
diff --git a/docs/samples/bar/stacked-groups.md b/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 = [
@@ -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)
+
diff --git a/docs/samples/bar/stacked.md b/docs/samples/bar/stacked.md
@@ -71,3 +71,7 @@ module.exports = {
   config: config,
 };
 ```
+## Docs
+* [Bar](../../charts/bar.html)
+  * [Stacked Bar Chart](../../charts/bar.html#stacked-bar-chart)
+
diff --git a/docs/samples/bar/vertical.md b/docs/samples/bar/vertical.md
@@ -113,3 +113,7 @@ module.exports = {
   config: config,
 };
 ```
+
+## Docs
+* [Bar](../../charts/bar.html)
+* [Data structures (`labels`)](../../general/data-structures.html)
diff --git a/docs/samples/legend/events.md b/docs/samples/legend/events.md
@@ -55,3 +55,9 @@ module.exports = {
   config
 };
 ```
+
+## Docs
+* [Doughnut and Pie Charts](../../charts/doughnut.html)
+* [Legend](../../configuration/legend.html)
+  * `onHover`
+  * `onLeave`
diff --git a/docs/samples/legend/html.md b/docs/samples/legend/html.md
@@ -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)  
diff --git a/docs/samples/legend/point-style.md b/docs/samples/legend/point-style.md
@@ -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)
diff --git a/docs/samples/legend/position.md b/docs/samples/legend/position.md
@@ -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)
diff --git a/docs/samples/legend/title.md b/docs/samples/legend/title.md
@@ -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)
diff --git a/docs/samples/line/interpolation.md b/docs/samples/line/interpolation.md
@@ -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)
+
diff --git a/docs/samples/line/line.md b/docs/samples/line/line.md
@@ -112,3 +112,7 @@ module.exports = {
   config: config,
 };
 ```
+
+## Docs
+* [Line](../../charts/line.html)
+* [Data structures (`labels`)](../../general/data-structures.html)
diff --git a/docs/samples/line/multi-axis.md b/docs/samples/line/multi-axis.md
@@ -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)
+
diff --git a/docs/samples/line/point-styling.md b/docs/samples/line/point-styling.md
@@ -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)