Home
Examples
Docs
Api
Updates
Contact
Social
Get License
Search CanvasXpress
×
Create New Page
×
Save dataset →
Login
×
Login →
Logout →
Create Account →
Request Password →
Documentation
Examples
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
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
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
Samples API
#
highlightSmp
highlightSmp
array
Name of samples in the 'data.y' object to highlight.
Default:
[]
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
maxSmpStringLen
maxSmpStringLen
integer
Maximum length in characters a sample label or description can have so anything above is truncated.
Default:
25
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
showSampleNames
showSampleNames
boolean
Flag to show the sample names in one dimensional plots.
Default:
true
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
smpHighlightColor
smpHighlightColor
color
The color for the higlighted samples.
Default:
rgb(255,0,0)
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
smpLabelDescription
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
smpLabelFontColor
color
Font color for the sample labels in one dimensional plots
Default:
rgb(0,0,0)
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
smpLabelFontSize
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:
12
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
smpLabelFontStyle
smpLabelFontStyle
option
Font style for the sample label.
Default:
Options:
,
bold
,
italic
,
bold italic
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
smpLabelInterval
smpLabelInterval
integer
Interval for the sample labels in one dimensional and circular plots
Default:
1
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
smpLabelRotate
smpLabelRotate
integer
Rotation for sample labels in degrees. It could be positive or negative.
Default:
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
smpLabelScaleFontFactor
smpLabelScaleFontFactor
float
Scaling factor used to increase or decrease sample label font size in the canvas.
Default:
1
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
smpTitle
smpTitle
string
Title for the sample axis in one dimensional plots
Default:
false
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
smpTitleFontColor
smpTitleFontColor
color
Font color for the sample title in one dimensional plots
Default:
rgb(0,0,0)
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
smpTitleFontSize
smpTitleFontSize
integer
Size for the sample title in one dimensional plots
Default:
12
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
smpTitleFontStyle
smpTitleFontStyle
option
Font style for the samples.
Default:
Options:
,
bold
,
italic
,
bold italic
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
#
smpTitleScaleFontFactor
smpTitleScaleFontFactor
float
Scaling factor used to increse or decrease sample title font size in the canvas
Default:
1
Used in:
Area
,
AreaLine
,
Bar
,
Boxplot
,
DotLine
,
Dotplot
,
Heatmap
,
Line
,
ParallelCoordinates
,
Pie
,
Sankey
,
Scatter2D
,
Scatter3D
,
ScatterBubble2D
,
Stacked
,
StackedLine
,
StackedPercent
,
StackedPercentLine
,
TagCloud
,
Tree
,
Treemap
On This Page
highlightSmp
maxSmpStringLen
showSampleNames
smpHighlightColor
smpLabelDescription
smpLabelFontColor
smpLabelFontSize
smpLabelFontStyle
smpLabelInterval
smpLabelRotate
smpLabelScaleFontFactor
smpTitle
smpTitleFontColor
smpTitleFontSize
smpTitleFontStyle
smpTitleScaleFontFactor
⇧
Create New Page