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
Heatmap Graphs API
#
adjustAspectRatioHeatmapIndicator
adjustAspectRatioHeatmapIndicator
boolean
Flag to adjust aspect ratio of heatmap indicator. It depends on the adjustAspectRatio parameter; that is, the adjustAspectRatio parameter has to set to true for the adjustAspectRatioHeatmapIndicator to take effect.
See also:
adjustAspectRatio
Default:
true
Used in:
Heatmap
#
heatmapAutoAdjust
heatmapAutoAdjust
boolean
Flag to adjust the range of the heatmaps when zooming in/out
Default:
false
Used in:
Heatmap
#
heatmapCellBox
heatmapCellBox
boolean
Flag to print a box around the heatmap cells
Default:
true
Used in:
Heatmap
#
heatmapCellBoxColor
heatmapCellBoxColor
color
Color for the heatmap boxes around the cells
Default:
rgb(220,220,220)
Used in:
Heatmap
#
heatmapCellBoxColorHighlight
heatmapCellBoxColorHighlight
color
Color for highlighting heatmap cells
Default:
rgb(255,215,0)
Used in:
Heatmap
#
heatmapCellBoxHighlightWidth
heatmapCellBoxHighlightWidth
float
Width for the highlighting heatmap boxes around the cells
Default:
1
Used in:
Heatmap
#
heatmapCellBoxWidth
heatmapCellBoxWidth
float
Width for the heatmap boxes around the cells
Default:
0.5
Used in:
Heatmap
#
heatmapCollapse
heatmapCollapse
boolean
Flag to collapse cells in heatmaps of type circle or hexagon. If true cells are ploted without outline otherwise the outline is the foreground color.
Default:
false
Used in:
Heatmap
#
heatmapIndicatorHeight
heatmapIndicatorHeight
integer
Length in pixels for the heatmap indicator
Default:
20
Used in:
Heatmap
#
heatmapIndicatorHistogram
heatmapIndicatorHistogram
boolean
Flag to show histogram in the heatmap indicator
Default:
false
Used in:
Heatmap
#
heatmapIndicatorHistogramColor
heatmapIndicatorHistogramColor
color
Color for the heatmap indicator histogram
Default:
rgb(0,255,255)
Used in:
Heatmap
#
heatmapIndicatorPosition
heatmapIndicatorPosition
option
Position for the heatmap indicator
Default:
top
Options:
topLeft
,
top
,
topRight
,
right
Used in:
Heatmap
#
heatmapIndicatorWidth
heatmapIndicatorWidth
integer
Length in pixels for the heatmap indicator line width used for increase the size of the indicator
Default:
160
Used in:
Heatmap
#
heatmapSeparatorThickness
heatmapSeparatorThickness
float
Thickness of the separation of samples and variables in the heatmap.
Default:
2.5
Used in:
Heatmap
#
heatmapSmpSeparateBy
heatmapSmpSeparateBy
string
Factor (in the x data object) used to separate the samples in the heatmap. The same factor must be included in the sample overlays.
See also:
smpOverlays
Default:
false
Used in:
Heatmap
#
heatmapType
heatmapType
option
Type of Heatmap used to overlay a layer on top of an image. Special for spatial transcriptomics.
Default:
normal
Options:
normal
,
circle
,
hexagon
Used in:
Heatmap
#
heatmapVarSeparateBy
heatmapVarSeparateBy
string
Factor (in the z data object) used to separate the variables in the heatmap. The same factor must be included in the variable overlays.
Default:
false
Used in:
Heatmap
#
isMultidimensionalData
isMultidimensionalData
boolean
Private
Flag to indicate if there is more than a single data set.
Default:
false
Used in:
Heatmap
#
showHeatmapIndicator
showHeatmapIndicator
boolean
Flag to show the heatmap color indicator
Default:
true
Used in:
Heatmap
#
smpIndicesStart
smpIndicesStart
integer
Private
Number that indicates starting point for samples in heatmaps when the canvas is zoom in.
Default:
-1
Used in:
Heatmap
#
varIndicesStart
varIndicesStart
integer
Private
Number that indicates starting point for variables in heatmaps when the canvas is zoom in.
Default:
-1
Used in:
Heatmap
#
varTitleLabelPosition
varTitleLabelPosition
option
Position for variable labels
Default:
bottom
Options:
bottom
,
top
Used in:
Heatmap
On This Page
adjustAspectRatioHeatmapIndicator
heatmapAutoAdjust
heatmapCellBox
heatmapCellBoxColor
heatmapCellBoxColorHighlight
heatmapCellBoxHighlightWidth
heatmapCellBoxWidth
heatmapCollapse
heatmapIndicatorHeight
heatmapIndicatorHistogram
heatmapIndicatorHistogramColor
heatmapIndicatorPosition
heatmapIndicatorWidth
heatmapSeparatorThickness
heatmapSmpSeparateBy
heatmapType
heatmapVarSeparateBy
isMultidimensionalData
showHeatmapIndicator
smpIndicesStart
varIndicesStart
varTitleLabelPosition
⇧
Create New Page