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

Samples : Properties associated with samples

# highlightSmp
Name of samples to highlight
Type: array
Default: []
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# maxSmpStringLen
Maximum length in characters a sample label or description can have so anything above is truncated
Type: integer
Default: 25
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# showSampleNames
Flag to show/hide the sample names
Type: boolean
Default: true
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpHighlightColor
Color for the higlighted samples
Type: color
Default: rgb(255,0,0)
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpLabelAutoAlignPosition
Flag to use best position for sample labels depending on the location of them. It will align them right when placed in the left of the graphs and viceversa
Type: boolean
Default: true
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpLabelImage
Flag to use images as sample labels when possible
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpLabelImageRound
Flag to use round images as sample labels
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpLabelInterval
Interval for the sample labels in one dimensional and circular plots
Type: integer
Default: 1
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTextAlign
Alignment (or position) for the sample labels
Type: string
Default: right
Options: left, center, right
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTextBaseline
Baseline (or reference line) for the sample labels
Type: string
Default: middle
Options: top, middle, bottom
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTextColor
Color for the text in sample labels
Type: color
Default: rgb(0,0,0)
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTextFontSize
Font size for the text in sample 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 smpTextScaleFontFactor
Type: integer
Default: 11
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTextFontStyle
Font style for the sample labels
Type: string
Default:
Options: , bold, italic, bold italic
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTextMargin
Margin to pad or separate the characters in the sample labels
Type: float
Default: 5
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTextRotate
Rotation in degrees for the sample labels
Type: integer
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTextScaleFontFactor
Scaling factor used to increase or decrease the sample labels font size in the canvas
Type: float
Default: 1
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTitle
Title for the sample axis in one dimensional plots
Type: string
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTitleAlign
Alignment (or position) for the sample title
Type: string
Default: center
Options: left, center, right
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTitleBaseline
Baseline (or reference line) for the sample title
Type: string
Default: middle
Options: top, middle, bottom
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTitleColor
Color for the text in sample title
Type: color
Default: rgb(0,0,0)
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTitleFontSize
Font size for the text in sample title. 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 smpTitleScaleFontFactor
Type: integer
Default: 11
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTitleFontStyle
Font style for the sample title
Type: string
Default:
Options: , bold, italic, bold italic
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTitleMargin
Margin to pad or separate the characters in the sample title
Type: float
Default: 5
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTitleRotate
Rotation in degrees for the sample title
Type: integer
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# smpTitleScaleFontFactor
Scaling factor used to increase or decrease the sample title font size in the canvas
Type: float
Default: 1
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

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
⇧