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 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 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 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 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 Venn Diagrams Violin Plots Visium Plots Waterfall Graphs Workflow Charts X-Axis Y-Axis Z-Axis Zooming, Panning and Resizing cxplot

Data Filters : Parameters associated with filtering

# aggregations
Flexible aggregation (Tableau-style materialized group-by). Each entry is { by:[annotation names], defaultFn, overrides:{ variable: fn }, sep? } where fn is mean | median | sum | min | max | sd | count | first. Collapses the samples by the grouping annotation(s) so the distinct group keys become the new samples, each variable reduced per group. Applied at load AFTER calculatedFields; serialized so it persists and reproduces
Type: array
Default: []
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# calculatedFields
Formula-derived columns (Tableau-style calculated fields). Each entry is { name, target, formula } where target is variable | sampleAnnotation | variableAnnotation and formula is a safe expression over existing fields (e.g. log2(A/B), (V1 - mean(V1)) / sd(V1)). Materialized into data.y/x/z at load; serialized so they persist and reproduce
Type: array
Default: []
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

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

# dataFilterBorderColor
Color for the Border color for the data filter panel
Type: color
Default: #087ad1
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# dataFilterFontSize
Font size for the data filter panel
Type: string
Default: 12px
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# dataFilterHoverColor
Color for the Hover highlight color for the data filter panel
Type: color
Default: rgba(124, 182, 226, 0.2)
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# dataFilterMaxItems
Maximum number of items in the data filter before it becomes a scroll box
Type: integer
Default: 12
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# dataFilterTextColor
Color for the Text color for the data filter panel
Type: color
Default: #555b62
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

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

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

# filterData
Array of arrays with filtering functions. Each function takes four parameters. The fisrt parameter is the type of filter. This could either of: var, smp, series, meta, x, y, z, data, network or guess (if not known). The second parameter is the key that usually correspond to a sample or variable factor name in the x or z object of the data. The third parameter is the operator to use which is one of: >, >=, <, <=, between, exact, like or not like and the four parameter is an array with the value or values that are needed for the corresponding evaluation. Here are some examples: [ x, class, exact, [ A ] ], [ guess, dose, between, [ 0.5, 2 ] ]
Type: array
Default: []
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# filterDataBy
Filter data by their value in the data object used in oncoprints. Used in the CanvasXpress UIs
Type: filter
Default: {}
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# filterEdgeBy
Filter edges by their properties used in network graphs. Used in the CanvasXpress UIs
Type: filter
Default: {}
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# filterFeatureBy
Filter features by their properties used in genome browser. Used in the CanvasXpress UIs
Type: filter
Default: {}
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# filterMode
Mode for the legend filters. Can be set to hide the data using transparency or to color the data points with the missingDataColor
Type: string
Default: hide
Options: hide, color
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# filterNodeBy
Filter nodes by their properties used in network graphs. Used in the CanvasXpress UIs
Type: filter
Default: {}
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# filterSkipNullKeys
Flag to bypass filtering when a key is non existent in the data objects
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# filterSkipNullValues
Flag to bypass filtering when a value is null
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# filterSmpBy
Filter samples by their annotation included in the data.x object used in one dimensional plots. Used in the CanvasXpress UIs
Type: filter
Default: {}
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# filterType
Type for the filter. Can be and or or
Type: string
Default: and
Options: and, or
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# filterVarBy
Filter variables by their annotation included in the data.z object used in one dimensional plots. Used in the CanvasXpress UIs
Type: filter
Default: {}
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# shelfStates
Saved named authoring states from the Shelves customizer section. Each entry is { name, config } where config is a snapshot of the authoring keys (graphType, colorBy/sizeBy/shapeBy/patternBy, segregate/grouping, filterData, calculatedFields, aggregations). Saved from the Shelves toolbar and re-applied (via updateConfig) from its dropdown; serialized so they persist and reproduce
Type: array
Default: []
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

# toggleSwitchBackgroundColor
Color for the toggle switch in the data filters
Type: color
Default: rgb(8, 122, 209)
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, 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
⇧