YtIoT/WebRoot/res/highcharts/code/es-modules/modules/treemap.src.js

/* *
 * (c) 2014-2019 Highsoft AS
 *
 * Authors: Jon Arild Nygard / Oystein Moseng
 *
 * License: www.highcharts.com/license
 */

'use strict';

import H from '../parts/Globals.js';
import mixinTreeSeries from '../mixins/tree-series.js';
import '../parts/Utilities.js';
import '../parts/Options.js';
import '../parts/Series.js';
import '../parts/Color.js';

var seriesType = H.seriesType,
    seriesTypes = H.seriesTypes,
    merge = H.merge,
    extend = H.extend,
    noop = H.noop,
    getColor = mixinTreeSeries.getColor,
    getLevelOptions = mixinTreeSeries.getLevelOptions,
    isArray = H.isArray,
    isBoolean = function (x) {
        return typeof x === 'boolean';
    },
    isNumber = H.isNumber,
    isObject = H.isObject,
    isString = H.isString,
    pick = H.pick,
    Series = H.Series,
    stableSort = H.stableSort,
    color = H.Color,
    eachObject = function (list, func, context) {
        context = context || this;
        H.objectEach(list, function (val, key) {
            func.call(context, val, key, list);
        });
    },
    // @todo find correct name for this function.
    // @todo Similar to reduce, this function is likely redundant
    recursive = function (item, func, context) {
        var next;

        context = context || this;
        next = func.call(context, item);
        if (next !== false) {
            recursive(next, func, context);
        }
    },
    updateRootId = mixinTreeSeries.updateRootId;

/**
 * @private
 * @class
 * @name Highcharts.seriesTypes.treemap
 *
 * @augments Highcharts.Series
 */
