Methods

This section describes methods that can be called to manipulate the TreeMap widget.

beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

clearSelection()

Deselects all nodes in the widget.

To deselect a particular node, call its select(state) method.

drillUp()

Drills one level up.

To learn how to implement the drill down functionality, see the drillDown() method description.

element()

Gets the root element of the widget.

Return Value: jQuery

The root element of the widget.

See Also

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

exportTo(fileName, format)

Exports the widget into a document with a specified name and format.

Parameters:
fileName: String

The name of a destination file.

format: String

A required format.
Accepted Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'

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

getCurrentNode()

Returns the current node.

Return Value: TreeMap Node

The current node.

NOTE
If the drill down feature is not implemented, this method returns the root node.
See Also

getDataSource()

Returns the DataSource instance.

Return Value: DataSource

The DataSource instance.

NOTE
This method returns the DataSource instance even if the dataSource option of the widget was given a simple array.
See Also

getRootNode()

Returns the root node.

Return Value: TreeMap Node

The root node.

See Also

getSize()

Gets the current size of the widget.

Return Value: Object

The current size of the widget.

Returns an object with the following fields.

  • width
    The width of the widget in pixels.
  • height
    The height of the widget in pixels.
See Also

hideLoadingIndicator()

Conceals the loading indicator.

Although the loading indicator hides automatically when the widget is ready, you can hide it from code at the required time using the hideLoadingIndicator() method.

If you need to show the loading indicator, invoke the showLoadingIndicator() method.

See Also

hideTooltip()

Hides the tooltip.

Use this and showTooltip() methods to change the visibility of the tooltip programmatically.

See Also

instance()

Returns this widget's instance. Use it to access other methods of the widget.

Return Value: Object

This widget's instance.

See Also

off(eventName)

Detaches all event handlers from the specified event.

Parameters:
eventName: String

The name of the event to unsubscribe from.

Return Value: Object

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

Parameters:
eventName: String

The name of the event to unsubscribe from.

eventHandler: function

The handler to be detached from the specified event.

Return Value: Object

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to a specified event.

Parameters:
eventName: String

The name of the event to be subscribed.

eventHandler: function

An event handler for the specified event.

Return Value: Object

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also

on(events)

Subscribes to the specified events.

Parameters:
events: Object

An object of the following structure: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value: Object

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

option()

Gets the widget's options.

Return Value: Object

The widget's options.

See Also

option(optionName)

Gets a specific option value.

Parameters:
optionName: String

The option name or the full path to the option.

Return Value: any

This option value.

See Also

option(optionName, optionValue)

Assigns a new value to a specific option.

Parameters:
optionName: String

The option name or the full path to the option.

optionValue: any

A new value for this option.

See Also

option(options)

Sets one or more options.

Parameters:
options: Object

The options along with their new values.

See Also

print()

Opens the browser's print window.

See Also

render()

Redraws the widget.

Normally, the widget will redraw itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, e.g., after the widget container is resized. For this purpose, call the render() method.

See Also

resetDrillDown()

Resets the drill down level.

Calling this method makes the root level the current one. If you need to drill one level up or down, use the drillUp() method of the widget or the drillDown() method of a node.

See Also

showLoadingIndicator()

Displays the loading indicator.

This method shows the loading indicator. To hide it, call the hideLoadingIndicator() method.

See Also

svg()

Returns the widget's SVG markup.

Return Value: String

The widget's SVG markup.

See Also