Samples

filterSmpBy filter

Filter samples by their annotation 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, TagCloud, Treemap

highlightSmp array

Name of samples in the 'data.y' object to highlight.

Default: []

Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap

maxSmpStringLen integer

Maximum length in characters a sample label or description can have so anything above is truncated.

Default: 50

Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap

showSampleNames boolean

Flag to show the sample names 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, TagCloud, Treemap

smpHighlightColor color

The color for the higlighted samples.

Default: rgb(255,0,0)

Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap

smpLabelDescription string

Sample label description is a valid sample classification included in the 'data.x' object used in heatmaps

Default: false

Used in: Heatmap

smpLabelFontColor color

Font color for the sample labels 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, TagCloud, Treemap

smpLabelFontSize integer

Size for the sample labels in one dimensional plots. 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 sample label scaling factor

See also: autoScaleFont, smpLabelScaleFontFactor

Default: 10

Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap

smpLabelFontStyle option

Font style for the sample label. @default

Default:

Options: , bold, italic, bold italic

Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap

smpLabelInterval integer

Interval for the sample labels 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, TagCloud, Treemap

smpLabelRotate integer

Rotation for sample labels in degrees. It could be positive or negative.

Default:

Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap

smpLabelScaleFontFactor float

Scaling factor used to increase or decrease sample label font size in the canvas.

Default: 1

Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap

smpTitle string

Title for the sample axis in one dimensional plots

Default: false

Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap

smpTitleFontColor color

Font color for the sample title 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, TagCloud, Treemap

smpTitleFontSize integer

Size for the sample title in one dimensional plots

Default: 10

Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap

smpTitleFontStyle option

Font style for the samples. @default

Default:

Options: , bold, italic, bold italic

Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap

smpTitleScaleFontFactor float

Scaling factor used to increse or decrease sample title font size in the canvas

Default: 1

Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap