Skip to content

feat(sankey): add sortNodes to Sankey documentation #500

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

Open
konewka17 wants to merge 1 commit into
base: master
Choose a base branch
from
+11 −1
Open

feat(sankey): add sortNodes to Sankey documentation #500

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion en/option/series/sankey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,17 @@ Note when [orient](~series-sankey.orient) is `vertical`, `nodeAlign` controls ve

<ExampleUIControlNumber default="32" min="0" max="100" step="1" />

The iterations of layout, which is used to iteratively optimize the position of the nodes and edges in the Sankey diagram to reduce the overlapping between nodes and edges. The default value is `32`. If you want the order of the nodes in the chart to be the same with the order in the original [data](~series-sankey.data), you can set the value to be `0`.
The iterations of layout, which is used to iteratively optimize the position of the nodes and edges in the Sankey diagram to reduce the overlapping between nodes and edges. The default value is `32`.

If you want to preserve the original order of nodes within each depth level while still using layout optimization, consider using [sortNodes](~series-sankey.sortNodes) instead of setting this value to `0`.

## sortNodes(boolean) = true

<ExampleUIControlBoolean default="true" />

Whether to sort nodes within each depth level during layout collision resolution.

By default, nodes are automatically sorted based on their computed position to reduce edge crossings and improve layout readability. If set to `false`, the original order of nodes defined in [data](~series-sankey.data) is preserved within each depth level, while the layout algorithm still performs the other layout optimization.

## orient(string) = 'horizontal'

Expand Down