3D Attributes Animations and Visualization Transitions Area Graphs Aspect Ratio, Space and Width Axis Bar Graphs Bin Plots Boxplot Graphs Bubble Graphs Bullet Graphs Chord Graphs Circular Graph Arc Sectors Circular Graph Connections Circular Graph Tracks Circular Graphs Citations or References Clustering Clustree Plots Colors Combination Plot Strips Combination Plots Confidence Intervals Context Menu 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 Time Series Data Transformation Data UI Widgets Debug Decorations Dendrograms Density Plots Dotplot Graphs Dumbbell Graphs Error Bars Events Fish Graphs Fit Lines Forecast 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 Orthographic Maps Tiles Marginal Text Margins Meter Graphs Missing Data Network Algorithm Parameters Network Cola Algorithm Parameters Network Communities Network Graphs Network Node and Edge Attributes Oncoprint Graphs OptionsWall Charts 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 Ridgeline Plots Samples Sankey Diagrams Scatter Plot Matrix Scatter Plots Scrollbar 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 Vector Field Plots Venn Diagrams Violin Plots Visium Plots Waterfall Graphs Workflow Charts X-Axis Y-Axis Z-Axis Zooming, Panning and Resizing cxplot

Data : Data related parameters

# appendNetworkData
Array containing additional data files to append to networks. Useful for loading KEGG and Wikipatways to decorate the nodes and the edges
Type: array
Default: []
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Map, Meter, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

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

dataTextAlign : "left"

dataTextAlign : "center"

dataTextAlign : "right"


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

# dataTextColor
Color for the text in data labels
Type: color
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Map, Meter, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

dataTextColor : "#9e0adb"

dataTextColor : "#ff7d00"


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

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

dataTextFontStyle : ""

dataTextFontStyle : "bold"

dataTextFontStyle : "bold italic"


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

dataTextMargin : 5

dataTextMargin : 15


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

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

dataTextScaleFontFactor : 0.5

dataTextScaleFontFactor : 1

dataTextScaleFontFactor : 1.5


# drillBreadcrumb
Flag to show the drill-down breadcrumb strip in the viewport when a drillHierarchy is active and the chart has been drilled. Set false for API-only drill control
Type: boolean
Default: true
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Map, Meter, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# drillHierarchy
An array of sample annotation names, coarse to fine (e.g. ["Region","State","City"]), defining a drill-down hierarchy. When set, clicking a mark filters to the clicked level value and regroups by the next finer annotation; a breadcrumb walks back. Each entry must be a category in the data.x object
Type: array
Default: []
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Map, Meter, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# groupingFactorLevelsOrder
Object to specify custom order for the levels in each grouping. The key of the object is the name of a valid sample or variable annotation included in the data object. The value for element is an array with the levels for the corresponding factor
Type: object
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Map, Meter, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# groupingFactors
An array that holds the group names used for grouping the data. It must be a category in the data.x object
Type: array
Default: []
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Map, Meter, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# groupingFactorsLabelsHide
An array that holds the group names used for grouping the data to hide the labels in the graph. It must be a category in the data.x object
Type: array
Default: []
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Map, Meter, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# summaryType
Summary type for the data when grouping
Type: string
Default:
Options: False, iqr, median, mean, cor, min, max, count, sum
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Map, Meter, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

summaryType : "mean"

summaryType : "median"

summaryType : "iqr"

summaryType : "sum"


# transposeData
Flag to transpose data as a parameter. This parameter accomplishes the same as the function transpose at load time
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Map, Meter, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

transposeData : true

transposeData : false


# weightBy
Name of a sample annotation (data.x) or variable (data.y.vars) whose per-sample value weighs that sample in count-type summaries: Meter count/countTotal, the meterProgress ring (selected/total by weight) and pieBy slices. Default false weighs every sample 1, a plain count. The dual of grouping: it expands one sample into many without materializing them (R count(wt=), ggplot aes(weight=))
Type: string
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Map, Meter, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, 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 Learn Api Spec Quality Accessibility Updates Changelog
Company
Contact License Governance Support Regulated & GxP Admin
Information
Terms of Use Privacy policy References
⇧