Documentation Documentation Examples Examples API Reference API References
Getting Started
Overview Installation
API
3D Attributes Animations and Visualization Transitions Area Graphs Aspect Ratio, Space and width Axis Bar Graphs Bins Boxplot Graphs Circular Graphs Citations or References Clustering Colors Combination Plots Contours Correlation Graphs DOE Data Data Explorer Data Filters Data Point Attributes Data Selection: Parameters used to select data in all visualizations Data Table Data Table/Filter Data sorting Debug Decorations Dendrograms Density Plots Dotplot Graphs Effect Error Bars and Confidence Intervals Events Fish Graphs Fonts Foreground and Background Functions Gantt Charts General General Attributes Genome Browser Gradients Heatmap Graphs Hierarchy Histograms Images Legends Line Graphs Lines Loess Maps Margins Meter Graphs Missing Data Motion Charts Network Algorithm Parameters Network Communities Network Graphs Network Node and Edge Attributes Oncoprint Graphs Overlays Pie Charts Plot area QQ Plots R R-Axis Random Remote Procedures Ridgeline Plots Samples Sankey Diagrams Scatter Plot Matrix Scatter Plots Shadows Shapes Tag Cloud Text Time Series Titles and Subtitles Treemap Graphs Trees Variables Venn Diagrams X-Axis X-Axis2 Y-Axis Z-Axis Zooming, Panning and Resizing

Data Filters API

# dataFilterWidth

dataFilterWidth integer
Size in pixels for the data filters.
Default: 220
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# filterDataBy

filterDataBy filter
Filter data by their value in the 'data' object used in oncoprints. Used in the CanvasXpress UIs.
Default: {'cases':[],'comp':[],'op':[],'type':[],'value':[]}
Used in: Heatmap

# filterEdgeBy

filterEdgeBy filter
Filter edges by their properties used in network graphs. Used in the CanvasXpress UIs.
Default: {'cases':[],'comp':[],'op':[],'type':[],'value':[]}
Used in: Network

# filterFeatureBy

filterFeatureBy filter
Filter features by their properties used in genome browser. Used in the CanvasXpress UIs.
Default: {'cases':[],'comp':[],'op':[],'type':[],'value':[]}
Used in: Genome

# filterMode

filterMode option
Mode for the filter. Can be 'remove' to remove the data from the plot, 'hide' to hide the data similarily to legend filters (may be useful to adjustor transparencyHidden) or 'color' to color the data point with a set color (may be useful to adjust missingDataColor).
See also: missingDataColor, transparencyHidden
Default: remove
Options: remove, hide, color
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# filterNodeBy

filterNodeBy filter
Filter nodes by their properties used in network graphs. Used in the CanvasXpress UIs.
Default: {'cases':[],'comp':[],'op':[],'type':[],'value':[]}
Used in: Network

# filterSkipNullKeys

filterSkipNullKeys boolean
Flag to indicate to bypass filtering when a key is non existent in the data objects.
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# filterSkipNullValues

filterSkipNullValues boolean
Flag to indicate to bypass filtering when a value is null.
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# filterSmpBy

filterSmpBy filter
Filter samples by their annotation included in the 'data.x' object used in one dimensional plots. Used in the CanvasXpress UIs.
Default: {'cases':[],'comp':[],'op':[],'type':[],'value':[]}
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# filterType

filterType option
Type for the filter. Can be 'and' or 'or'.
Default: and
Options: and, or
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# filterVarBy

filterVarBy filter
Filter variables by their annotation included in the 'data.z' object used in one dimensional plots. Used in the CanvasXpress UIs.
Default: {'cases':[],'comp':[],'op':[],'type':[],'value':[]}
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# filtersExposed

filtersExposed array
Exposed filters after rendering the plot. Each element in the array is an object as follows: {name: [var or smp annotation|vars|smps], position: [topRight|topLeft|bottomRight|bottomLeft], css: {property:value}}
Default: []
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

⇧