Legend is used to provide valuable information for interpreting what the tree map is displaying and can be represented in various colors, shapes or other identifiers based on data.
Legend position is used to place legend in various positions. Based on the legend position, the legend item will be aligned. For example, if the position is top or bottom, the legend items are placed by rows. If the position is left or right, the legend items are placed by columns.
The following options are available to customize the legend position:
The following code example shows the legend position.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { TreeMapComponent, Inject, TreeMapLegend } from '@syncfusion/ej2-react-treemap';
class App extends React.Component {
render() {
return ( <TreeMapComponent id='treemap'
dataSource={[
{ fruit:'Apple', count:5000 },
{ fruit:'Mango', count:3000 },
{ fruit:'Orange', count:2300 },
{ fruit:'Banana', count:500 },
{ fruit:'Grape', count:4300 },
{ fruit:'Papaya', count:1200 },
{ fruit:'Melon', count:4500 }
]}
weightValuePath= 'count'
rangeColorValuePath='count'
legendSettings= {{
visible: true,
position: 'Top'
}}
leafItemSettings= {{
labelPath: 'fruit',
colorMapping:[
{
from:500,
to:3000,
color:'orange'
},
{
from:3000,
to:5000,
color:'green'
}
]
}}>
<Inject services={[TreeMapLegend]} />
</TreeMapComponent> );
}
}
ReactDOM.render(<App />, document.getElementById('treemap'));Legend Alignment is used to align the legend items in specific location. The following options are available to customize the legend alignment:
The following code example shows legend alignment.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { TreeMapComponent, Inject, TreeMapLegend } from '@syncfusion/ej2-react-treemap';
class App extends React.Component {
render() {
return ( <TreeMapComponent id='treemap'
dataSource={[
{ fruit:'Apple', count:5000 },
{ fruit:'Mango', count:3000 },
{ fruit:'Orange', count:2300 },
{ fruit:'Banana', count:500 },
{ fruit:'Grape', count:4300 },
{ fruit:'Papaya', count:1200 },
{ fruit:'Melon', count:4500 }
]}
weightValuePath= 'count'
rangeColorValuePath='count'
legendSettings= {{
visible: true,
alignment: 'Far'
}}
leafItemSettings= {{
labelPath: 'fruit',
colorMapping:[
{
from:500,
to:3000,
color:'orange'
},
{
from:3000,
to:5000,
color:'green'
}
]
}}>
<Inject services={[TreeMapLegend]} />
</TreeMapComponent> );
}
}
ReactDOM.render(<App />, document.getElementById('treemap'));The tree map control supports two different types of legend rendering modes such as Default and Interactive.
Default mode
In default mode, legends have symbols with legend labels that are used to identify the items in tree map control.
The following code example shows the default mode of legends.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { TreeMapComponent, Inject, TreeMapLegend } from '@syncfusion/ej2-react-treemap';
class App extends React.Component {
render() {
return ( <TreeMapComponent id='treemap'
dataSource={[
{ Car:'Mustang', Brand:'Ford', count:232 },
{ Car:'EcoSport', Brand:'Ford', count:121 },
{ Car:'Swift', Brand:'Maruti', count:143 },
{ Car:'Baleno', Brand:'Maruti', count:454 },
{ Car:'Vitara Brezza', Brand:'Maruti', count:545 },
{ Car:'A3 Cabriolet', Brand:'Audi',count:123 },
{ car:'RS7 Sportback', Brand:'Audi', count:523 }
]}
weightValuePath= 'count'
equalColorValuePath='Brand'
legendSettings= {{
visible: true,
position:'Top',
border: {color:'black',width:2}
}}
leafItemSettings= {{
labelPath: 'Car',
colorMapping:[
{
value:'Ford',
color:'green'
},
{
value:'Audi',
color:'red'
},
{
value:'Maruti',
color:'orange'
}
]
}}>
<Inject services={[TreeMapLegend]} />
</TreeMapComponent> );
}
}
ReactDOM.render(<App />, document.getElementById('treemap'));Interactive mode
The legends can be made interactive with an arrow mark that indicates exact range color in legend when the mouse hovers over the corresponding shape. You can enable this option by setting the mode property in legendSettings value to “Interactive”. The default value of the mode property is “Default” to enable normal legend.
The following code example shows the interactive mode of legends.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { TreeMapComponent, Inject, TreeMapLegend } from '@syncfusion/ej2-react-treemap';
class App extends React.Component {
render() {
return ( <TreeMapComponent id='treemap'
dataSource={[
{ Car:'Mustang', Brand:'Ford', count:232 },
{ Car:'EcoSport', Brand:'Ford', count:121 },
{ Car:'Swift', Brand:'Maruti', count:143 },
{ Car:'Baleno', Brand:'Maruti', count:454 },
{ Car:'Vitara Brezza', Brand:'Maruti', count:545 },
{ Car:'A3 Cabriolet', Brand:'Audi',count:123 },
{ car:'RS7 Sportback', Brand:'Audi', count:523 }
]}
weightValuePath= 'count'
equalColorValuePath='Brand'
legendSettings= {{
visible: true,
mode:'Interactive',
position:'Top',
border: {color:'black',width:2}
}}
leafItemSettings= {{
labelPath: 'Car',
colorMapping:[
{
value:'Ford',
color:'green'
},
{
value:'Audi',
color:'red'
},
{
value:'Maruti',
color:'orange'
}
]
}}>
<Inject services={[TreeMapLegend]} />
</TreeMapComponent> );
}
}
ReactDOM.render(<App />, document.getElementById('treemap'));You can customize the legend size by modifying the [height] and [width] properties in the legendSettings. It accepts values in both percentage and pixel. If the value is specified in percentage for height or width, the legend height will be calculated for overall height.
Legend size is shown in the following example.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { TreeMapComponent, Inject, TreeMapLegend } from '@syncfusion/ej2-react-treemap';
class App extends React.Component {
render() {
return ( <TreeMapComponent id='treemap'
dataSource={[
{ Car:'Mustang', Brand:'Ford', count:232 },
{ Car:'EcoSport', Brand:'Ford', count:121 },
{ Car:'Swift', Brand:'Maruti', count:143 },
{ Car:'Baleno', Brand:'Maruti', count:454 },
{ Car:'Vitara Brezza', Brand:'Maruti', count:545 },
{ Car:'A3 Cabriolet', Brand:'Audi',count:123 },
{ car:'RS7 Sportback', Brand:'Audi', count:523 }
]}
weightValuePath= 'count'
equalColorValuePath='Brand'
legendSettings= {{
visible: true,
height:'50px',
width:'200px',
position:'Top',
border: {color:'black',width:2}
}}
leafItemSettings= {{
labelPath: 'Car',
colorMapping:[
{
value:'Ford',
color:'green'
},
{
value:'Audi',
color:'red'
},
{
value:'Maruti',
color:'orange'
}
]
}}>
<Inject services={[TreeMapLegend]} />
</TreeMapComponent> );
}
}
ReactDOM.render(<App />, document.getElementById('treemap'));Paging support
The tree map supports the legend paging. Legend paging will be enabled if the legend items cannot placed within provided height and width.
The following code example shows enabling legend paging.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { TreeMapComponent, Inject, TreeMapLegend } from '@syncfusion/ej2-react-treemap';
class App extends React.Component {
render() {
return ( <TreeMapComponent id='treemap'
dataSource={[
{ Car:'Mustang', Brand:'Ford', count:232 },
{ Car:'EcoSport', Brand:'Ford', count:121 },
{ Car:'Swift', Brand:'Maruti', count:143 },
{ Car:'Baleno', Brand:'Maruti', count:454 },
{ Car:'Vitara Brezza', Brand:'Maruti', count:545 },
{ Car:'A3 Cabriolet', Brand:'Audi',count:123 },
{ car:'RS7 Sportback', Brand:'Audi', count:523 }
]}
weightValuePath= 'count'
equalColorValuePath='Brand'
legendSettings= {{
visible: true,
height:'50px',
width:'100px',
border: {color:'black',width:2}
}}
leafItemSettings= {{
labelPath: 'Car',
colorMapping:[
{
value:'Ford',
color:'green'
},
{
value:'Audi',
color:'red'
},
{
value:'Maruti',
color:'orange'
}
]
}}>
<Inject services={[TreeMapLegend]} />
</TreeMapComponent> );
}
}
ReactDOM.render(<App />, document.getElementById('treemap'));Based on the ranges in the data source, get the excluded ranges from color mapping, and then show the legend with excluded range values are bound to the specific legend.
The following code example shows how to set the color for items excluded from color mapping.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { TreeMapComponent, Inject, TreeMapLegend } from '@syncfusion/ej2-react-treemap';
class App extends React.Component {
render() {
return ( <TreeMapComponent id='treemap'
dataSource={[
{ fruit:'Apple', count:5000 },
{ fruit:'Mango', count:3000 },
{ fruit:'Orange', count:2300 },
{ fruit:'Banana', count:500 },
{ fruit:'Grape', count:4300 },
{ fruit:'Papaya', count:1200 },
{ fruit:'Melon', count:4500 }
]}
weightValuePath= 'count'
rangeColorValuePath='count'
legendSettings= {{
visible: true
}}
leafItemSettings= {{
labelPath: 'fruit',
colorMapping:[
{
from:500,
to:2500,
minOpacity:0.2,
maxOpacity:0.5,
color:'orange'
},
{
from:3000,
to:4000,
minOpacity:0.5,
maxOpacity:0.8,
color:'green'
},
{
color:'red'
}]
}}>
<Inject services={[TreeMapLegend]} />
</TreeMapComponent> );
}
}
ReactDOM.render(<App />, document.getElementById('treemap'));To enable or disable the desired legend for each colormapping,set the showLegend property to true in colorMapping.
The following code example shows to hide the desired legend.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { TreeMapComponent, Inject, TreeMapLegend } from '@syncfusion/ej2-react-treemap';
class App extends React.Component {
render() {
return ( <TreeMapComponent id='treemap'
dataSource={[
{ fruit:'Apple', count:5000 },
{ fruit:'Mango', count:3000 },
{ fruit:'Orange', count:2300 },
{ fruit:'Banana', count:500 },
{ fruit:'Grape', count:4300 },
{ fruit:'Papaya', count:1200 },
{ fruit:'Melon', count:4500 }
]}
weightValuePath= 'count'
rangeColorValuePath='count'
legendSettings= {{
visible: true
}}
leafItemSettings= {{
labelPath: 'fruit',
colorMapping:[
{
from:500,
to:2500,
color:'orange',
showLegend: true
},
{
from:3000,
to:4000,
color:'green',
showLegend: false
}]
}}>
<Inject services={[TreeMapLegend]} />
</TreeMapComponent> );
}
}
ReactDOM.render(<App />, document.getElementById('treemap'));To enable or disable the legend visibility for each item, bind the field name in the data source to the showLegendPath property in legendSettings.
The following code example shows how to hide legend items based on data source value.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { TreeMapComponent, Inject, TreeMapLegend } from '@syncfusion/ej2-react-treemap';
class App extends React.Component {
render() {
return ( <TreeMapComponent id='treemap'
dataSource={[
{ fruit:'Apple', count:5000, visibility: true , color: '#71B081' },
{ fruit:'Mango', count:3000, visibility: false, color: '#5A9A77' },
{ fruit:'Orange', count:2300, visibility: true, color: '#498770' },
{ fruit:'Banana', count:500, visibility: false, color: '#39776C' },
{ fruit:'Grape', count:4300, visibility: true, color: '#266665' },
{ fruit:'Papaya', count:1200, visibility: false, color: '#124F5E' }
]}
weightValuePath= 'count'
colorValuePath='color'
palette= {[]}
legendSettings= {{
visible: true,
showLegendPath: 'visibility'
}}
leafItemSettings= {{
labelPath: 'fruit',
}}>
<Inject services={[TreeMapLegend]} />
</TreeMapComponent> );
}
}
ReactDOM.render(<App />, document.getElementById('treemap'));To show the legend text based on binding, the field name in the datasource should be set to the valuePath property in legendSettings.
The following code example shows how to show legend item text based on data source value.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { TreeMapComponent, Inject, TreeMapLegend } from '@syncfusion/ej2-react-treemap';
class App extends React.Component {
render() {
return ( <TreeMapComponent id='treemap'
dataSource={[
{ fruit:'Apple', count:5000, visibility: true , color: '#71B081' },
{ fruit:'Mango', count:3000, visibility: false, color: '#5A9A77' },
{ fruit:'Orange', count:2300, visibility: true, color: '#498770' },
{ fruit:'Banana', count:500, visibility: false, color: '#39776C' },
{ fruit:'Grape', count:4300, visibility: true, color: '#266665' },
{ fruit:'Papaya', count:1200, visibility: false, color: '#124F5E' }
]}
weightValuePath= 'count'
colorValuePath='color'
palette= {[]}
legendSettings= {{
visible: true,
valuePath: 'fruit'
}}
leafItemSettings= {{
labelPath: 'fruit',
}}>
<Inject services={[TreeMapLegend]} />
</TreeMapComponent> );
}
}
ReactDOM.render(<App />, document.getElementById('treemap'));To enable or disable the duplicate legend items, set the removeDuplicateLegend property to true in legendSettings.
The following code example shows how to hide duplicate legend items based on data source value.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { TreeMapComponent, Inject, TreeMapLegend } from '@syncfusion/ej2-react-treemap';
class App extends React.Component {
render() {
return ( <TreeMapComponent id='treemap'
dataSource={[
{ fruit:'Apple', count:5000, visibility: true , color: '#71B081' },
{ fruit:'Grape', count:3000, visibility: false, color: '#5A9A77' },
{ fruit:'Apple', count:2300, visibility: true, color: '#498770' },
{ fruit:'Banana', count:500, visibility: false, color: '#39776C' },
{ fruit:'Grape', count:4300, visibility: true, color: '#266665' },
{ fruit:'Papaya', count:1200, visibility: false, color: '#124F5E' }
]}
weightValuePath= 'count'
colorValuePath='color'
palette= {[]}
legendSettings= {{
visible: true,
valuePath: 'fruit',
removeDuplicateLegend: true
}}
leafItemSettings= {{
labelPath: 'fruit',
}}>
<Inject services={[TreeMapLegend]} />
</TreeMapComponent> );
}
}
ReactDOM.render(<App />, document.getElementById('treemap'));