jQuery Sankey Methods

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

format:

The file's format. One of 'PNG', 'PDF', 'JPEG', 'SVG' and 'GIF'.
PNG is used if the browser does not support exporting to the specified format.

NOTE

Safari on Mac OS does not implement an API for saving files, but you can set up a server-side proxy.

View Demo

getAllLinks()

Gets all sankey links.

Return Value:

Array<Link>

A collection of Link objects.

getAllNodes()

Gets all sankey nodes.

Return Value:

Array<Node>

A collection of Node objects.

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE

This method returns the DataSource instance even if the widget's dataSource option was given a simple array.

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:

element:

DOM Node

|

jQuery

The widget's container.

Return Value:

The widget's instance.

getInstance is a static method that the widget class supports. The following code demonstrates how to get the Sankey instance found in an element with the mySankey ID:

// Modular approach
import Sankey from "devextreme/viz/sankey";
...
let element = document.getElementById("mySankey");
let instance = Sankey.getInstance(element) as Sankey;

// Non-modular approach
let element = document.getElementById("mySankey");
let instance = DevExpress.viz.dxSankey.getInstance(element);

getSize()

Gets the current widget size.

Return Value:

Size

The current widget size.

Returns an object with the following fields.

width
The width of the widget in pixels.
height
The height of the widget in pixels.

hideLoadingIndicator()

Hides the loading indicator.

Although the loading indicator hides automatically once the widget is ready, you can hide it from code at the required moment using this method.

hideTooltip()

Hides all widget tooltips.

instance()

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

Return Value:

This widget's instance.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

The object for which this method is called.

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

on(events)

Subscribes to events.

Parameters:

events:

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

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.

option()

Gets all widget options.

Return Value:

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:

optionName:

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:

optionName:

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:

options:

Options with their new values.

print()

Opens the browser's print window.

View Demo

render()

Redraws the widget.

Normally, the widget redraws itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, for example, after the widget's container is resized. For this purpose, call the render() method.

showLoadingIndicator()

Shows the loading indicator.

svg()

Gets the widget's SVG markup.

Return Value: