Merge pull request #1617 from ag-grid/AG-11687

AG-11687 Sankey, chord docs
ag-grid · May 24, 2024 · 2675e77 · 2675e77
2 parents ff22e73 + 2bdcdef
commit 2675e77
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 7 deletions.
diff --git a/packages/ag-charts-website/src/content/docs/chord-series/_examples/link-style/main.ts b/packages/ag-charts-website/src/content/docs/chord-series/_examples/link-style/main.ts
@@ -1,3 +1,4 @@
+// https://www.un.org/development/desa/pd/content/international-migrant-stock
 import { AgChartOptions, AgCharts } from 'ag-charts-enterprise';
 
 const options: AgChartOptions = {

diff --git a/packages/ag-charts-website/src/content/docs/chord-series/_examples/node-style/main.ts b/packages/ag-charts-website/src/content/docs/chord-series/_examples/node-style/main.ts
@@ -1,3 +1,4 @@
+// https://www.un.org/development/desa/pd/content/international-migrant-stock
 import { AgChartOptions, AgCharts } from 'ag-charts-enterprise';
 
 const options: AgChartOptions = {

diff --git a/packages/ag-charts-website/src/content/docs/chord-series/_examples/simple-chord/main.ts b/packages/ag-charts-website/src/content/docs/chord-series/_examples/simple-chord/main.ts
@@ -1,3 +1,4 @@
+// https://www.un.org/development/desa/pd/content/international-migrant-stock
 import { AgChartOptions, AgCharts } from 'ag-charts-enterprise';
 
 const options: AgChartOptions = {

diff --git a/packages/ag-charts-website/src/content/docs/chord-series/index.mdoc b/packages/ag-charts-website/src/content/docs/chord-series/index.mdoc
@@ -2,7 +2,7 @@
 title: 'Chord Series'
 ---
 
-A Chord Series visualises movement or change between different items, and the proportions between these movements or changes.
+A Chord Series visualises movement or change between different items, using nodes and links.
 
 ## Simple Chord
 
@@ -23,8 +23,8 @@ series: [
 
 In this configuration:
 
-- `fromKey` defines the start of each link.
-- `toKey` defines the end of each link.
+- `fromKey` defines the start node of each link.
+- `toKey` defines the end node of each link.
 - `sizeKey` defines the size of each link.
 
 ## Customisation

diff --git a/packages/ag-charts-website/src/content/docs/sankey-series/_examples/justification/main.ts b/packages/ag-charts-website/src/content/docs/sankey-series/_examples/justification/main.ts
@@ -1,3 +1,4 @@
+// Fictitious data used for demonstration purposes
 import { AgChartOptions, AgCharts, AgSankeySeriesOptions } from 'ag-charts-enterprise';
 
 const options: AgChartOptions = {

diff --git a/packages/ag-charts-website/src/content/docs/sankey-series/_examples/link-style/main.ts b/packages/ag-charts-website/src/content/docs/sankey-series/_examples/link-style/main.ts
@@ -1,3 +1,4 @@
+// Source: https://www.nationalgrideso.com/data-portal
 import { AgChartOptions, AgCharts } from 'ag-charts-enterprise';
 
 const options: AgChartOptions = {

diff --git a/packages/ag-charts-website/src/content/docs/sankey-series/_examples/node-style/main.ts b/packages/ag-charts-website/src/content/docs/sankey-series/_examples/node-style/main.ts
@@ -1,3 +1,4 @@
+// Source: https://www.nationalgrideso.com/data-portal
 import { AgChartOptions, AgCharts } from 'ag-charts-enterprise';
 
 const options: AgChartOptions = {

diff --git a/packages/ag-charts-website/src/content/docs/sankey-series/_examples/simple-sankey/main.ts b/packages/ag-charts-website/src/content/docs/sankey-series/_examples/simple-sankey/main.ts
@@ -1,3 +1,4 @@
+// Source: https://www.nationalgrideso.com/data-portal
 import { AgChartOptions, AgCharts } from 'ag-charts-enterprise';
 
 const options: AgChartOptions = {

diff --git a/packages/ag-charts-website/src/content/docs/sankey-series/index.mdoc b/packages/ag-charts-website/src/content/docs/sankey-series/index.mdoc
@@ -2,7 +2,7 @@
 title: 'Sankey Series'
 ---
 
-A Sankey Series visualises movement or change between different items, and the proportions between these movements or changes.
+A Sankey Series visualises movement or change between different items, using nodes and links.
 
 ## Simple Sankey
 
@@ -23,11 +23,13 @@ series: [
 
 In this configuration:
 
-- `fromKey` defines the start of each link.
-- `toKey` defines the end of each link.
+- `fromKey` defines the start node of each link.
+- `toKey` defines the end node of each link.
 - `sizeKey` defines the size of each link.
 
+{% warning %}
 Circular loops are not allowed in Sankey diagrams.
+{% /warning %}
 
 ## Justification
 

diff --git a/packages/ag-charts-website/src/content/gallery/data.json b/packages/ag-charts-website/src/content/gallery/data.json
@@ -683,7 +683,17 @@
  "title": "Chord Customisation",
  "description": "",
  "name": "chord-customisation"
- },
+ }
+ ]
+ }
+ ],
+ [
+ {
+ "title": "Sankey",
+ "seriesName": "sankey",
+ "icon": "chartsSankey",
+ "enterprise": true,
+ "examples": [
  {
  "title": "Sankey",
  "description": "",