3D Attributes Animations and Visualization Transitions Area Graphs Aspect Ratio, Space and Width Axis Bar Graphs Bin Plots Bins Boxplot Graphs Bullet Graphs Circular Graphs Citations or References Clustering Colors Combination Plots Confidence Intervals Contours Correlation Graphs DOE Data Data Context Data Customizer Data Faceting Data Filters Data Point Attributes Data Ratio Reference Data Selection Data Sorting Data Table Data Table/Filter Data Time Series Data Transformation Data UI Widgets Debug Decorations Dendrograms Density Plots Dotplot Graphs Dumbbell Graphs Effect Error Bars Events Fish Graphs Fit Lines Foreground and Background Gantt Charts General General Attributes Genome Browser Genome Browser Features Genome Browser Sequences Genome Browser Tracks Gradients Graph Metadata Grey Out HTML Widgets Heatmap Color Indicators Heatmap Graphs Hierarchy Histograms Ideograms Images Kaplan Meier Plots LLM Legends Line Graphs Lines Loess Lollipop Graphs Manhattan Plots Maps Maps Albers Maps Leaflet Maps Orthographic Marginal Text Margins Meter Graphs Missing Data Motion Charts Network Algorithm Parameters Network Cola Algorithm Parameters Network Communities Network Graphs Network Node and Edge Attributes Oncoprint Graphs Overlays Parallel Coordinates Graphs Pie Charts Plot Area Plot and Panel Areas Print Quantile Regression Plots R R-Axis Random Regression Remote Procedures Ridgeline Plots Samples Sankey Diagrams Scatter Plot Matrix Scatter Plots Shadows Shapes Stream Plots Swimmer Graphs Tag Cloud Text Text Placement Titles and Subtitles Tooltip Transparency Treemap Graphs Trees UpSet Plots Variables Venn Diagrams Violin Plots Visium Plots X-Axis Y-Axis Z-Axis Zooming, Panning and Resizing cxplot

Sankey Diagrams : General parameters in sankey diagrams

# sankeyAxes
Axes to include in the alluvial plots. It must sample annotations of the string type in the x object
Type: array
Default: []
Used in: Sankey

# sankeyLinksColor
Color for the sankey lines (links)
Type: color
Default: rgba(150,150,150,0.5)
Used in: Sankey

# sankeyNodePadding
Padding between the Sankey nodes
Type: integer
Default: 8
Used in: Sankey

# sankeyNodeWidth
Width for the Sankey nodes
Type: integer
Default: 20
Used in: Sankey

# sankeyNodesColor
Color for the sankey nodes
Type: color
Default: false
Used in: Sankey

# sankeyOutlineColor
Color for the sankey outline
Type: color
Default: rgba(0,0,0,0)
Used in: Sankey

# sankeySource
Name of a sample annotation to use as source in the sankey diagrams
Type: string
Default:
Options: 0
Used in: Sankey

# sankeyTarget
Name of a sample annotation to use as target in the sankey diagrams
Type: string
Default:
Options: 0
Used in: Sankey

# sankeyTextAlign
Alignment (or position) for the sankey diagram labels
Type: string
Default: center
Options: left, center, right
Used in: Sankey

# sankeyTextAuto
Flag to adjust the text orientation and the visibility for the labels in the Sankey diagrams
Type: boolean
Default: true
Used in: Sankey

# sankeyTextBaseline
Baseline (or reference line) for the sankey diagram labels
Type: string
Default: middle
Options: top, middle, bottom
Used in: Sankey

# sankeyTextColor
Color for the text in sankey diagram labels
Type: color
Default: rgb(0,0,0)
Used in: Sankey

# sankeyTextFontSize
Font size for the text in sankey diagram labels. Be aware that auto scaling font must be turned off for this property to take effect. A more convenient way to modify the size is to use the sankeyTextScaleFontFactor
Type: integer
Default: 11
Used in: Sankey

# sankeyTextFontStyle
Font style for the sankey diagram labels
Type: string
Default:
Options: , bold, italic, bold italic
Used in: Sankey

# sankeyTextInside
Flag to draw the text of the sankey labels inside the plot. It is only applicable when sankeyTextAuto is false
Type: boolean
Default: true
Used in: Sankey

# sankeyTextMargin
Margin to pad or separate the characters in the sankey diagram labels
Type: float
Default:
Used in: Sankey

# sankeyTextRotate
Rotation in degrees for the sankey diagram labels
Type: integer
Default: 90
Used in: Sankey

# sankeyTextScaleFontFactor
Scaling factor used to increase or decrease the sankey diagram labels font size in the canvas
Type: float
Default: 1
Used in: Sankey

# sankeyTextShow
Flag to show/hide the labels in the Sankey diagrams
Type: boolean
Default: true
Used in: Sankey

# sankeyTitleAlign
Alignment (or position) for the sankey diagram titles
Type: string
Default: center
Options: left, center, right
Used in: Sankey

# sankeyTitleBaseline
Baseline (or reference line) for the sankey diagram titles
Type: string
Default: middle
Options: top, middle, bottom
Used in: Sankey

# sankeyTitleColor
Color for the text in sankey diagram titles
Type: color
Default: rgb(0,0,0)
Used in: Sankey

# sankeyTitleFontSize
Font size for the text in sankey diagram titles. Be aware that auto scaling font must be turned off for this property to take effect. A more convenient way to modify the size is to use the sankeyTitleScaleFontFactor
Type: integer
Default: 11
Used in: Sankey

# sankeyTitleFontStyle
Font style for the sankey diagram titles
Type: string
Default:
Options: , bold, italic, bold italic
Used in: Sankey

# sankeyTitleMargin
Margin to pad or separate the characters in the sankey diagram titles
Type: float
Default:
Used in: Sankey

# sankeyTitleRotate
Rotation in degrees for the sankey diagram titles
Type: integer
Default:
Used in: Sankey

# sankeyTitleScaleFontFactor
Scaling factor used to increase or decrease the sankey diagram titles font size in the canvas
Type: float
Default: 1
Used in: Sankey

# sankeyTitleShow
Flag to show/hide the titles in the Sankey diagrams
Type: boolean
Default: true
Used in: Sankey

CanvasXpress Logo

CanvasXpress a stand-alone JavaScript Library for Data Analytics. Built for the purpose of reproducible research with a sophisticated and unobtrusive user interface. Full and effortless audit trail of data, configuration and all user interactions in every visualization.

©2025 All Rights Reserved. CanvasXpress®

Documentation
Examples Docs Api Updates
Company
Contact License Admin
Information
Terms of Use Privacy policy References
⇧