JavaScript/jQuery Sankey Options

See Also

• Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout

The adaptive layout enables the UI component to hide optional elements if they do not fit in the container. Elements are hidden in the following sequence:

1. Title
2. Export menu icon
3. Labels (can be saved by setting the adaptiveLayout.keepLabels property to true)

Use the height and width properties in the adaptiveLayout object to specify the minimum container size at which the layout begins to adapt.

A string value aligns all node columns uniformly. An array of strings allows you to align each node column individually. For example, the Sankey UI component contains four columns, and the alignment property is specified as follows:

$(function() {
    $("#sankeyContainer").dxSankey({
        // ...
        alignment: ["top", "bottom", "bottom"]
    });
});

<dx-sankey ...
    [alignment]="['top', 'bottom', 'bottom']">
</dx-sankey>

import { DxSankeyModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxSankeyModule
    ],
    // ...
})

<template>
    <DxSankey ... 
        :alignment="['top', 'bottom', 'bottom']">
    </DxSankey>
</template>

<script>
import DxSankey from 'devextreme-vue/sankey';

export default {
    components: {
        DxSankey
    }
}
</script>

import React from 'react';

import Sankey from 'devextreme-react/sankey';

const alignmentValues = [
    'top', 
    'bottom', 
    'bottom'
];

class App extends React.Component {
    render() {
        return (
            <Sankey ... 
                alignment={alignmentValues}>
            </Sankey>
        );
    }
}

export default App;     

With this setting, the leftmost node column is aligned to the top, and the next two columns are aligned to the bottom. The rightmost column does not have a value in the alignment array and is aligned to the center (according to the default value).

The Sankey works with collections of objects.

Depending on your data source, bind the Sankey to data as follows. In each case, also specify the sourceField, targetField, and weightField properties.

• Data Array
  Assign the array to the dataSource option. View Demo

• Read-Only Data in JSON Format
  Set the dataSource property to the URL of a JSON file or service that returns JSON data.

• OData
  Implement an ODataStore.

• Web API, PHP, MongoDB
  Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

  • DevExtreme.AspNet.Data
  • DevExtreme-PHP-Data
  • devextreme-query-mongodb

  Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

  jQuery

  JavaScript

  $(function() {
      let serviceUrl = "https://url/to/my/service";
      $("#sankeyContainer").dxSankey({
          // ...
          dataSource: DevExpress.data.AspNet.createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      })
  });

  Angular

  app.component.ts

  app.component.html

  app.module.ts

  import { Component } from '@angular/core';
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      store: CustomStore;
      constructor() {
          let serviceUrl = "https://url/to/my/service";
          this.store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      }
  }

  <dx-sankey ...
      [dataSource]="store">
  </dx-sankey>

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxSankeyModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxSankeyModule
      ],
      providers: [],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

  <template> 
      <DxSankey ...
          :data-source="store" />
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.common.css';
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import { DxSankey } from 'devextreme-vue/sankey';
  
  export default {
      components: {
          DxSankey
      },
      data() {
          const serviceUrl = "https://url/to/my/service";
          const store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          });
          return {
              store
          }
      }
  }
  </script>

  React

  App.js

  import React from 'react';
  import 'devextreme/dist/css/dx.common.css';
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import Sankey from 'devextreme-react/sankey';
  
  const serviceUrl = "https://url/to/my/service";
  const store = createStore({
      key: "ID",
      loadUrl: serviceUrl + "/GetAction",
      insertUrl: serviceUrl + "/InsertAction",
      updateUrl: serviceUrl + "/UpdateAction",
      deleteUrl: serviceUrl + "/DeleteAction"
  });
  
  class App extends React.Component {
      render() {
          return (
              <Sankey ...
                  dataSource={store} />
          );
      }
  }
  export default App;

• Any other data source
  Implement a CustomStore.

Regardless of the data source on the input, the Sankey always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

These features allow a user to export your UI component into a document or print it. When exporting is enabled, the "Exporting/Printing" button appears in the UI component. 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.

See Also

• exportTo(fileName, format)
• print()
• DevExpress.viz.exportWidgets(widgetInstances, options)

See Also

• node.hoverStyle
• link.hoverStyle
• onNodeHoverChanged
• onLinkHoverChanged

See Also

• Colorize Labels
• Customize Labels

See Also

• Customize Nodes and Links

When the UI component is bound to a remote data source, it can display a loading indicator while data is loading.

To enable the automatic loading indicator, set the enabled property to true.

If you want to change the loading indicator's visibility, use the show property or the showLoadingIndicator() and hideLoadingIndicator() methods.

See Also

• Customize Nodes and Links

See Also

• onExporting
• onFileSaving

See Also

• onExported
• onFileSaving

See Also

• onExporting
• onExported

The UI component 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 property 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 UI component that produced the error or warning.
• version
  The used DevExtreme version.

