wordcloud.src.js 30.5 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
/**
 * (c) 2016 Highsoft AS
 * Authors: Jon Arild Nygard
 *
 * License: www.highcharts.com/license
 *
 * This is an experimental Highcharts module which enables visualization
 * of a word cloud.
 */
'use strict';
import H from '../parts/Globals.js';
import drawPoint from '../mixins/draw-point.js';
import polygon from '../mixins/polygon.js';
import '../parts/Series.js';
var each = H.each,
    extend = H.extend,
    isArray = H.isArray,
    isNumber = H.isNumber,
    isObject = H.isObject,
    map = H.map,
    merge = H.merge,
    find = H.find,
    reduce = H.reduce,
    getBoundingBoxFromPolygon = polygon.getBoundingBoxFromPolygon,
    getPolygon = polygon.getPolygon,
    isPolygonsColliding = polygon.isPolygonsColliding,
    movePolygon = polygon.movePolygon,
    Series = H.Series;

/**
 * isRectanglesIntersecting - Detects if there is a collision between two
 *                            rectangles.
 *
 * @param  {object} r1 First rectangle.
 * @param  {object} r2 Second rectangle.
 * @return {boolean} Returns true if the rectangles overlap.
 */
var isRectanglesIntersecting = function isRectanglesIntersecting(r1, r2) {
    return !(
        r2.left > r1.right ||
        r2.right < r1.left ||
        r2.top > r1.bottom ||
        r2.bottom < r1.top
    );
};

/**
 * intersectsAnyWord - Detects if a word collides with any previously placed
 *                     words.
 *
 * @param  {Point} point Point which the word is connected to.
 * @param  {Array} points Previously placed points to check against.
 * @return {boolean} Returns true if there is collision.
 */
var intersectsAnyWord = function intersectsAnyWord(point, points) {
    var intersects = false,
        rect = point.rect,
        polygon = point.polygon,
        lastCollidedWith = point.lastCollidedWith,
        isIntersecting = function (p) {
            var result = isRectanglesIntersecting(rect, p.rect);
            if (result && (point.rotation % 90 || p.roation % 90)) {
                result = isPolygonsColliding(
                    polygon,
                    p.polygon
                );
            }
            return result;
        };

    // If the point has already intersected a different point, chances are they
    // are still intersecting. So as an enhancement we check this first.
    if (lastCollidedWith) {
        intersects = isIntersecting(lastCollidedWith);
        // If they no longer intersects, remove the cache from the point.
        if (!intersects) {
            delete point.lastCollidedWith;
        }
    }

    // If not already found, then check if we can find a point that is
    // intersecting.
    if (!intersects) {
        intersects = !!find(points, function (p) {
            var result = isIntersecting(p);
            if (result) {
                point.lastCollidedWith = p;
            }
            return result;
        });
    }
    return intersects;
};

/**
 * archimedeanSpiral - Gives a set of cordinates for an Archimedian Spiral.
 *
 * @param {number} attempt How far along the spiral we have traversed.
 * @param {object} params Additional parameters.
 * @param {object} params.field Size of field.
 * @return {boolean|object} Resulting coordinates, x and y. False if the word
 * should be dropped from the visualization.
 */
var archimedeanSpiral = function archimedeanSpiral(attempt, params) {
    var field = params.field,
        result = false,
        maxDelta = (field.width * field.width) + (field.height * field.height),
        t = attempt * 0.8; // 0.2 * 4 = 0.8. Enlarging the spiral.
    // Emergency brake. TODO make spiralling logic more foolproof.
    if (attempt <= 10000) {
        result = {
            x: t * Math.cos(t),
            y: t * Math.sin(t)
        };
        if (!(Math.min(Math.abs(result.x), Math.abs(result.y)) < maxDelta)) {
            result = false;
        }
    }
    return result;
};

/**
 * squareSpiral - Gives a set of cordinates for an rectangular spiral.
 *
 * @param {number} attempt How far along the spiral we have traversed.
 * @param {object} params Additional parameters.
 * @return {boolean|object} Resulting coordinates, x and y. False if the word
 * should be dropped from the visualization.
 */
