| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736 |
- /**
- * @license Highcharts JS v6.1.0 (2018-04-13)
- * Sankey diagram module
- *
- * (c) 2010-2017 Torstein Honsi
- *
- * License: www.highcharts.com/license
- */
- 'use strict';
- (function (factory) {
- if (typeof module === 'object' && module.exports) {
- module.exports = factory;
- } else {
- factory(Highcharts);
- }
- }(function (Highcharts) {
- (function (H) {
- /**
- * Sankey diagram module
- *
- * (c) 2010-2017 Torstein Honsi
- *
- * License: www.highcharts.com/license
- */
- var defined = H.defined,
- each = H.each,
- extend = H.extend,
- seriesType = H.seriesType,
- pick = H.pick,
- Point = H.Point;
- /**
- * A sankey diagram is a type of flow diagram, in which the width of the
- * link between two nodes is shown proportionally to the flow quantity.
- *
- * @extends {plotOptions.column}
- * @product highcharts
- * @sample highcharts/demo/sankey-diagram/
- * Sankey diagram
- * @sample highcharts/plotoptions/sankey-inverted/
- * Inverted sankey diagram
- * @sample highcharts/plotoptions/sankey-outgoing
- * Sankey diagram with outgoing links
- * @since 6.0.0
- * @excluding animationLimit,boostThreshold,borderColor,borderRadius,
- * borderWidth,crisp,cropThreshold,depth,edgeColor,edgeWidth,
- * findNearestPointBy,grouping,groupPadding,groupZPadding,
- * maxPointWidth,negativeColor,pointInterval,pointIntervalUnit,
- * pointPadding,pointPlacement,pointRange,pointStart,pointWidth,
- * shadow,softThreshold,stacking,threshold,zoneAxis,zones
- * @optionparent plotOptions.sankey
- */
- seriesType('sankey', 'column', {
- colorByPoint: true,
- /**
- * Higher numbers makes the links in a sankey diagram render more curved.
- * A `curveFactor` of 0 makes the lines straight.
- */
- curveFactor: 0.33,
- /**
- * Options for the data labels appearing on top of the nodes and links. For
- * sankey charts, data labels are visible for the nodes by default, but
- * hidden for links. This is controlled by modifying the `nodeFormat`, and
- * the `format` that applies to links and is an empty string by default.
- */
- dataLabels: {
- enabled: true,
- backgroundColor: 'none', // enable padding
- crop: false,
- /**
- * The [format string](http://www.highcharts.com/docs/chart-
- * concepts/labels-and-string-formatting) specifying what to show
- * for _nodes_ in the sankey diagram. By default the
- * `nodeFormatter` returns `{point.name}`.
- *
- * @type {String}
- */
- nodeFormat: undefined,
- /**
- * Callback to format data labels for _nodes_ in the sankey diagram.
- * The `nodeFormat` option takes precedence over the `nodeFormatter`.
- *
- * @type {Function}
- * @since 6.0.2
- */
- nodeFormatter: function () {
- return this.point.name;
- },
- /**
- * The [format string](http://www.highcharts.com/docs/chart-
- * concepts/labels-and-string-formatting) specifying what to show for
- * _links_ in the sankey diagram. Defaults to an empty string returned
- * from the `formatter`, in effect disabling the labels.
- */
- format: undefined,
- /**
- * Callback to format data labels for _links_ in the sankey diagram.
- * The `format` option takes precedence over the `formatter`.
- *
- * @since 6.0.2
- */
- formatter: function () {
- return '';
- },
- inside: true
- },
-
- /**
- * Opacity for the links between nodes in the sankey diagram.
- */
- linkOpacity: 0.5,
-
- /**
- * The pixel width of each node in a sankey diagram, or the height in case
- * the chart is inverted.
- */
- nodeWidth: 20,
- /**
- * The padding between nodes in a sankey diagram, in pixels.
- */
- nodePadding: 10,
- showInLegend: false,
- states: {
- hover: {
- /**
- * Opacity for the links between nodes in the sankey diagram in
- * hover mode.
- */
- linkOpacity: 1
- }
- },
- tooltip: {
- /**
- * A callback for defining the format for _nodes_ in the sankey chart's
- * tooltip, as opposed to links.
- *
- * @type {Function}
- * @since 6.0.2
- * @apioption plotOptions.sankey.tooltip.nodeFormatter
- */
- /**
- * Whether the tooltip should follow the pointer or stay fixed on the
- * item.
- */
- followPointer: true,
-
- headerFormat:
- '<span style="font-size: 0.85em">{series.name}</span><br/>',
-
- pointFormat: '{point.fromNode.name} \u2192 {point.toNode.name}: <b>{point.weight}</b><br/>',
- /**
- * The [format string](http://www.highcharts.com/docs/chart-
- * concepts/labels-and-string-formatting) specifying what to
- * show for _nodes_ in tooltip
- * of a sankey diagram series, as opposed to links.
- */
- nodeFormat: '{point.name}: <b>{point.sum}</b><br/>'
- }
- }, {
- isCartesian: false,
- forceDL: true,
- /**
- * Create a single node that holds information on incoming and outgoing
- * links.
- */
- createNode: function (id) {
- function findById(nodes, id) {
- return H.find(nodes, function (node) {
- return node.id === id;
- });
- }
- var node = findById(this.nodes, id),
- options;
- if (!node) {
- options = this.options.nodes && findById(this.options.nodes, id);
- node = (new Point()).init(
- this,
- extend({
- className: 'highcharts-node',
- isNode: true,
- id: id,
- y: 1 // Pass isNull test
- }, options)
- );
- node.linksTo = [];
- node.linksFrom = [];
- node.formatPrefix = 'node';
- node.name = node.name || node.id; // for use in formats
- /**
- * Return the largest sum of either the incoming or outgoing links.
- */
- node.getSum = function () {
- var sumTo = 0,
- sumFrom = 0;
- each(node.linksTo, function (link) {
- sumTo += link.weight;
- });
- each(node.linksFrom, function (link) {
- sumFrom += link.weight;
- });
- return Math.max(sumTo, sumFrom);
- };
- /**
- * Get the offset in weight values of a point/link.
- */
- node.offset = function (point, coll) {
- var offset = 0;
- for (var i = 0; i < node[coll].length; i++) {
- if (node[coll][i] === point) {
- return offset;
- }
- offset += node[coll][i].weight;
- }
- };
- /**
- * Return true if the node has a shape, otherwise all links are
- * outgoing.
- */
- node.hasShape = function () {
- var outgoing = 0;
- each(node.linksTo, function (link) {
- if (link.outgoing) {
- outgoing++;
- }
- });
- return !node.linksTo.length || outgoing !== node.linksTo.length;
- };
- this.nodes.push(node);
- }
- return node;
- },
- /**
- * Create a node column.
- */
- createNodeColumn: function () {
- var chart = this.chart,
- column = [],
- nodePadding = this.options.nodePadding;
- column.sum = function () {
- var sum = 0;
- each(this, function (node) {
- sum += node.getSum();
- });
- return sum;
- };
- /**
- * Get the offset in pixels of a node inside the column.
- */
- column.offset = function (node, factor) {
- var offset = 0;
- for (var i = 0; i < column.length; i++) {
- if (column[i] === node) {
- return offset + (node.options.offset || 0);
- }
- offset += column[i].getSum() * factor + nodePadding;
- }
- };
- /**
- * Get the column height in pixels.
- */
- column.top = function (factor) {
- var height = 0;
- for (var i = 0; i < column.length; i++) {
- if (i > 0) {
- height += nodePadding;
- }
- height += column[i].getSum() * factor;
- }
- return (chart.plotSizeY - height) / 2;
- };
- return column;
- },
- /**
- * Create node columns by analyzing the nodes and the relations between
- * incoming and outgoing links.
- */
- createNodeColumns: function () {
- var columns = [];
- each(this.nodes, function (node) {
- var fromColumn = 0,
- i,
- point;
- if (!H.defined(node.options.column)) {
- // No links to this node, place it left
- if (node.linksTo.length === 0) {
- node.column = 0;
- // There are incoming links, place it to the right of the
- // highest order column that links to this one.
- } else {
- for (i = 0; i < node.linksTo.length; i++) {
- point = node.linksTo[0];
- if (point.fromNode.column > fromColumn) {
- fromColumn = point.fromNode.column;
- }
- }
- node.column = fromColumn + 1;
- }
- }
- if (!columns[node.column]) {
- columns[node.column] = this.createNodeColumn();
- }
- columns[node.column].push(node);
- }, this);
- return columns;
- },
-
- /**
- * Return the presentational attributes.
- */
- pointAttribs: function (point, state) {
- var opacity = this.options.linkOpacity;
- if (state) {
- opacity = this.options.states[state].linkOpacity || opacity;
- }
- return {
- fill: point.isNode ?
- point.color :
- H.color(point.color).setOpacity(opacity).get()
- };
- },
-
- /**
- * Extend generatePoints by adding the nodes, which are Point objects
- * but pushed to the this.nodes array.
- */
- generatePoints: function () {
- var nodeLookup = {};
- H.Series.prototype.generatePoints.call(this);
- if (!this.nodes) {
- this.nodes = []; // List of Point-like node items
- }
- this.colorCounter = 0;
- // Reset links from previous run
- each(this.nodes, function (node) {
- node.linksFrom.length = 0;
- node.linksTo.length = 0;
- });
- // Create the node list and set up links
- each(this.points, function (point) {
- if (defined(point.from)) {
- if (!nodeLookup[point.from]) {
- nodeLookup[point.from] = this.createNode(point.from);
- }
- nodeLookup[point.from].linksFrom.push(point);
- point.fromNode = nodeLookup[point.from];
- // Point color defaults to the fromNode's color
-
- point.color =
- point.options.color || nodeLookup[point.from].color;
-
- }
- if (defined(point.to)) {
- if (!nodeLookup[point.to]) {
- nodeLookup[point.to] = this.createNode(point.to);
- }
- nodeLookup[point.to].linksTo.push(point);
- point.toNode = nodeLookup[point.to];
- }
- point.name = point.name || point.id; // for use in formats
- }, this);
- },
- /**
- * Run pre-translation by generating the nodeColumns.
- */
- translate: function () {
- if (!this.processedXData) {
- this.processData();
- }
- this.generatePoints();
- this.nodeColumns = this.createNodeColumns();
- var chart = this.chart,
- inverted = chart.inverted,
- options = this.options,
- left = 0,
- nodeWidth = options.nodeWidth,
- nodeColumns = this.nodeColumns,
- colDistance = (chart.plotSizeX - nodeWidth) /
- (nodeColumns.length - 1),
- curvy = (
- (inverted ? -colDistance : colDistance) *
- options.curveFactor
- ),
- factor = Infinity;
- // Find out how much space is needed. Base it on the translation
- // factor of the most spaceous column.
- each(this.nodeColumns, function (column) {
- var height = chart.plotSizeY -
- (column.length - 1) * options.nodePadding;
- factor = Math.min(factor, height / column.sum());
- });
- each(this.nodeColumns, function (column) {
- each(column, function (node) {
- var sum = node.getSum(),
- height = sum * factor,
- fromNodeTop = (
- column.top(factor) +
- column.offset(node, factor)
- ),
- nodeLeft = inverted ?
- chart.plotSizeX - left :
- left;
- node.sum = sum;
- // Draw the node
- node.shapeType = 'rect';
- if (!inverted) {
- node.shapeArgs = {
- x: nodeLeft,
- y: fromNodeTop,
- width: nodeWidth,
- height: height
- };
- } else {
- node.shapeArgs = {
- x: nodeLeft - nodeWidth,
- y: chart.plotSizeY - fromNodeTop - height,
- width: nodeWidth,
- height: height
- };
- }
- node.shapeArgs.display = node.hasShape() ? '' : 'none';
- // Pass test in drawPoints
- node.plotY = 1;
- // Draw the links from this node
- each(node.linksFrom, function (point) {
- var linkHeight = point.weight * factor,
- fromLinkTop = node.offset(point, 'linksFrom') *
- factor,
- fromY = fromNodeTop + fromLinkTop,
- toNode = point.toNode,
- toColTop = nodeColumns[toNode.column].top(factor),
- toY = (
- toColTop +
- (toNode.offset(point, 'linksTo') * factor) +
- nodeColumns[toNode.column].offset(
- toNode,
- factor
- )
- ),
- nodeW = nodeWidth,
- right = toNode.column * colDistance,
- outgoing = point.outgoing;
- if (inverted) {
- fromY = chart.plotSizeY - fromY;
- toY = chart.plotSizeY - toY;
- right = chart.plotSizeX - right;
- nodeW = -nodeW;
- linkHeight = -linkHeight;
- }
- point.shapeType = 'path';
- point.shapeArgs = {
- d: [
- 'M', nodeLeft + nodeW, fromY,
- 'C', nodeLeft + nodeW + curvy, fromY,
- right - curvy, toY,
- right, toY,
- 'L',
- right + (outgoing ? nodeW : 0),
- toY + linkHeight / 2,
- 'L',
- right,
- toY + linkHeight,
- 'C', right - curvy, toY + linkHeight,
- nodeLeft + nodeW + curvy, fromY + linkHeight,
- nodeLeft + nodeW, fromY + linkHeight,
- 'z'
- ]
- };
- // Place data labels in the middle
- point.dlBox = {
- x: nodeLeft + (right - nodeLeft + nodeW) / 2,
- y: fromY + (toY - fromY) / 2,
- height: linkHeight,
- width: 0
- };
- // Pass test in drawPoints
- point.y = point.plotY = 1;
- if (!point.color) {
- point.color = node.color;
- }
- });
- });
- left += colDistance;
- }, this);
- },
- /**
- * Extend the render function to also render this.nodes together with
- * the points.
- */
- render: function () {
- var points = this.points;
- this.points = this.points.concat(this.nodes);
- H.seriesTypes.column.prototype.render.call(this);
- this.points = points;
- },
- animate: H.Series.prototype.animate
- }, {
- getClassName: function () {
- return 'highcharts-link ' + Point.prototype.getClassName.call(this);
- },
- isValid: function () {
- return this.isNode || typeof this.weight === 'number';
- }
- });
- /**
- * A `sankey` series. If the [type](#series.sankey.type) option is not
- * specified, it is inherited from [chart.type](#chart.type).
- *
- * @type {Object}
- * @extends series,plotOptions.sankey
- * @excluding animationLimit,boostThreshold,borderColor,borderRadius,
- * borderWidth,crisp,cropThreshold,dataParser,dataURL,depth,
- * edgeColor,edgeWidth,findNearestPointBy,grouping,groupPadding,
- * groupZPadding,maxPointWidth,negativeColor,pointInterval,
- * pointIntervalUnit,pointPadding,pointPlacement,pointRange,
- * pointStart,pointWidth,shadow,softThreshold,stacking,threshold,
- * zoneAxis,zones
- * @product highcharts
- * @apioption series.sankey
- */
- /**
- * A collection of options for the individual nodes. The nodes in a sankey
- * diagram are auto-generated instances of `Highcharts.Point`, but options can
- * be applied here and linked by the `id`.
- *
- * @sample highcharts/css/sankey/
- * Sankey diagram with node options
- * @type {Array.<Object>}
- * @product highcharts
- * @apioption series.sankey.nodes
- */
- /**
- * The id of the auto-generated node, refering to the `from` or `to` setting of
- * the link.
- *
- * @type {String}
- * @product highcharts
- * @apioption series.sankey.nodes.id
- */
- /**
- * The color of the auto generated node.
- *
- * @type {Color}
- * @product highcharts
- * @apioption series.sankey.nodes.color
- */
- /**
- * The color index of the auto generated node, especially for use in styled
- * mode.
- *
- * @type {Number}
- * @product highcharts
- * @apioption series.sankey.nodes.colorIndex
- */
- /**
- * An optional column index of where to place the node. The default behaviour is
- * to place it next to the preceding node.
- *
- * @type {Undefined|Number}
- * @default undefined
- * @sample highcharts/plotoptions/sankey-node-column/
- * Specified node column
- * @product highcharts
- * @since 6.0.5
- * @apioption series.sankey.nodes.column
- */
- /**
- * The name to display for the node in data labels and tooltips. Use this when
- * the name is different from the `id`. Where the id must be unique for each
- * node, this is not necessary for the name.
- *
- * @type {String}
- * @sample highcharts/css/sankey/
- * Sankey diagram with node options
- * @product highcharts
- * @apioption series.sankey.nodes.name
- */
- /**
- * The vertical offset of a node in terms of weight. Positive values shift the
- * node downwards, negative shift it upwards.
- *
- * @type {Number}
- * @default 0
- * @sample highcharts/plotoptions/sankey-node-column/
- * Specified node offset
- * @product highcharts
- * @since 6.0.5
- * @apioption series.sankey.nodes.offset
- */
- /**
- * An array of data points for the series. For the `sankey` series type,
- * points can be given in the following way:
- *
- * An array of objects with named values. The objects are point
- * configuration objects as seen below. If the total number of data
- * points exceeds the series' [turboThreshold](#series.area.turboThreshold),
- * this option is not available.
- *
- * ```js
- * data: [{
- * from: 'Category1',
- * to: 'Category2',
- * weight: 2
- * }, {
- * from: 'Category1',
- * to: 'Category3',
- * weight: 5
- * }]
- * ```
- *
- * @type {Array<Object|Array|Number>}
- * @extends series.line.data
- * @excluding drilldown,marker,x,y
- * @sample {highcharts} highcharts/chart/reflow-true/
- * Numerical values
- * @sample {highcharts} highcharts/series/data-array-of-arrays/
- * Arrays of numeric x and y
- * @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/
- * Arrays of datetime x and y
- * @sample {highcharts} highcharts/series/data-array-of-name-value/
- * Arrays of point.name and y
- * @sample {highcharts} highcharts/series/data-array-of-objects/
- * Config objects
- * @product highcharts
- * @apioption series.sankey.data
- */
- /**
- * The color for the individual _link_. By default, the link color is the same
- * as the node it extends from. The `series.fillOpacity` option also applies to
- * the points, so when setting a specific link color, consider setting the
- * `fillOpacity` to 1.
- *
- * @type {String}
- * @product highcharts
- * @apioption series.sankey.data.color
- */
- /**
- * The node that the link runs from.
- *
- * @type {String}
- * @product highcharts
- * @apioption series.sankey.data.from
- */
- /**
- * The node that the link runs to.
- *
- * @type {String}
- * @product highcharts
- * @apioption series.sankey.data.to
- */
- /**
- * Whether the link goes out of the system.
- *
- * @type {Boolean}
- * @default false
- * @sample highcharts/plotoptions/sankey-outgoing
- * Sankey chart with outgoing links
- * @product highcharts
- * @apioption series.sankey.data.outgoing
- */
- /**
- * The weight of the link.
- *
- * @type {Number}
- * @product highcharts
- * @apioption series.sankey.data.weight
- */
- }(Highcharts));
- }));
|