seriesType(
    'treemap',
    'scatter'

    /**
     * A treemap displays hierarchical data using nested rectangles. The data
     * can be laid out in varying ways depending on options.
     *
     * @sample highcharts/demo/treemap-large-dataset/
     *         Treemap
     *
     * @extends      plotOptions.scatter
     * @excluding    marker, jitter
     * @product      highcharts
     * @optionparent plotOptions.treemap
     */
    , {

        /**
         * When enabled the user can click on a point which is a parent and
         * zoom in on its children.
         *
         * @sample {highcharts} highcharts/plotoptions/treemap-allowdrilltonode/
         *         Enabled
         *
         * @type      {boolean}
         * @default   false
         * @since     4.1.0
         * @product   highcharts
         * @apioption plotOptions.treemap.allowDrillToNode
         */

        /**
         * When the series contains less points than the crop threshold, all
         * points are drawn, event if the points fall outside the visible plot
         * area at the current zoom. The advantage of drawing all points
         * (including markers and columns), is that animation is performed on
         * updates. On the other hand, when the series contains more points than
         * the crop threshold, the series data is cropped to only contain points
         * that fall within the plot area. The advantage of cropping away
         * invisible points is to increase performance on large series.
         *
         * @type      {number}
         * @default   300
         * @since     4.1.0
         * @product   highcharts
         * @apioption plotOptions.treemap.cropThreshold
         */

        /**
         * This option decides if the user can interact with the parent nodes
         * or just the leaf nodes. When this option is undefined, it will be
         * true by default. However when allowDrillToNode is true, then it will
         * be false by default.
         *
         * @sample {highcharts} highcharts/plotoptions/treemap-interactbyleaf-false/
         *         False
         * @sample {highcharts} highcharts/plotoptions/treemap-interactbyleaf-true-and-allowdrilltonode/
         *         InteractByLeaf and allowDrillToNode is true
         *
         * @type      {boolean}
         * @since     4.1.2
         * @product   highcharts
         * @apioption plotOptions.treemap.interactByLeaf
         */

        /**
         * The sort index of the point inside the treemap level.
         *
         * @sample {highcharts} highcharts/plotoptions/treemap-sortindex/
         *         Sort by years
         *
         * @type      {number}
         * @since     4.1.10
         * @product   highcharts
         * @apioption plotOptions.treemap.sortIndex
         */

        /**
         * When using automatic point colors pulled from the `options.colors`
         * collection, this option determines whether the chart should receive
         * one color per series or one color per point.
         *
         * @see [series colors](#plotOptions.treemap.colors)
         *
         * @type      {boolean}
         * @default   false
         * @since     2.0
         * @product   highcharts
         * @apioption plotOptions.treemap.colorByPoint
         */

        /**
         * A series specific or series type specific color set to apply instead
         * of the global [colors](#colors) when
         * [colorByPoint](#plotOptions.treemap.colorByPoint) is true.
         *
         * @type      {Array<Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject>}
         * @since     3.0
         * @product   highcharts
         * @apioption plotOptions.treemap.colors
         */

        /**
         * Whether to display this series type or specific series item in the
         * legend.
         */
        showInLegend: false,

        /**
         * @ignore
         */
        marker: false,

        colorByPoint: false,

        /**
         * @extends plotOptions.heatmap.dataLabels
         * @since   4.1.0
         */
        dataLabels: {
            enabled: true,
            defer: false,
            verticalAlign: 'middle',
            formatter: function () {
                var point = this && this.point ? this.point : {},
                    name = isString(point.name) ? point.name : '';

                return name;
            },
            inside: true
        },

        tooltip: {
            headerFormat: '',
            pointFormat: '<b>{point.name}</b>: {point.value}<br/>'
        },

        /**
         * Whether to ignore hidden points when the layout algorithm runs.
         * If `false`, hidden points will leave open spaces.
         *
         * @since 5.0.8
         */
        ignoreHiddenPoint: true,

        /**
         * This option decides which algorithm is used for setting position
         * and dimensions of the points.
         *
         * @see [How to write your own algorithm](https://www.highcharts.com/docs/chart-and-series-types/treemap)
         *
         * @sample {highcharts} highcharts/plotoptions/treemap-layoutalgorithm-sliceanddice/
         *         SliceAndDice by default
         * @sample {highcharts} highcharts/plotoptions/treemap-layoutalgorithm-stripes/
         *         Stripes
         * @sample {highcharts} highcharts/plotoptions/treemap-layoutalgorithm-squarified/
         *         Squarified
         * @sample {highcharts} highcharts/plotoptions/treemap-layoutalgorithm-strip/
         *         Strip
         *
         * @since      4.1.0
         * @validvalue ["sliceAndDice", "stripes", "squarified", "strip"]
         */
        layoutAlgorithm: 'sliceAndDice',

        /**
         * Defines which direction the layout algorithm will start drawing.
         *
         * @since       4.1.0
         * @validvalue ["vertical", "horizontal"]
         */
        layoutStartingDirection: 'vertical',

        /**
         * Enabling this option will make the treemap alternate the drawing
         * direction between vertical and horizontal. The next levels starting
         * direction will always be the opposite of the previous.
         *
         * @sample {highcharts} highcharts/plotoptions/treemap-alternatestartingdirection-true/
         *         Enabled
         *
         * @since 4.1.0
         */
        alternateStartingDirection: false,

        /**
         * Used together with the levels and allowDrillToNode options. When
         * set to false the first level visible when drilling is considered
         * to be level one. Otherwise the level will be the same as the tree
         * structure.
         *
         * @since 4.1.0
         */
        levelIsConstant: true,

        /**
         * Options for the button appearing when drilling down in a treemap.
         */
        drillUpButton: {

            /**
             * The position of the button.
             */
            position: {

                /**
                 * Vertical alignment of the button.
                 *
                 * @default    top
                 * @validvalue ["top", "middle", "bottom"]
                 * @product    highcharts
                 * @apioption  plotOptions.treemap.drillUpButton.position.verticalAlign
                 */

                /**
                 * Horizontal alignment of the button.
                 *
                 * @validvalue ["left", "center", "right"]
                 */
                align: 'right',

                /**
                 * Horizontal offset of the button.
                 */
                x: -10,

                /**
                 * Vertical offset of the button.
                 */
                y: 10
            }
        },


        /**
         * Set options on specific levels. Takes precedence over series options,
         * but not point options.
         *
         * @sample {highcharts} highcharts/plotoptions/treemap-levels/
         *         Styling dataLabels and borders
         * @sample {highcharts} highcharts/demo/treemap-with-levels/
         *         Different layoutAlgorithm
         *
         * @type      {Array<*>}
         * @since     4.1.0
         * @product   highcharts
         * @apioption plotOptions.treemap.levels
         */

        /**
         * Can set a `borderColor` on all points which lies on the same level.
         *
         * @type      {Highcharts.ColorString}
         * @since     4.1.0
         * @product   highcharts
         * @apioption plotOptions.treemap.levels.borderColor
         */

        /**
         * Set the dash style of the border of all the point which lies on the
         * level. See <a href"#plotoptions.scatter.dashstyle">
         * plotOptions.scatter.dashStyle</a> for possible options.
         *
         * @type      {string}
         * @since     4.1.0
         * @product   highcharts
         * @apioption plotOptions.treemap.levels.borderDashStyle
         */

        /**
         * Can set the borderWidth on all points which lies on the same level.
         *
         * @type      {number}
         * @since     4.1.0
         * @product   highcharts
         * @apioption plotOptions.treemap.levels.borderWidth
         */

        /**
         * Can set a color on all points which lies on the same level.
         *
         * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
         * @since     4.1.0
         * @product   highcharts
         * @apioption plotOptions.treemap.levels.color
         */

        /**
         * A configuration object to define how the color of a child varies from
         * the parent's color. The variation is distributed among the children
         * of node. For example when setting brightness, the brightness change
         * will range from the parent's original brightness on the first child,
         * to the amount set in the `to` setting on the last node. This allows a
         * gradient-like color scheme that sets children out from each other
         * while highlighting the grouping on treemaps and sectors on sunburst
         * charts.
         *
         * @sample highcharts/demo/sunburst/
         *         Sunburst with color variation
         *
         * @since     6.0.0
         * @product   highcharts
         * @apioption plotOptions.treemap.levels.colorVariation
         */

        /**
         * The key of a color variation. Currently supports `brightness` only.
         *
         * @type       {string}
         * @since      6.0.0
         * @product    highcharts
         * @validvalue ["brightness"]
         * @apioption  plotOptions.treemap.levels.colorVariation.key
         */

        /**
         * The ending value of a color variation. The last sibling will receive
         * this value.
         *
         * @type      {number}
         * @since     6.0.0
         * @product   highcharts
         * @apioption plotOptions.treemap.levels.colorVariation.to
         */

        /**
         * Can set the options of dataLabels on each point which lies on the
         * level.
         * [plotOptions.treemap.dataLabels](#plotOptions.treemap.dataLabels) for
         * possible values.
         *
         * @type      {object}
         * @since     4.1.0
         * @product   highcharts
         * @apioption plotOptions.treemap.levels.dataLabels
         */

        /**
         * Can set the layoutAlgorithm option on a specific level.
         *
         * @type       {string}
         * @since      4.1.0
         * @product    highcharts
         * @validvalue ["sliceAndDice", "stripes", "squarified", "strip"]
         * @apioption  plotOptions.treemap.levels.layoutAlgorithm
         */

        /**
         * Can set the layoutStartingDirection option on a specific level.
         *
         * @type       {string}
         * @since      4.1.0
         * @product    highcharts
         * @validvalue ["vertical", "horizontal"]
         * @apioption  plotOptions.treemap.levels.layoutStartingDirection
         */

        /**
         * Decides which level takes effect from the options set in the levels
         * object.
         *
         * @sample {highcharts} highcharts/plotoptions/treemap-levels/
         *         Styling of both levels
         *
         * @type      {number}
         * @since     4.1.0
         * @product   highcharts
         * @apioption plotOptions.treemap.levels.level
         */


        // Presentational options

        /**
         * The color of the border surrounding each tree map item.
         *
         * @type {Highcharts.ColorString}
         */
        borderColor: '#e6e6e6',

        /**
         * The width of the border surrounding each tree map item.
         */
        borderWidth: 1,

        /**
         * The opacity of a point in treemap. When a point has children, the
         * visibility of the children is determined by the opacity.
         *
         * @since 4.2.4
         */
        opacity: 0.15,

        /**
         * A wrapper object for all the series options in specific states.
         *
         * @extends plotOptions.heatmap.states
         */
        states: {

            /**
             * Options for the hovered series
             *
             * @extends   plotOptions.heatmap.states.hover
             * @excluding halo
             */
            hover: {

                /**
                 * The border color for the hovered state.
                 */
                borderColor: '#999999',

                /**
                 * Brightness for the hovered point. Defaults to 0 if the
                 * heatmap series is loaded first, otherwise 0.1.
                 *
                 * @type    {number}
                 * @default undefined
                 */
                brightness: seriesTypes.heatmap ? 0 : 0.1,

                /**
                 * @extends plotOptions.heatmap.states.hover.halo
                 */
                halo: false,

                /**
                 * The opacity of a point in treemap. When a point has children,
                 * the visibility of the children is determined by the opacity.
                 *
                 * @since 4.2.4
                 */
                opacity: 0.75,

                /**
                 * The shadow option for hovered state.
                 */
                shadow: false
            }
        }


        // Prototype members
    }, {
        pointArrayMap: ['value'],
        directTouch: true,
        optionalAxis: 'colorAxis',
        getSymbol: noop,
        parallelArrays: ['x', 'y', 'value', 'colorValue'],
        colorKey: 'colorValue', // Point color option key
        trackerGroups: ['group', 'dataLabelsGroup'],
        /**
         * Creates an object map from parent id to childrens index.
         *
         * @private
         * @function Highcharts.Series#getListOfParents
         *
         * @param {Highcharts.SeriesTreemapDataOptions} data
         *        List of points set in options.
         *
         * @param {Array<string>} existingIds
         *        List of all point ids.
         *
         * @return {object}
         *         Map from parent id to children index in data.
         */
        getListOfParents: function (data, existingIds) {
            var arr = isArray(data) ? data : [],
                ids = isArray(existingIds) ? existingIds : [],
                listOfParents = arr.reduce(function (prev, curr, i) {
                    var parent = pick(curr.parent, '');

                    if (prev[parent] === undefined) {
                        prev[parent] = [];
                    }
                    prev[parent].push(i);
                    return prev;
                }, {
                    '': [] // Root of tree
                });

            // If parent does not exist, hoist parent to root of tree.
            eachObject(listOfParents, function (children, parent, list) {
                if ((parent !== '') && (ids.indexOf(parent) === -1)) {
                    children.forEach(function (child) {
                        list[''].push(child);
                    });
                    delete list[parent];
                }
            });
            return listOfParents;
        },
        // Creates a tree structured object from the series points
        getTree: function () {
            var series = this,
                allIds = this.data.map(function (d) {
                    return d.id;
                }),
                parentList = series.getListOfParents(this.data, allIds);

            series.nodeMap = [];
            return series.buildNode('', -1, 0, parentList, null);
        },
        init: function (chart, options) {
            var series = this,
                colorSeriesMixin = H.colorSeriesMixin;

            // If color series logic is loaded, add some properties
            if (H.colorSeriesMixin) {
                this.translateColors = colorSeriesMixin.translateColors;
                this.colorAttribs = colorSeriesMixin.colorAttribs;
                this.axisTypes = colorSeriesMixin.axisTypes;
            }

            Series.prototype.init.call(series, chart, options);
            if (series.options.allowDrillToNode) {
                H.addEvent(series, 'click', series.onClickDrillToNode);
            }
        },
        buildNode: function (id, i, level, list, parent) {
            var series = this,
                children = [],
                point = series.points[i],
                height = 0,
                node,
                child;

            // Actions
            ((list[id] || [])).forEach(function (i) {
                child = series.buildNode(
                    series.points[i].id,
                    i,
                    (level + 1),
                    list,
                    id
                );
                height = Math.max(child.height + 1, height);
                children.push(child);
            });
            node = {
                id: id,
                i: i,
                children: children,
                height: height,
                level: level,
                parent: parent,
                visible: false // @todo move this to better location
            };
            series.nodeMap[node.id] = node;
            if (point) {
                point.node = node;
            }
            return node;
        },
        setTreeValues: function (tree) {
            var series = this,
                options = series.options,
                idRoot = series.rootNode,
                mapIdToNode = series.nodeMap,
                nodeRoot = mapIdToNode[idRoot],
                levelIsConstant = (
                    isBoolean(options.levelIsConstant) ?
                        options.levelIsConstant :
                        true
                ),
                childrenTotal = 0,
                children = [],
                val,
                point = series.points[tree.i];

            // First give the children some values
            tree.children.forEach(function (child) {
                child = series.setTreeValues(child);
                children.push(child);
                if (!child.ignore) {
                    childrenTotal += child.val;
                }
            });
            // Sort the children
            stableSort(children, function (a, b) {
                return a.sortIndex - b.sortIndex;
            });
            // Set the values
            val = pick(point && point.options.value, childrenTotal);
            if (point) {
                point.value = val;
            }
            extend(tree, {
                children: children,
                childrenTotal: childrenTotal,
                // Ignore this node if point is not visible
                ignore: !(pick(point && point.visible, true) && (val > 0)),
                isLeaf: tree.visible && !childrenTotal,
                levelDynamic: (
                    tree.level - (levelIsConstant ? 0 : nodeRoot.level)
                ),
                name: pick(point && point.name, ''),
                sortIndex: pick(point && point.sortIndex, -val),
                val: val
            });
            return tree;
        },
        /**
         * Recursive function which calculates the area for all children of a
         * node.
         *
         * @private
         * @function Highcharts.Series#calculateChildrenAreas
         *
         * @param {object} node
         *        The node which is parent to the children.
         *
         * @param {object} area
         *        The rectangular area of the parent.
         */
        calculateChildrenAreas: function (parent, area) {
            var series = this,
                options = series.options,
                mapOptionsToLevel = series.mapOptionsToLevel,
                level = mapOptionsToLevel[parent.level + 1],
                algorithm = pick(
                    (
                        series[level &&
                    level.layoutAlgorithm] &&
                    level.layoutAlgorithm
                    ),
                    options.layoutAlgorithm
                ),
                alternate = options.alternateStartingDirection,
                childrenValues = [],
                children;

            // Collect all children which should be included
            children = parent.children.filter(function (n) {
                return !n.ignore;
            });

            if (level && level.layoutStartingDirection) {
                area.direction = level.layoutStartingDirection === 'vertical' ?
                    0 :
                    1;
            }
            childrenValues = series[algorithm](area, children);
            children.forEach(function (child, index) {
                var values = childrenValues[index];

                child.values = merge(values, {
                    val: child.childrenTotal,
                    direction: (alternate ? 1 - area.direction : area.direction)
                });
                child.pointValues = merge(values, {
                    x: (values.x / series.axisRatio),
                    width: (values.width / series.axisRatio)
                });
                // If node has children, then call method recursively
                if (child.children.length) {
                    series.calculateChildrenAreas(child, child.values);
                }
            });
        },
        setPointValues: function () {
            var series = this,
                xAxis = series.xAxis,
                yAxis = series.yAxis;

            series.points.forEach(function (point) {
                var node = point.node,
                    values = node.pointValues,
                    x1,
                    x2,
                    y1,
                    y2,
                    crispCorr = 0;

                // Get the crisp correction in classic mode. For this to work in
                // styled mode, we would need to first add the shape (without x,
                // y, width and height), then read the rendered stroke width
                // using point.graphic.strokeWidth(), then modify and apply the
                // shapeArgs. This applies also to column series, but the
                // downside is performance and code complexity.
                if (!series.chart.styledMode) {
                    crispCorr = (
                        (series.pointAttribs(point)['stroke-width'] || 0) % 2
                    ) / 2;
                }

                // Points which is ignored, have no values.
                if (values && node.visible) {
                    x1 = Math.round(
                        xAxis.translate(values.x, 0, 0, 0, 1)
                    ) - crispCorr;
                    x2 = Math.round(
                        xAxis.translate(values.x + values.width, 0, 0, 0, 1)
                    ) - crispCorr;
                    y1 = Math.round(
                        yAxis.translate(values.y, 0, 0, 0, 1)
                    ) - crispCorr;
                    y2 = Math.round(
                        yAxis.translate(values.y + values.height, 0, 0, 0, 1)
                    ) - crispCorr;
                    // Set point values
                    point.shapeType = 'rect';
                    point.shapeArgs = {
                        x: Math.min(x1, x2),
                        y: Math.min(y1, y2),
                        width: Math.abs(x2 - x1),
                        height: Math.abs(y2 - y1)
                    };
                    point.plotX =
                        point.shapeArgs.x + (point.shapeArgs.width / 2);
                    point.plotY =
                        point.shapeArgs.y + (point.shapeArgs.height / 2);
                } else {
                // Reset visibility
                    delete point.plotX;
                    delete point.plotY;
                }
            });
        },

        // Set the node's color recursively, from the parent down.
        setColorRecursive: function (
            node,
            parentColor,
            colorIndex,
            index,
            siblings
        ) {
            var series = this,
                chart = series && series.chart,
                colors = chart && chart.options && chart.options.colors,
                colorInfo,
                point;

            if (node) {
                colorInfo = getColor(node, {
                    colors: colors,
                    index: index,
                    mapOptionsToLevel: series.mapOptionsToLevel,
                    parentColor: parentColor,
                    parentColorIndex: colorIndex,
                    series: series,
                    siblings: siblings
                });

                point = series.points[node.i];
                if (point) {
                    point.color = colorInfo.color;
                    point.colorIndex = colorInfo.colorIndex;
                }

                // Do it all again with the children
                (node.children || []).forEach(function (child, i) {
                    series.setColorRecursive(
                        child,
                        colorInfo.color,
                        colorInfo.colorIndex,
                        i,
                        node.children.length
                    );
                });
            }
        },
        algorithmGroup: function (h, w, d, p) {
            this.height = h;
            this.width = w;
            this.plot = p;
            this.direction = d;
            this.startDirection = d;
            this.total = 0;
            this.nW = 0;
            this.lW = 0;
            this.nH = 0;
            this.lH = 0;
            this.elArr = [];
            this.lP = {
                total: 0,
                lH: 0,
                nH: 0,
                lW: 0,
                nW: 0,
                nR: 0,
                lR: 0,
                aspectRatio: function (w, h) {
                    return Math.max((w / h), (h / w));
                }
            };
            this.addElement = function (el) {
                this.lP.total = this.elArr[this.elArr.length - 1];
                this.total = this.total + el;
                if (this.direction === 0) {
                // Calculate last point old aspect ratio
                    this.lW = this.nW;
                    this.lP.lH = this.lP.total / this.lW;
                    this.lP.lR = this.lP.aspectRatio(this.lW, this.lP.lH);
                    // Calculate last point new aspect ratio
                    this.nW = this.total / this.height;
                    this.lP.nH = this.lP.total / this.nW;
                    this.lP.nR = this.lP.aspectRatio(this.nW, this.lP.nH);
                } else {
                // Calculate last point old aspect ratio
                    this.lH = this.nH;
                    this.lP.lW = this.lP.total / this.lH;
                    this.lP.lR = this.lP.aspectRatio(this.lP.lW, this.lH);
                    // Calculate last point new aspect ratio
                    this.nH = this.total / this.width;
                    this.lP.nW = this.lP.total / this.nH;
                    this.lP.nR = this.lP.aspectRatio(this.lP.nW, this.nH);
                }
                this.elArr.push(el);
            };
            this.reset = function () {
                this.nW = 0;
                this.lW = 0;
                this.elArr = [];
                this.total = 0;
            };
        },
        algorithmCalcPoints: function (
            directionChange, last, group, childrenArea
        ) {
            var pX,
                pY,
                pW,
                pH,
                gW = group.lW,
                gH = group.lH,
                plot = group.plot,
                keep,
                i = 0,
                end = group.elArr.length - 1;

            if (last) {
                gW = group.nW;
                gH = group.nH;
            } else {
                keep = group.elArr[group.elArr.length - 1];
            }
            group.elArr.forEach(function (p) {
                if (last || (i < end)) {
                    if (group.direction === 0) {
                        pX = plot.x;
                        pY = plot.y;
                        pW = gW;
                        pH = p / pW;
                    } else {
                        pX = plot.x;
                        pY = plot.y;
                        pH = gH;
                        pW = p / pH;
                    }
                    childrenArea.push({
                        x: pX,
                        y: pY,
                        width: pW,
                        height: pH
                    });
                    if (group.direction === 0) {
                        plot.y = plot.y + pH;
                    } else {
                        plot.x = plot.x + pW;
                    }
                }
                i = i + 1;
            });
            // Reset variables
            group.reset();
            if (group.direction === 0) {
                group.width = group.width - gW;
            } else {
                group.height = group.height - gH;
            }
            plot.y = plot.parent.y + (plot.parent.height - group.height);
            plot.x = plot.parent.x + (plot.parent.width - group.width);
            if (directionChange) {
                group.direction = 1 - group.direction;
            }
            // If not last, then add uncalculated element
            if (!last) {
                group.addElement(keep);
            }
        },
        algorithmLowAspectRatio: function (directionChange, parent, children) {
            var childrenArea = [],
                series = this,
                pTot,
                plot = {
                    x: parent.x,
                    y: parent.y,
                    parent: parent
                },
                direction = parent.direction,
                i = 0,
                end = children.length - 1,
                group = new this.algorithmGroup( // eslint-disable-line new-cap
                    parent.height,
                    parent.width,
                    direction,
                    plot
                );

            // Loop through and calculate all areas
            children.forEach(function (child) {
                pTot =
                    (parent.width * parent.height) * (child.val / parent.val);
                group.addElement(pTot);
                if (group.lP.nR > group.lP.lR) {
                    series.algorithmCalcPoints(
                        directionChange,
                        false,
                        group,
                        childrenArea,
                        plot
                    );
                }
                // If last child, then calculate all remaining areas
                if (i === end) {
                    series.algorithmCalcPoints(
                        directionChange,
                        true,
                        group,
                        childrenArea,
                        plot
                    );
                }
                i = i + 1;
            });
            return childrenArea;
        },
        algorithmFill: function (directionChange, parent, children) {
            var childrenArea = [],
                pTot,
                direction = parent.direction,
                x = parent.x,
                y = parent.y,
                width = parent.width,
                height = parent.height,
                pX,
                pY,
                pW,
                pH;

            children.forEach(function (child) {
                pTot =
                    (parent.width * parent.height) * (child.val / parent.val);
                pX = x;
                pY = y;
                if (direction === 0) {
                    pH = height;
                    pW = pTot / pH;
                    width = width - pW;
                    x = x + pW;
                } else {
                    pW = width;
                    pH = pTot / pW;
                    height = height - pH;
                    y = y + pH;
                }
                childrenArea.push({
                    x: pX,
                    y: pY,
                    width: pW,
                    height: pH
                });
                if (directionChange) {
                    direction = 1 - direction;
                }
            });
            return childrenArea;
        },
        strip: function (parent, children) {
            return this.algorithmLowAspectRatio(false, parent, children);
        },
        squarified: function (parent, children) {
            return this.algorithmLowAspectRatio(true, parent, children);
        },
        sliceAndDice: function (parent, children) {
            return this.algorithmFill(true, parent, children);
        },
        stripes: function (parent, children) {
            return this.algorithmFill(false, parent, children);
        },
        translate: function () {
            var series = this,
                options = series.options,
                // NOTE: updateRootId modifies series.
                rootId = updateRootId(series),
                rootNode,
                pointValues,
                seriesArea,
                tree,
                val;

            // Call prototype function
            Series.prototype.translate.call(series);

            // @todo Only if series.isDirtyData is true
            tree = series.tree = series.getTree();
            rootNode = series.nodeMap[rootId];
            series.mapOptionsToLevel = getLevelOptions({
                from: rootNode.level + 1,
                levels: options.levels,
                to: tree.height,
                defaults: {
                    levelIsConstant: series.options.levelIsConstant,
                    colorByPoint: options.colorByPoint
                }
            });
            if (
                rootId !== '' &&
            (!rootNode || !rootNode.children.length)
            ) {
                series.drillToNode('', false);
                rootId = series.rootNode;
                rootNode = series.nodeMap[rootId];
            }
            // Parents of the root node is by default visible
            recursive(series.nodeMap[series.rootNode], function (node) {
                var next = false,
                    p = node.parent;

                node.visible = true;
                if (p || p === '') {
                    next = series.nodeMap[p];
                }
                return next;
            });
            // Children of the root node is by default visible
            recursive(
                series.nodeMap[series.rootNode].children,
                function (children) {
                    var next = false;

                    children.forEach(function (child) {
                        child.visible = true;
                        if (child.children.length) {
                            next = (next || []).concat(child.children);
                        }
                    });
                    return next;
                }
            );
            series.setTreeValues(tree);

            // Calculate plotting values.
            series.axisRatio = (series.xAxis.len / series.yAxis.len);
            series.nodeMap[''].pointValues = pointValues =
            { x: 0, y: 0, width: 100, height: 100 };
            series.nodeMap[''].values = seriesArea = merge(pointValues, {
                width: (pointValues.width * series.axisRatio),
                direction: (
                    options.layoutStartingDirection === 'vertical' ? 0 : 1
                ),
                val: tree.val
            });
            series.calculateChildrenAreas(tree, seriesArea);

            // Logic for point colors
            if (series.colorAxis) {
                series.translateColors();
            } else if (!options.colorByPoint) {
                series.setColorRecursive(series.tree);
            }

            // Update axis extremes according to the root node.
            if (options.allowDrillToNode) {
                val = rootNode.pointValues;
                series.xAxis.setExtremes(val.x, val.x + val.width, false);
                series.yAxis.setExtremes(val.y, val.y + val.height, false);
                series.xAxis.setScale();
                series.yAxis.setScale();
            }

            // Assign values to points.
            series.setPointValues();
        },
        /**
         * Extend drawDataLabels with logic to handle custom options related to
         * the treemap series:
         *
         * - Points which is not a leaf node, has dataLabels disabled by
         *   default.
         *
         * - Options set on series.levels is merged in.
         *
         * - Width of the dataLabel is set to match the width of the point
         *   shape.
         *
         * @private
         * @function Highcharts.Series#drawDataLabels
         */
        drawDataLabels: function () {
            var series = this,
                mapOptionsToLevel = series.mapOptionsToLevel,
                points = series.points.filter(function (n) {
                    return n.node.visible;
                }),
                options,
                level;

            points.forEach(function (point) {
                level = mapOptionsToLevel[point.node.level];
                // Set options to new object to avoid problems with scope
                options = { style: {} };

                // If not a leaf, then label should be disabled as default
                if (!point.node.isLeaf) {
                    options.enabled = false;
                }

                // If options for level exists, include them as well
                if (level && level.dataLabels) {
                    options = merge(options, level.dataLabels);
                    series._hasPointLabels = true;
                }

                // Set dataLabel width to the width of the point shape.
                if (point.shapeArgs) {
                    options.style.width = point.shapeArgs.width;
                    if (point.dataLabel) {
                        point.dataLabel.css({
                            width: point.shapeArgs.width + 'px'
                        });
                    }
                }

                // Merge custom options with point options
                point.dlOptions = merge(options, point.options.dataLabels);
            });
            Series.prototype.drawDataLabels.call(this);
        },

        // Over the alignment method by setting z index
        alignDataLabel: function (point, dataLabel, labelOptions) {
            var style = labelOptions.style;

            // #8160: Prevent the label from exceeding the point's
            // boundaries in treemaps by applying ellipsis overflow.
            // The issue was happening when datalabel's text contained a
            // long sequence of characters without a whitespace.
            if (
                !H.defined(style.textOverflow) &&
                dataLabel.text &&
                dataLabel.getBBox().width > dataLabel.text.textWidth
            ) {
                dataLabel.css({
                    textOverflow: 'ellipsis',
                    // unit (px) is required when useHTML is true
                    width: style.width += 'px'
                });
            }

            seriesTypes.column.prototype.alignDataLabel.apply(this, arguments);
            if (point.dataLabel) {
            // point.node.zIndex could be undefined (#6956)
                point.dataLabel.attr({ zIndex: (point.node.zIndex || 0) + 1 });
            }
        },

        // Get presentational attributes
        pointAttribs: function (point, state) {
            var series = this,
                mapOptionsToLevel = (
                    isObject(series.mapOptionsToLevel) ?
                        series.mapOptionsToLevel :
                        {}
                ),
                level = point && mapOptionsToLevel[point.node.level] || {},
                options = this.options,
                attr,
                stateOptions = (state && options.states[state]) || {},
                className = (point && point.getClassName()) || '',
                opacity;

            // Set attributes by precedence. Point trumps level trumps series.
            // Stroke width uses pick because it can be 0.
            attr = {
                'stroke':
                (point && point.borderColor) ||
                level.borderColor ||
                stateOptions.borderColor ||
                options.borderColor,
                'stroke-width': pick(
                    point && point.borderWidth,
                    level.borderWidth,
                    stateOptions.borderWidth,
                    options.borderWidth
                ),
                'dashstyle':
                (point && point.borderDashStyle) ||
                level.borderDashStyle ||
                stateOptions.borderDashStyle ||
                options.borderDashStyle,
                'fill': (point && point.color) || this.color
            };

            // Hide levels above the current view
            if (className.indexOf('highcharts-above-level') !== -1) {
                attr.fill = 'none';
                attr['stroke-width'] = 0;

                // Nodes with children that accept interaction
            } else if (
                className.indexOf('highcharts-internal-node-interactive') !== -1
            ) {
                opacity = pick(stateOptions.opacity, options.opacity);
                attr.fill = color(attr.fill).setOpacity(opacity).get();
                attr.cursor = 'pointer';
                // Hide nodes that have children
            } else if (className.indexOf('highcharts-internal-node') !== -1) {
                attr.fill = 'none';

            } else if (state) {
            // Brighten and hoist the hover nodes
                attr.fill = color(attr.fill)
                    .brighten(stateOptions.brightness)
                    .get();
            }
            return attr;
        },

        // Extending ColumnSeries drawPoints
        drawPoints: function () {
            var series = this,
                points = series.points.filter(function (n) {
                    return n.node.visible;
                });

            points.forEach(function (point) {
                var groupKey = 'level-group-' + point.node.levelDynamic;

                if (!series[groupKey]) {
                    series[groupKey] = series.chart.renderer.g(groupKey)
                        .attr({
                        // @todo Set the zIndex based upon the number of levels,
                        // instead of using 1000
                            zIndex: 1000 - point.node.levelDynamic
                        })
                        .add(series.group);
                }
                point.group = series[groupKey];

            });
            // Call standard drawPoints
            seriesTypes.column.prototype.drawPoints.call(this);

            // In styled mode apply point.color. Use CSS, otherwise the fill
            // used in the style sheet will take precedence over the fill
            // attribute.
            if (this.colorAttribs && series.chart.styledMode) {
                // Heatmap is loaded
                this.points.forEach(function (point) {
                    if (point.graphic) {
                        point.graphic.css(this.colorAttribs(point));
                    }
                }, this);
            }

            // If drillToNode is allowed, set a point cursor on clickables & add
            // drillId to point
            if (series.options.allowDrillToNode) {
                points.forEach(function (point) {
                    if (point.graphic) {
                        point.drillId = series.options.interactByLeaf ?
                            series.drillToByLeaf(point) :
                            series.drillToByGroup(point);
                    }
                });
            }
        },
        // Add drilling on the suitable points
        onClickDrillToNode: function (event) {
            var series = this,
                point = event.point,
                drillId = point && point.drillId;

            // If a drill id is returned, add click event and cursor.
            if (isString(drillId)) {
                point.setState(''); // Remove hover
                series.drillToNode(drillId);
            }
        },
        /**
         * Finds the drill id for a parent node. Returns false if point should
         * not have a click event.
         *
         * @private
         * @function Highcharts.Series#drillToByGroup
         *
         * @param {object} point
         *
         * @return {boolean|string}
         *         Drill to id or false when point should not have a click
         *         event.
         */
        drillToByGroup: function (point) {
            var series = this,
                drillId = false;

            if ((point.node.level - series.nodeMap[series.rootNode].level) ===
                1 &&
                !point.node.isLeaf
            ) {
                drillId = point.id;
            }
            return drillId;
        },
        /**
         * Finds the drill id for a leaf node. Returns false if point should not
         * have a click event
         *
         * @private
         * @function Highcharts.Series#drillToByLeaf
         *
         * @param {object} point
         *
         * @return {boolean|string}
         *         Drill to id or false when point should not have a click
         *         event.
         */
        drillToByLeaf: function (point) {
            var series = this,
                drillId = false,
                nodeParent;

            if ((point.node.parent !== series.rootNode) &&
                point.node.isLeaf
            ) {
                nodeParent = point.node;
                while (!drillId) {
                    nodeParent = series.nodeMap[nodeParent.parent];
                    if (nodeParent.parent === series.rootNode) {
                        drillId = nodeParent.id;
                    }
                }
            }
            return drillId;
        },
        drillUp: function () {
            var series = this,
                node = series.nodeMap[series.rootNode];

            if (node && isString(node.parent)) {
                series.drillToNode(node.parent);
            }
        },
        drillToNode: function (id, redraw) {
            var series = this,
                nodeMap = series.nodeMap,
                node = nodeMap[id];

            series.idPreviousRoot = series.rootNode;
            series.rootNode = id;
            if (id === '') {
                series.drillUpButton = series.drillUpButton.destroy();
            } else {
                series.showDrillUpButton((node && node.name || id));
            }
            this.isDirty = true; // Force redraw
            if (pick(redraw, true)) {
                this.chart.redraw();
            }
        },
        showDrillUpButton: function (name) {
            var series = this,
                backText = (name || '< Back'),
                buttonOptions = series.options.drillUpButton,
                attr,
                states;

            if (buttonOptions.text) {
                backText = buttonOptions.text;
            }
            if (!this.drillUpButton) {
                attr = buttonOptions.theme;
                states = attr && attr.states;

                this.drillUpButton = this.chart.renderer.button(
                    backText,
                    null,
                    null,
                    function () {
                        series.drillUp();
                    },
                    attr,
                    states && states.hover,
                    states && states.select
                )
                    .addClass('highcharts-drillup-button')
                    .attr({
                        align: buttonOptions.position.align,
                        zIndex: 7
                    })
                    .add()
                    .align(
                        buttonOptions.position,
                        false,
                        buttonOptions.relativeTo || 'plotBox'
                    );
            } else {
                this.drillUpButton.placed = false;
                this.drillUpButton.attr({
                    text: backText
                })
                    .align();
            }
        },
        buildKDTree: noop,
        drawLegendSymbol: H.LegendSymbolMixin.drawRectangle,
        getExtremes: function () {
        // Get the extremes from the value data
            Series.prototype.getExtremes.call(this, this.colorValueData);
            this.valueMin = this.dataMin;
            this.valueMax = this.dataMax;

            // Get the extremes from the y data
            Series.prototype.getExtremes.call(this);
        },
        getExtremesFromAll: true,
        bindAxes: function () {
            var treeAxis = {
                endOnTick: false,
                gridLineWidth: 0,
                lineWidth: 0,
                min: 0,
                dataMin: 0,
                minPadding: 0,
                max: 100,
                dataMax: 100,
                maxPadding: 0,
                startOnTick: false,
                title: null,
                tickPositions: []
            };

            Series.prototype.bindAxes.call(this);
            H.extend(this.yAxis.options, treeAxis);
            H.extend(this.xAxis.options, treeAxis);
        },
        utils: {
            recursive: recursive
        }

        // Point class
    }, {
        getClassName: function () {
            var className = H.Point.prototype.getClassName.call(this),
                series = this.series,
                options = series.options;

            // Above the current level
            if (this.node.level <= series.nodeMap[series.rootNode].level) {
                className += ' highcharts-above-level';

            } else if (
                !this.node.isLeaf &&
            !pick(options.interactByLeaf, !options.allowDrillToNode)
            ) {
                className += ' highcharts-internal-node-interactive';

            } else if (!this.node.isLeaf) {
                className += ' highcharts-internal-node';
            }
            return className;
        },

        /**
         * A tree point is valid if it has han id too, assume it may be a parent
         * item.
         *
         * @private
         * @function Highcharts.Point#isValid
         */
        isValid: function () {
            return this.id || isNumber(this.value);
        },
        setState: function (state) {
            H.Point.prototype.setState.call(this, state);

            // Graphic does not exist when point is not visible.
            if (this.graphic) {
                this.graphic.attr({
                    zIndex: state === 'hover' ? 1 : 0
                });
            }
        },
        setVisible: seriesTypes.pie.prototype.pointClass.prototype.setVisible
    }
);