var squareSpiral = function squareSpiral(attempt) {
    var a = attempt * 4,
        k = Math.ceil((Math.sqrt(a) - 1) / 2),
        t = 2 * k + 1,
        m = Math.pow(t, 2),
        isBoolean = function (x) {
            return typeof x === 'boolean';
        },
        result = false;
    t -= 1;
    if (attempt <= 10000) {
        if (isBoolean(result) && a >= m - t) {
            result = {
                x: k - (m - a),
                y: -k
            };
        }
        m -= t;
        if (isBoolean(result) && a >= m - t) {
            result = {
                x: -k,
                y: -k + (m - a)
            };
        }

        m -= t;
        if (isBoolean(result)) {
            if (a >= m - t) {
                result = {
                    x: -k + (m - a),
                    y: k
                };
            } else {
                result = {
                    x: k,
                    y: k - (m - a - t)
                };
            }
        }
        result.x *= 5;
        result.y *= 5;
    }
    return result;
};

/**
 * rectangularSpiral - Gives a set of cordinates for an rectangular spiral.
 *
 * @param {number} attempt How far along the spiral we have traversed.
 * @param {object} params Additional parameters.
 * @return {boolean|object} Resulting coordinates, x and y. False if the word
 * should be dropped from the visualization.
 */
var rectangularSpiral = function rectangularSpiral(attempt, params) {
    var result = squareSpiral(attempt, params),
        field = params.field;
    if (result) {
        result.x *= field.ratioX;
        result.y *= field.ratioY;
    }
    return result;
};

/**
 * getRandomPosition
 *
 * @param  {number} size
 * @return {number}
 */
var getRandomPosition = function getRandomPosition(size) {
    return Math.round((size * (Math.random() + 0.5)) / 2);
};

/**
 * getScale - Calculates the proper scale to fit the cloud inside the plotting
 *            area.
 *
 * @param  {number} targetWidth  Width of target area.
 * @param  {number} targetHeight Height of target area.
 * @param  {object} field The playing field.
 * @param  {Series} series Series object.
 * @return {number} Returns the value to scale the playing field up to the size
 *     of the target area.
 */
var getScale = function getScale(targetWidth, targetHeight, field) {
    var height = Math.max(Math.abs(field.top), Math.abs(field.bottom)) * 2,
        width = Math.max(Math.abs(field.left), Math.abs(field.right)) * 2,
        scaleX = width > 0 ? 1 / width * targetWidth : 1,
        scaleY = height > 0 ? 1 / height * targetHeight : 1;
    return Math.min(scaleX, scaleY);
};

/**
 * getPlayingField - Calculates what is called the playing field.
 *    The field is the area which all the words are allowed to be positioned
 *    within. The area is proportioned to match the target aspect ratio.
 *
 * @param  {number} targetWidth Width of the target area.
 * @param  {number} targetHeight Height of the target area.
 * @param  {array} data Array of {@link Point} objects.
 * @param  {object} data.dimensions The height and width of the word.
 * @return {object} The width and height of the playing field.
 */
var getPlayingField = function getPlayingField(
    targetWidth,
    targetHeight,
    data
) {
    var info = reduce(data, function (obj, point) {
            var dimensions = point.dimensions,
                x = Math.max(dimensions.width, dimensions.height);
            // Find largest height.
            obj.maxHeight = Math.max(obj.maxHeight, dimensions.height);
            // Find largest width.
            obj.maxWidth = Math.max(obj.maxWidth, dimensions.width);
            // Sum up the total maximum area of all the words.
            obj.area += x * x;
            return obj;
        }, {
            maxHeight: 0,
            maxWidth: 0,
            area: 0
        }),
        /**
         * Use largest width, largest height, or root of total area to give size
         * to the playing field.
         */
        x = Math.max(
            info.maxHeight, // Have enough space for the tallest word
            info.maxWidth, // Have enough space for the broadest word
            // Adjust 15% to account for close packing of words
            Math.sqrt(info.area) * 0.85
        ),
        ratioX = targetWidth > targetHeight ? targetWidth / targetHeight : 1,
        ratioY = targetHeight > targetWidth ? targetHeight / targetWidth : 1;
    return {
        width: x * ratioX,
        height: x * ratioY,
        ratioX: ratioX,
        ratioY: ratioY
    };
};


