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

Variables : Properties associated with variables

# highlightVar

Name of variables to highlight
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

# maxVarStringLen

Maximum length in characters a variable label or description can have so anything above is truncated
Type: integer
Default: 25
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# showVariableNames

Flag to show/hide the variable names
Type: boolean
Default: true
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varHighlightColor

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

# varLabelInterval

Interval for the variable labels in heatmaps
Type: integer
Default: 1
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTextAlign

Align for the variable text
Type: string
Default: center
Options: left, center, right
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTextBaseline

Baseline for the variable text
Type: string
Default: middle
Options: top, middle, bottom
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTextColor

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

# varTextFontSize

Font size for the text in variable text. 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 varTextScaleFontFactor
Type: integer
Default: 11
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTextFontStyle

Font style for the variable text
Type: string
Default:
Options: , bold, italic, bold italic
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTextMargin

Margin used in variable text
Type: float
Default: 5
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTextRotate

Rotation in degrees for the variable text
Type: integer
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTextScaleFontFactor

Scaling factor used to increase or decrease the variable text font size in the canvas
Type: float
Default: 1
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTitle

Title for the variables in hetamap plots
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

# varTitleAlign

Align for the variable title
Type: string
Default: center
Options: left, center, right
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTitleBaseline

Baseline for the variable title
Type: string
Default: middle
Options: top, middle, bottom
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTitleColor

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

# varTitleFontSize

Font size for the text in variable title. 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 varTitleScaleFontFactor
Type: integer
Default: 11
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTitleFontStyle

Font style for the variable title
Type: string
Default:
Options: , bold, italic, bold italic
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTitleMargin

Margin used in variable title
Type: float
Default: 5
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTitleRotate

Rotation in degrees for the variable title
Type: integer
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varTitleScaleFontFactor

Scaling factor used to increase or decrease the variable title font size in the canvas
Type: float
Default: 1
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Fish, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

⇧