TreeMap

@nivo/treemaphierarchysvgisomorphic
svghtmlcanvashttp api

A tree map component using d3-hierarchy.treemap, see this demo.

You can fully customize it using nodeComponent property to define your own node component, if you wish to do so you should have a look at native SVG node component for available properties.

The responsive alternative of this component is ResponsiveTreeMap, it also offers other implementations, see TreeMapHtml and TreeMapCanvas.

The TreeMap component is also available in the @nivo/api, see sample or try it using the API client.

Actions Logs
Start interacting with the chart to log actions
Base
objectrequired
The hierarchical data object.
string | Functionoptionaldefault:'id'
The key or function to use to retrieve nodes identity.
string | Functionoptionaldefault:'value'
The key or function to use to retrieve nodes value.
string | Functionoptional
open editor
Value format supporting d3-format notation, this formatted value will then be used for labels and tooltips.
stringoptionaldefault:'squarify'
squarify
Strategy used to compute nodes.
booleanoptionaldefault:false
   Only render leaf nodes (no parent).
numberoptionaldefault:0
px
Padding between parent and child node.
numberoptionaldefault:0
px
Padding between parent and child node.
numberrequired
Chart width.
numberrequired
Chart height.
numberoptionaldefault:'Depends on device'
Adjust pixel ratio, useful for HiDPI screens.
supportsvghtmlcanvasapi
objectoptional
px
px
px
px
Chart margin.
Style
string | Function | string[]optionaldefault:{"scheme":"nivo"}
nivo
Defines how to compute node color.
numberoptionaldefault:0.33
Node opacity (0~1).
numberoptionaldefault:1
px
Control node border width.
string | object | Functionoptionaldefault:{"from":"color","modifiers":[["darker",1]]}
inheritthemecustom
inherited property
color
modifiers
darker
Method to compute border color.
object[]optional
Define patterns and gradients.
supportsvghtmlcanvasapi
object[]optional
Define rules to apply patterns and gradients
supportsvghtmlcanvasapi
Labels
booleanoptionaldefault:true
   Enable/disable labels.
string | Functionoptional
formattedValue
Label accessor.
numberoptional
px
Skip label rendering if node minimal side length is lower than given value, 0 to disable.
booleanoptionaldefault:true
   Orient labels according to max node width/height.
string | object | Functionoptional
inheritthemecustom
inherited property
color
modifiers
darker
Method to compute label text color.
booleanoptionaldefault:true
   Enable/disable labels.
supportsvghtmlcanvasapi
string | Functionoptional
id
Parent label accessor.
supportsvghtmlcanvasapi
numberoptionaldefault:20
Parent label size.
supportsvghtmlcanvasapi
'top' | 'right' | 'bottom' | 'left'optionaldefault:'top'
top
Parent label position.
supportsvghtmlcanvasapi
numberoptionaldefault:6
Parent label padding.
supportsvghtmlcanvasapi
string | object | Functionoptional
inheritthemecustom
inherited property
color
modifiers
darker
Method to compute parent label text color.
supportsvghtmlcanvasapi
Interactivity
booleanoptionaldefault:true
   Enable/disable interactivity.
supportsvghtmlcanvasapi
(node, event) => voidoptional
onMouseEnter handler.
supportsvghtmlcanvasapi
(node, event) => voidoptional
onMouseMove handler.
supportsvghtmlcanvasapi
(node, event) => voidoptional
onMouseLeave handler.
supportsvghtmlcanvasapi
(node, event) => voidoptional
onClick handler.
supportsvghtmlcanvasapi
Motion
booleanoptionaldefault:true
   Enable/disable transitions.
supportsvghtmlcanvasapi
string | objectoptionaldefault:'gentle'
gentle
Motion config for react-spring, either a preset or a custom configuration.
supportsvghtmlcanvasapi
Recipes
Using custom tooltipPatterns & Gradients