Overlays
Colored boxes to help in the visualization of samples and variables
Font for the overlays in one dimensional plots
Default:
Used in:
Area,
AreaLine,
Bar,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
overlayFontColor
color
Color for the overlays in one dimensional plots
Default:
rgb(0,0,0)
Used in:
Area,
AreaLine,
Bar,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
overlayFontSize
integer
Font size for the overlays in one dimensional plots
Default:
6
Used in:
Area,
AreaLine,
Bar,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
overlayFontStyle
option
Font style for the overlays. @default
Default:
Used in:
Area,
AreaLine,
Bar,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
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,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
overlaysThickness
integer
Length in pixels of the thickness for the colored boxes to classify samples
and or variables in one dimensional plots
Default:
30
Used in:
Area,
AreaLine,
Bar,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
showLevelOverlays
boolean
Flag to indicate to show or not the level overlays in one dimensional plots
Default:
true
Used in:
Area,
AreaLine,
Bar,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
showOverlays
boolean
Flag to indicate to show or not the overlays in one dimensional plots
Default:
true
Used in:
Area,
AreaLine,
Bar,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
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 increasing, or decreasing
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,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
smpOverlayRecycleColors
boolean
Flag to indicate to recycle sample overlay colors with each overlay
Default:
false
Used in:
Area,
AreaLine,
Bar,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
smpOverlays
array
Sample annotations included in the 'data.x' object used in one dimensional
plots
Default:
[]
Used in:
Area,
AreaLine,
Bar,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
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,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
varOverlayRecycleColors
boolean
Flag to indicate to recycle variable overlay colors with each overlay
Default:
false
Used in:
Area,
AreaLine,
Bar,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
varOverlays
array
Variable annotations included in the 'data.z' object used in one
dimensional plots
Default:
[]
Used in:
Area,
AreaLine,
Bar,
Barline,
Boxplot,
Candlestick,
Correletion,
DotLine,
Dotplot,
Heatmap,
Line,
Pie,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine