3D Attributes Animations and Visualization Transitions Area Graphs Aspect Ratio, Space and Width Axis Bar Graphs Bin Plots Bins Boxplot Graphs Bubble Graphs Bullet Graphs Chord Graphs Circular Graph Arc Sectors Circular Graph Connections Circular Graph Tracks Circular Graphs Citations or References Clustering Colors Combination Plot Strips Combination Plots Confidence Intervals Context Menu Contours Correlation Graphs DOE Data Data Context Data Customizer Data Faceting Data Filters Data Point Attributes Data Ratio Reference Data Selection Data Sorting Data Table Data Time Series Data Transformation Data UI Widgets Debug Decorations Dendrograms Density Plots Dotplot Graphs Dumbbell Graphs Error Bars Events Fish Graphs Fit Lines Foreground and Background Gantt Charts General General Attributes General One Dimensional Graphs Genome Browser Genome Browser Features Genome Browser Sequences Genome Browser Tracks Gradients Graph Metadata Grey Out HTML Widgets Heatmap Color Indicators Heatmap Graphs Hierarchy Histograms Ideograms Images Kaplan Meier Plots LLM Legends Line Graphs Lines Loess Lollipop Graphs Manhattan Plots Maps Maps Albers Maps Leaflet Maps Orthographic Marginal Text Margins Meter Graphs Missing Data Network Algorithm Parameters Network Cola Algorithm Parameters Network Communities Network Graphs Network Node and Edge Attributes Oncoprint Graphs Overlays Parallel Coordinates Graphs Pie Charts Plot Area Plot Data Type Plot Mode Plot Performance Plot View Plot and Panel Areas Print Quantile Regression Plots R R-Axis Random Ranges Regression Ridgeline Plots Samples Sankey Diagrams Scatter Plot Matrix Scatter Plots Scrollbar Shadows Shapes Sizes Smp-Axis Stream Plots Swimmer Graphs Tag Cloud Text Text Placement Titles and Subtitles Tooltip Transparency Tree Bracket Treemap Graphs Trees UpSet Plots Var-Axis Variables Venn Diagrams Violin Plots Visium Plots Waterfall Graphs Workflow Charts X-Axis Y-Axis Z-Axis Zooming, Panning and Resizing cxplot

Heatmap Graphs : General parameters for heatmaps

# heatmapAutoAdjust
Flag to adjust the color spectrum of the heatmaps when zooming in/out. The full spectrum range will be utilized to cover the selcted cells in the heatmap if the flag is set to true
Type: boolean
Default: false
Used in: Heatmap

heatmapAutoAdjust : true

heatmapAutoAdjust : false


# heatmapCellBox
Flag to print a box around the heatmap cells
Type: boolean
Default: true
Used in: Heatmap

heatmapCellBox : true

heatmapCellBox : false


# heatmapCellBoxColor
Color for the heatmap boxes around the cells
Type: color
Default: rgb(102,102,102)
Used in: Heatmap

heatmapCellBoxColor : "#000000"

heatmapCellBoxColor : "#ffffff"


# heatmapCellBoxColorHighlight
Color for the highlighted heatmap cells
Type: color
Default: #fed385
Used in: Heatmap

heatmapCellBoxColorHighlight : "#9e0adb"

heatmapCellBoxColorHighlight : "#47db0a"


# heatmapCellBoxHighlightWidth
Width for the highlighting heatmap boxes around the cells
Type: float
Default: 1
Used in: Heatmap

heatmapCellBoxHighlightWidth : 0.5

heatmapCellBoxHighlightWidth : 1.5


# heatmapCellBoxWidth
Width for the heatmap boxes around the cells
Type: float
Default: 1
Used in: Heatmap

heatmapCellBoxWidth : 1

heatmapCellBoxWidth : 2


# heatmapCellMarkerColorColor
Color for the default color for heatmap cell markers when an entry omits its own color
Type: color
Default: rgb(0,0,0)
Used in: Heatmap

heatmapCellMarkerColorColor : "rgb(0,0,0)"

heatmapCellMarkerColorColor : "#FFCDD2"


# heatmapCellMarkerShape
Default shape for heatmap cell markers when an entry in heatmapCellMarkers omits its own shape
Type: string
Default: pch4
Options: pch4, pch3, pch1, pch0, pch5, pch2, pch16, pch15, pch17, pch18, circle, square, diamond, triangle
Used in: Heatmap

heatmapCellMarkerShape : "pch4"

heatmapCellMarkerShape : "pch3"

heatmapCellMarkerShape : "circle"


# heatmapCellMarkerSize
Default size of heatmap cell markers as a fraction of the cell (0..1) when an entry omits its own size. The X marker (pch4) spans the full cell corner-to-corner by default (fraction 1) regardless of this value
Type: float
Default: 0.6
Used in: Heatmap

heatmapCellMarkerSize : 0.6

heatmapCellMarkerSize : 0.9


# heatmapCellMarkerWidth
Default line width for the X (pch4) heatmap cell marker when an entry omits its own width
Type: float
Default: 1
Used in: Heatmap

heatmapCellMarkerWidth : 1

heatmapCellMarkerWidth : 3


# heatmapCellMarkers
Array of per-cell shape overlays drawn on top of standard heatmap cells. Each entry is an object with a *variable* and *sample* name identifying the cell, plus optional *shape*, *color*, and *size* (fraction of the cell, 0..1). Example: [{variable: "V1", sample: "S3", shape: "pch4"}] to cross out a cell with an X. Common shapes: pch4 (X), pch3 (plus), pch1 (open circle), pch0 (open square), pch5 (open diamond), pch16 (filled circle), circle, square, diamond
Type: array
Default: []
Used in: Heatmap

heatmapCellMarkers : [{"variable": "V1", "sample": "S3", "shape": "pch4"}]


# heatmapCollapse
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
Type: boolean
Default: false
Used in: Heatmap

heatmapCollapse : true

heatmapCollapse : false


# heatmapHighlightByRowCol
Flag to highlight specific rows and columns in the heatmap cells when a variable or a sample is selected
Type: boolean
Default: false
Used in: Heatmap

heatmapHighlightByRowCol : true

heatmapHighlightByRowCol : false


# heatmapHighlightByRowColIntersection
Color for the highlighted heatmap cells where rows and columns intersect
Type: color
Default: #9b6f2b
Used in: Heatmap

heatmapHighlightByRowColIntersection : true

heatmapHighlightByRowColIntersection : false


# heatmapHighlightByRowColIntersectionWidth
Width for the highlighting heatmap boxes around the cells where rows and columns intersect
Type: float
Default: 3
Used in: Heatmap

heatmapHighlightByRowColIntersectionWidth : 0.5

heatmapHighlightByRowColIntersectionWidth : 2


# heatmapType
Type of Heatmap used to overlay a layer on top of an image. Special for spatial transcriptomics and UpSet plots
Type: string
Default: normal
Options: normal, circle, hexagon, upset, correlation, split
Used in: Heatmap

heatmapType : "normal"

heatmapType : "circle"

heatmapType : "hexagon"


# smpTitleLabelPosition
Position for sample labels
Type: string
Default: left
Options: left, right
Used in: Heatmap

smpTitleLabelPosition : "left"

smpTitleLabelPosition : "right"


# varTitleLabelPosition
Position for variable labels
Type: string
Default: bottom
Options: bottom, top
Used in: Heatmap

varTitleLabelPosition : "bottom"

varTitleLabelPosition : "top"


CanvasXpress Logo

CanvasXpress a stand-alone JavaScript Library for Data Analytics. Built for the purpose of reproducible research with a sophisticated and unobtrusive user interface. Full and effortless audit trail of data, configuration and all user interactions in every visualization.

©2025 All Rights Reserved. CanvasXpress®

Documentation
Examples Docs Api Updates
Company
Contact License Admin
Information
Terms of Use Privacy policy References
⇧