Overlays

Colored boxes to help in the visualization of samples and variables


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
Color for the overlays in one dimensional plots
Default: rgb(0,0,0)
overlayFontSize integer
Font size for the overlays in one dimensional plots
Default: 12
Font style for the overlays.
Default:
Options: , bold, italic, bold italic
Scaling factor used to increse or decrease overlays font size in the canvas in one dimensional plots
Default: 1
Position for the variable and sample overlays legend in the graphs.
Default: topRight
Options: topRight, right, bottomLeft, bottom
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
Flag to indicate to show or not the level overlays in one dimensional plots
Default: true
showOverlays boolean
Flag to indicate to show or not the overlays in one dimensional plots
Default: true
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
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
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: {}
smpOverlays array
Sample annotations included in the 'data.x' object used in one dimensional plots
Default: []
Number of columns for the sample overlay legends
Default: 1
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: {}
varOverlays array
Variable annotations included in the 'data.z' object used in one dimensional plots
Default: []
Number of columns for the variable overlay legends
Default: 1