highcharts
Version:
JavaScript charting framework
1,448 lines (1,419 loc) • 73.1 kB
JavaScript
/**
* @license Highcharts JS v12.1.2 (2024-12-21)
* @module highcharts/modules/venn
* @requires highcharts
*
* (c) 2017-2024 Highsoft AS
* Authors: Jon Arild Nygard
*
* License: www.highcharts.com/license
*/
(function webpackUniversalModuleDefinition(root, factory) {
if(typeof exports === 'object' && typeof module === 'object')
module.exports = factory(root["_Highcharts"], root["_Highcharts"]["Color"], root["_Highcharts"]["SeriesRegistry"]);
else if(typeof define === 'function' && define.amd)
define("highcharts/modules/venn", ["highcharts/highcharts"], function (amd1) {return factory(amd1,amd1["Color"],amd1["SeriesRegistry"]);});
else if(typeof exports === 'object')
exports["highcharts/modules/venn"] = factory(root["_Highcharts"], root["_Highcharts"]["Color"], root["_Highcharts"]["SeriesRegistry"]);
else
root["Highcharts"] = factory(root["Highcharts"], root["Highcharts"]["Color"], root["Highcharts"]["SeriesRegistry"]);
})(typeof window === 'undefined' ? this : window, (__WEBPACK_EXTERNAL_MODULE__944__, __WEBPACK_EXTERNAL_MODULE__620__, __WEBPACK_EXTERNAL_MODULE__512__) => {
return /******/ (() => { // webpackBootstrap
/******/ "use strict";
/******/ var __webpack_modules__ = ({
/***/ 620:
/***/ ((module) => {
module.exports = __WEBPACK_EXTERNAL_MODULE__620__;
/***/ }),
/***/ 512:
/***/ ((module) => {
module.exports = __WEBPACK_EXTERNAL_MODULE__512__;
/***/ }),
/***/ 944:
/***/ ((module) => {
module.exports = __WEBPACK_EXTERNAL_MODULE__944__;
/***/ })
/******/ });
/************************************************************************/
/******/ // The module cache
/******/ var __webpack_module_cache__ = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/ // Check if module is in cache
/******/ var cachedModule = __webpack_module_cache__[moduleId];
/******/ if (cachedModule !== undefined) {
/******/ return cachedModule.exports;
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = __webpack_module_cache__[moduleId] = {
/******/ // no module.id needed
/******/ // no module.loaded needed
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/************************************************************************/
/******/ /* webpack/runtime/compat get default export */
/******/ (() => {
/******/ // getDefaultExport function for compatibility with non-harmony modules
/******/ __webpack_require__.n = (module) => {
/******/ var getter = module && module.__esModule ?
/******/ () => (module['default']) :
/******/ () => (module);
/******/ __webpack_require__.d(getter, { a: getter });
/******/ return getter;
/******/ };
/******/ })();
/******/
/******/ /* webpack/runtime/define property getters */
/******/ (() => {
/******/ // define getter functions for harmony exports
/******/ __webpack_require__.d = (exports, definition) => {
/******/ for(var key in definition) {
/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {
/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] });
/******/ }
/******/ }
/******/ };
/******/ })();
/******/
/******/ /* webpack/runtime/hasOwnProperty shorthand */
/******/ (() => {
/******/ __webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))
/******/ })();
/******/
/************************************************************************/
var __webpack_exports__ = {};
// EXPORTS
__webpack_require__.d(__webpack_exports__, {
"default": () => (/* binding */ venn_src)
});
// EXTERNAL MODULE: external {"amd":["highcharts/highcharts"],"commonjs":["highcharts"],"commonjs2":["highcharts"],"root":["Highcharts"]}
var highcharts_commonjs_highcharts_commonjs2_highcharts_root_Highcharts_ = __webpack_require__(944);
var highcharts_commonjs_highcharts_commonjs2_highcharts_root_Highcharts_default = /*#__PURE__*/__webpack_require__.n(highcharts_commonjs_highcharts_commonjs2_highcharts_root_Highcharts_);
// EXTERNAL MODULE: external {"amd":["highcharts/highcharts","Color"],"commonjs":["highcharts","Color"],"commonjs2":["highcharts","Color"],"root":["Highcharts","Color"]}
var highcharts_Color_commonjs_highcharts_Color_commonjs2_highcharts_Color_root_Highcharts_Color_ = __webpack_require__(620);
var highcharts_Color_commonjs_highcharts_Color_commonjs2_highcharts_Color_root_Highcharts_Color_default = /*#__PURE__*/__webpack_require__.n(highcharts_Color_commonjs_highcharts_Color_commonjs2_highcharts_Color_root_Highcharts_Color_);
;// ./code/es-modules/Core/Geometry/GeometryUtilities.js
/* *
*
* (c) 2010-2024 Highsoft AS
*
* License: www.highcharts.com/license
*
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
*
* */
/* *
*
* Namespace
*
* */
var GeometryUtilities;
(function (GeometryUtilities) {
/* *
*
* Functions
*
* */
/**
* Calculates the center between a list of points.
*
* @private
*
* @param {Array<Highcharts.PositionObject>} points
* A list of points to calculate the center of.
*
* @return {Highcharts.PositionObject}
* Calculated center
*/
function getCenterOfPoints(points) {
const sum = points.reduce((sum, point) => {
sum.x += point.x;
sum.y += point.y;
return sum;
}, { x: 0, y: 0 });
return {
x: sum.x / points.length,
y: sum.y / points.length
};
}
GeometryUtilities.getCenterOfPoints = getCenterOfPoints;
/**
* Calculates the distance between two points based on their x and y
* coordinates.
*
* @private
*
* @param {Highcharts.PositionObject} p1
* The x and y coordinates of the first point.
*
* @param {Highcharts.PositionObject} p2
* The x and y coordinates of the second point.
*
* @return {number}
* Returns the distance between the points.
*/
function getDistanceBetweenPoints(p1, p2) {
return Math.sqrt(Math.pow(p2.x - p1.x, 2) + Math.pow(p2.y - p1.y, 2));
}
GeometryUtilities.getDistanceBetweenPoints = getDistanceBetweenPoints;
/**
* Calculates the angle between two points.
* @todo add unit tests.
* @private
* @param {Highcharts.PositionObject} p1 The first point.
* @param {Highcharts.PositionObject} p2 The second point.
* @return {number} Returns the angle in radians.
*/
function getAngleBetweenPoints(p1, p2) {
return Math.atan2(p2.x - p1.x, p2.y - p1.y);
}
GeometryUtilities.getAngleBetweenPoints = getAngleBetweenPoints;
/**
* Test for point in polygon. Polygon defined as array of [x,y] points.
* @private
* @param {PositionObject} point The point potentially within a polygon.
* @param {Array<Array<number>>} polygon The polygon potentially containing the point.
*/
function pointInPolygon({ x, y }, polygon) {
const len = polygon.length;
let i, j, inside = false;
for (i = 0, j = len - 1; i < len; j = i++) {
const [x1, y1] = polygon[i], [x2, y2] = polygon[j];
if (y1 > y !== y2 > y &&
(x < (x2 - x1) *
(y - y1) /
(y2 - y1) +
x1)) {
inside = !inside;
}
}
return inside;
}
GeometryUtilities.pointInPolygon = pointInPolygon;
})(GeometryUtilities || (GeometryUtilities = {}));
/* *
*
* Default Export
*
* */
/* harmony default export */ const Geometry_GeometryUtilities = (GeometryUtilities);
;// ./code/es-modules/Core/Geometry/CircleUtilities.js
/* *
*
* (c) 2010-2024 Highsoft AS
*
* License: www.highcharts.com/license
*
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
*
* */
const { getAngleBetweenPoints, getCenterOfPoints, getDistanceBetweenPoints } = Geometry_GeometryUtilities;
/* *
*
* Namespace
*
* */
var CircleUtilities;
(function (CircleUtilities) {
/* *
*
* Functions
*
* */
/**
* @private
*
* @param {number} x
* Number to round
*
* @param {number} decimals
* Number of decimals to round to
*
* @return {number}
* Rounded number
*/
function round(x, decimals) {
const a = Math.pow(10, decimals);
return Math.round(x * a) / a;
}
CircleUtilities.round = round;
/**
* Calculates the area of a circle based on its radius.
*
* @private
*
* @param {number} r
* The radius of the circle.
*
* @return {number}
* Returns the area of the circle.
*/
function getAreaOfCircle(r) {
if (r <= 0) {
throw new Error('radius of circle must be a positive number.');
}
return Math.PI * r * r;
}
CircleUtilities.getAreaOfCircle = getAreaOfCircle;
/**
* Calculates the area of a circular segment based on the radius of the
* circle and the height of the segment.
*
* @see http://mathworld.wolfram.com/CircularSegment.html
*
* @private
*
* @param {number} r
* The radius of the circle.
*
* @param {number} h
* The height of the circular segment.
*
* @return {number}
* Returns the area of the circular segment.
*/
function getCircularSegmentArea(r, h) {
return (r * r * Math.acos(1 - h / r) -
(r - h) * Math.sqrt(h * (2 * r - h)));
}
CircleUtilities.getCircularSegmentArea = getCircularSegmentArea;
/**
* Calculates the area of overlap between two circles based on their
* radiuses and the distance between them.
*
* @see http://mathworld.wolfram.com/Circle-CircleIntersection.html
*
* @private
*
* @param {number} r1
* Radius of the first circle.
*
* @param {number} r2
* Radius of the second circle.
*
* @param {number} d
* The distance between the two circles.
*
* @return {number}
* Returns the area of overlap between the two circles.
*/
function getOverlapBetweenCircles(r1, r2, d) {
let overlap = 0;
// If the distance is larger than the sum of the radiuses then the
// circles does not overlap.
if (d < r1 + r2) {
if (d <= Math.abs(r2 - r1)) {
// If the circles are completely overlapping, then the overlap
// equals the area of the smallest circle.
overlap = getAreaOfCircle(r1 < r2 ? r1 : r2);
}
else {
// Height of first triangle segment.
const d1 = (r1 * r1 - r2 * r2 + d * d) / (2 * d),
// Height of second triangle segment.
d2 = d - d1;
overlap = (getCircularSegmentArea(r1, r1 - d1) +
getCircularSegmentArea(r2, r2 - d2));
}
// Round the result to two decimals.
overlap = round(overlap, 14);
}
return overlap;
}
CircleUtilities.getOverlapBetweenCircles = getOverlapBetweenCircles;
/**
* Calculates the intersection points of two circles.
*
* NOTE: does not handle floating errors well.
*
* @private
*
* @param {Highcharts.CircleObject} c1
* The first circle.
*
* @param {Highcharts.CircleObject} c2
* The second circle.
*
* @return {Array<Highcharts.PositionObject>}
* Returns the resulting intersection points.
*/
function getCircleCircleIntersection(c1, c2) {
const d = getDistanceBetweenPoints(c1, c2), r1 = c1.r, r2 = c2.r;
let points = [];
if (d < r1 + r2 && d > Math.abs(r1 - r2)) {
// If the circles are overlapping, but not completely overlapping,
// then it exists intersecting points.
const r1Square = r1 * r1, r2Square = r2 * r2,
// `d^2 - r^2 + R^2 / 2d`
x = (r1Square - r2Square + d * d) / (2 * d),
// `y^2 = R^2 - x^2`
y = Math.sqrt(r1Square - x * x), x1 = c1.x, x2 = c2.x, y1 = c1.y, y2 = c2.y, x0 = x1 + x * (x2 - x1) / d, y0 = y1 + x * (y2 - y1) / d, rx = -(y2 - y1) * (y / d), ry = -(x2 - x1) * (y / d);
points = [
{ x: round(x0 + rx, 14), y: round(y0 - ry, 14) },
{ x: round(x0 - rx, 14), y: round(y0 + ry, 14) }
];
}
return points;
}
CircleUtilities.getCircleCircleIntersection = getCircleCircleIntersection;
/**
* Calculates all the intersection points for between a list of circles.
*
* @private
*
* @param {Array<Highcharts.CircleObject>} circles
* The circles to calculate the points from.
*
* @return {Array<Highcharts.GeometryObject>}
* Returns a list of intersection points.
*/
function getCirclesIntersectionPoints(circles) {
return circles.reduce((points, c1, i, arr) => {
const additional = arr
.slice(i + 1)
.reduce((points, c2, j) => {
const indexes = [i, j + i + 1];
return points.concat(getCircleCircleIntersection(c1, c2).map((p) => {
p.indexes = indexes;
return p;
}));
}, []);
return points.concat(additional);
}, []);
}
CircleUtilities.getCirclesIntersectionPoints = getCirclesIntersectionPoints;
/**
* Tests whether the first circle is completely overlapping the second
* circle.
*
* @private
*
* @param {Highcharts.CircleObject} circle1
* The first circle.
*
* @param {Highcharts.CircleObject} circle2
* The second circle.
*
* @return {boolean}
* Returns true if circle1 is completely overlapping circle2, false if not.
*/
function isCircle1CompletelyOverlappingCircle2(circle1, circle2) {
return getDistanceBetweenPoints(circle1, circle2) + circle2.r < circle1.r + 1e-10;
}
CircleUtilities.isCircle1CompletelyOverlappingCircle2 = isCircle1CompletelyOverlappingCircle2;
/**
* Tests whether a point lies within a given circle.
* @private
* @param {Highcharts.PositionObject} point
* The point to test for.
*
* @param {Highcharts.CircleObject} circle
* The circle to test if the point is within.
*
* @return {boolean}
* Returns true if the point is inside, false if outside.
*/
function isPointInsideCircle(point, circle) {
return getDistanceBetweenPoints(point, circle) <= circle.r + 1e-10;
}
CircleUtilities.isPointInsideCircle = isPointInsideCircle;
/**
* Tests whether a point lies within a set of circles.
*
* @private
*
* @param {Highcharts.PositionObject} point
* The point to test.
*
* @param {Array<Highcharts.CircleObject>} circles
* The list of circles to test against.
*
* @return {boolean}
* Returns true if the point is inside all the circles, false if not.
*/
function isPointInsideAllCircles(point, circles) {
return !circles.some(function (circle) {
return !isPointInsideCircle(point, circle);
});
}
CircleUtilities.isPointInsideAllCircles = isPointInsideAllCircles;
/**
* Tests whether a point lies outside a set of circles.
*
* TODO: add unit tests.
*
* @private
*
* @param {Highcharts.PositionObject} point
* The point to test.
*
* @param {Array<Highcharts.CircleObject>} circles
* The list of circles to test against.
*
* @return {boolean}
* Returns true if the point is outside all the circles, false if not.
*/
function isPointOutsideAllCircles(point, circles) {
return !circles.some(function (circle) {
return isPointInsideCircle(point, circle);
});
}
CircleUtilities.isPointOutsideAllCircles = isPointOutsideAllCircles;
/**
* Calculates the points for the polygon of the intersection area between
* a set of circles.
*
* @private
*
* @param {Array<Highcharts.CircleObject>} circles
* List of circles to calculate polygon of.
*
* @return {Array<Highcharts.GeometryObject>}
* Return list of points in the intersection polygon.
*/
function getCirclesIntersectionPolygon(circles) {
return getCirclesIntersectionPoints(circles)
.filter(function (p) {
return isPointInsideAllCircles(p, circles);
});
}
CircleUtilities.getCirclesIntersectionPolygon = getCirclesIntersectionPolygon;
/**
* Calculate the path for the area of overlap between a set of circles.
*
* @todo handle cases with only 1 or 0 arcs.
*
* @private
*
* @param {Array<Highcharts.CircleObject>} circles
* List of circles to calculate area of.
*
* @return {Highcharts.GeometryIntersectionObject|undefined}
* Returns the path for the area of overlap. Returns an empty string if
* there are no intersection between all the circles.
*/
function getAreaOfIntersectionBetweenCircles(circles) {
let intersectionPoints = getCirclesIntersectionPolygon(circles), result;
if (intersectionPoints.length > 1) {
// Calculate the center of the intersection points.
const center = getCenterOfPoints(intersectionPoints);
intersectionPoints = intersectionPoints
// Calculate the angle between the center and the points.
.map(function (p) {
p.angle = getAngleBetweenPoints(center, p);
return p;
})
// Sort the points by the angle to the center.
.sort(function (a, b) {
return b.angle - a.angle;
});
const startPoint = intersectionPoints[intersectionPoints.length - 1];
const arcs = intersectionPoints
.reduce(function (data, p1) {
const { startPoint } = data, midPoint = getCenterOfPoints([startPoint, p1]);
// Calculate the arc from the intersection points and their
// circles.
const arc = p1.indexes
// Filter out circles that are not included in both
// intersection points.
.filter(function (index) {
return startPoint.indexes.indexOf(index) > -1;
})
// Iterate the circles of the intersection points and
// calculate arcs.
.reduce(function (arc, index) {
const circle = circles[index], angle1 = getAngleBetweenPoints(circle, p1), angle2 = getAngleBetweenPoints(circle, startPoint), angleDiff = angle2 - angle1 +
(angle2 < angle1 ? 2 * Math.PI : 0), angle = angle2 - angleDiff / 2;
let width = getDistanceBetweenPoints(midPoint, {
x: circle.x + circle.r * Math.sin(angle),
y: circle.y + circle.r * Math.cos(angle)
});
const { r } = circle;
// Width can sometimes become to large due to
// floating point errors
if (width > r * 2) {
width = r * 2;
}
// Get the arc with the smallest width.
if (!arc || arc.width > width) {
arc = {
r,
largeArc: width > r ? 1 : 0,
width,
x: p1.x,
y: p1.y
};
}
// Return the chosen arc.
return arc;
}, null);
// If we find an arc then add it to the list and update p2.
if (arc) {
const { r } = arc;
data.arcs.push(['A', r, r, 0, arc.largeArc, 1, arc.x, arc.y]);
data.startPoint = p1;
}
return data;
}, {
startPoint: startPoint,
arcs: []
}).arcs;
if (arcs.length === 0) {
// Empty
}
else if (arcs.length === 1) {
// Empty
}
else {
arcs.unshift(['M', startPoint.x, startPoint.y]);
result = {
center,
d: arcs
};
}
}
return result;
}
CircleUtilities.getAreaOfIntersectionBetweenCircles = getAreaOfIntersectionBetweenCircles;
})(CircleUtilities || (CircleUtilities = {}));
/* *
*
* Default Export
*
* */
/* harmony default export */ const Geometry_CircleUtilities = (CircleUtilities);
;// ./code/es-modules/Series/DrawPointUtilities.js
/* *
*
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
*
* */
/* *
*
* Functions
*
* */
/**
* Handles the drawing of a component.
* Can be used for any type of component that reserves the graphic property,
* and provides a shouldDraw on its context.
*
* @private
*
* @todo add type checking.
* @todo export this function to enable usage
*/
function draw(point, params) {
const { animatableAttribs, onComplete, css, renderer } = params;
const animation = (point.series && point.series.chart.hasRendered) ?
// Chart-level animation on updates
void 0 :
// Series-level animation on new points
(point.series &&
point.series.options.animation);
let graphic = point.graphic;
params.attribs = {
...params.attribs,
'class': point.getClassName()
} || {};
if ((point.shouldDraw())) {
if (!graphic) {
if (params.shapeType === 'text') {
graphic = renderer.text();
}
else if (params.shapeType === 'image') {
graphic = renderer.image(params.imageUrl || '')
.attr(params.shapeArgs || {});
}
else {
graphic = renderer[params.shapeType](params.shapeArgs || {});
}
point.graphic = graphic;
graphic.add(params.group);
}
if (css) {
graphic.css(css);
}
graphic
.attr(params.attribs)
.animate(animatableAttribs, params.isNew ? false : animation, onComplete);
}
else if (graphic) {
const destroy = () => {
point.graphic = graphic = (graphic && graphic.destroy());
if (typeof onComplete === 'function') {
onComplete();
}
};
// Animate only runs complete callback if something was animated.
if (Object.keys(animatableAttribs).length) {
graphic.animate(animatableAttribs, void 0, () => destroy());
}
else {
destroy();
}
}
}
/* *
*
* Default Export
*
* */
const DrawPointUtilities = {
draw
};
/* harmony default export */ const Series_DrawPointUtilities = (DrawPointUtilities);
// EXTERNAL MODULE: external {"amd":["highcharts/highcharts","SeriesRegistry"],"commonjs":["highcharts","SeriesRegistry"],"commonjs2":["highcharts","SeriesRegistry"],"root":["Highcharts","SeriesRegistry"]}
var highcharts_SeriesRegistry_commonjs_highcharts_SeriesRegistry_commonjs2_highcharts_SeriesRegistry_root_Highcharts_SeriesRegistry_ = __webpack_require__(512);
var highcharts_SeriesRegistry_commonjs_highcharts_SeriesRegistry_commonjs2_highcharts_SeriesRegistry_root_Highcharts_SeriesRegistry_default = /*#__PURE__*/__webpack_require__.n(highcharts_SeriesRegistry_commonjs_highcharts_SeriesRegistry_commonjs2_highcharts_SeriesRegistry_root_Highcharts_SeriesRegistry_);
;// ./code/es-modules/Series/Venn/VennPoint.js
/* *
*
* Experimental Highcharts module which enables visualization of a Venn
* diagram.
*
* (c) 2016-2024 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. !!!!!!!
*
* */
const { scatter: { prototype: { pointClass: ScatterPoint } } } = (highcharts_SeriesRegistry_commonjs_highcharts_SeriesRegistry_commonjs2_highcharts_SeriesRegistry_root_Highcharts_SeriesRegistry_default()).seriesTypes;
const { isNumber } = (highcharts_commonjs_highcharts_commonjs2_highcharts_root_Highcharts_default());
/* *
*
* Class
*
* */
class VennPoint extends ScatterPoint {
/* *
*
* Functions
*
* */
isValid() {
return isNumber(this.value);
}
shouldDraw() {
// Only draw points with single sets.
return !!this.shapeArgs;
}
}
/* *
*
* Default Export
*
* */
/* harmony default export */ const Venn_VennPoint = (VennPoint);
;// ./code/es-modules/Series/Venn/VennSeriesDefaults.js
/* *
*
* Experimental Highcharts module which enables visualization of a Venn
* diagram.
*
* (c) 2016-2024 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. !!!!!!!
*
* */
/* *
*
* API Options
*
* */
/**
* 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
* @sample {highcharts} highcharts/series-venn/point-legend/
* Venn diagram with a legend
*
* @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
*/
const VennSeriesDefaults = {
borderColor: "#cccccc" /* Palette.neutralColor20 */,
borderDashStyle: 'solid',
borderWidth: 1,
brighten: 0,
clip: false,
colorByPoint: true,
dataLabels: {
enabled: true,
verticalAlign: 'middle',
formatter: function () {
return this.point.name;
}
},
/**
* @default true
* @extends plotOptions.series.inactiveOtherPoints
* @private
*/
inactiveOtherPoints: true,
/**
* @ignore-option
* @private
*/
marker: false,
opacity: 0.75,
showInLegend: false,
/**
* @ignore-option
*
* @private
*/
legendType: 'point',
states: {
/**
* @excluding halo
*/
hover: {
opacity: 1,
borderColor: "#333333" /* Palette.neutralColor80 */
},
/**
* @excluding halo
*/
select: {
color: "#cccccc" /* Palette.neutralColor20 */,
borderColor: "#000000" /* Palette.neutralColor100 */,
animation: false
},
inactive: {
opacity: 0.075
}
},
tooltip: {
pointFormat: '{point.name}: {point.value}'
},
legendSymbol: 'rectangle'
};
/**
* 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 {string}
* @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
*/
''; // Detachs doclets above
/* *
*
* Default Export
*
* */
/* harmony default export */ const Venn_VennSeriesDefaults = (VennSeriesDefaults);
;// ./code/es-modules/Series/Venn/VennUtils.js
/* *
*
* Experimental Highcharts module which enables visualization of a Venn
* diagram.
*
* (c) 2016-2024 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. !!!!!!!
*
* */
const { getAreaOfCircle, getCircleCircleIntersection, getOverlapBetweenCircles: getOverlapBetweenCirclesByDistance, isPointInsideAllCircles, isPointInsideCircle, isPointOutsideAllCircles } = Geometry_CircleUtilities;
const { getDistanceBetweenPoints: VennUtils_getDistanceBetweenPoints } = Geometry_GeometryUtilities;
const { extend, isArray, isNumber: VennUtils_isNumber, isObject, isString } = (highcharts_commonjs_highcharts_commonjs2_highcharts_root_Highcharts_default());
/* *
*
* Functions
*
* */
/**
* Takes an array of relations and adds the properties `totalOverlap` and
* `overlapping` to each set. The property `totalOverlap` is the sum of
* value for each relation where this set is included. The property
* `overlapping` is a map of how much this set is overlapping another set.
* NOTE: This algorithm ignores relations consisting of more than 2 sets.
* @private
* @param {Array<Highcharts.VennRelationObject>} relations
* The list of relations that should be sorted.
* @return {Array<Highcharts.VennRelationObject>}
* Returns the modified input relations with added properties `totalOverlap`
* and `overlapping`.
*/
function addOverlapToSets(relations) {
// Calculate the amount of overlap per set.
const mapOfIdToProps = {};
relations
// Filter out relations consisting of 2 sets.
.filter((relation) => (relation.sets.length === 2))
// Sum up the amount of overlap for each set.
.forEach((relation) => {
relation.sets.forEach((set, i, arr) => {
if (!isObject(mapOfIdToProps[set])) {
mapOfIdToProps[set] = {
totalOverlap: 0,
overlapping: {}
};
}
mapOfIdToProps[set] = {
totalOverlap: (mapOfIdToProps[set].totalOverlap || 0) +
relation.value,
overlapping: {
...(mapOfIdToProps[set].overlapping || {}),
[arr[1 - i]]: relation.value
}
};
});
});
relations
// Filter out single sets
.filter(isSet)
// Extend the set with the calculated properties.
.forEach((set) => {
const properties = mapOfIdToProps[set.sets[0]];
extend(set, properties);
});
// Returns the modified relations.
return relations;
}
/**
* Finds the root of a given function. The root is the input value needed
* for a function to return 0.
*
* See https://en.wikipedia.org/wiki/Bisection_method#Algorithm
*
* TODO: Add unit tests.
*
* @param {Function} f
* The function to find the root of.
* @param {number} a
* The lowest number in the search range.
* @param {number} b
* The highest number in the search range.
* @param {number} [tolerance=1e-10]
* The allowed difference between the returned value and root.
* @param {number} [maxIterations=100]
* The maximum iterations allowed.
* @return {number}
* Root number.
*/
function bisect(f, a, b, tolerance, maxIterations) {
const fA = f(a), fB = f(b), nMax = maxIterations || 100, tol = tolerance || 1e-10;
let delta = b - a, x, fX, n = 1;
if (a >= b) {
throw new Error('a must be smaller than b.');
}
else if (fA * fB > 0) {
throw new Error('f(a) and f(b) must have opposite signs.');
}
if (fA === 0) {
x = a;
}
else if (fB === 0) {
x = b;
}
else {
while (n++ <= nMax && fX !== 0 && delta > tol) {
delta = (b - a) / 2;
x = a + delta;
fX = f(x);
// Update low and high for next search interval.
if (fA * fX > 0) {
a = x;
}
else {
b = x;
}
}
}
return x;
}
/**
* @private
*/
function getCentroid(simplex) {
const arr = simplex.slice(0, -1), length = arr.length, result = [], sum = (data, point) => {
data.sum += point[data.i];
return data;
};
for (let i = 0; i < length; i++) {
result[i] = arr.reduce(sum, { sum: 0, i: i }).sum / length;
}
return result;
}
/**
* Uses the bisection method to make a best guess of the ideal distance
* between two circles too get the desired overlap.
* Currently there is no known formula to calculate the distance from the
* area of overlap, which makes the bisection method preferred.
* @private
* @param {number} r1
* Radius of the first circle.
* @param {number} r2
* Radius of the second circle.
* @param {number} overlap
* The wanted overlap between the two circles.
* @return {number}
* Returns the distance needed to get the wanted overlap between the two
* circles.
*/
function getDistanceBetweenCirclesByOverlap(r1, r2, overlap) {
const maxDistance = r1 + r2;
let distance;
if (overlap <= 0) {
// If overlap is below or equal to zero, then there is no overlap.
distance = maxDistance;
}
else if (getAreaOfCircle(r1 < r2 ? r1 : r2) <= overlap) {
// When area of overlap is larger than the area of the smallest
// circle, then it is completely overlapping.
distance = 0;
}
else {
distance = bisect((x) => {
const actualOverlap = getOverlapBetweenCirclesByDistance(r1, r2, x);
// Return the difference between wanted and actual overlap.
return overlap - actualOverlap;
}, 0, maxDistance);
}
return distance;
}
/**
* Finds the available width for a label, by taking the label position and
* finding the largest distance, which is inside all internal circles, and
* outside all external circles.
*
* @private
* @param {Highcharts.PositionObject} pos
* The x and y coordinate of the label.
* @param {Array<Highcharts.CircleObject>} internal
* Internal circles.
* @param {Array<Highcharts.CircleObject>} external
* External circles.
* @return {number}
* Returns available width for the label.
*/
function getLabelWidth(pos, internal, external) {
const radius = internal.reduce((min, circle) => Math.min(circle.r, min), Infinity),
// Filter out external circles that are completely overlapping.
filteredExternals = external.filter((circle) => !isPointInsideCircle(pos, circle));
const findDistance = function (maxDistance, direction) {
return bisect((x) => {
const testPos = {
x: pos.x + (direction * x),
y: pos.y
}, isValid = (isPointInsideAllCircles(testPos, internal) &&
isPointOutsideAllCircles(testPos, filteredExternals));
// If the position is valid, then we want to move towards the
// max distance. If not, then we want to away from the max distance.
return -(maxDistance - x) + (isValid ? 0 : Number.MAX_VALUE);
}, 0, maxDistance);
};
// Find the smallest distance of left and right.
return Math.min(findDistance(radius, -1), findDistance(radius, 1)) * 2;
}
/**
* Calculates a margin for a point based on the internal and external
* circles. The margin describes if the point is well placed within the
* internal circles, and away from the external.
* @private
* @todo add unit tests.
* @param {Highcharts.PositionObject} point
* The point to evaluate.
* @param {Array<Highcharts.CircleObject>} internal
* The internal circles.
* @param {Array<Highcharts.CircleObject>} external
* The external circles.
* @return {number}
* Returns the margin.
*/
function getMarginFromCircles(point, internal, external) {
let margin = internal.reduce((margin, circle) => {
const m = circle.r - VennUtils_getDistanceBetweenPoints(point, circle);
return (m <= margin) ? m : margin;
}, Number.MAX_VALUE);
margin = external.reduce((margin, circle) => {
const m = VennUtils_getDistanceBetweenPoints(point, circle) - circle.r;
return (m <= margin) ? m : margin;
}, margin);
return margin;
}
/**
* Calculates the area of overlap between a list of circles.
* @private
* @todo add support for calculating overlap between more than 2 circles.
* @param {Array<Highcharts.CircleObject>} circles
* List of circles with their given positions.
* @return {number}
* Returns the area of overlap between all the circles.
*/
function getOverlapBetweenCircles(circles) {
let overlap = 0;
// When there is only two circles we can find the overlap by using their
// radiuses and the distance between them.
if (circles.length === 2) {
const circle1 = circles[0];
const circle2 = circles[1];
overlap = getOverlapBetweenCirclesByDistance(circle1.r, circle2.r, VennUtils_getDistanceBetweenPoints(circle1, circle2));
}
return overlap;
}
// eslint-disable-next-line require-jsdoc
/**
*
*/
function isSet(x) {
return isArray(x.sets) && x.sets.length === 1;
}
// eslint-disable-next-line require-jsdoc
/**
*
*/
function isValidRelation(x) {
const map = {};
return (isObject(x) &&
(VennUtils_isNumber(x.value) && x.value > -1) &&
(isArray(x.sets) && x.sets.length > 0) &&
!x.sets.some(function (set) {
let invalid = false;
if (!map[set] && isString(set)) {
map[set] = true;
}
else {
invalid = true;
}
return invalid;
}));
}
// eslint-disable-next-line require-jsdoc
/**
*
*/
function isValidSet(x) {
return (isValidRelation(x) && isSet(x) && x.value > 0);
}
/**
* Uses a greedy approach to position all the sets. Works well with a small
* number of sets, and are in these cases a good choice aesthetically.
* @private
* @param {Array<object>} relations List of the overlap between two or more
* sets, or the size of a single set.
* @return {Array<object>} List of circles and their calculated positions.
*/
function layoutGreedyVenn(relations) {
const positionedSets = [], mapOfIdToCircles = {};
// Define a circle for each set.
relations
.filter((relation) => (relation.sets.length === 1))
.forEach((relation) => {
mapOfIdToCircles[relation.sets[0]] = relation.circle = {
x: Number.MAX_VALUE,
y: Number.MAX_VALUE,
r: Math.sqrt(relation.value / Math.PI)
};
});
/**
* Takes a set and updates the position, and add the set to the list of
* positioned sets.
* @private
* @param {Object} set
* The set to add to its final position.
* @param {Object} coordinates
* The coordinates to position the set at.
*/
const positionSet = (set, coordinates) => {
const circle = set.circle;
if (circle) {
circle.x = coordinates.x;
circle.y = coordinates.y;
}
positionedSets.push(set);
};
// Find overlap between sets. Ignore relations with more then 2 sets.
addOverlapToSets(relations);
// Sort sets by the sum of their size from large to small.
const sortedByOverlap = relations
.filter(isSet)
.sort(sortByTotalOverlap);
// Position the most overlapped set at 0,0.
positionSet(sortedByOverlap.shift(), { x: 0, y: 0 });
const relationsWithTwoSets = relations.filter((x) => (x.sets.length === 2));
// Iterate and position the remaining sets.
for (const set of sortedByOverlap) {
const circle = set.circle;
if (!circle) {
continue;
}
const radius = circle.r, overlapping = set.overlapping;
const bestPosition = positionedSets.reduce((best, positionedSet, i) => {
const positionedCircle = positionedSet.circle;
if (!positionedCircle || !overlapping) {
return best;
}
const overlap = overlapping[positionedSet.sets[0]];
// Calculate the distance between the sets to get the
// correct overlap
const distance = getDistanceBetweenCirclesByOverlap(radius, positionedCircle.r, overlap);
// Create a list of possible coordinates calculated from
// distance.
let possibleCoordinates = [
{ x: positionedCircle.x + distance, y: positionedCircle.y },
{ x: positionedCircle.x - distance, y: positionedCircle.y },
{ x: positionedCircle.x, y: positionedCircle.y + distance },
{ x: positionedCircle.x, y: positionedCircle.y - distance }
];
// If there are more circles overlapping, then add the
// intersection points as possible positions.
for (const positionedSet2 of positionedSets.slice(i + 1)) {
const positionedCircle2 = positionedSet2.circle, overlap2 = overlapping[positionedSet2.sets[0]];
if (!positionedCircle2) {
continue;
}
const distance2 = getDistanceBetweenCirclesByOverlap(radius, positionedCircle2.r, overlap2);
// Add intersections to list of coordinates.
possibleCoordinates = possibleCoordinates.concat(getCircleCircleIntersection({
x: positionedCircle.x,
y: positionedCircle.y,
r: distance
}, {
x: positionedCircle2.x,
y: positionedCircle2.y,
r: distance2
}));
}
// Iterate all suggested coordinates and find the best one.
for (const coordinates of possibleCoordinates) {
circle.x = coordinates.x;
circle.y = coordinates.y;
// Calculate loss for the suggested coordinates.
const currentLoss = loss(mapOfIdToCircles, relationsWithTwoSets);
// If the loss is better, then use these new coordinates
if (currentLoss < best.loss) {
best.loss = currentLoss;
best.coordinates = coordinates;
}
}
// Return resulting coordinates.
return best;
}, {
loss: Number.MAX_VALUE,
coordinates: void 0
});
// Add the set to its final position.
positionSet(set, bestPosition.coordinates);
}
// Return the positions of each set.
return mapOfIdToCircles;
}
/**
* Calculates the difference between the desired overlap and the actual
* overlap between two circles.
* @private
* @param {Dictionary<Highcharts.CircleObject>} mapOfIdToCircle
* Map from id to circle.
* @param {Array<Highcharts.VennRelationObject>} relations
* List of relations to calculate the loss of.
* @return {number}
* Returns the loss between positions of the circles for the given
* relations.
*/
function loss(mapOfIdToCircle, relations) {
const precision = 10e10;
// Iterate all the relations and calculate their individual loss.
return relations.reduce(function (totalLoss, relation) {
let loss = 0;
if (relation.sets.length > 1) {
const wantedOverlap = relation.value;
// Calculate the actual overlap between the sets.
const actualOverlap = getOverlapBetweenCircles(
// Get the circles for the given sets.
relation.sets.map(function (set) {
return mapOfIdToCircle[set];
}));
const diff = wantedOverlap - actualOverlap;
loss = Math.round((diff * diff) * precision) / precision;
}
// Add calculated loss to the sum.
return totalLoss + loss;
}, 0);
}
/**
* Finds an optimal position for a given point.
* @todo add unit tests.
* @todo add constraints to optimize the algorithm.
* @private
* @param {Highcharts.NelderMeadTestFunction} fn
* The function to test a point.
* @param {Highcharts.NelderMeadPointArray} initial
* The initial point to optimize.
* @return {Highcharts.NelderMeadPointArray}
* Returns the optimized position of a point.
*/
function nelderMead(fn, initial) {
const maxIterations = 100, sortByFx = function (a, b) {
return a.fx - b.fx;
}, pRef = 1, // Reflection parameter
pExp = 2, // Expansion parameter
pCon = -0.5, // Contraction parameter
pOCon = pCon * pRef, // Outwards contraction parameter
pShrink = 0.5; // Shrink parameter
/**
* @private
*/
const weightedSum = (weight1, v1, weight2, v2) => v1.map((x, i) => weight1 * x + weight2 * v2[i]);
/**
* @private
*/
const getSimplex = (initial) => {
const n = initial.length, simplex = new Array(n + 1);
// Initial point to the simplex.
simplex[0] = initial;
simplex[0].fx = fn(initial);
// Create a set of extra points based on the initial.
for (let i = 0; i < n; ++i) {
const point = initial.slice();
point[i] = point[i] ? point[i] * 1.05 : 0.001;
point.fx = fn(point);
simplex[i + 1] = point;
}
return simplex;
};
const updateSimplex = (simplex, point) => {
point.fx = fn(point);
simplex[simplex.length - 1] = point;
return simplex;
};
const shrinkSimplex = (simplex) => {
const best = simplex[0];
return simplex.map((point) => {
const p = weightedSum(1 - pShrink, best, pShrink, point);
p.fx = fn(p);
return p;
});
};
const getPoint = (centroid, worst, a, b) => {
const point = weightedSum(a, centroid, b, worst);
point.fx = fn(point);
return point;
};
// Create a simplex
let simplex = getSimplex(initial);
// Iterate from 0 to max iterations
for (let i = 0; i < maxIterations; i++) {
// Sort the simplex
simplex.sort(sortByFx);
// Create a centroid from the simplex
const worst = simplex[simplex.length - 1];
const centroid = getCentroid(simplex);
// Calculate the reflected point.
const reflected = getPoint(centroid, worst, 1 + pRef, -pRef);
if (reflected.fx < simplex[0].fx) {
// If reflected point is the best, then possibly expand.
const expanded = getPoint(centroid, worst, 1 + pExp, -pExp);
simplex = updateSimplex(simplex, (expanded.fx < reflected.fx) ? expanded : reflected);
}
else if (reflected.fx >= simplex[simplex.length -