/**
 * getRotation - Calculates a number of degrees to rotate, based upon a number
 *     of orientations within a range from-to.
 *
 * @param  {number} orientations Number of orientations.
 * @param  {number} index Index of point, used to decide orientation.
 * @param  {number} from The smallest degree of rotation.
 * @param  {number} to The largest degree of rotation.
 * @return {boolean|number} Returns the resulting rotation for the word. Returns
 * false if invalid input parameters.
 */
var getRotation = function getRotation(orientations, index, from, to) {
    var result = false, // Default to false
        range,
        intervals,
        orientation;

    // Check if we have valid input parameters.
    if (
        isNumber(orientations) &&
        isNumber(index) &&
        isNumber(from) &&
        isNumber(to) &&
        orientations > -1 &&
        index > -1 &&
        to > from
    ) {
        range = to - from;
        intervals = range / (orientations - 1);
        orientation = index % orientations;
        result = from + (orientation * intervals);
    }
    return result;
};

/**
 * Calculates the spiral positions and store them in scope for quick access.
 *
 * @param {function} fn The spiral function.
 * @param {object} params Additional parameters for the spiral.
 * @returns {function} Function with access to spiral positions.
 */
var getSpiral = function (fn, params) {
    var length = 10000,
        arr = map(new Array(length), function (_, i) {
            return fn(i + 1, params);
        });
    return function (attempt) {
        return attempt <= length ? arr[attempt - 1] : false;
    };
};

/**
 * outsidePlayingField - Detects if a word is placed outside the playing field.
 *
 * @param  {Point} point Point which the word is connected to.
 * @param  {object} field The width and height of the playing field.
 * @return {boolean} Returns true if the word is placed outside the field.
 */
var outsidePlayingField = function outsidePlayingField(rect, field) {
    var playingField = {
        left: -(field.width / 2),
        right: field.width / 2,
        top: -(field.height / 2),
        bottom: field.height / 2
    };
    return !(
        playingField.left < rect.left &&
        playingField.right > rect.right &&
        playingField.top < rect.top &&
        playingField.bottom > rect.bottom
    );
};

/**
 * intersectionTesting - Check if a point intersects with previously placed
 * words, or if it goes outside the field boundaries. If a collision, then try
 * to adjusts the position.
 *
 * @param  {object} point Point to test for intersections.
 * @param  {object} options Options object.
 * @return {boolean|object} Returns an object with how much to correct the
 * positions. Returns false if the word should not be placed at all.
 */
var intersectionTesting = function intersectionTesting(point, options) {
    var placed = options.placed,
        field = options.field,
        rectangle = options.rectangle,
        polygon = options.polygon,
        spiral = options.spiral,
        attempt = 1,
        delta = {
            x: 0,
            y: 0
        },
        // Make a copy to update values during intersection testing.
        rect = point.rect = extend({}, rectangle);
    point.polygon = polygon;
    point.rotation = options.rotation;

    /**
     * while w intersects any previously placed words:
     *    do {
     *      move w a little bit along a spiral path
     *    } while any part of w is outside the playing field and
     *        the spiral radius is still smallish
     */
    while (
        delta !== false &&
        (
            intersectsAnyWord(point, placed) ||
            outsidePlayingField(rect, field)
        )
    ) {
        delta = spiral(attempt);
        if (isObject(delta)) {
            // Update the DOMRect with new positions.
            rect.left = rectangle.left + delta.x;
            rect.right = rectangle.right + delta.x;
            rect.top = rectangle.top + delta.y;
            rect.bottom = rectangle.bottom + delta.y;
            point.polygon = movePolygon(delta.x, delta.y, polygon);
        }
        attempt++;
    }
    return delta;
};

/**
 * extendPlayingField - Extends the playing field to have enough space to fit a
 * given word.
 * @param {object} field The width, height and ratios of a playing field.
 * @param {object} rectangle The bounding box of the word to add space for.
 * @return Returns the extended playing field with updated height and width.
 */
var extendPlayingField = function extendPlayingField(field, rectangle) {
    var height, width, ratioX, ratioY, x, extendWidth, extendHeight, result;

    if (isObject(field) && isObject(rectangle)) {
        height = (rectangle.bottom - rectangle.top);
        width = (rectangle.right - rectangle.left);
        ratioX = field.ratioX;
        ratioY = field.ratioY;

        // Use the same variable to extend both the height and width.
        x = ((width * ratioX) > (height * ratioY)) ? width : height;

        // Multiply variable with ratios to preserve aspect ratio.
        extendWidth = x * ratioX;
        extendHeight = x * ratioY;

        // Calculate the size of the new field after adding space for the word.
        result = merge(field, {
            // Add space on the left and right.
            width: field.width + (extendWidth * 2),
            // Add space on the top and bottom.
            height: field.height + (extendHeight * 2)
        });
    } else {
        result = field;
    }

    // Return the new extended field.
    return result;
};

/**
 * updateFieldBoundaries - If a rectangle 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.
 *
 * @param  {object} field The bounding box of a playing field.
 * @param  {object} placement The bounding box for a placed point.
 * @return {object} Returns a modified field object.
 */
var updateFieldBoundaries = function updateFieldBoundaries(field, rectangle) {
    // TODO improve type checking.
    if (!isNumber(field.left) || field.left > rectangle.left) {
        field.left = rectangle.left;
    }
    if (!isNumber(field.right) || field.right < rectangle.right) {
        field.right = rectangle.right;
    }
    if (!isNumber(field.top) || field.top > rectangle.top) {
        field.top = rectangle.top;
    }
    if (!isNumber(field.bottom) || field.bottom < rectangle.bottom) {
        field.bottom = rectangle.bottom;
    }
    return field;
};

/**
 * A word cloud is a visualization of a set of words, where the size and
 * placement of a word is determined by how it is weighted.
 *
 * @extends plotOptions.column
 * @sample highcharts/demo/wordcloud Word Cloud chart
 * @excluding allAreas, boostThreshold, clip, colorAxis, compare, compareBase,
 *            crisp, cropTreshold, dataGrouping, dataLabels, depth, edgeColor,
 *            findNearestPointBy, getExtremesFromAll, grouping, groupPadding,
 *            groupZPadding, joinBy, maxPointWidth, minPointLength,
 *            navigatorOptions, negativeColor, pointInterval, pointIntervalUnit,
 *            pointPadding, pointPlacement, pointRange, pointStart, pointWidth,
 *            pointStart, pointWidth, shadow, showCheckbox, showInNavigator,
 *            softThreshold, stacking, threshold, zoneAxis, zones
 * @product highcharts
 * @since  6.0.0
 * @optionparent plotOptions.wordcloud
 */
var wordCloudOptions = {
    /**
     * If there is no space for a word on the playing field, then this option
     * will allow the playing field to be extended to fit the word.
     * If false then the word will be dropped from the visualization.
     * NB! This option is currently not decided to be published in the API, and
     * is therefore marked as private.
     *
     * @private
     */
    allowExtendPlayingField: true,
    animation: {
        duration: 500
    },
    borderWidth: 0,
    clip: false, // Something goes wrong with clip. // TODO fix this
    colorByPoint: true,
    /**
     * A threshold determining the minimum font size that can be applied to a
     * word.
     */
    minFontSize: 1,
    /**
     * The word with the largest weight will have a font size equal to this
     * value. The font size of a word is the ratio between its weight and the
     * largest occuring weight, multiplied with the value of maxFontSize.
     */
    maxFontSize: 25,
    /**
     * This option decides which algorithm is used for placement, and rotation
     * of a word. The choice of algorith is therefore a crucial part of the
     * resulting layout of the wordcloud.
     * It is possible for users to add their own custom placement strategies
     * for use in word cloud. Read more about it in our
     * [documentation](https://www.highcharts.com/docs/chart-and-series-types/word-cloud-series#custom-placement-strategies)
     *
     * @validvalue: ["center", "random"]
     */
    placementStrategy: 'center',
    /**
     * Rotation options for the words in the wordcloud.
     * @sample highcharts/plotoptions/wordcloud-rotation
     *         Word cloud with rotation
     */
    rotation: {
        /**
         * The smallest degree of rotation for a word.
         */
        from: 0,
        /**
         * The number of possible orientations for a word, within the range of
         * `rotation.from` and `rotation.to`.
         */
        orientations: 2,
        /**
         * The largest degree of rotation for a word.
         */
        to: 90
    },
    showInLegend: false,
    /**
     * Spiral used for placing a word after the initial position experienced a
     * collision with either another word or the borders.
     * It is possible for users to add their own custom spiralling algorithms
     * for use in word cloud. Read more about it in our
     * [documentation](https://www.highcharts.com/docs/chart-and-series-types/word-cloud-series#custom-spiralling-algorithm)
     *
     * @validvalue: ["archimedean", "rectangular", "square"]
     */
    spiral: 'rectangular',
    /**
     * CSS styles for the words.
     *
     * @type {CSSObject}
     * @default {"fontFamily":"sans-serif", "fontWeight": "900"}
     */
    style: {
        fontFamily: 'sans-serif',
        fontWeight: '900'
    },
    tooltip: {
        followPointer: true,
        pointFormat: '<span style="color:{point.color}">\u25CF</span> {series.name}: <b>{point.weight}</b><br/>'
    }
};

/**
 * Properties of the WordCloud series.
 */