See Also

• Get a UI component Instance in Angular | AngularJS | Knockout | Vue | React

See Also

• link

See Also

• link.hoverStyle

See Also

• node

See Also

• node.hoverStyle

The following example shows how to subscribe to component property changes:

$(function() {
    $("#sankeyContainer").dxSankey({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<dx-sankey ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-sankey>

import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxSankeyModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxSankeyModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  

<template> 
    <DxSankey ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script> 
import 'devextreme/dist/css/dx.common.css'; 
import 'devextreme/dist/css/dx.light.css'; 
import DxSankey from 'devextreme-vue/sankey'; 

export default { 
    components: { 
        DxSankey
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 

import React from 'react'; 
import 'devextreme/dist/css/dx.common.css'; 
import 'devextreme/dist/css/dx.light.css'; 

import Sankey from 'devextreme-react/sankey'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Sankey ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

This property accepts either the name of a predefined palette or an array of colors. The array can include the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors

See Also

• Palettes
• paletteExtensionMode
• DevExpress.viz.generateColors(palette, count, options)

The following variants are available:

• "blend"
  Create a blend of two neighboring colors and insert it between these colors in the palette.

• "alternate"
  Repeat the full set of palette colors, alternating their normal, lightened, and darkened shades in that order.

• "extrapolate"
  Repeat the full set of palette colors, changing their shade gradually from dark to light.

View Demo

See Also

• Customize Nodes and Links

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

See Also

• DevExpress.viz.refreshPaths()

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

When this property is set to true, the UI component 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.

DevExpress.config({
    rtlEnabled: true
});

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

$(function() {
    $("#sankeyContainer").dxSankey({
        // ...
        size: {
            height: 300,
            width: 600
        }
    });
});

<dx-sankey ... >
    <dxo-size
        [height]="300"
        [width]="600">
    </dxo-size>
</dx-sankey>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxSankeyModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxSankeyModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxSankey ... >
        <DxSize
            :height="300"
            :width="600"
        />
    </DxSankey>
</template>

<script>

import DxSankey, {
    DxSize
} from 'devextreme-vue/sankey';

export default {
    components: {
        DxSankey,
        DxSize
    },
    // ...
}
</script>

import React from 'react';

import Sankey, {
    Size
} from 'devextreme-react/sankey';

class App extends React.Component {
    render() {
        return (
            <Sankey ... >
                <Size
                    height={300}
                    width={600}
                />
            </Sankey>
        );
    }
}
export default App;

Alternatively, you can style the UI component's container using CSS:

$(function() {
    $("#sankey").dxSankey({
        // ...
    });
});

#sankey {
    width: 85%;
    height: 70%;
}

<dx-sankey ...
    id="sankey">
</dx-sankey>

#sankey {
    width: 85%;
    height: 70%;
}

<template>
    <DxSankey ...
        id="sankey">
    </DxSankey>
</template>

<script>
import DxSankey from 'devextreme-vue/sankey';

export default {
    components: {
        DxSankey
    },
    // ...
}
</script>

<style>
#sankey {
    width: 85%;
    height: 70%;
}
</style>

import React from 'react';

import Sankey from 'devextreme-react/sankey';

class App extends React.Component {
    render() {
        return (
            <Sankey ...
                id="sankey">
            </Sankey>
        );
    }
}
export default App;

#sankey {
    width: 85%;
    height: 70%;
}

The sorting order depends on the node's weight: the heavier the node, the lower it is in the column. All nodes have the same weight initially (equals 1).

For example, without the sortData object, source nodes in the following code would be sorted as declared in the data source (top to bottom): Australia, New Zealand, Japan. Weights in the sortData object specify the following sorting order: New Zealand, Japan, Australia.

$(function() {
    $("#sankeyContainer").dxSankey({
        dataSource: [
            { source: "Australia", target: "Portugal", weight: 5 },
            { source: "New Zealand", target: "Portugal", weight: 1 },
            { source: "Japan", target: "Senegal", weight: 3 }
        ],
        sortData: { "Australia": 3, "New Zealand": 1, "Japan": 2 }
    });
});

import { DxSankeyModule } from "devextreme-angular";
// ...
export class AppComponent {
    data: Array<{ source: string, target: string, weight: number }> = [
        { source: "Australia", target: "Portugal", weight: 5 },
        { source: "New Zealand", target: "Portugal", weight: 1 },
        { source: "Japan", target: "Senegal", weight: 3 }
    ];
    sortData = { "Australia": 3, "New Zealand": 1, "Japan": 2 };
}
@NgModule({
    imports: [
        // ...
        DxSankeyModule
    ],
    // ...
})

<dx-sankey
    [dataSource]="data"
    [sortData]="sortData">
</dx-sankey>

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

The UI component'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 property. Otherwise, set this property 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.