Getting Started
Overview
Installation
CanvasXpress AI
LLM
Copilot
API
3D Attributes Animations and Visualization Transitions Area Graphs Aspect Ratio, Space and Width Aspect Ratio, Space and width Axis Bar Graphs Bin Plots Bins Boxplot 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 Effect Error Bars Events Fish Graphs Fit Lines Foreground and Background Gantt Charts General General Attributes Genome Browser Genome Browser Features Genome Browser Features: General parameters used in genome browser features Genome Browser Sequences Genome Browser Sequences: General parameters used in genome browser sequeces Genome Browser Tracks Genome Browser Tracks: General parameters used in 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 Manhattan and ManhattanCNV 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 Plot area 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 Time Series Titles and Subtitles Transparency Treemap Graphs Trees UpSet Plots Variables Venn Diagrams Violin Plots Visium Plots X-Axis Y-Axis Z-Axis Zooming, Panning and Resizing cxplot false

Data Point Attributes : General attributes for data points in scatter and one dimensional plots

# colorBy

Name of a variable annotation or a sample name or the string variable to color the variables
Type: string
Default: false
Options: false, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# colorByData

String that identify the object containing a two dimensional array with discrete values used to color data points when drawing a multidimensional Heatmap. It must be located within the data.y object (for example: data.y.data2)
Type: string
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# colorKey

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
Type: object
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# colorLabelBy

Name of the variable annotation to color the labels in Scatter2D plots
Type: string
Default: false
Options: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# colorLegendTitle

Title for the color legend
Type: string
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# confidenceBy

Name of a variable annotation to color the confidence intervals
Type: string
Default: false
Options: false, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# connectBy

Name of a variable annotation to connect the variables
Type: string
Default: false
Options: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# connectByColor

Color for the connectBy lines
Type: color
Default: rgb(204,204,204)
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# connectByNoColor

Flag to prevent coloring the lines by the connectBy annotation. Usefull when connectBy is used along with colorBy to avoid confusion of colors
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# connectByWidth

Width for the line of the connectBy line
Type: integer
Default: 2
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# connectKey

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
Type: object
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# dodgeBy

Name of a sample annotation to dodge the samples of each variable in Bar graphs
Type: string
Default: false
Options: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# ellipseBy

Utility to create error ellipses in Scatter plots
Type: string
Default: false
Options: false, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# lineBy

Name of a sample annotation to stack the samples of each variable in Line graphs
Type: string
Default: false
Options: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# markerBy

Utility to create dynamic markers in Map. It must have a latitude and longitude metadata too
Type: string
Default: false
Options: false, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# motionBy

Utility to create dynamic filtering of data in Scatter plots
Type: string
Default: false
Options: false, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# outlineBy

Name of the annotation for the outline when drawing a multidimensional Heatmap
Type: string
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# outlineByData

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)
Type: string
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# patternBy

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
Type: string
Default: false
Options: false, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# patternByData

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)
Type: string
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# patternKey

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
Type: object
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# pieBy

Utility to create pie with a sample annotation
Type: string
Default: false
Options: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# pivotBy

Utility to pivot data with a sample annotation
Type: string
Default: false
Options: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# plotStyle

Style for some shapes used mainly in boxplot, violin and density plots
Type: string
Default: default
Options: default, ggplot, ggplotSwitched, open, border
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# ribbonBy

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. Alternatively it could be a pair of arrays witht the actual data. Works in coordination with the lineBy parameter
Type: string
Default: false
Options: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# ribbonByType

Type of ribbon to create
Type: string
Default: line
Options: line, area
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# ridgeBy

Utility to create ridgelines in Scatter2D plots
Type: string
Default: false
Options: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# shapeBy

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
Type: string
Default: false
Options: false, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# shapeByContinuous

Flag to use pie shapes with continuous data as opposed to by binning the data and show regular shapes
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# shapeByData

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)
Type: string
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# shapeByShape

String that identify the shape to use in regular and multidimensional heatmaps. shapeByData will take precedence over this property
Type: string
Default: false
Options: false, sphere, square, triangle, star, rhombus, octagon, oval, plus, minus, mdavid
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# shapeKey

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
Type: object
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# shapeLegendTitle

Title for the shape legend
Type: string
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# sizeBy

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
Type: string
Default: false
Options: false, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# sizeByContinuous

Flag to show the size data continuously as opposed to by binning the sizes
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# sizeByData

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)
Type: string
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# sizeKey

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
Type: object
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# sizeLabelBy

Name of the variable annotation to size the labels in Scatter2D plots
Type: string
Default: false
Options: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# sizeLegendTitle

Title for the size legend
Type: string
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# stackBy

Name of a sample annotation to stack the samples of each variable in Bar graphs
Type: string
Default: false
Options: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# treemapBy

Array of sample annotations to treemap the variables. The array may also include sample to use as last level
Type: array
Default: []
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

⇧