var wordCloudSeries = {
    animate: Series.prototype.animate,
    bindAxes: function () {
        var wordcloudAxis = {
            endOnTick: false,
            gridLineWidth: 0,
            lineWidth: 0,
            maxPadding: 0,
            startOnTick: false,
            title: null,
            tickPositions: []
        };
        Series.prototype.bindAxes.call(this);
        extend(this.yAxis.options, wordcloudAxis);
        extend(this.xAxis.options, wordcloudAxis);
    },
    /**
     * deriveFontSize - Calculates the fontSize of a word based on its weight.
     *
     * @param {number} [relativeWeight] The weight of the word, on a scale 0-1.
     * Defaults to 0.
     * @param {number} [maxFontSize] The maximum font size of a word. Defaults
     * to 1.
     * @param {number} [minFontSize] The minimum font size of a word. Defaults
     * to 1.
     * @returns {number} Returns the resulting fontSize of a word. If
     * minFontSize is larger then maxFontSize the result will equal minFontSize.
     */
    deriveFontSize: function deriveFontSize(
        relativeWeight,
        maxFontSize,
        minFontSize
    ) {
        var weight = isNumber(relativeWeight) ? relativeWeight : 0,
            max = isNumber(maxFontSize) ? maxFontSize : 1,
            min = isNumber(minFontSize) ? minFontSize : 1;
        return Math.floor(Math.max(min, weight * max));
    },
    drawPoints: function () {
        var series = this,
            hasRendered = series.hasRendered,
            xAxis = series.xAxis,
            yAxis = series.yAxis,
            chart = series.chart,
            group = series.group,
            options = series.options,
            animation = options.animation,
            allowExtendPlayingField = options.allowExtendPlayingField,
            renderer = chart.renderer,
            testElement = renderer.text().add(group),
            placed = [],
            placementStrategy = series.placementStrategy[
                options.placementStrategy
            ],
            spiral,
            rotation = options.rotation,
            scale,
            weights = series.points
                .map(function (p) {
                    return p.weight;
                }),
            maxWeight = Math.max.apply(null, weights),
            data = series.points
                .sort(function (a, b) {
                    return b.weight - a.weight; // Sort descending
                }),
            field;

        // Get the dimensions for each word.
        // Used in calculating the playing field.
        each(data, function (point) {
            var relativeWeight = 1 / maxWeight * point.weight,
                fontSize = series.deriveFontSize(
                    relativeWeight,
                    options.maxFontSize,
                    options.minFontSize
                ),
                css = extend({
                    fontSize: fontSize + 'px'
                }, options.style),
                bBox;

            testElement.css(css).attr({
                x: 0,
                y: 0,
                text: point.name
            });
            bBox = testElement.getBBox(true);
            point.dimensions = {
                height: bBox.height,
                width: bBox.width
            };
        });

        // Calculate the playing field.
        field = getPlayingField(xAxis.len, yAxis.len, data);
        spiral = getSpiral(series.spirals[options.spiral], {
            field: field
        });
        // Draw all the points.
        each(data, function (point) {
            var relativeWeight = 1 / maxWeight * point.weight,
                fontSize = series.deriveFontSize(
                    relativeWeight,
                    options.maxFontSize,
                    options.minFontSize
                ),
                css = extend({
                    fontSize: fontSize + 'px',
                    fill: point.color
                }, options.style),
                placement = placementStrategy(point, {
                    data: data,
                    field: field,
                    placed: placed,
                    rotation: rotation
                }),
                attr = {
                    align: 'center',
                    'alignment-baseline': 'middle',
                    x: placement.x,
                    y: placement.y,
                    text: point.name,
                    rotation: placement.rotation
                },
                polygon = getPolygon(
                    placement.x,
                    placement.y,
                    point.dimensions.width,
                    point.dimensions.height,
                    placement.rotation
                ),
                rectangle = getBoundingBoxFromPolygon(polygon),
                delta = intersectionTesting(point, {
                    rectangle: rectangle,
                    polygon: polygon,
                    field: field,
                    placed: placed,
                    spiral: spiral,
                    rotation: placement.rotation
                }),
                animate;

            // If there is no space for the word, extend the playing field.
            if (!delta && allowExtendPlayingField) {
                // Extend the playing field to fit the word.
                field = extendPlayingField(field, rectangle);

                // Run intersection testing one more time to place the word.
                delta = intersectionTesting(point, {
                    rectangle: rectangle,
                    polygon: polygon,
                    field: field,
                    placed: placed,
                    spiral: spiral,
                    rotation: placement.rotation
                });
            }
            /**
             * Check if point was placed, if so delete it,
             * otherwise place it on the correct positions.
             */
            if (isObject(delta)) {
                attr.x += delta.x;
                attr.y += delta.y;
                rectangle.left += delta.x;
                rectangle.right += delta.x;
                rectangle.top += delta.y;
                rectangle.bottom += delta.y;
                field = updateFieldBoundaries(field, rectangle);
                placed.push(point);
                point.isNull = false;
            } else {
                point.isNull = true;
            }

            if (animation) {
                // Animate to new positions
                animate = {
                    x: attr.x,
                    y: attr.y
                };
                // Animate from center of chart
                if (!hasRendered) {
                    attr.x = 0;
                    attr.y = 0;
                // or animate from previous position
                } else {
                    delete attr.x;
                    delete attr.y;
                }
            }

            point.draw({
                animate: animate,
                attr: attr,
                css: css,
                group: group,
                renderer: renderer,
                shapeArgs: undefined,
                shapeType: 'text'
            });
        });

        // Destroy the element after use.
        testElement = testElement.destroy();

        /**
         * Scale the series group to fit within the plotArea.
         */
        scale = getScale(xAxis.len, yAxis.len, field);
        series.group.attr({
            scaleX: scale,
            scaleY: scale
        });
    },
    hasData: function () {
        var series = this;
        return (
            isObject(series) &&
            series.visible === true &&
            isArray(series.points) &&
            series.points.length > 0
        );
    },
    /**
     * Strategies used for deciding rotation and initial position of a word.
     * To implement a custom strategy, have a look at the function
     * randomPlacement for example.
     */
    placementStrategy: {
        random: function randomPlacement(point, options) {
            var field = options.field,
                r = options.rotation;
            return {
                x: getRandomPosition(field.width) - (field.width / 2),
                y: getRandomPosition(field.height) - (field.height / 2),
                rotation: getRotation(r.orientations, point.index, r.from, r.to)
            };
        },
        center: function centerPlacement(point, options) {
            var r = options.rotation;
            return {
                x: 0,
                y: 0,
                rotation: getRotation(r.orientations, point.index, r.from, r.to)
            };
        }
    },
    pointArrayMap: ['weight'],
    /**
     * Spirals used for placing a word after the initial position experienced a
     * collision with either another word or the borders. To implement a custom
     * spiral, look at the function archimedeanSpiral for example.
     */
    spirals: {
        'archimedean': archimedeanSpiral,
        'rectangular': rectangularSpiral,
        'square': squareSpiral
    },
    utils: {
        extendPlayingField: extendPlayingField,
        getRotation: getRotation,
        isPolygonsColliding: isPolygonsColliding,
        rotate2DToOrigin: polygon.rotate2DToOrigin,
        rotate2DToPoint: polygon.rotate2DToPoint
    },
    getPlotBox: function () {
        var series = this,
            chart = series.chart,
            inverted = chart.inverted,
            // Swap axes for inverted (#2339)
            xAxis = series[(inverted ? 'yAxis' : 'xAxis')],
            yAxis = series[(inverted ? 'xAxis' : 'yAxis')],
            width = xAxis ? xAxis.len : chart.plotWidth,
            height = yAxis ? yAxis.len : chart.plotHeight,
            x = xAxis ? xAxis.left : chart.plotLeft,
            y = yAxis ? yAxis.top : chart.plotTop;
        return {
            translateX: x + (width / 2),
            translateY: y + (height / 2),
            scaleX: 1, // #1623
            scaleY: 1
        };
    }
};

/**
 * Properties of the Sunburst series.
 */
var wordCloudPoint = {
    draw: drawPoint,
    shouldDraw: function shouldDraw() {
        var point = this;
        return !point.isNull;
    },
    weight: 1
};

/**
 * A `wordcloud` series. If the [type](#series.wordcloud.type) option is
 * not specified, it is inherited from [chart.type](#chart.type).
 *
 * @type {Object}
 * @extends series,plotOptions.wordcloud
 * @product highcharts
 * @apioption series.wordcloud
 */

/**
 * An array of data points for the series. For the `wordcloud` series
 * type, points can be given in the following ways:
 *
 * 1.  An array of arrays with 2 values. In this case, the values
 * correspond to `name,weight`.
 *
 *  ```js
 *     data: [
 *         ['Lorem', 4],
 *         ['Ipsum', 1]
 *     ]
 *  ```
 *
 * 2.  An array of objects with named values. The following snippet shows only a
 * few settings, see the complete options set below. If the total number of data
 * points exceeds the series'
 * [turboThreshold](#series.arearange.turboThreshold), this option is not
 * available.
 *
 *  ```js
 *     data: [{
 *         name: "Lorem",
 *         weight: 4
 *     }, {
 *         name: "Ipsum",
 *         weight: 1
 *     }]
 *  ```
 *
 * @type {Array<Object|Array>}
 * @extends series.line.data
 * @excluding drilldown,marker,x,y
 * @product highcharts
 * @apioption series.wordcloud.data
 */

/**
* The name decides the text for a word.
*
* @type {String}
* @default undefined
* @since 6.0.0
* @product highcharts
* @apioption series.sunburst.data.name
*/

/**
* The weighting of a word. The weight decides the relative size of a word
* compared to the rest of the collection.
*
* @type {Number}
* @default undefined
* @since 6.0.0
* @product highcharts
* @apioption series.sunburst.data.weight
*/
H.seriesType(
    'wordcloud',
    'column',
    wordCloudOptions,
    wordCloudSeries,
    wordCloudPoint
);