Methods and Events

20 Jun 201811 minutes to read

Method

refresh()

refresh() method is used to reload the treemap with updated values.

Returns: void

JS

//refresh method for treemap
   $("#container").ejTreeMap("refresh");

Events

treeMapItemSelected

treeMapItemSelected event will trigger when treemap item is selected.

Name	Type	Description
HTML originalEvent	object	Returns selected treeMapItem object.

JS

//treemap item selected event for treemap
  $("#container").ejTreeMap({
   treeMapItemSelected: function () {}
  });

drillStarted

drillStarted event will fire, when the drilldown action is started in the treemap control.

Name	Type	Description
HTML originalEvent	object	Returns selected drilled treeMap object.

JS

//drillStarted event for treemap
  $("#container").ejTreeMap({
   drillStarted: function () {}
  });

drillDownItemSelected

If the treemap drilldown item is selected, then drillDownItemSelected event will fire.

Name	Type	Description
HTML originalEvent	object	Returns selected drilldown treeMap object.

JS

//drillDownItemSelected event for treemap
  $("#container").ejTreeMap({
   drillDownItemSelected: function () {}
  });

headerTemplateRendering

headerTemplateRendering event will fire before rendering the treemap drilldown header template.

Name	Type	Description
HTML originalEvent	object	Returns drilldown header.

JS

//headerTemplateRendering event for treemap
  $("#container").ejTreeMap({
   headerTemplateRendering: function () {}
  });

refreshed

refreshed event will trigger after refreshing the treemap control with updated values.

Name	Type	Description
HTML originalEvent	object	Refresh and load the treemap.

JS

//refreshed event for treemap
  $("#container").ejTreeMap({
   refreshed: function () {}
  });

treeMapGroupSelected

treeMapGroupSelected event will fired when the group selection is performed on treemap items.

Name	Type	Description
HTML originalEvent	object	Returns the selected group of treeMapItems as object.

JS

//treeMapGroupSelected event for treemap
  $("#container").ejTreeMap({
   treeMapGroupSelected: function () {}
  });

itemRendering

itemRendering event will trigger while rendering each item in treemap.

Name	Type	Description
HTML originalEvent	object	Returns each leaf items in treemap

JS

//item rendering event for treemap
  $("#container").ejTreeMap({
   itemRendering: function () {}
  });

legendItemRendering

legendItemRendering event will trigger while rendering each legend item in treemap.

Name	Type	Description
HTML originalEvent	object	Returns each legend item in treemap

JS

//legend item rendering event for treemap
  $("#container").ejTreeMap({
   legendItemRendering: function () {}
  });

Click

click event will trigger while clicking an item in the treemap.

Name	Type	Description
HTML originalEvent	object	Returns the clicked group of treeMapItems as object.

JS

//Click event for tree map

 $("#container").ejTreeMap({

    click: function (args) {
              //Do something
    }
   
});

doubleClick

doubleClick event will trigger while double clicking an item in the treemap.

Name	Type	Description
HTML originalEvent	object	Returns the double clicked group of treeMapItems as object.

JS

//DoubleClick event for tree map

 $("#container").ejTreeMap({

    doubleClick: function (args) {
              //Do something
    }
   
});

rightClick

rightClick event will trigger while right clicking an item in the treemap.

Name	Type	Description
HTML originalEvent	object	Returns the right clicked group of treeMapItems as object.

JS

//RightClick event for tree map

 $("#container").ejTreeMap({
    rightClick: function (args) {
              //Do something
    }
   
});