Events

This section describes events fired by this widget.

See Also

click

Raised when a node is clicked or tapped.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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

Use 'event' instead.

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.

node

TreeMap Node

The clicked node; described in the Node section.

Cannot be used in themes.

Main article: onClick

See Also

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TreeMap

The widget 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.

Main article: onDisposing

See Also

drawn

Raised when the widget's rendering has finished.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.

Cannot be used in themes.

Main article: onDrawn

See Also

drill

Raised when a user drills up or down.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.

node

TreeMap Node

The Node object.

Cannot be used in themes.

Main article: onDrill

See Also

exported

Raised after the widget is exported.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.

Main article: onExported

See Also

exporting

Raised before the widget is exported.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.

Main article: onExporting

See Also

fileSaving

Raised before a file with exported widget is saved to the user's local storage.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.

Main article: onFileSaving

See Also

hoverChanged

Raised after the pointer enters or leaves a node.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.

node

TreeMap Node

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

Cannot be used in themes.

Main article: onHoverChanged

See Also

incidentOccurred

Raised when an error or warning occurs.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.

Main article: onIncidentOccurred

See Also

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.

Main article: onInitialized

See Also

nodesInitialized

Raised only once, after the nodes are initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.

root

TreeMap Node

The root node; described in the Node section.

Cannot be used in themes.

Main article: onNodesInitialized

See Also

nodesRendering

Raised before the nodes are displayed and each time the collection of active nodes is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.

node

TreeMap Node

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

Cannot be used in themes.

Main article: onNodesRendering

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.

Main article: onOptionChanged

See Also

selectionChanged

Raised when a node is selected or the selection is canceled.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.

node

TreeMap Node

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

Cannot be used in themes.

Main article: onSelectionChanged

See Also