1024 lines
38 KiB
JavaScript
1024 lines
38 KiB
JavaScript
/* *
|
|
*
|
|
* Experimental Highcharts module which enables visualization of a Venn
|
|
* diagram.
|
|
*
|
|
* (c) 2016-2020 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. !!!!!!!
|
|
*
|
|
* */
|
|
'use strict';
|
|
import H from '../parts/Globals.js';
|
|
import draw from '../mixins/draw-point.js';
|
|
import geometry from '../mixins/geometry.js';
|
|
import geometryCirclesModule from '../mixins/geometry-circles.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 nelderMeadModule from '../mixins/nelder-mead.js';
|
|
// TODO: replace with individual imports
|
|
var nelderMead = nelderMeadModule.nelderMead;
|
|
import Color from '../parts/Color.js';
|
|
var color = Color.parse;
|
|
import U from '../parts/Utilities.js';
|
|
var addEvent = U.addEvent, animObject = U.animObject, extend = U.extend, isArray = U.isArray, isNumber = U.isNumber, isObject = U.isObject, isString = U.isString, merge = U.merge, seriesType = U.seriesType;
|
|
import '../parts/Series.js';
|
|
var getCenterOfPoints = geometry.getCenterOfPoints, getDistanceBetweenPoints = geometry.getDistanceBetweenPoints, seriesTypes = H.seriesTypes;
|
|
var objectValues = function objectValues(obj) {
|
|
return Object.keys(obj).map(function (x) {
|
|
return obj[x];
|
|
});
|
|
};
|
|
/**
|
|
* 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.
|
|
*/
|
|
var getOverlapBetweenCircles = function getOverlapBetweenCircles(circles) {
|
|
var 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) {
|
|
var circle1 = circles[0];
|
|
var circle2 = circles[1];
|
|
overlap = getOverlapBetweenCirclesByDistance(circle1.r, circle2.r, getDistanceBetweenPoints(circle1, circle2));
|
|
}
|
|
return overlap;
|
|
};
|
|
/**
|
|
* 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.
|
|
*/
|
|
var loss = function loss(mapOfIdToCircle, relations) {
|
|
var precision = 10e10;
|
|
// Iterate all the relations and calculate their individual loss.
|
|
return relations.reduce(function (totalLoss, relation) {
|
|
var loss = 0;
|
|
if (relation.sets.length > 1) {
|
|
var wantedOverlap = relation.value;
|
|
// Calculate the actual overlap between the sets.
|
|
var actualOverlap = getOverlapBetweenCircles(
|
|
// Get the circles for the given sets.
|
|
relation.sets.map(function (set) {
|
|
return mapOfIdToCircle[set];
|
|
}));
|
|
var diff = wantedOverlap - actualOverlap;
|
|
loss = Math.round((diff * diff) * precision) / precision;
|
|
}
|
|
// Add calculated loss to the sum.
|
|
return totalLoss + loss;
|
|
}, 0);
|
|
};
|
|
/**
|
|
* 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.
|
|
*/
|
|
var bisect = function bisect(f, a, b, tolerance, maxIterations) {
|
|
var fA = f(a), fB = f(b), nMax = maxIterations || 100, tol = tolerance || 1e-10, delta = b - a, n = 1, x, fX;
|
|
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;
|
|
};
|
|
/**
|
|
* 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
|
|
* Radiues 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.
|
|
*/
|
|
var getDistanceBetweenCirclesByOverlap = function getDistanceBetweenCirclesByOverlap(r1, r2, overlap) {
|
|
var maxDistance = r1 + r2, 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(function (x) {
|
|
var actualOverlap = getOverlapBetweenCirclesByDistance(r1, r2, x);
|
|
// Return the differance between wanted and actual overlap.
|
|
return overlap - actualOverlap;
|
|
}, 0, maxDistance);
|
|
}
|
|
return distance;
|
|
};
|
|
var isSet = function (x) {
|
|
return isArray(x.sets) && x.sets.length === 1;
|
|
};
|
|
/**
|
|
* Calculates a margin for a point based on the iternal 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.
|
|
*/
|
|
var getMarginFromCircles = function getMarginFromCircles(point, internal, external) {
|
|
var margin = internal.reduce(function (margin, circle) {
|
|
var m = circle.r - getDistanceBetweenPoints(point, circle);
|
|
return (m <= margin) ? m : margin;
|
|
}, Number.MAX_VALUE);
|
|
margin = external.reduce(function (margin, circle) {
|
|
var m = getDistanceBetweenPoints(point, circle) - circle.r;
|
|
return (m <= margin) ? m : margin;
|
|
}, margin);
|
|
return margin;
|
|
};
|
|
/**
|
|
* 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.
|
|
*/
|
|
var getLabelPosition = function getLabelPosition(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 = getMarginFromCircles(point, internal, external);
|
|
// If the margin better than the current best, then update best.
|
|
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 -(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;
|
|
};
|
|
/**
|
|
* 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.
|
|
*/
|
|
var getLabelWidth = function getLabelWidth(pos, internal, external) {
|
|
var radius = internal.reduce(function (min, circle) {
|
|
return Math.min(circle.r, min);
|
|
}, Infinity),
|
|
// Filter out external circles that are completely overlapping.
|
|
filteredExternals = external.filter(function (circle) {
|
|
return !isPointInsideCircle(pos, circle);
|
|
});
|
|
var findDistance = function (maxDistance, direction) {
|
|
return bisect(function (x) {
|
|
var 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;
|
|
};
|
|
/**
|
|
* 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.
|
|
*/
|
|
function getLabelValues(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 = getLabelPosition(data.internal, data.external);
|
|
// Calculate the label width
|
|
var width = getLabelWidth(position, data.internal, data.external);
|
|
return {
|
|
position: position,
|
|
width: width
|
|
};
|
|
}
|
|
/**
|
|
* 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`.
|
|
*/
|
|
var addOverlapToSets = function addOverlapToSets(relations) {
|
|
// Calculate the amount of overlap per set.
|
|
var mapOfIdToProps = relations
|
|
// Filter out relations consisting of 2 sets.
|
|
.filter(function (relation) {
|
|
return relation.sets.length === 2;
|
|
})
|
|
// Sum up the amount of overlap for each set.
|
|
.reduce(function (map, relation) {
|
|
var sets = relation.sets;
|
|
sets.forEach(function (set, i, arr) {
|
|
if (!isObject(map[set])) {
|
|
map[set] = {
|
|
overlapping: {},
|
|
totalOverlap: 0
|
|
};
|
|
}
|
|
map[set].totalOverlap += relation.value;
|
|
map[set].overlapping[arr[1 - i]] = relation.value;
|
|
});
|
|
return map;
|
|
}, {});
|
|
relations
|
|
// Filter out single sets
|
|
.filter(isSet)
|
|
// Extend the set with the calculated properties.
|
|
.forEach(function (set) {
|
|
var properties = mapOfIdToProps[set.sets[0]];
|
|
extend(set, properties);
|
|
});
|
|
// Returns the modified relations.
|
|
return relations;
|
|
};
|
|
/**
|
|
* Takes two sets and finds the one with the largest total overlap.
|
|
* @private
|
|
* @param {object} a The first set to compare.
|
|
* @param {object} b The second set to compare.
|
|
* @return {number} Returns 0 if a and b are equal, <0 if a is greater, >0 if b
|
|
* is greater.
|
|
*/
|
|
var sortByTotalOverlap = function sortByTotalOverlap(a, b) {
|
|
return b.totalOverlap - a.totalOverlap;
|
|
};
|
|
/**
|
|
* 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.
|
|
*/
|
|
var layoutGreedyVenn = function layoutGreedyVenn(relations) {
|
|
var positionedSets = [], mapOfIdToCircles = {};
|
|
// Define a circle for each set.
|
|
relations
|
|
.filter(function (relation) {
|
|
return relation.sets.length === 1;
|
|
}).forEach(function (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.
|
|
* @return {void}
|
|
*/
|
|
var positionSet = function positionSet(set, coordinates) {
|
|
var circle = set.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.
|
|
var sortedByOverlap = relations
|
|
.filter(isSet)
|
|
.sort(sortByTotalOverlap);
|
|
// Position the most overlapped set at 0,0.
|
|
positionSet(sortedByOverlap.shift(), { x: 0, y: 0 });
|
|
var relationsWithTwoSets = relations.filter(function (x) {
|
|
return x.sets.length === 2;
|
|
});
|
|
// Iterate and position the remaining sets.
|
|
sortedByOverlap.forEach(function (set) {
|
|
var circle = set.circle, radius = circle.r, overlapping = set.overlapping;
|
|
var bestPosition = positionedSets
|
|
.reduce(function (best, positionedSet, i) {
|
|
var positionedCircle = positionedSet.circle, overlap = overlapping[positionedSet.sets[0]];
|
|
// Calculate the distance between the sets to get the correct
|
|
// overlap
|
|
var distance = getDistanceBetweenCirclesByOverlap(radius, positionedCircle.r, overlap);
|
|
// Create a list of possible coordinates calculated from
|
|
// distance.
|
|
var 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.
|
|
positionedSets.slice(i + 1).forEach(function (positionedSet2) {
|
|
var positionedCircle2 = positionedSet2.circle, overlap2 = overlapping[positionedSet2.sets[0]], 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.
|
|
possibleCoordinates.forEach(function (coordinates) {
|
|
circle.x = coordinates.x;
|
|
circle.y = coordinates.y;
|
|
// Calculate loss for the suggested coordinates.
|
|
var 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 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 set.
|
|
* @return {Highcharts.Dictionary<*>}
|
|
* List of circles and their calculated positions.
|
|
*/
|
|
function layout(relations) {
|
|
var mapOfIdToShape = {};
|
|
var mapOfIdToLabelValues = {};
|
|
// Calculate best initial positions by using greedy layout.
|
|
if (relations.length > 0) {
|
|
var mapOfIdToCircles_1 = layoutGreedyVenn(relations);
|
|
var setRelations_1 = relations.filter(isSet);
|
|
relations
|
|
.forEach(function (relation) {
|
|
var sets = relation.sets;
|
|
var id = sets.join();
|
|
// Get shape from map of circles, or calculate intersection.
|
|
var shape = 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] = getLabelValues(relation, setRelations_1);
|
|
}
|
|
});
|
|
}
|
|
return { mapOfIdToShape: mapOfIdToShape, mapOfIdToLabelValues: mapOfIdToLabelValues };
|
|
}
|
|
var isValidRelation = function (x) {
|
|
var map = {};
|
|
return (isObject(x) &&
|
|
(isNumber(x.value) && x.value > -1) &&
|
|
(isArray(x.sets) && x.sets.length > 0) &&
|
|
!x.sets.some(function (set) {
|
|
var invalid = false;
|
|
if (!map[set] && isString(set)) {
|
|
map[set] = true;
|
|
}
|
|
else {
|
|
invalid = true;
|
|
}
|
|
return invalid;
|
|
}));
|
|
};
|
|
var isValidSet = function (x) {
|
|
return (isValidRelation(x) && isSet(x) && x.value > 0);
|
|
};
|
|
/**
|
|
* Prepares the venn data so that it is usable for the layout function. Filter
|
|
* out sets, or intersections that includes sets, that are missing in the data
|
|
* or has (value < 1). Adds missing relations between sets in the data as
|
|
* value = 0.
|
|
* @private
|
|
* @param {Array<object>} data The raw input data.
|
|
* @return {Array<object>} Returns an array of valid venn data.
|
|
*/
|
|
var processVennData = function processVennData(data) {
|
|
var d = isArray(data) ? data : [];
|
|
var validSets = d
|
|
.reduce(function (arr, x) {
|
|
// Check if x is a valid set, and that it is not an duplicate.
|
|
if (isValidSet(x) && arr.indexOf(x.sets[0]) === -1) {
|
|
arr.push(x.sets[0]);
|
|
}
|
|
return arr;
|
|
}, [])
|
|
.sort();
|
|
var mapOfIdToRelation = d.reduce(function (mapOfIdToRelation, relation) {
|
|
if (isValidRelation(relation) &&
|
|
!relation.sets.some(function (set) {
|
|
return validSets.indexOf(set) === -1;
|
|
})) {
|
|
mapOfIdToRelation[relation.sets.sort().join()] =
|
|
relation;
|
|
}
|
|
return mapOfIdToRelation;
|
|
}, {});
|
|
validSets.reduce(function (combinations, set, i, arr) {
|
|
var remaining = arr.slice(i + 1);
|
|
remaining.forEach(function (set2) {
|
|
combinations.push(set + ',' + set2);
|
|
});
|
|
return combinations;
|
|
}, []).forEach(function (combination) {
|
|
if (!mapOfIdToRelation[combination]) {
|
|
var obj = {
|
|
sets: combination.split(','),
|
|
value: 0
|
|
};
|
|
mapOfIdToRelation[combination] = obj;
|
|
}
|
|
});
|
|
// Transform map into array.
|
|
return objectValues(mapOfIdToRelation);
|
|
};
|
|
/**
|
|
* 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.
|
|
*/
|
|
var getScale = function getScale(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.
|
|
*/
|
|
var updateFieldBoundaries = function updateFieldBoundaries(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;
|
|
};
|
|
/**
|
|
* 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
|
|
* @product highcharts
|
|
* @requires modules/venn
|
|
* @optionparent plotOptions.venn
|
|
*/
|
|
var vennOptions = {
|
|
borderColor: '#cccccc',
|
|
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: '#333333'
|
|
},
|
|
/**
|
|
* @excluding halo
|
|
*/
|
|
select: {
|
|
color: '#cccccc',
|
|
borderColor: '#000000',
|
|
animation: false
|
|
},
|
|
inactive: {
|
|
opacity: 0.075
|
|
}
|
|
},
|
|
tooltip: {
|
|
pointFormat: '{point.name}: {point.value}'
|
|
}
|
|
};
|
|
var vennSeries = {
|
|
isCartesian: false,
|
|
axisTypes: [],
|
|
directTouch: true,
|
|
pointArrayMap: ['value'],
|
|
translate: function () {
|
|
var chart = this.chart;
|
|
this.processedXData = this.xData;
|
|
this.generatePoints();
|
|
// Process the data before passing it into the layout function.
|
|
var relations = processVennData(this.options.data);
|
|
// Calculate the positions of each circle.
|
|
var _a = 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 updateFieldBoundaries(field, mapOfIdToShape[key]);
|
|
}, { top: 0, bottom: 0, left: 0, right: 0 }), scaling = 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('∩');
|
|
});
|
|
},
|
|
/* eslint-disable valid-jsdoc */
|
|
/**
|
|
* Draw the graphics for each point.
|
|
* @private
|
|
*/
|
|
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'
|
|
});
|
|
});
|
|
},
|
|
/**
|
|
* 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.
|
|
*/
|
|
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)
|
|
.setOpacity(options.opacity)
|
|
.brighten(options.brightness)
|
|
.get(),
|
|
'stroke': options.borderColor,
|
|
'stroke-width': options.borderWidth,
|
|
'dashstyle': options.borderDashStyle
|
|
};
|
|
},
|
|
/* eslint-enable valid-jsdoc */
|
|
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);
|
|
}
|
|
},
|
|
utils: {
|
|
addOverlapToSets: addOverlapToSets,
|
|
geometry: geometry,
|
|
geometryCircles: geometryCirclesModule,
|
|
getLabelWidth: getLabelWidth,
|
|
getMarginFromCircles: getMarginFromCircles,
|
|
getDistanceBetweenCirclesByOverlap: getDistanceBetweenCirclesByOverlap,
|
|
layoutGreedyVenn: layoutGreedyVenn,
|
|
loss: loss,
|
|
nelderMead: nelderMeadModule,
|
|
processVennData: processVennData,
|
|
sortByTotalOverlap: sortByTotalOverlap
|
|
}
|
|
};
|
|
var vennPoint = {
|
|
draw: draw,
|
|
shouldDraw: function () {
|
|
var point = this;
|
|
// Only draw points with single sets.
|
|
return !!point.shapeArgs;
|
|
},
|
|
isValid: function () {
|
|
return isNumber(this.value);
|
|
}
|
|
};
|
|
/**
|
|
* 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
|
|
* @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
|
|
*/
|
|
/**
|
|
* @private
|
|
* @class
|
|
* @name Highcharts.seriesTypes.venn
|
|
*
|
|
* @augments Highcharts.Series
|
|
*/
|
|
seriesType('venn', 'scatter', vennOptions, vennSeries, vennPoint);
|
|
/* eslint-disable no-invalid-this */
|
|
// Modify final series options.
|
|
addEvent(seriesTypes.venn, '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;
|
|
});
|
|
}
|
|
});
|