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,
Scatter2D,
Scatter3D,
ScatterBubble2D,
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,
Scatter2D,
Scatter3D,
ScatterBubble2D,
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,
Scatter2D,
Scatter3D,
ScatterBubble2D,
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,
Scatter2D,
Scatter3D,
ScatterBubble2D,
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,
Scatter2D,
Scatter3D,
ScatterBubble2D,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine
overlaysWidth
integer
Length in pixels of the width 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,
Scatter2D,
Scatter3D,
ScatterBubble2D,
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,
Scatter2D,
Scatter3D,
ScatterBubble2D,
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,
Scatter2D,
Scatter3D,
ScatterBubble2D,
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,
Scatter2D,
Scatter3D,
ScatterBubble2D,
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,
Scatter2D,
Scatter3D,
ScatterBubble2D,
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,
Scatter2D,
Scatter3D,
ScatterBubble2D,
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,
Scatter2D,
Scatter3D,
ScatterBubble2D,
Stacked,
StackedLine,
StackedPercent,
StackedPercentLine