Configuration

This section describes properties that configure the contents, behavior and appearance of the TreeMap widget.

childrenField

Specifies the name of the data source field that provides nested items for a group. Applies to hierarchical data sources only.

Type:

String

Default Value: 'items'

In hierarchical data sources, objects normally have at least one nested array of objects. To specify the field providing this array, assign its name to the childrenField option. Such hierarchical objects will be visualized by groups of tiles.

See Also
  • dataSource - specifies the origin of data for the widget.
  • valueField - specifies the data source field that provides values for tiles.
  • labelField - specifies the data source field that provides texts for tile and group labels.

colorField

Specifies the name of the data source field that provides colors for tiles.

Type:

String

Default Value: 'color'

There are several approaches to colorizing tiles.

  • Colorizing each tile uniquely into the color specified directly in the data object.
  • Colorizing tiles using the colorizer.
  • Specifying a single color for all tiles using the tile.color option.

You can use the first approach only if objects of your data source contain a field providing colors. If so, assign the name of this field to the colorField option. The colors must have one of the following formats:

This approach has the highest priority among the others. To get familiar with the other two approaches, see the colorizer and tile.color option descriptions.

colorizer

Manages the color settings.

Type:

Object

There are several approaches to colorizing tiles.

  • Colorizing each tile uniquely into the color specified directly in the data object.
  • Colorizing tiles using the colorizer.
  • Specifying a single color for all tiles using the tile.color option.

If for some reason you cannot use the first approach, colorize tiles using the colorizer object. It offers three colorization algorithms: "discrete", "gradient" and "range". For more information on how to use each algorithm, refer to the type option description.

To find out how else you can colorize tiles, see the colorField and tile.color option descriptions.

View Demo Watch Video

dataSource

Specifies the origin of data for the widget.

Cannot be used in themes.

This option accepts one of the following.

  • Array of objects
    A simple JavaScript array containing a collection of plain objects.

  • URL
    A URL to JSON data or to a service returning data in JSON format.

  • DataSource or its configuration object
    A DataSource is an object that provides a handy API for data processing. A DataSource is a stateful object, which means that it saves data processing settings and applies them each time data is loaded. All underlying data access logic of a DataSource is isolated in a Store. A Store provides an API for reading and modifying data. Unlike the DataSource, a Store is a stateless object.

NOTE
Data field names should not contain the following characters: ., ,, :, [, and ]. Their presence may cause issues in the widget's operation.

Basically, all data providers contain data objects. Objects that have a plain structure are visualized by tiles. For example, the following data source produces four individual tiles.

JavaScript
var treeMapOptions = {
    // ...
    dataSource: [
        { name: 'Apples', value: 10 },
        { name: 'Oranges', value: 13 },
        { name: 'Cucumbers', value: 4 },
        { name: 'Tomatoes', value: 8 }
    ]    
};

Hierarchically-structured objects are visualized by groups of tiles. For example, the following data source arranges the tiles from the previous code snippet in two groups: "Fruits" and "Vegetables".

JavaScript
var treeMapOptions = {
    // ...
    dataSource: [{
        name: 'Fruits',
        items: [
            { name: 'Apples', value: 10 },
            { name: 'Oranges', value: 13 }
        ]
    }, {
        name: 'Vegetables',
        items: [
            { name: 'Cucumbers', value: 4 },
            { name: 'Tomatoes', value: 8 }
        ]
    }] 
};

After providing data, bind it to the widget using the valueField, labelField and childrenField options.

In certain cases, you may have a plain data source that implies a hierarchical structure. For example, the following code declares such a data source. Nevertheless, it will be visualized in the same manner as the data source from the code snippet above.

JavaScript
var treeMapOptions = {
    // ...
    dataSource: [
        { id: 1, name: 'Fruits'},
        { parent: 1, name: 'Apples', value: 10 },
        { parent: 1, name: 'Oranges', value: 13 },

        { id: 2, name: 'Vegetables' },
        { parent: 2, name: 'Cucumbers', value: 4 },
        { parent: 2, name: 'Tomatoes', value: 8 }
    ],
    idField: 'id',
    parentField: 'parent'
};

