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

Overlays : Colored boxes to help in the visualization of samples and variables

# maxOverlayStringLen

Maximum length in characters for the sample or variable metadata when included as an overlay. Anything above is truncated
Type: integer
Default: 30
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlayAlign

Align for the overlays
Type: string
Default: center
Options: left, center, right
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlayBaseline

Baseline for the overlays
Type: string
Default: middle
Options: top, middle, bottom
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlayColor

Color for the text in overlays
Type: color
Default: rgb(0,0,0)
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlayFontSize

Font size for the text in overlays. 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 overlayScaleFontFactor
Type: integer
Default: 12
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlayFontStyle

Font style for the overlays
Type: string
Default:
Options: , bold, italic, bold italic
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlayMargin

Margin used in overlays
Type: float
Default: 5
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlayRotate

Rotation in degrees for the overlays
Type: integer
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlayScaleFontFactor

Scaling factor used to increase or decrease the overlays font size in the canvas
Type: float
Default: 1
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlaysLegendPosition

Position for the the variable and sample overlays legend
Type: string
Default: topRight
Options: topRight, right, bottomLeft, bottom
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlaysThickness

Relative length in pixels for the thickness of the colored boxes to classify samples and or variables in one dimensional plots. This value is adjusted acording to the graph dimensions if the adjustAspectRatio parameter is set to true
Type: integer
Default: 18
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# showLevelOverlays

Flag to show/hide the overlay levels (values) in one dimensional plots
Type: boolean
Default: true
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# showOverlays

Flag to show/hide the overlays in one dimensional plots
Type: boolean
Default: true
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# showSmpOverlaysLegend

Flag to show/hide the sample overlay legends
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# showVarOverlaysLegend

Flag to show/hide the sample overlay legends
Type: boolean
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# smpOverlayProperties

Object to assign properties of the sample overlays. The key should be a valid sample annotation (metadata) and the value and object with properties like: type, color, spectrum, scheme, showLegend, showName, showBox, rotate, position, thicknes
Type: object
Default: HASH(0x7f77ab082840)
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# smpOverlays

Sample metadata to overlay in one dimensional plots
Type: array
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# smpOverlaysLegendColumns

Number of columns for the sample overlay legends
Type: integer
Default: 1
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varOverlayProperties

Object to assign properties of the variable overlays. The key should be a valid variable annotation (metadata) and the value and object with properties like: type, color, spectrum, scheme, showLegend, showName, showBox, rotate, position, thicknes
Type: object
Default: HASH(0x7f77aa219398)
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varOverlays

Variable metadata to overlay in heatmap plots
Type: array
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varOverlaysLegendColumns

Number of columns for the variable overlay legends
Type: integer
Default: 1
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

⇧