highcharts
Version:
JavaScript charting framework
640 lines (639 loc) • 25.2 kB
JavaScript
/* *
*
* Experimental Highcharts module which enables visualization of a Venn
* diagram.
*
* (c) 2016-2021 Highsoft AS
* Authors: Jon Arild Nygard
*
* Layout algorithm by Ben Frederickson:
* https://www.benfrederickson.com/better-venn-diagrams/
*
* License: www.highcharts.com/license
*
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
*
* */
;
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
import A from '../../Core/Animation/AnimationUtilities.js';
var animObject = A.animObject;
import Color from '../../Core/Color/Color.js';
var color = Color.parse;
import GeometryMixin from '../../Mixins/Geometry.js';
var getCenterOfPoints = GeometryMixin.getCenterOfPoints, getDistanceBetweenPoints = GeometryMixin.getDistanceBetweenPoints;
import GeometryCirclesModule from '../../Mixins/GeometryCircles.js';
var getAreaOfCircle = GeometryCirclesModule.getAreaOfCircle, getAreaOfIntersectionBetweenCircles = GeometryCirclesModule.getAreaOfIntersectionBetweenCircles, getCircleCircleIntersection = GeometryCirclesModule.getCircleCircleIntersection, getCirclesIntersectionPolygon = GeometryCirclesModule.getCirclesIntersectionPolygon, getOverlapBetweenCirclesByDistance = GeometryCirclesModule.getOverlapBetweenCircles, isCircle1CompletelyOverlappingCircle2 = GeometryCirclesModule.isCircle1CompletelyOverlappingCircle2, isPointInsideAllCircles = GeometryCirclesModule.isPointInsideAllCircles, isPointInsideCircle = GeometryCirclesModule.isPointInsideCircle, isPointOutsideAllCircles = GeometryCirclesModule.isPointOutsideAllCircles;
import NelderMeadMixin from '../../Mixins/NelderMead.js';
var nelderMead = NelderMeadMixin.nelderMead;
import palette from '../../Core/Color/Palette.js';
import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
var ScatterSeries = SeriesRegistry.seriesTypes.scatter;
import VennPoint from './VennPoint.js';
import VennUtils from './VennUtils.js';
import U from '../../Core/Utilities.js';
var addEvent = U.addEvent, extend = U.extend, isArray = U.isArray, isNumber = U.isNumber, isObject = U.isObject, isString = U.isString, merge = U.merge;
/* *
*
* Class
*
* */
/**
* @private
* @class
* @name Highcharts.seriesTypes.venn
*
* @augments Highcharts.Series
*/
var VennSeries = /** @class */ (function (_super) {
__extends(VennSeries, _super);
function VennSeries() {
/* *
*
* Static Properties
*
* */
var _this = _super !== null && _super.apply(this, arguments) || this;
/* *
*
* Properties
*
* */
_this.data = void 0;
_this.mapOfIdToRelation = void 0;
_this.options = void 0;
_this.points = void 0;
return _this;
/* eslint-enable valid-jsdoc */
}
/* *
*
* Static Functions
*
* */
/**
* Finds the optimal label position by looking for a position that has a low
* distance from the internal circles, and as large possible distane to the
* external circles.
* @private
* @todo Optimize the intial position.
* @todo Add unit tests.
* @param {Array<Highcharts.CircleObject>} internal
* Internal circles.
* @param {Array<Highcharts.CircleObject>} external
* External circles.
* @return {Highcharts.PositionObject}
* Returns the found position.
*/
VennSeries.getLabelPosition = function (internal, external) {
// Get the best label position within the internal circles.
var best = internal.reduce(function (best, circle) {
var d = circle.r / 2;
// Give a set of points with the circle to evaluate as the best
// label position.
return [
{ x: circle.x, y: circle.y },
{ x: circle.x + d, y: circle.y },
{ x: circle.x - d, y: circle.y },
{ x: circle.x, y: circle.y + d },
{ x: circle.x, y: circle.y - d }
]
// Iterate the given points and return the one with the largest
// margin.
.reduce(function (best, point) {
var margin = VennUtils.getMarginFromCircles(point, internal, external);
// If the margin better than the current best, then update
// sbest.
if (best.margin < margin) {
best.point = point;
best.margin = margin;
}
return best;
}, best);
}, {
point: void 0,
margin: -Number.MAX_VALUE
}).point;
// Use nelder mead to optimize the initial label position.
var optimal = nelderMead(function (p) {
return -(VennUtils.getMarginFromCircles({ x: p[0], y: p[1] }, internal, external));
}, [best.x, best.y]);
// Update best to be the point which was found to have the best margin.
best = {
x: optimal[0],
y: optimal[1]
};
if (!(isPointInsideAllCircles(best, internal) &&
isPointOutsideAllCircles(best, external))) {
// If point was either outside one of the internal, or inside one of
// the external, then it was invalid and should use a fallback.
if (internal.length > 1) {
best = getCenterOfPoints(getCirclesIntersectionPolygon(internal));
}
else {
best = {
x: internal[0].x,
y: internal[0].y
};
}
}
// Return the best point.
return best;
};
/**
* Calulates data label values for a given relations object.
*
* @private
* @todo add unit tests
* @param {Highcharts.VennRelationObject} relation A relations object.
* @param {Array<Highcharts.VennRelationObject>} setRelations The list of
* relations that is a set.
* @return {Highcharts.VennLabelValuesObject}
* Returns an object containing position and width of the label.
*/
VennSeries.getLabelValues = function (relation, setRelations) {
var sets = relation.sets;
// Create a list of internal and external circles.
var data = setRelations.reduce(function (data, set) {
// If the set exists in this relation, then it is internal,
// otherwise it will be external.
var isInternal = sets.indexOf(set.sets[0]) > -1;
var property = isInternal ? 'internal' : 'external';
// Add the circle to the list.
data[property].push(set.circle);
return data;
}, {
internal: [],
external: []
});
// Filter out external circles that are completely overlapping all
// internal
data.external = data.external.filter(function (externalCircle) {
return data.internal.some(function (internalCircle) {
return !isCircle1CompletelyOverlappingCircle2(externalCircle, internalCircle);
});
});
// Calulate the label position.
var position = VennSeries.getLabelPosition(data.internal, data.external);
// Calculate the label width
var width = VennUtils.getLabelWidth(position, data.internal, data.external);
return {
position: position,
width: width
};
};
/**
* Calculates the positions, and the label values of all the sets in the
* venn diagram.
*
* @private
* @todo Add support for constrained MDS.
* @param {Array<Highchats.VennRelationObject>} relations
* List of the overlap between two or more sets, or the size of a single
* sset.
* @return {Highcharts.Dictionary<*>}
* List of circles and their calculated positions.
*/
VennSeries.layout = function (relations) {
var mapOfIdToShape = {};
var mapOfIdToLabelValues = {};
// Calculate best initial positions by using greedy layout.
if (relations.length > 0) {
var mapOfIdToCircles_1 = VennUtils.layoutGreedyVenn(relations);
var setRelations_1 = relations.filter(VennUtils.isSet);
relations
.forEach(function (relation) {
var sets = relation.sets;
var id = sets.join();
// Get shape from map of circles, or calculate intersection.
var shape = VennUtils.isSet(relation) ?
mapOfIdToCircles_1[id] :
getAreaOfIntersectionBetweenCircles(sets.map(function (set) {
return mapOfIdToCircles_1[set];
}));
// Calculate label values if the set has a shape
if (shape) {
mapOfIdToShape[id] = shape;
mapOfIdToLabelValues[id] = VennSeries.getLabelValues(relation, setRelations_1);
}
});
}
return { mapOfIdToShape: mapOfIdToShape, mapOfIdToLabelValues: mapOfIdToLabelValues };
};
/**
* Calculates the proper scale to fit the cloud inside the plotting area.
* @private
* @todo add unit test
* @param {number} targetWidth
* Width of target area.
* @param {number} targetHeight
* Height of target area.
* @param {Highcharts.PolygonBoxObject} field
* The playing field.
* @return {Highcharts.Dictionary<number>}
* Returns the value to scale the playing field up to the size of the target
* area, and center of x and y.
*/
VennSeries.getScale = function (targetWidth, targetHeight, field) {
var height = field.bottom - field.top, // top is smaller than bottom
width = field.right - field.left, scaleX = width > 0 ? 1 / width * targetWidth : 1, scaleY = height > 0 ? 1 / height * targetHeight : 1, adjustX = (field.right + field.left) / 2, adjustY = (field.top + field.bottom) / 2, scale = Math.min(scaleX, scaleY);
return {
scale: scale,
centerX: targetWidth / 2 - adjustX * scale,
centerY: targetHeight / 2 - adjustY * scale
};
};
/**
* If a circle is outside a give field, then the boundaries of the field is
* adjusted accordingly. Modifies the field object which is passed as the
* first parameter.
* @private
* @todo NOTE: Copied from wordcloud, can probably be unified.
* @param {Highcharts.PolygonBoxObject} field
* The bounding box of a playing field.
* @param {Highcharts.CircleObject} circle
* The bounding box for a placed point.
* @return {Highcharts.PolygonBoxObject}
* Returns a modified field object.
*/
VennSeries.updateFieldBoundaries = function (field, circle) {
var left = circle.x - circle.r, right = circle.x + circle.r, bottom = circle.y + circle.r, top = circle.y - circle.r;
// TODO improve type checking.
if (!isNumber(field.left) || field.left > left) {
field.left = left;
}
if (!isNumber(field.right) || field.right < right) {
field.right = right;
}
if (!isNumber(field.top) || field.top > top) {
field.top = top;
}
if (!isNumber(field.bottom) || field.bottom < bottom) {
field.bottom = bottom;
}
return field;
};
/* *
*
* Functions
*
* */
/* eslint-disable valid-jsdoc */
VennSeries.prototype.animate = function (init) {
if (!init) {
var series = this, animOptions = animObject(series.options.animation);
series.points.forEach(function (point) {
var args = point.shapeArgs;
if (point.graphic && args) {
var attr = {}, animate = {};
if (args.d) {
// If shape is a path, then animate opacity.
attr.opacity = 0.001;
}
else {
// If shape is a circle, then animate radius.
attr.r = 0;
animate.r = args.r;
}
point.graphic
.attr(attr)
.animate(animate, animOptions);
// If shape is path, then fade it in after the circles
// animation
if (args.d) {
setTimeout(function () {
if (point && point.graphic) {
point.graphic.animate({
opacity: 1
});
}
}, animOptions.duration);
}
}
}, series);
}
};
/**
* Draw the graphics for each point.
* @private
*/
VennSeries.prototype.drawPoints = function () {
var series = this,
// Series properties
chart = series.chart, group = series.group, points = series.points || [],
// Chart properties
renderer = chart.renderer;
// Iterate all points and calculate and draw their graphics.
points.forEach(function (point) {
var attribs = {
zIndex: isArray(point.sets) ? point.sets.length : 0
}, shapeArgs = point.shapeArgs;
// Add point attribs
if (!chart.styledMode) {
extend(attribs, series.pointAttribs(point, point.state));
}
// Draw the point graphic.
point.draw({
isNew: !point.graphic,
animatableAttribs: shapeArgs,
attribs: attribs,
group: group,
renderer: renderer,
shapeType: shapeArgs && shapeArgs.d ? 'path' : 'circle'
});
});
};
VennSeries.prototype.init = function () {
ScatterSeries.prototype.init.apply(this, arguments);
// Venn's opacity is a different option from other series
delete this.opacity;
};
/**
* Calculates the style attributes for a point. The attributes can vary
* depending on the state of the point.
* @private
* @param {Highcharts.Point} point
* The point which will get the resulting attributes.
* @param {string} [state]
* The state of the point.
* @return {Highcharts.SVGAttributes}
* Returns the calculated attributes.
*/
VennSeries.prototype.pointAttribs = function (point, state) {
var series = this, seriesOptions = series.options || {}, pointOptions = point && point.options || {}, stateOptions = (state && seriesOptions.states[state]) || {}, options = merge(seriesOptions, { color: point && point.color }, pointOptions, stateOptions);
// Return resulting values for the attributes.
return {
'fill': color(options.color)
.brighten(options.brightness)
.get(),
// Set opacity directly to the SVG element, not to pattern #14372.
opacity: options.opacity,
'stroke': options.borderColor,
'stroke-width': options.borderWidth,
'dashstyle': options.borderDashStyle
};
};
VennSeries.prototype.translate = function () {
var chart = this.chart;
this.processedXData = this.xData;
this.generatePoints();
// Process the data before passing it into the layout function.
var relations = VennUtils.processVennData(this.options.data);
// Calculate the positions of each circle.
var _a = VennSeries.layout(relations), mapOfIdToShape = _a.mapOfIdToShape, mapOfIdToLabelValues = _a.mapOfIdToLabelValues;
// Calculate the scale, and center of the plot area.
var field = Object.keys(mapOfIdToShape)
.filter(function (key) {
var shape = mapOfIdToShape[key];
return shape && isNumber(shape.r);
})
.reduce(function (field, key) {
return VennSeries.updateFieldBoundaries(field, mapOfIdToShape[key]);
}, { top: 0, bottom: 0, left: 0, right: 0 }), scaling = VennSeries.getScale(chart.plotWidth, chart.plotHeight, field), scale = scaling.scale, centerX = scaling.centerX, centerY = scaling.centerY;
// Iterate all points and calculate and draw their graphics.
this.points.forEach(function (point) {
var sets = isArray(point.sets) ? point.sets : [], id = sets.join(), shape = mapOfIdToShape[id], shapeArgs, dataLabelValues = mapOfIdToLabelValues[id] || {}, dataLabelWidth = dataLabelValues.width, dataLabelPosition = dataLabelValues.position, dlOptions = point.options && point.options.dataLabels;
if (shape) {
if (shape.r) {
shapeArgs = {
x: centerX + shape.x * scale,
y: centerY + shape.y * scale,
r: shape.r * scale
};
}
else if (shape.d) {
var d = shape.d;
d.forEach(function (seg) {
if (seg[0] === 'M') {
seg[1] = centerX + seg[1] * scale;
seg[2] = centerY + seg[2] * scale;
}
else if (seg[0] === 'A') {
seg[1] = seg[1] * scale;
seg[2] = seg[2] * scale;
seg[6] = centerX + seg[6] * scale;
seg[7] = centerY + seg[7] * scale;
}
});
shapeArgs = { d: d };
}
// Scale the position for the data label.
if (dataLabelPosition) {
dataLabelPosition.x = centerX + dataLabelPosition.x * scale;
dataLabelPosition.y = centerY + dataLabelPosition.y * scale;
}
else {
dataLabelPosition = {};
}
if (isNumber(dataLabelWidth)) {
dataLabelWidth = Math.round(dataLabelWidth * scale);
}
}
point.shapeArgs = shapeArgs;
// Placement for the data labels
if (dataLabelPosition && shapeArgs) {
point.plotX = dataLabelPosition.x;
point.plotY = dataLabelPosition.y;
}
// Add width for the data label
if (dataLabelWidth && shapeArgs) {
point.dlOptions = merge(true, {
style: {
width: dataLabelWidth
}
}, isObject(dlOptions) && dlOptions);
}
// Set name for usage in tooltip and in data label.
point.name = point.options.name || sets.join('∩');
});
};
/**
* A Venn diagram displays all possible logical relations between a
* collection of different sets. The sets are represented by circles, and
* the relation between the sets are displayed by the overlap or lack of
* overlap between them. The venn diagram is a special case of Euler
* diagrams, which can also be displayed by this series type.
*
* @sample {highcharts} highcharts/demo/venn-diagram/
* Venn diagram
* @sample {highcharts} highcharts/demo/euler-diagram/
* Euler diagram
*
* @extends plotOptions.scatter
* @excluding connectEnds, connectNulls, cropThreshold, dragDrop,
* findNearestPointBy, getExtremesFromAll, jitter, label,
* linecap, lineWidth, linkedTo, marker, negativeColor,
* pointInterval, pointIntervalUnit, pointPlacement,
* pointStart, softThreshold, stacking, steps, threshold,
* xAxis, yAxis, zoneAxis, zones, dataSorting, boostThreshold,
* boostBlending
* @product highcharts
* @requires modules/venn
* @optionparent plotOptions.venn
*/
VennSeries.defaultOptions = merge(ScatterSeries.defaultOptions, {
borderColor: palette.neutralColor20,
borderDashStyle: 'solid',
borderWidth: 1,
brighten: 0,
clip: false,
colorByPoint: true,
dataLabels: {
enabled: true,
verticalAlign: 'middle',
formatter: function () {
return this.point.name;
}
},
/**
* @ignore-option
* @private
*/
inactiveOtherPoints: true,
marker: false,
opacity: 0.75,
showInLegend: false,
states: {
/**
* @excluding halo
*/
hover: {
opacity: 1,
borderColor: palette.neutralColor80
},
/**
* @excluding halo
*/
select: {
color: palette.neutralColor20,
borderColor: palette.neutralColor100,
animation: false
},
inactive: {
opacity: 0.075
}
},
tooltip: {
pointFormat: '{point.name}: {point.value}'
}
});
return VennSeries;
}(ScatterSeries));
extend(VennSeries.prototype, {
axisTypes: [],
directTouch: true,
isCartesian: false,
pointArrayMap: ['value'],
pointClass: VennPoint,
utils: VennUtils
});
SeriesRegistry.registerSeriesType('venn', VennSeries);
/* *
*
* Default Export
*
* */
export default VennSeries;
/* *
*
* API Options
*
* */
/**
* A `venn` series. If the [type](#series.venn.type) option is
* not specified, it is inherited from [chart.type](#chart.type).
*
* @extends series,plotOptions.venn
* @excluding connectEnds, connectNulls, cropThreshold, dataParser, dataURL,
* findNearestPointBy, getExtremesFromAll, label, linecap, lineWidth,
* linkedTo, marker, negativeColor, pointInterval, pointIntervalUnit,
* pointPlacement, pointStart, softThreshold, stack, stacking, steps,
* threshold, xAxis, yAxis, zoneAxis, zones, dataSorting,
* boostThreshold, boostBlending
* @product highcharts
* @requires modules/venn
* @apioption series.venn
*/
/**
* @type {Array<*>}
* @extends series.scatter.data
* @excluding marker, x, y
* @product highcharts
* @apioption series.venn.data
*/
/**
* The name of the point. Used in data labels and tooltip. If name is not
* defined then it will default to the joined values in
* [sets](#series.venn.sets).
*
* @sample {highcharts} highcharts/demo/venn-diagram/
* Venn diagram
* @sample {highcharts} highcharts/demo/euler-diagram/
* Euler diagram
*
* @type {number}
* @since 7.0.0
* @product highcharts
* @apioption series.venn.data.name
*/
/**
* The value of the point, resulting in a relative area of the circle, or area
* of overlap between two sets in the venn or euler diagram.
*
* @sample {highcharts} highcharts/demo/venn-diagram/
* Venn diagram
* @sample {highcharts} highcharts/demo/euler-diagram/
* Euler diagram
*
* @type {number}
* @since 7.0.0
* @product highcharts
* @apioption series.venn.data.value
*/
/**
* The set or sets the options will be applied to. If a single entry is defined,
* then it will create a new set. If more than one entry is defined, then it
* will define the overlap between the sets in the array.
*
* @sample {highcharts} highcharts/demo/venn-diagram/
* Venn diagram
* @sample {highcharts} highcharts/demo/euler-diagram/
* Euler diagram
*
* @type {Array<string>}
* @since 7.0.0
* @product highcharts
* @apioption series.venn.data.sets
*/
/**
* @excluding halo
* @apioption series.venn.states.hover
*/
/**
* @excluding halo
* @apioption series.venn.states.select
*/
''; // detach doclets above
/* eslint-disable no-invalid-this */
// Modify final series options.
addEvent(VennSeries, 'afterSetOptions', function (e) {
var options = e.options, states = options.states;
if (this.is('venn')) {
// Explicitly disable all halo options.
Object.keys(states).forEach(function (state) {
states[state].halo = false;
});
}
});