3D Attributes Animations and Visualization Transitions Area Graphs Aspect Ratio, Space and Width Axis Bar Graphs Bin Plots Bins Boxplot Graphs Bubble Graphs Bullet Graphs Chord Graphs Circular Graph Arc Sectors Circular Graph Connections Circular Graph Tracks Circular Graphs Citations or References Clustering Colors Combination Plot Strips 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 General One Dimensional Graphs 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 Data Type Plot Mode Plot Performance Plot View Plot and Panel Areas Print Quantile Regression Plots R R-Axis Random Ranges Regression Remote Procedures Ridgeline Plots Samples Sankey Diagrams Scatter Plot Matrix Scatter Plots Shadows Shapes Sizes Stream Plots Swimmer Graphs Tag Cloud Text Text Placement Titles and Subtitles Tooltip Transparency Tree Bracket Treemap Graphs Trees UpSet Plots Variables Venn Diagrams Violin Plots Visium Plots Waterfall Graphs X-Axis Y-Axis Z-Axis Zooming, Panning and Resizing cxplot

Clustering : Parameters used in clustering

# clusterAxis
Axis to use when clustering data
Type: string
Default: samples
Options: samples, variables
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Dumbbell, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine, Tree, Treemap

# clusteringDistance
Distance metric to use when clustering data
Type: string
Default: euclidianDistance
Options: euclidianDistance, manhattanDistance, maxDistance
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Dumbbell, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine, Tree, Treemap

clusteringDistance : "euclidianDistance"

clusteringDistance : "manhattanDistance"

clusteringDistance : "maxDistance"


# imputeMethod
Imputation method for missing data when clustering
Type: string
Default: mean
Options: mean, median
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Dumbbell, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine, Tree, Treemap

# kmeansSmpClusters
Number of clusters when clustering sample data with kmeans
Type: integer
Default: 3
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Dumbbell, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine, Tree, Treemap

kmeansSmpClusters : 2

kmeansSmpClusters : 3

kmeansSmpClusters : 4


# kmeansVarClusters
Number of clusters when clustering variable data with kmeans
Type: integer
Default: 3
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Dumbbell, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine, Tree, Treemap

kmeansVarClusters : 2

kmeansVarClusters : 3

kmeansVarClusters : 4


# linkage
Linkage type to use when clustering data
Type: string
Default: complete
Options: single, complete, average
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Dumbbell, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine, Tree, Treemap

linkage : "single"

linkage : "complete"

linkage : "average"


# maxIterations
Number of maximum iterations when clustering data with kmeans for one dimensional graphs or maximum number of iterations when calculating force direct layout networks
Type: integer
Default: 500
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Dumbbell, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine, Tree, Treemap

# samplesClustered
Flag to cluster samples
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Dumbbell, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine, Tree, Treemap

samplesClustered : true

samplesClustered : false


# samplesKmeaned
Flag to k-mean samples
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Dumbbell, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine, Tree, Treemap

samplesKmeaned : true

samplesKmeaned : false


# variablesClustered
Flag to cluster variables
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Dumbbell, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine, Tree, Treemap

variablesClustered : true

variablesClustered : false


# variablesKmeaned
Flag to k-mean variables
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Dumbbell, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine, Tree, Treemap

variablesKmeaned : true

variablesKmeaned : false


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
⇧