/**
 * A `treemap` series. If the [type](#series.treemap.type) option is
 * not specified, it is inherited from [chart.type](#chart.type).
 *
 * @extends   series,plotOptions.treemap
 * @excluding dataParser, dataURL, stack
 * @product   highcharts
 * @apioption series.treemap
 */

/**
 * An array of data points for the series. For the `treemap` series
 * type, points can be given in the following ways:
 *
 * 1.  An array of numerical values. In this case, the numerical values
 * will be interpreted as `value` options. Example:
 *
 *  ```js
 *  data: [0, 5, 3, 5]
 *  ```
 *
 * 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.treemap.turboThreshold),
 * this option is not available.
 *
 *  ```js
 *     data: [{
 *         value: 9,
 *         name: "Point2",
 *         color: "#00FF00"
 *     }, {
 *         value: 6,
 *         name: "Point1",
 *         color: "#FF00FF"
 *     }]
 *  ```
 *
 * @sample {highcharts} highcharts/chart/reflow-true/
 *         Numerical values
 * @sample {highcharts} highcharts/series/data-array-of-objects/
 *         Config objects
 *
 * @type      {Array<number|*>}
 * @extends   series.heatmap.data
 * @excluding x, y
 * @product   highcharts
 * @apioption series.treemap.data
 */

/**
 * The value of the point, resulting in a relative area of the point
 * in the treemap.
 *
 * @type      {number}
 * @product   highcharts
 * @apioption series.treemap.data.value
 */

/**
 * Serves a purpose only if a `colorAxis` object is defined in the chart
 * options. This value will decide which color the point gets from the
 * scale of the colorAxis.
 *
 * @type      {number}
 * @since     4.1.0
 * @product   highcharts
 * @apioption series.treemap.data.colorValue
 */

/**
 * Only for treemap. Use this option to build a tree structure. The
 * value should be the id of the point which is the parent. If no points
 * has a matching id, or this option is undefined, then the parent will
 * be set to the root.
 *
 * @sample {highcharts} highcharts/point/parent/
 *         Point parent
 * @sample {highcharts} highcharts/demo/treemap-with-levels/
 *         Example where parent id is not matching
 *
 * @type      {string}
 * @since     4.1.0
 * @product   highcharts
 * @apioption series.treemap.data.parent
 */