Note that in this data source, objects that have children have the "id" field whose value is unique. Their children have the "parent" field pointing at the parent's ID. The "id" and "parent" fields can have other names, but in any case, they must be assigned to the idField and parentField options. Otherwise, you will get four individual tiles (as in the first code snippet) instead of two groups by two tiles. To specify the fields that provide values and labels, use the valueField and labelField options as well.

The examples above show how to provide data using an array of objects. If you are looking for a more powerful and versatile data solution, consider using the DataSource object. To learn how to implement a DataSource that serves your needs best, refer to the Data Source Examples article.

View hierarchical Data Structure Demo View Flat Data Structure Demo

Watch Video

See Also

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}
jQuery
$(function(){
    $("#treeMapContainer").dxTreeMap({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-tree-map ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-tree-map>
import { DxTreeMapModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxTreeMapModule
    ],
    // ...
})
ASP.NET MVC Control
Razor C#
Razor VB
@(Html.DevExtreme().TreeMap()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)
@(Html.DevExtreme().TreeMap() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

export

Configures the exporting and printing features.

Type:

Object

These features allow a user to export your widget into a document or print it. When exporting is enabled, the "Exporting/Printing" button appears in the widget. A click on it invokes a drop-down menu that lists exporting and printing commands. The following formats are supported for exporting into: PNG, PDF, JPEG, SVG and GIF.

NOTE
Safari on Mac OS does not implement an API for saving files. Therefore, exporting in these browsers requires setting up a server-side proxy. For details, refer to the proxyUrl option description.
See Also

Watch Video

group

Configures groups.

Type:

Object

A group is an element that collects several tiles in it. In terms of data, it is a node that has children in the current context. Groups appear only if the data source implies a hierarchical structure.

The following list provides an overview of group features that you can configure using the group object.

  • Labels
    Each group is identified by a label. Its appearance can be changed using the fields of the label object. If the group's width is too small, the label will be hidden.
  • Headers' Height
    Group headers contain labels. To specify the height of the group headers, use the headerHeight option.
  • Color
    There are several approaches to colorizing the group headers. Refer to the color option description to find information about all of them.
  • Hover and Selection Styles
    A group can be in the hover or selected state. In these states, its style changes to the one specified by the hoverStyle or selectionStyle object respectively. A group can also enter the hover or selected state when a nested tile enters it. To enable this feature, assign true to the interactWithGroup option of the root configuration object.
  • Border's Appearance
    Specify the fields of the border object to configure group borders.

An object assigned to the group field configures all groups in the widget. To customize a specific group, pass a similar object to the customize(options) method of the node represented by the group.

hoverEnabled

Specifies whether tiles and groups change their style when a user pauses on them.

Type:

Boolean

Default Value: undefined
NOTE
When the user pauses on a group, not only the group changes its style, but also tiles that belong to that group. However, the isHovered() method, which checks the tiles' state, will return false although visually they have entered the hover state.
See Also

idField

Specifies the name of the data source field that provides IDs for items. Applies to plain data sources only.

Type:

String

Default Value: undefined

In certain cases, you may have a plain data source that implies a hierarchical structure. For example, the following code declares a data source that, despite being plain, can be rearranged into a hierarchy of two groups with two items in each.

JavaScript
var treeMapOptions = {
    // ...
    dataSource: [
        // Group 1
        { id: 1, name: 'Fruits'},
        { parent: 1, name: 'Apples', value: 10 },
        { parent: 1, name: 'Oranges', value: 13 },

        // Group 2
        { id: 2, name: 'Vegetables' },
        { parent: 2, name: 'Cucumbers', value: 4 },
        { parent: 2, name: 'Tomatoes', value: 8 }
    ]
};

Note that in this data source, objects that have children have the "id" field whose value is unique. Their children have the "parent" field pointing at the parent's ID. The "id" and "parent" fields can have other names, but in any case, they must be assigned to the idField and parentField options.

JavaScript
var treeMapOptions = {
    // ...
    idField: 'id',
    parentField: 'parent'
};

View Demo

interactWithGroup

Specifies whether the user will interact with a single tile or its group.

Type:

Boolean

Default Value: false

By default, the click, hoverChanged and selectionChanged events are fired for the tile that has been clicked, paused on or selected. If you need these events to be passed on to the parent group of the tile, set the interactWithGroup option to true. This setting impacts appearance as well. For example, when the user pauses on a tile, the whole group to which the tile belongs will apply the hover style.

labelField

Specifies the name of the data source field that provides texts for tile and group labels.

Type:

String

Default Value: 'name'

Each tile or group of tiles is accompanied by a text label. Usually, a label displays the name of the tile or the group. However, you can put any desired text into it. For this purpose, call the label(label) method of the node whose label must be changed. You can call this method, for example, when all nodes are initialized or when they are being rendered.

If you need to change the appearance of all labels, use the tile.label and group.label objects. To change the appearance of a particular label, use the customize(options) function of the node to which the label belongs.

See Also
  • dataSource - specifies the origin of data for the widget.
  • valueField - specifies the data source field that provides values for tiles.
  • childrenField - specifies the data source field that provides nested items for a group.

layoutAlgorithm

Specifies the layout algorithm.

Type:

String

|

Function

Function parameters:
e:

Object

Data for implementing a custom layout algorithm.

Object structure:
rect:

Array<Number>

The rectangle available for subdivision.
Contains the X and Y coordinates of two diagonally-opposite points in the following format: [x1, y1, x2, y2].

sum:

Number

The sum total value of all nodes on the current level.

items:

Array<any>

A set of items to distribute. Each object in this array contains the value and rect fields.
By default, rect is undefined. It must be assigned an array of the following format: [x1, y1, x2, y2], where (x1, y1) and (x2, y2) are coordinates of two diagonally-opposite points defining a rectangle.

Default Value: 'squarified'
Accepted Values: 'sliceanddice' | 'squarified' | 'strip'

Layout algorithms determine the position and size of tiles and groups. Therefore, the chosen algorithm plays the definitive role in the resulting look of the widget. TreeMap provides the following algorithms out of the box.

  • Squarified
    This algorithm lays the items out so that the aspect ratio will be closer to 1. In other words, this algorithm tries to make items as square as possible.

    For more information about this algorithm, refer to the Squarified Treemaps paper.

  • Strip
    This algorithm is a modification of the "Squarified" algorithm. At the beginning, the algorithm has an available area divided into several strips and a set of items to distribute between the strips. Throughout the layout process, a current strip is maintained. For each item to be arranged, the algorithm checks whether or not adding the item to the current strip improves the average aspect ratios of the rectangles in the current strip. If so, the item is added to the current strip. Otherwise, it is added to the next strip.

    The direction of the strips depends on the size of the available area. If the width is greater than the height, the strips are lined up horizontally. If vice versa, vertically.

    For more information on this algorithm, see the Ordered and Quantum Treemaps: Making Effective Use of 2D Space to Display Hierarchies paper.

  • Slice and Dice
    This algorithm uses parallel lines to divide an available area into rectangles representing items. In case of a hierarchical structure, each rectangle representing an item is divided once more into smaller rectangles representing its children, and so on.

    To learn more about this algorithm, refer to the Tree Visualization with Tree-Maps: a 2D Space-Filling Approach paper.

DevExpress DevExtreme HTML5 TreeMap Squarified SliceAndDice Strip

If none of the predefined algorithms satisfy your needs, implement your own algorithm. For this purpose, assign a function to the layoutAlgorithm option. Basically, this function should calculate the coordinates of two diagonally-opposite points defining a rectangle and assign them to the needed item. To access a set of items to distribute, use the items field of the function's parameter. All available fields of the parameter are listed in the header of this description.

JavaScript
var treeMapOptions = {
    // ...
    layoutAlgorithm: function (e) {
        // ...
        e.items.forEach(function(item) {
            // ...
            // Calculating the rectangle for the current item here
            // ...
            item.rect = rectPoints;
        });
    }
};

In addition, you can change the layout direction. For this purpose, use the layoutDirection option.

Use the TreeMapLayoutAlgorithm enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Squarified, Strip, and SliceAndDice.

View Demo

layoutDirection

Specifies the direction in which the items will be laid out.

Type:

String

Default Value: 'leftTopRightBottom'
Accepted Values: 'leftBottomRightTop' | 'leftTopRightBottom' | 'rightBottomLeftTop' | 'rightTopLeftBottom'

The value of this option determines the start and end point of the layout. See the image below to spot the difference between the available layout directions.

DevExpress DevExtreme HTML5 TreeMap LayoutDirection

NOTE
If you use a custom layout algorithm, this option will be ignored.

Use the TreeMapLayoutDirection enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: LeftTopRightBottom, LeftBottomRightTop, RightTopLeftBottom, and RightBottomLeftTop.

loadingIndicator

Configures the loading indicator.

Type:

Object

When the widget visualizes local data, loading is instant. But when the widget is bound to a remote data source, loading may takes a considerable amount of time. To keep the viewer's attention, the widget can display a loading indicator.

DevExtreme HTML5 Charts LoadingIndicator

To activate the loading indicator, assign true to the loadingIndicator.show option. Once data is loaded, the loading indicator will be hidden automatically.

See Also

maxDepth

Specifies how many hierarchical levels must be visualized.

Type:

Number

Default Value: undefined

If you have a structure with deep nesting level, displaying all levels at once produces visual clutter. To reduce it, specify the number of levels that can be visualized at a time using the maxDepth property.

DevExpress DevExtreme HTML5 TreeMap

When you set this option, data that occupies the lowest levels may become unavailable to the user. For such cases, implement the drill down feature.

onClick

A function that is executed when a node is clicked or tapped.

Type:

Function

|

String

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

The clicked node; described in the Node section.

Default Value: null
Cannot be used in themes.

This function is often used to implement item selection as shown in the following code:

jQuery
JavaScript
$(function () {
    $("#treeMapContainer").dxTreeMap({
        // ...
        onClick: function (e) {
            e.node.select(!e.node.isSelected());
        }
    });
});
Angular
HTML
TypeScript
<dx-tree-map ...
    (onClick)="selectItem($event)">
</dx-tree-map>
import { DxTreeMapModule } from "devextreme-angular";
// ...
export class AppComponent {
    selectItem (e) {
        e.node.select(!e.node.isSelected());
    }
}
@NgModule({
    imports: [
        // ...
        DxTreeMapModule
    ],
    // ...
})

To identify whether the clicked node is a single tile or a group of tiles, use the node's isLeaf() method.

onDisposing

A function that is executed before the widget is disposed of.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onDrawn

A function that is executed when the widget's rendering has finished.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null
Cannot be used in themes.

onDrill

A function that is executed when a user drills up or down.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

The Node object.

Default Value: null
Cannot be used in themes.

Although not provided out-of-the-box, the drill down capability is easy to implement using the API methods. Learn how to do this from the drillDown() method description.

View Demo Watch Video

onExported

A function that is executed after the widget is exported.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onExporting

A function that is executed before the widget is exported.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

fileName:

String

The name of the file to which the widget is about to be exported.

cancel:

Boolean

Allows you to prevent exporting.

format:

String

The resulting file format. One of PNG, PDF, JPEG, SVG and GIF.

Default Value: null

onFileSaving

A function that is executed before a file with exported widget is saved to the user's local storage.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

fileName:

String

The name of the file to be saved.

format:

String

The format of the file to be saved.
Possible Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'

data:

BLOB

Exported data as a BLOB.

cancel:

Boolean

Allows you to prevent file saving.

Default Value: null

onHoverChanged

A function that is executed after the pointer enters or leaves a node.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

The node whose hover state has been changed; described in the Node section.

Default Value: null
Cannot be used in themes.

To identify whether the pointer has entered or left the node, call the node's isHovered() method. To identify whether the node is a single tile or a group of tiles, use the node's isLeaf() method.

onIncidentOccurred

A function that is executed when an error or warning occurs.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

target: any

Information on the occurred incident.

Default Value: null

The widget notifies you of errors and warnings by passing messages to the browser console. Each message contains the incident's ID, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found.

The onIncidentOccurred function allows you to handle errors and warnings the way you require. The object passed to it contains the target field. This field provides information about the occurred incident and contains the following properties:

  • id
    The incident's ID. The full list of IDs can be found in the Errors and Warnings section.
  • type
    The incident's type: "error" or "warning".
  • args
    The argument of the incident's message. Depends on the incident. For example, it may be the name of the data source field that was specified incorrectly, or the name of the option that was not set properly.
  • text
    The text passed to the browser's console. Includes the args content, if there is any.
  • widget
    The name of the widget that produced the error or warning.
  • version
    The used DevExtreme version.

onInitialized

A function that is executed only once, after the widget is initialized.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

You cannot access widget elements in this function because it is executed before they are ready. Use the onDrawn function instead.

onNodesInitialized

A function that is executed only once, after the nodes are initialized.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

The root node; described in the Node section.

Default Value: null
Cannot be used in themes.

Use this function to change the node structure. The root node is available via the root field of the function's parameter. Using the root node's getAllNodes(), getAllChildren() and getChild(index) methods, you can access any other node.

onNodesRendering

A function that is executed before the nodes are displayed and each time the collection of active nodes is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

In most cases, the root node. When drilling down, the node of the highest displayed level.
Described in the Node section.

Default Value: null
Cannot be used in themes.

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onSelectionChanged

A function that is executed when a node is selected or the selection is canceled.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TreeMap

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

The node whose selection state has been changed; described in the Node section.

Default Value: null
Cannot be used in themes.

To identify whether the selection has been applied or canceled, call the node's isSelected() method. To identify whether the clicked node is a single tile or a group of tiles, use the node's isLeaf() method.

parentField

Specifies the name of the data source field that provides parent IDs for items. Applies to plain data sources only.

Type:

String

Default Value: undefined

In certain cases, you may have a plain data source that implies a hierarchical structure. For example, the following code declares a data source that, despite being plain, can be rearranged into a hierarchy of two groups with two items in each.

JavaScript
var treeMapOptions = {
    // ...
    dataSource: [
        // Group 1
        { id: 1, name: 'Fruits'},
        { parent: 1, name: 'Apples', value: 10 },
        { parent: 1, name: 'Oranges', value: 13 },

        // Group 2
        { id: 2, name: 'Vegetables' },
        { parent: 2, name: 'Cucumbers', value: 4 },
        { parent: 2, name: 'Tomatoes', value: 8 }
    ]
};

Note that in this data source, objects that have children have the "id" field whose value is unique. Their children have the "parent" field pointing at the parent's ID. The "id" and "parent" fields can have other names, but in any case they must be assigned to the idField and parentField options.

JavaScript
var treeMapOptions = {
    // ...
    idField: 'id',
    parentField: 'parent'
};

View Demo

pathModified

Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path.

Type:

Boolean

Default Value: false
Cannot be used in themes.

If you place the widget on a page that uses a tag modifying the path (<base>, <iframe>, etc.), some of the widget elements may get mixed up or disappear. To solve this problem, set the pathModified option to true.

See Also

redrawOnResize

Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates.

Type:

Boolean

Default Value: true
Cannot be used in themes.

When this option is set to true, the widget will be redrawn automatically in case the size of its parent window changes.

NOTE
To redraw the widget after the size of its container has changed, call the render() method of the widget's instance.

resolveLabelOverflow

Decides whether those labels that overflow their tile/group should be hidden or truncated with ellipsis.

Type:

String

Default Value: 'hide'
Accepted Values: 'ellipsis' | 'hide'

Use the TreeMapResolveLabelOverflow enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Hide and Ellipsis.

View Demo

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false
Cannot be used in themes.

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});

selectionMode

Specifies whether a single or multiple nodes can be in the selected state simultaneously.

Type:

String

Default Value: undefined
Accepted Values: 'multiple' | 'none' | 'single'

In a single mode, only one node can be in the selected state at one moment. When the user selects another node, the formerly selected node becomes unselected. In a multiple mode, any number of nodes can be in the selected state.

To implement selection, assign the following or similar callback function to the onClick option.

JavaScript
var treeMapOptions = {
    // ...
    onClick: function (e) {
        e.node.select(!e.node.isSelected());
    }    
};

When entering the selected state, a tile or a group of tiles changes its appearance. You can configure it using the group | selectionStyle and tile.selectionStyle objects.

To control the selection feature in code, use the isSelected, select(state) and clearSelection() methods. In addition, you can perform certain actions when a node enters/leaves the selected state. For this purpose, implement the onSelectionChanged event handler.

Use the SelectionMode enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: None, Single and Multiple.

size

Specifies the widget's size in pixels.

Type:

Object

Default Value: undefined

The widget occupies its container's entire area by default. Use the size object to specify the widget's size if it should be different from that of its container. Assign 0 to size object's height and width options to hide the widget.

theme

Sets the name of the theme the widget uses.

Type:

String

Default Value: 'generic.light'
Accepted Values: 'generic.dark' | 'generic.light' | 'generic.contrast' | 'ios7.default' | 'generic.carmine' | 'generic.darkmoon' | 'generic.darkviolet' | 'generic.greenmist' | 'generic.softblue' | 'material.blue.light' | 'material.lime.light' | 'material.orange.light' | 'material.purple.light' | 'material.teal.light'

A theme is a widget configuration that gives the widget a distinctive appearance. Use can use one of the predefined themes or create a custom one. Changing the option values in the widget's configuration object overrides the theme's corresponding values.

NOTE
The following themes were deprecated or renamed: 'desktop', 'desktop-dark', 'android', 'android-holo-light', *android5.light*, 'ios', 'win8', 'win8-white', 'win8.white', 'win8.black', 'win10.white', 'win10.black'. In new applications, use themes listed in the accepted values.

Use the VizTheme enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: GenericLight, GenericDark, GenericContrast, GenericCarmine, GenericDarkMoon, GenericSoftBlue, GenericDarkViolet, GenericGreenMist, IOS7Default, MaterialBlueLight, MaterialLimeLight, MaterialOrangeLight, MaterialPurpleLight, MaterialTealLight.

tile

Configures tiles.

Type:

Object

A tile is a rectangle representing a node that has no children in the current context. Several tiles can be collected into a group if the data source implies a hierarchical structure.

The following list provides an overview of tiles' features that you can configure using the tile object.

  • Labels
    Each tile is identified by a label. Its appearance can be changed using the fields of the label object. If the tile's area is too small, the label will be hidden.
  • Color
    There are several approaches to colorizing the tiles. Refer to the color option description to find information about all of them.
  • Hover and Selection Styles
    A tile can be in the hover or selected state. In these states, its style changes to the one specified by the hoverStyle or selectionStyle object respectively. Along with the tile, its parent group can enter the hover or selected state. To enable this feature, assign true to the interactWithGroup option of the root configuration object.
  • Border's Appearance
    Specify the fields of the border object to configure the tile borders.

An object assigned to the tile field configures all tiles in the widget. To customize a specific tile, pass a similar object to the customize(options) method of the node represented by the tile.

title

Configures the widget's title.

Type:

Object

|

String

The widget's title is a short text that usually indicates what is visualized. If you need to specify the title's text only, assign it directly to the title option. Otherwise, set this option to an object with the text and other fields specified.

The title can be accompanied by a subtitle elaborating on the visualized subject using the title.subtitle object.

tooltip

Configures tooltips - small pop-up rectangles that display information about a data-visualizing widget element being pressed or hovered over with the mouse pointer.

Type:

Object

valueField

Specifies the name of the data source field that provides values for tiles.

Type:

String

Default Value: 'value'
See Also
  • dataSource - specifies the origin of data for the widget.
  • childrenField - specifies the data source field that provides nested items for a group.
  • labelField - specifies the data source field that provides texts for tile and group labels.