Getting Started
Overview
Installation
API
3D Attributes Animations and Visualization Transitions Area Graphs Aspect Ratio, Space and width Axis Bar Graphs Bin Plots 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 Data Table Data Table/Filter Data sorting Debug Decorations Dendrograms Density Plots Dotplot Graphs Effect Error Bars and Confidence Intervals Events Fish Graphs 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 Quantile Regression 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 Y-Axis Z-Axis Zooming, Panning and Resizing cxplot

Data Point Attributes API

# colorBy

colorBy option
Name of a variable annotation or a sample name or the string 'variable' to color the variables.
Default: false
Options: false, variable
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

# colorByShowLegend

colorByShowLegend boolean
Flag to show the colorBy legend
Default: true
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

# colorKey

colorKey object
Object to assign custom colors to sample annotations and variable annotations included in the data object. The key of the object is the name of an annotation in the data.x object, or the name of an annotation in the data.z object. The value for each key could be either: (1) a scalar with a valid color scheme (see this.meta.def.colorSchemes), or (2) an array with valid colors, or (3) an object to specify custom colors for each of the values of the annotation. A default color will be assigned to a data point whose value was not included the object. CanvasXpress will handle string and numeric annotation approprietly. However, if an object is specified like that one in number (3) the annotation will be treated as categorical even if the annotation is numeric.
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

# connectBy

connectBy option
Name of a variable annotation to connect the variables.
Default: false
Options: false
Used in: Scatter2D, Scatter3D, ScatterBubble2D

# connectByColor

connectByColor color
The color for the connectBy lines
Default: rgb(204,204,204)
Used in: Scatter2D, Scatter3D, ScatterBubble2D

# connectByData

connectByData object Private
Internal object with connectBy data
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

# connectByNoColor

connectByNoColor boolean
Flag to prevent coloring the lines by the connectBy annotation. Usefull when connectBy is used along with colorBy to avoid confusion of colors
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

# connectByShowLegend

connectByShowLegend boolean
Flag to show the connectBy legend
Default: true
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

# connectByWidth

connectByWidth integer
Width for the line of the connectBy line
Default: 2
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

# connectKey

connectKey object
Object to assign custom colors to lines when samples are connected by a sample annotations included in the data object. The key of the object is the name of an annotation in the data.x object. A default connect will be assigned to a data point whose value was not included the object.
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

# ellipseBy

ellipseBy option
Utility to create error ellipses in Scatter plots
@funtion getZData
Default: false
Options: false, variable
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

# lineBy

lineBy option
Name of a sample annotation to stack the samples of each variable in Line graphs.
Default: false
Options: 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

# lineByShowLegend

lineByShowLegend boolean
Flag to show the lineBy legend
Default: true
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

# markerBy

markerBy option
Utility to create dynamic markers in Map. It must have a latitude and longitude metadata too.
Default: false
Options: false, variable
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

# motionBy

motionBy option
Utility to create dynamic filtering of data in Scatter plots
Default: false
Options: false, variable
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

# outlineBy

outlineBy string
Name of the annotation for the outline when drawing a multidimensional Heatmap
See also: outlineByData
Default: false
Used in: Heatmap

# outlineByData

outlineByData string
String that identify the object containing a two dimensional array with values used to color the outline data points when drawing a multidimensional Heatmap. It must be located within the data.y object (for example: data.y.data4)
See also: outlineBy
Default: false
Used in: Heatmap

# outlineByShowLegend

outlineByShowLegend boolean
Flag to show the outlineBy legend
Default: true
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

# patternBy

patternBy option
Name of a variable annotation or a sample name or the string 'variable' to pattern the variables. When patternByData is specified patternBy is used for the title in the legend.
See also: patternByData
Default: false
Options: false, variable
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

# patternByData

patternByData string
String that identify the object containing a two dimensional array with values used to pattern the data points when drawing a multidimensional Heatmap. It must be located within the data.y object (for example: data.y.data4)
See also: patternBy
Default: false
Used in: Heatmap

# patternByShowLegend

patternByShowLegend boolean
Flag to show the patternBy legend
Default: true
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

# patternKey

patternKey object
Object to assign custom patterns to sample annotations and variable annotations included in the data object. The key of the object is the name of an annotation in the data.x object or the name of an annotation in the data.z object. A default pattern will be assigned to a data point whose value was not included the object.
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

# ribbonBy

ribbonBy option
Name of a sample annotation(s) to create a ribbon of each variable in scatter plots. If a single annotation is passed then it will be used as a standard deviation. If two annotations are passed then, it will be used as upper and lower confidence intervals. Works in coordination with the lineBy parameter.
Default: false
Options: 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

# ridgeBy

ridgeBy option
Utility to create ridgelines in Scatter2D plots
@funtion getZData
Default: false
Options: 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

# shapeBy

shapeBy option
Name of a variable annotation or a sample name or the string 'variable' to shape the variables. When shapeByData is specified shapeBy is used for the title in the legend.
See also: shapeByData
Default: false
Options: false, variable
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

# shapeByContinuous

shapeByContinuous boolean
Flag to use pie shapes with continuous data as opposed to by binning the data and show regular shapes
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

# shapeByData

shapeByData string
String that identify the object containing a two dimensional array with values used to shape data points when drawing a multidimensional Heatmap. It must be located within the data.y object (for example: data.y.data2)
See also: shapeBy
Default: false
Used in: Heatmap

# shapeByShape

shapeByShape option
String that identify the shape to use in regular and multidimensional heatmaps. shapeByData will take precedence over this property.
Default: false
Options: false, sphere, square, triangle, star, rhombus, octagon, oval, plus, minus, mdavid
Used in: Heatmap

# shapeByShowLegend

shapeByShowLegend boolean
Flag to show the shapeBy legend
Default: true
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

# shapeKey

shapeKey object
Object to assign custom shapes to sample annotations and variable annotations included in the data object. The key of the object is the name of an annotation in the data.x object or the name of an annotation in the data.z object. A default shape will be assigned to a data point whose value was not included the object.
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

# sizeBy

sizeBy option
Name of a variable annotation or a sample name or the string 'variable' to size the variables. When sizeByData is specified sizeBy is used for the title in the legend.
See also: sizeByData
Default: false
Options: false, variable
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

# sizeByContinuous

sizeByContinuous boolean
Flag to show the size data continuously as opposed to by binning the sizes
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

# sizeByData

sizeByData string
String that identify the object containing a two dimensional array with values used to size data points when drawing a multidimensional Heatmap. It must be located within the data.y object (for example: data.y.data3)
See also: sizeBy
Default: false
Used in: Heatmap

# sizeByShowLegend

sizeByShowLegend boolean
Flag to show the sizeBy legend
Default: true
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

# sizeKey

sizeKey object
Object to assign custom sizes to sample annotations and variable annotations included in the data object. The key of the object is the name of an annotation in the data.x object or the name of an annotation in the data.z object. A default size will be assigned to a data point whose value was not included the object.
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

# stackBy

stackBy option
Name of a sample annotation to stack the samples of each variable in Bar graphs.
Default: false
Options: 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

# treemapBy

treemapBy array
Array of sample annotations to treemap the variables. The array may also include 'sample' to use as last level.
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

⇧