Documentation Documentation Examples Examples API Reference API References
Getting Started
Overview Installation
API
3D Attributes Animations and Visualization Transitions Area Graphs Aspect Ratio, Space and width Axis Bar Graphs Bins Boxplot Graphs Circular Graphs Citations or References Clustering Colors Combination Plots Contours Correlation Graphs DOE Data Data Explorer Data Filters Data Point Attributes Data Selection: Parameters used to select data in all visualizations Data Table Data Table/Filter Data sorting Debug Decorations Dendrograms Density Plots Dotplot Graphs Effect Error Bars and Confidence Intervals Events Fish Graphs Fonts Foreground and Background Functions Gantt Charts General General Attributes Genome Browser Gradients Heatmap Graphs Hierarchy Histograms Images Legends Line Graphs Lines Loess Maps Margins Meter Graphs Missing Data Motion Charts Network Algorithm Parameters Network Communities Network Graphs Network Node and Edge Attributes Oncoprint Graphs Overlays Pie Charts Plot area QQ Plots R R-Axis Random 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 Variables Venn Diagrams X-Axis X-Axis2 Y-Axis Z-Axis Zooming, Panning and Resizing

Overlays API

# maxOverlayStringLen

maxOverlayStringLen integer
Maximum length in characters for the sample factor (in the 'data.x' object) or variable annotation (in the 'data.z' object) when included as an overlay. Anything above is truncated.
Default: 30
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlayFontColor

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

# overlayFontSize

overlayFontSize integer
Font size for the overlays in one dimensional plots
Default: 12
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# overlayFontStyle

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

# overlayScaleFontFactor

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

# overlaysLegendPosition

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

# overlaysThickness

overlaysThickness integer
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'.
See also: adjustAspectRatio
Default: 18
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# showLevelOverlays

showLevelOverlays boolean
Flag to indicate to show or not the level overlays in one dimensional plots
Default: true
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# showOverlays

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

# showSmpOverlaysLegend

showSmpOverlaysLegend boolean
Flag to show or not the legend for the sample overlays in the graphs. If set to false the level information will be displayed in the actual colored boxes of the overlays
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# showVarOverlaysLegend

showVarOverlaysLegend boolean
Flag to show or not the legend for the variable overlays in the graphs. If set to false the level information will be displayed in the actual colored boxes of the overlays
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# smpOverlayProperties

smpOverlayProperties object
Object to assign properties to the variable overlays. The key should be an annotation in the 'data.z' object and the value may contain 'type' which could be either one of the one dimensional graph types or Increase, or Decrease for continuous annotations; 'color' to assign the color for the Bar, Line, etc.; 'level' which is an object where the key is the level and the value is the corresponding color. 'height' to identify how tall the overlay will be
Default: {}
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# smpOverlays

smpOverlays array
Sample annotations included in the 'data.x' object used in one dimensional plots
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# smpOverlaysLegendColumns

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

# varOverlayProperties

varOverlayProperties object
Object to assign properties to the variable overlays. The key should be an annotation in the 'data.z' object and the value should be either type which could be either one of the one dimensional graph types or increasing, or decreasing for continuous annotations
Default: {}
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varOverlays

varOverlays array
Variable annotations included in the 'data.z' object used in one dimensional plots
Default: []
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# varOverlaysLegendColumns

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

⇧