3D Attributes Animations and Visualization Transitions Area Graphs Aspect Ratio, Space and Width Axis Bar Graphs Bin Plots Bins Boxplot Graphs Bubble Graphs Bullet Graphs Chord Graphs Circular Graph Arc Sectors Circular Graph Connections Circular Graph Tracks Circular Graphs Citations or References Clustering Colors Combination Plot Strips 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 Dumbbell Graphs Effect Error Bars Events Fish Graphs Fit Lines Foreground and Background Gantt Charts General General Attributes General One Dimensional Graphs Genome Browser Genome Browser Features Genome Browser Sequences 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 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 Data Type Plot Mode Plot Performance Plot View Plot and Panel Areas Print Quantile Regression Plots R R-Axis Random Ranges Regression Remote Procedures Ridgeline Plots Samples Sankey Diagrams Scatter Plot Matrix Scatter Plots Shadows Shapes Sizes Stream Plots Swimmer Graphs Tag Cloud Text Text Placement Titles and Subtitles Tooltip Transparency Tree Bracket Treemap Graphs Trees UpSet Plots Variables Venn Diagrams Violin Plots Visium Plots Waterfall Graphs X-Axis Y-Axis Z-Axis Zooming, Panning and Resizing cxplot

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:
Options: 0, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

colorBy : "Group"

colorBy : false


# 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:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# 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:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# colorLabelBy
Name of the variable annotation to color the labels in Scatter2D plots
Type: string
Default:
Options: 0
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# colorLegendTitle
Title for the color legend
Type: string
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

colorLegendTitle : "Title Color"

colorLegendTitle : false


# confidenceBy
Name of a variable annotation to color the confidence intervals
Type: string
Default:
Options: 0, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# connectBy
Name of a variable annotation to connect the variables
Type: string
Default:
Options: 0
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

connectBy : "NumFact"

connectBy : false


# connectByColor
Color for the connectBy lines
Type: color
Default: rgb(204,204,204)
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

connectByColor : "rgb(255,0,0)"

connectByColor : "rgb(0,255,0)"


# 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, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

connectByNoColor : true

connectByNoColor : false


# connectByWidth
Width for the line of the connectBy line
Type: integer
Default: 2
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

connectByWidth : 1

connectByWidth : 3


# 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:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# dodgeBy
Name of a sample annotation to dodge the samples of each variable in Bar graphs
Type: string
Default:
Options: 0
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# ellipseBy
Utility to create error ellipses in Scatter plots
Type: string
Default:
Options: 0, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

ellipseBy : false

ellipseBy : "Category"


# lineBy
Name of a sample annotation to stack the samples of each variable in Line graphs
Type: string
Default:
Options: 0
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

lineBy : false

lineBy : "Category"


# markerBy
Utility to create dynamic markers in Map. It must have a latitude and longitude metadata too
Type: string
Default:
Options: 0, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# motionBy
Utility to create dynamic filtering of data in Scatter plots
Type: string
Default:
Options: 0, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

motionBy : "YearFact"


# outlineBy
Name of the annotation for the outline when drawing a multidimensional Heatmap
Type: string
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# 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:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# 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:
Options: 0, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

patternBy : false

patternBy : "Type"


# 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:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# 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:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# pieBy
Utility to create pie with a sample annotation
Type: string
Default:
Options: 0
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# pivotBy
Utility to pivot data with a sample annotation
Type: string
Default:
Options: 0
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# 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:
Options: 0
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# ribbonByType
Type of ribbon to create
Type: string
Default: line
Options: line, area
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# ridgeBy
Utility to create ridgelines in Scatter2D plots
Type: string
Default:
Options: 0
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

ridgeBy : "Category"

ridgeBy : "Group"


# 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:
Options: 0, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

shapeBy : "Group"

shapeBy : false


# 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, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# 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:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# shapeByShape
String that identify the shape to use in regular and multidimensional heatmaps. shapeByData will take precedence over this property
Type: string
Default:
Options: 0, sphere, square, triangle, star, rhombus, octagon, oval, plus, minus, mdavid
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# 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:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# shapeLegendTitle
Title for the shape legend
Type: string
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

shapeLegendTitle : "Title Shape"

shapeLegendTitle : false


# 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:
Options: 0, variable
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

sizeBy : "Col3"

sizeBy : false


# 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, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

sizeByContinuous : false

sizeByContinuous : true


# 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:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# 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:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# sizeLabelBy
Name of the variable annotation to size the labels in Scatter2D plots
Type: string
Default:
Options: 0
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# sizeLegendTitle
Title for the size legend
Type: string
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

sizeLegendTitle : "Title Size"

sizeLegendTitle : false


# stackBy
Name of a sample annotation to stack the samples of each variable in Bar graphs
Type: string
Default:
Options: 0
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

# 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, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Heatmap, Histogram, Line, Lollipop, Meter, ParallelCoordinates, Pie, Radar, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Violin, Waterfall

CanvasXpress Logo

CanvasXpress a stand-alone JavaScript Library for Data Analytics. Built for the purpose of reproducible research with a sophisticated and unobtrusive user interface. Full and effortless audit trail of data, configuration and all user interactions in every visualization.

©2025 All Rights Reserved. CanvasXpress®

Documentation
Examples Docs Api Updates
Company
Contact License Admin
Information
Terms of Use Privacy policy References
⇧