ej2-vue-ui-components/components/treemap

Vue TreeMap Component

The Vue TreeMap component provides a simple and effective way to visualize flat or hierarchical data as clustered rectangles with a specific, weighted attribute determining the size of each rectangle.

Getting started . Online demos . Learn more

Trusted by the world's leading companies

Setup

Create a Vue Application

You can use Vue CLI to setup your Vue 2 applications. To install Vue CLI, use the following commands.

npm install -g @vue/cli
vue create quickstart
cd quickstart
npm run serve

Initiating a new project prompts us to choose the type of project to be used for the current application. Select the option Default ([Vue 2] babel, eslint) from the menu.

Add Syncfusion TreeMap package

All Syncfusion Vue packages are published in npmjs.com registry. To install Vue TreeMap package, use the following command.

npm install @syncfusion/ej2-vue-treemap --save

Register TreeMap Component

You can register the TreeMap component in your application by using the Vue.use(). Refer to the code example given below.

import { TreeMapPlugin } from '@syncfusion/ej2-vue-treemap';

Vue.use(TreeMapPlugin);

Registering TreeMapPlugin in Vue, will register the TreeMap component along with its required child directives globally.

Add TreeMap Component

Add the Vue TreeMap by using ejs-treemap selector in template section of the App.vue file.

<template>
    <div id="app">
        <ejs-treemap :dataSource='data' weightValuePath='Count'
     :leafItemSettings='leafItemSettings'></ejs-treemap>
    </div>
</template>
<script>
    import Vue from 'vue';
    import { TreeMapPlugin } from '@syncfusion/ej2-vue-treemap';

    Vue.use(TreeMapPlugin);
    export default Vue.extend ({
	    data: function() {
		    return {
			    dataSource: [
					{ State: 'Brazil', Count: 25 },
					{ State: 'Colombia', Count: 12 },
					{ State: 'Argentina', Count: 9 },
					{ State: 'Ecuador', Count: 7 },
					{ State: 'Chile', Count: 6 },
					{ State: 'Peru', Count: 3 },
					{ State: 'Venezuela', Count: 3 },
					{ State: 'Bolivia', Count: 2 },
					{ State: 'Paraguay', Count: 2 },
					{ State: 'Uruguay', Count: 2 },
					{ State: 'Falkland Islands',Count: 1 },
					{ State: 'French Guiana', Count:1 },
					{ State: 'Guyana', Count: 1 },
					{ State: 'Suriname', Count: 1 },
				],
				leafItemSettings: { labelPath: 'State' }
			}
		}
	});
</script>

Refer the Getting Started with Vue3 topic for using Syncfusion Vue components in Vue 3 applications.

Supported frameworks

TreeMap component is also offered in the following list of frameworks.

JavaScript	Angular	React	ASP.NET Core	ASP.NET MVC

Showcase samples

• Olympic medal categories - Live Demo
• Countries population - Live Demo

Key features

• Data sources: Binds the treemap component with an array of JSON objects or DataManager. Both hierarchical and flat collection data sources are supported.
• Levels: Renders with any number of levels and items.
• Layout: Supports four types of layouts: square, horizontal, vertical, and auto.
• Drill-down: Provides drill-down option to have a closer look at the lower level of a hierarchy.
• Data label: Provides additional information about the nodes.
• Header template: Uses any custom HTML element to customize the header of each item.
• Label template: Uses any custom HTML element to customize the data label for each node.
• Color mapping: Applies colors to the nodes based on various conditions. Treemap supports three types of color mapping: range, equal, and desaturation.
• Legend: Provide useful information for conveying what the treemap showcases.
• Selection and highlight: Support selecting or highlighting the nodes to bring center of attraction.
• Tooltip: Provides additional information about the node on hover.
• Print and Export: Prints or exports the rendered treemap to a desired format. Exporting supports four formats: PDF, PNG, JPEG and SVG.
• Globalization: Personalize the component with different languages, as well as culture-specific number, date and time formatting.
• Accessibility: Provides with built-in accessibility support which helps to access all the treemap component features through the keyboard, screen readers, or other assistive technology devices.

Support

Product support is available through the following mediums.

• Support ticket - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support
• Community forum
• GitHub issues
• Request feature or report bug
• Live chat

Changelog

Check the changelog here. Get minor improvements and bug fixes every week to stay up to date with frequent updates.

License and copyright

This is a commercial product and requires a paid license for possession or use. Syncfusion’s licensed software, including this component, is subject to the terms and conditions of Syncfusion's EULA. To acquire a license for 80+ Vue UI components, you can purchase or start a free 30-day trial.

A free community license is also available for companies and individuals whose organizations have less than $1 million USD in annual gross revenue and five or fewer developers.

See LICENSE FILE for more info.

© Copyright 2022 Syncfusion, Inc. All Rights Reserved. The Syncfusion Essential Studio license and copyright applies to this distribution.