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 Confidence Intervals Contours Correlation Graphs DOE Data Data Customizer Data Filters Data Point Attributes Data Selection Data Table Data Table/Filter Data sorting 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 Gradients Heatmap Graphs Hierarchy Histograms Ideograms Images Kaplan Meier Plots Legends Line Graphs Lines Loess Maps 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 Pie Charts Plot area Quantile Regression Plots R R-Axis Random Regression 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 UpSet Plots Variables Venn Diagrams X-Axis Y-Axis Z-Axis Zooming, Panning and Resizing cxplot false

Data : Data related parameters

# appendNetworkData

Array containing additional data files to append to networks. Useful for loading KEGG and Wikipatways to decorate the nodes and the edges
Type: array
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# asSampleFactors

Array containing variable names. Numeric variable data (in rows) to be treated as a sample factor (move from y to x object). This parameter accomplishes the same as the function switchVarToAnnotation at load time. It can be used in conjunction with the parameter stringSampleFactors to be treated as a string. TO DO: write example
Type: array
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# asVariableFactors

Array containing sample names. Numeric sample data (in columns) to be treated as a variable factor (move from y to z object). This parameter accomplishes the same as the function switchSmpToAnnotation at load time. It can be used in conjunction with the parameter stringVariableFactors to be treated as a string. TO DO: write example
Type: array
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# dataLabelAlign

Align for the data labels
Type: string
Default: center
Options: left, center, right
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# dataLabelBaseline

Baseline for the data labels
Type: string
Default: middle
Options: top, middle, bottom
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# dataLabelColor

Color for the text in data labels
Type: color
Default: rgb(0,0,0)
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# dataLabelFontSize

Font size for the text in data labels. 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 dataLabelScaleFontFactor
Type: integer
Default: 12
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# dataLabelFontStyle

Font style for the data labels
Type: string
Default:
Options: , bold, italic, bold italic
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# dataLabelMargin

Margin used in data labels
Type: float
Default: 5
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# dataLabelRotate

Rotation in degrees for the data labels
Type: integer
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# dataLabelScaleFontFactor

Scaling factor used to increase or decrease the data labels font size in the canvas
Type: float
Default: 1
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# groupingFactors

An array that holds the group names used for grouping the data. It must be a category in the data.x object
Type: array
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# histogramData

Flag or sample annotation to create histogram. If true is specified then the histogram will be done with all data
Type: string
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# isBoxplotCalc

Flag to indicate if the iqr has been calculated when the graph type is Boxplot
Type: boolean Private
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# isGroupedData

Flag to indicate if the data is grouped
Type: boolean Private
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# isTransformedData

Flag to indicate if the data is transformed
Type: boolean Private
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# ratioGroupReference

Name of the group used in ratio transformation. Almost private parameters used within the different CanvasXpress UIs
Type: string
Default: false
Options: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# ratioLevelReference

Name of the level used in ratio transformation. Almost private parameters used within the different CanvasXpress UIs
Type: string
Default:
Options:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# ratioReference

Default index of sample used in ratio transformation. Almost private parameters used within the different CanvasXpress UIs
Type: integer
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# ratioSampleReference

Name of the sample used in ratio transformation. Almost private parameters used within the different CanvasXpress UIs
Type: string
Default: false
Options: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# segregateSamplesBy

An array that holds the annotation(s) used to segregate the samples ala Facet way in R. It must be categories in the data.x object
Type: array
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# segregateVariablesBy

An array that holds the annotation(s) used to segregate the variables ala Facet way in R. It must be categories in the data.z object
Type: array
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# splitSamplesBy

Factor (in the x data object) used to split the samples ala split in complex heatmap
Type: string
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# splitSeparation

Length in pixels to separate the splits in samples and variables
Type: integer
Default: 10
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# splitVariablesBy

Factor (in the z data object) used to separate the variables ala split in complex heatmap
Type: string
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# stringEdgeAttributes

Array containing edge attributes. The numeric edge attributes will be treated as strings. This parameter accomplishes the same as the function switchNumericToString for edges at load time
Type: array
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# stringNodeAttributes

Array containing node attributes. The numeric node attributes will be treated as strings. This parameter accomplishes the same as the function switchNumericToString for nodes at load time
Type: array
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# stringSampleFactors

Array containing sample factors. The numeric sample factors will be treated as strings. This parameter accomplishes the same as the function switchNumericToString for samples at load time. It can be used in conjunction with the parameter asSampleFactors. TO DO: write example
Type: array
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# stringVariableFactors

Array containing variable factors. The numeric variable factors will be treated as strings. This parameter accomplishes the same as the function switchNumericToString for variables at load time. It can be used in conjunction with the parameter asVariableFactors. TO DO: write example
Type: array
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# summaryType

Summary type for the data when grouping
Type: string
Default: false
Options: false, iqr, median, mean, cor, min, max, count, sum
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# transformAxis

Default axis to use to transform the data when either z-score or ratio transformation is used
Type: string
Default: samples
Options: samples, variables
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# transformBase

Default log or exponential transformation for the data
Type: integer Private
Default: 10
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# transformData

Default transformation type for ALL the data. Data can also be transformed by axis (x,y,z) to give more flexibility. false, save reset and undo are NOT real transformations. They are only used in the canvasXpress UIs to save the transformed data
Type: string
Default: false
Options: false, log2, log10, exp2, exp10, percentile, zscore, ratio2, ratio10, save, reset, undo
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# transposeData

Flag to transpose data as a parameter. This parameter accomplishes the same as the function transpose at load time
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

⇧