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 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 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 and Panel 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

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

# overlayTextAlign

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

# overlayTextBaseline

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

# overlayTextColor

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

# overlayTextFontSize

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 overlayTextScaleFontFactor
Type: integer
Default: 11
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlayTextFontStyle

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

# overlayTextMargin

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

# overlayTextRotate

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

# overlayTextScaleFontFactor

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

# showNameOverlays

Flag to show/hide the the overlays name
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

# showValueOverlays

Flag to show/hide the overlay values in one dimensional plots
Type: boolean
Default: true
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: {}
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: {}
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

⇧