TreeGrid.js
29.3 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
/**
* (c) 2016 Highsoft AS
* Authors: Jon Arild Nygard
*
* License: www.highcharts.com/license
*/
/* eslint no-console: 0 */
'use strict';
import H from '../parts/Globals.js';
import '../parts/Utilities.js';
import './GridAxis.js';
import Tree from './Tree.js';
import mixinTreeSeries from '../mixins/tree-series.js';
import '../modules/broken-axis.src.js';
var argsToArray = function (args) {
return Array.prototype.slice.call(args, 1);
},
defined = H.defined,
each = H.each,
extend = H.extend,
find = H.find,
fireEvent = H.fireEvent,
getLevelOptions = mixinTreeSeries.getLevelOptions,
map = H.map,
merge = H.merge,
inArray = H.inArray,
isBoolean = function (x) {
return typeof x === 'boolean';
},
isNumber = H.isNumber,
isObject = function (x) {
// Always use strict mode.
return H.isObject(x, true);
},
isString = H.isString,
keys = H.keys,
pick = H.pick,
reduce = H.reduce,
wrap = H.wrap,
GridAxis = H.Axis,
GridAxisTick = H.Tick;
/**
* some - Equivalent of Array.prototype.some
*
* @param {Array} arr Array to look for matching elements in.
* @param {function} condition The condition to check against.
* @return {boolean} Whether some elements pass the condition.
*/
var some = function (arr, condition) {
var result = false;
each(arr, function (element, index, array) {
if (!result) {
result = condition(element, index, array);
}
});
return result;
};
var override = function (obj, methods) {
var method,
func;
for (method in methods) {
if (methods.hasOwnProperty(method)) {
func = methods[method];
wrap(obj, method, func);
}
}
};
/**
* getCategoriesFromTree - getCategories based on a tree
*
* @param {object} tree Root of tree to collect categories from
* @return {Array} Array of categories
*/
var getCategoriesFromTree = function (tree) {
var categories = [];
if (tree.data) {
categories.push(tree.data.name);
}
each(tree.children, function (child) {
categories = categories.concat(getCategoriesFromTree(child));
});
return categories;
};
var mapTickPosToNode = function (node, categories) {
var map = {},
name = node.data && node.data.name,
pos = inArray(name, categories);
map[pos] = node;
each(node.children, function (child) {
extend(map, mapTickPosToNode(child, categories));
});
return map;
};
var getBreakFromNode = function (node, max) {
var from = node.collapseStart,
to = node.collapseEnd;
// In broken-axis, the axis.max is minimized until it is not within a break.
// Therefore, if break.to is larger than axis.max, the axis.to should not
// add the 0.5 axis.tickMarkOffset, to avoid adding a break larger than
// axis.max
// TODO consider simplifying broken-axis and this might solve itself
if (to >= max) {
from -= 0.5;
}
return {
from: from,
to: to,
showPoints: false
};
};
/**
* Creates a list of positions for the ticks on the axis. Filters out positions
* that are outside min and max, or is inside an axis break.
*
* @param {Object} axis The Axis to get the tick positions from.
* @param {number} axis.min The minimum value of the axis.
* @param {number} axis.max The maximum value of the axis.
* @param {function} axis.isInAnyBreak Function to determine if a position is
* inside any breaks on the axis.
* @returns {number[]} List of positions.
*/
var getTickPositions = function (axis) {
return reduce(
keys(axis.mapOfPosToGridNode),
function (arr, key) {
var pos = +key;
if (
axis.min <= pos &&
axis.max >= pos &&
!axis.isInAnyBreak(pos)
) {
arr.push(pos);
}
return arr;
},
[]
);
};
/**
* Check if a node is collapsed.
* @param {object} axis The axis to check against.
* @param {object} node The node to check if is collapsed.
* @param {number} pos The tick position to collapse.
* @returns {boolean} Returns true if collapsed, false if expanded.
*/
var isCollapsed = function (axis, node) {
var breaks = (axis.options.breaks || []),
obj = getBreakFromNode(node, axis.max);
return some(breaks, function (b) {
return b.from === obj.from && b.to === obj.to;
});
};
/**
* Calculates the new axis breaks to collapse a node.
* @param {object} axis The axis to check against.
* @param {object} node The node to collapse.
* @param {number} pos The tick position to collapse.
* @returns {array} Returns an array of the new breaks for the axis.
*/
var collapse = function (axis, node) {
var breaks = (axis.options.breaks || []),
obj = getBreakFromNode(node, axis.max);
breaks.push(obj);
return breaks;
};
/**
* Calculates the new axis breaks to expand a node.
* @param {object} axis The axis to check against.
* @param {object} node The node to expand.
* @param {number} pos The tick position to expand.
* @returns {array} Returns an array of the new breaks for the axis.
*/
var expand = function (axis, node) {
var breaks = (axis.options.breaks || []),
obj = getBreakFromNode(node, axis.max);
// Remove the break from the axis breaks array.
return reduce(breaks, function (arr, b) {
if (b.to !== obj.to || b.from !== obj.from) {
arr.push(b);
}
return arr;
}, []);
};
/**
* Calculates the new axis breaks after toggling the collapse/expand state of a
* node. If it is collapsed it will be expanded, and if it is exapended it will
* be collapsed.
* @param {object} axis The axis to check against.
* @param {object} node The node to toggle.
* @param {number} pos The tick position to toggle.
* @returns {array} Returns an array of the new breaks for the axis.
*/
var toggleCollapse = function (axis, node) {
return (
isCollapsed(axis, node) ?
expand(axis, node) :
collapse(axis, node)
);
};
var renderLabelIcon = function (tick, params) {
var icon = tick.labelIcon,
isNew = !icon,
renderer = params.renderer,
labelBox = params.xy,
options = params.options,
width = options.width,
height = options.height,
iconCenter = {
x: labelBox.x - (width / 2) - options.padding,
y: labelBox.y - (height / 2)
},
rotation = params.collapsed ? 90 : 180,
shouldRender = params.show && H.isNumber(iconCenter.y);
if (isNew) {
tick.labelIcon = icon = renderer.path(renderer.symbols[options.type](
options.x,
options.y,
width,
height
))
.addClass('highcharts-label-icon')
.add(params.group);
}
// Set the new position, and show or hide
if (!shouldRender) {
icon.attr({ y: -9999 }); // #1338
}
// Presentational attributes
icon
.attr({
'stroke-width': 1,
'fill': pick(params.color, '#666666')
})
.css({
cursor: 'pointer',
stroke: options.lineColor,
strokeWidth: options.lineWidth
});
// Update the icon positions
icon[isNew ? 'attr' : 'animate']({
translateX: iconCenter.x,
translateY: iconCenter.y,
rotation: rotation
});
};
var onTickHover = function (label) {
label.addClass('highcharts-treegrid-node-active');
label.css({
textDecoration: 'underline'
});
};
var onTickHoverExit = function (label, options) {
var css = defined(options.style) ? options.style : {};
label.removeClass('highcharts-treegrid-node-active');
label.css({
textDecoration: css.textDecoration
});
};
/**
* Creates a tree structure of the data, and the treegrid. Calculates
* categories, and y-values of points based on the tree.
* @param {Array} data All the data points to display in the axis.
* @param {boolean} uniqueNames Wether or not the data node with the same name
* should share grid cell. If true they do share cell. False by default.
* @returns {object} Returns an object containing categories, mapOfIdToNode,
* mapOfPosToGridNode, and tree.
* @todo There should be only one point per line.
* @todo It should be optional to have one category per point, or merge cells
* @todo Add unit-tests.
*/
var getTreeGridFromData = function (data, uniqueNames, numberOfSeries) {
var categories = [],
collapsedNodes = [],
mapOfIdToNode = {},
mapOfPosToGridNode = {},
posIterator = -1,
uniqueNamesEnabled = isBoolean(uniqueNames) ? uniqueNames : false,
tree,
treeParams,
updateYValuesAndTickPos;
// Build the tree from the series data.
treeParams = {
// After the children has been created.
after: function (node) {
var gridNode = mapOfPosToGridNode[node.pos],
height = 0,
descendants = 0;
each(gridNode.children, function (child) {
descendants += child.descendants + 1;
height = Math.max(child.height + 1, height);
});
gridNode.descendants = descendants;
gridNode.height = height;
if (gridNode.collapsed) {
collapsedNodes.push(gridNode);
}
},
// Before the children has been created.
before: function (node) {
var data = isObject(node.data) ? node.data : {},
name = isString(data.name) ? data.name : '',
parentNode = mapOfIdToNode[node.parent],
parentGridNode = (
isObject(parentNode) ?
mapOfPosToGridNode[parentNode.pos] :
null
),
hasSameName = function (x) {
return x.name === name;
},
gridNode,
pos;
// If not unique names, look for a sibling node with the same name.
if (
uniqueNamesEnabled &&
isObject(parentGridNode) &&
!!(gridNode = find(parentGridNode.children, hasSameName))
) {
// If if there is a gridNode with the same name, reuse position.
pos = gridNode.pos;
// Add data node to list of nodes in the grid node.
gridNode.nodes.push(node);
} else {
// If it is a new grid node, increment position.
pos = posIterator++;
}
// Add new grid node to map.
if (!mapOfPosToGridNode[pos]) {
mapOfPosToGridNode[pos] = gridNode = {
depth: parentGridNode ? parentGridNode.depth + 1 : 0,
name: name,
nodes: [node],
children: [],
pos: pos
};
// If not root, then add name to categories.
if (pos !== -1) {
categories.push(name);
}
// Add name to list of children.
if (isObject(parentGridNode)) {
parentGridNode.children.push(gridNode);
}
}
// Add data node to map
if (isString(node.id)) {
mapOfIdToNode[node.id] = node;
}
// If one of the points are collapsed, then start the grid node in
// collapsed state.
if (data.collapsed === true) {
gridNode.collapsed = true;
}
// Assign pos to data node
node.pos = pos;
}
};
updateYValuesAndTickPos = function (map, numberOfSeries) {
var setValues = function (gridNode, start, result) {
var nodes = gridNode.nodes,
end = start + (start === -1 ? 0 : numberOfSeries - 1),
diff = (end - start) / 2,
padding = 0.5,
pos = start + diff;
each(nodes, function (node) {
var data = node.data;
if (isObject(data)) {
// Update point
data.y = start + data.seriesIndex;
// Remove the property once used
delete data.seriesIndex;
}
node.pos = pos;
});
result[pos] = gridNode;
gridNode.pos = pos;
gridNode.tickmarkOffset = diff + padding;
gridNode.collapseStart = end + padding;
each(gridNode.children, function (child) {
setValues(child, end + 1, result);
end = child.collapseEnd - padding;
});
// Set collapseEnd to the end of the last child node.
gridNode.collapseEnd = end + padding;
return result;
};
return setValues(map['-1'], -1, {});
};
// Create tree from data
tree = Tree.getTree(data, treeParams);
// Update y values of data, and set calculate tick positions.
mapOfPosToGridNode = updateYValuesAndTickPos(
mapOfPosToGridNode,
numberOfSeries
);
// Return the resulting data.
return {
categories: categories,
mapOfIdToNode: mapOfIdToNode,
mapOfPosToGridNode: mapOfPosToGridNode,
collapsedNodes: collapsedNodes,
tree: tree
};
};
override(GridAxis.prototype, {
init: function (proceed, chart, userOptions) {
var axis = this,
removeFoundExtremesEvent,
isTreeGrid = userOptions.type === 'treegrid';
// Set default and forced options for TreeGrid
if (isTreeGrid) {
userOptions = merge({
// Default options
grid: {
enabled: true
},
// TODO: add support for align in treegrid.
labels: {
align: 'left',
/**
* Set options on specific levels in a tree grid axis. Takes
* precedence over labels options.
*
* @product gantt
* @sample {gantt} gantt/treegrid-axis/labels-levels
* Levels on TreeGrid Labels
* @type {Array<Object>}
* @apioption yAxis.labels.levels
*/
levels: [{
/**
* Specify the level which the options within this object
* applies to.
*
* @sample {gantt} gantt/treegrid-axis/labels-levels
*/
level: undefined
}, {
level: 1,
style: {
fontWeight: 'bold'
}
}],
/**
* The symbol for the collapse and expand icon in a
* treegrid.
*
* @product gantt
* @optionparent yAxis.labels.symbol
*/
symbol: {
/**
* The symbol type. Points to a definition function in
* the `Highcharts.Renderer.symbols` collection.
*
* @validvalue ['arc', 'circle', 'diamond', 'square', 'triangle', 'triangle-down']
*/
type: 'triangle',
x: -5,
y: -5,
height: 10,
width: 10,
padding: 5
}
},
uniqueNames: false
}, userOptions, { // User options
// Forced options
reversed: true,
// grid.columns is not supported in treegrid
grid: {
columns: undefined
}
});
}
// Now apply the original function with the original arguments,
// which are sliced off this function's arguments
proceed.apply(axis, [chart, userOptions]);
if (isTreeGrid) {
H.addEvent(axis.chart, 'beforeRender', function () {
var labelOptions = axis.options && axis.options.labels;
// beforeRender is fired after all the series is initialized,
// which is an ideal time to update the axis.categories.
axis.updateYNames();
// Update yData now that we have calculated the y values
// TODO: it would be better to be able to calculate y values
// before Series.setData
each(axis.series, function (series) {
series.yData = map(series.options.data, function (data) {
return data.y;
});
});
// Calculate the label options for each level in the tree.
axis.mapOptionsToLevel = getLevelOptions({
defaults: labelOptions,
from: 1,
levels: labelOptions.levels,
to: axis.tree.height
});
// Collapse all the nodes belonging to a point where collapsed
// equals true.
// Can be called from beforeRender, if getBreakFromNode removes
// its dependency on axis.max.
removeFoundExtremesEvent =
H.addEvent(axis, 'foundExtremes', function () {
each(axis.collapsedNodes, function (node) {
var breaks = collapse(axis, node);
axis.setBreaks(breaks, false);
});
removeFoundExtremesEvent();
});
});
axis.hasNames = true;
axis.options.showLastLabel = true;
}
},
/**
* Override to add indentation to axis.maxLabelDimensions.
* @param {Function} proceed the original function
* @returns {undefined}
*/
getMaxLabelDimensions: function (proceed) {
var axis = this,
options = axis.options,
labelOptions = options && options.labels,
indentation = (
labelOptions && isNumber(labelOptions.indentation) ?
options.labels.indentation :
0
),
retVal = proceed.apply(axis, argsToArray(arguments)),
isTreeGrid = axis.options.type === 'treegrid',
treeDepth;
if (isTreeGrid) {
treeDepth = axis.mapOfPosToGridNode[-1].height;
retVal.width += indentation * (treeDepth - 1);
}
return retVal;
},
/**
* Generates a tick for initial positioning.
*
* @private
* @param {function} proceed The original generateTick function.
* @param {number} pos The tick position in axis values.
*/
generateTick: function (proceed, pos) {
var axis = this,
mapOptionsToLevel = (
isObject(axis.mapOptionsToLevel) ? axis.mapOptionsToLevel : {}
),
isTreeGrid = axis.options.type === 'treegrid',
ticks = axis.ticks,
tick = ticks[pos],
levelOptions,
options,
gridNode;
if (isTreeGrid) {
gridNode = axis.mapOfPosToGridNode[pos];
levelOptions = mapOptionsToLevel[gridNode.depth];
if (levelOptions) {
options = {
labels: levelOptions
};
}
if (!tick) {
ticks[pos] = tick =
new GridAxisTick(axis, pos, null, undefined, {
category: gridNode.name,
tickmarkOffset: gridNode.tickmarkOffset,
options: options
});
} else {
// update labels depending on tick interval
tick.parameters.category = gridNode.name;
tick.options = options;
tick.addLabel();
}
} else {
proceed.apply(axis, argsToArray(arguments));
}
},
/**
* Set the tick positions, tickInterval, axis min and max.
*
* @private
*/
setTickInterval: function (proceed) {
var axis = this,
options = axis.options,
isTreeGrid = options.type === 'treegrid';
if (isTreeGrid) {
axis.min = pick(axis.userMin, options.min, axis.dataMin);
axis.max = pick(axis.userMax, options.max, axis.dataMax);
fireEvent(axis, 'foundExtremes');
// setAxisTranslation modifies the min and max according to
// axis breaks.
axis.setAxisTranslation(true);
axis.tickmarkOffset = 0.5;
axis.tickInterval = 1;
axis.tickPositions = getTickPositions(axis);
} else {
proceed.apply(axis, argsToArray(arguments));
}
}
});
override(GridAxisTick.prototype, {
getLabelPosition: function (
proceed,
x,
y,
label,
horiz,
labelOptions,
tickmarkOffset,
index,
step
) {
var tick = this,
lbOptions = pick(
tick.options && tick.options.labels,
labelOptions
),
pos = tick.pos,
axis = tick.axis,
options = axis.options,
isTreeGrid = options.type === 'treegrid',
result = proceed.apply(
tick,
[x, y, label, horiz, lbOptions, tickmarkOffset, index, step]
),
symbolOptions,
indentation,
mapOfPosToGridNode,
node,
level;
if (isTreeGrid) {
symbolOptions = (
lbOptions && isObject(lbOptions.symbol) ?
lbOptions.symbol :
{}
);
indentation = (
lbOptions && isNumber(lbOptions.indentation) ?
lbOptions.indentation :
0
);
mapOfPosToGridNode = axis.mapOfPosToGridNode;
node = mapOfPosToGridNode && mapOfPosToGridNode[pos];
level = (node && node.depth) || 1;
result.x += (
// Add space for symbols
((symbolOptions.width) + (symbolOptions.padding * 2)) +
// Apply indentation
((level - 1) * indentation)
);
}
return result;
},
renderLabel: function (proceed) {
var tick = this,
pos = tick.pos,
axis = tick.axis,
label = tick.label,
mapOfPosToGridNode = axis.mapOfPosToGridNode,
options = axis.options,
labelOptions = pick(
tick.options && tick.options.labels,
options && options.labels
),
symbolOptions = (
labelOptions && isObject(labelOptions.symbol) ?
labelOptions.symbol :
{}
),
node = mapOfPosToGridNode && mapOfPosToGridNode[pos],
level = node && node.depth,
isTreeGrid = options.type === 'treegrid',
hasLabel = !!(label && label.element),
shouldRender = inArray(pos, axis.tickPositions) > -1,
prefixClassName = 'highcharts-treegrid-node-',
collapsed,
addClassName,
removeClassName;
if (isTreeGrid && node) {
// Add class name for hierarchical styling.
if (hasLabel) {
label.addClass(prefixClassName + 'level-' + level);
}
}
proceed.apply(tick, argsToArray(arguments));
if (isTreeGrid && node && hasLabel && node.descendants > 0) {
collapsed = isCollapsed(axis, node);
renderLabelIcon(
tick,
{
color: label.styles.color,
collapsed: collapsed,
group: label.parentGroup,
options: symbolOptions,
renderer: label.renderer,
show: shouldRender,
xy: label.xy
}
);
// Add class name for the node.
addClassName = prefixClassName +
(collapsed ? 'collapsed' : 'expanded');
removeClassName = prefixClassName +
(collapsed ? 'expanded' : 'collapsed');
label
.addClass(addClassName)
.removeClass(removeClassName);
label.css({
cursor: 'pointer'
});
// Add events to both label text and icon
each([label, tick.labelIcon], function (object) {
if (!object.attachedTreeGridEvents) {
// On hover
H.addEvent(object.element, 'mouseover', function () {
onTickHover(label);
});
// On hover out
H.addEvent(object.element, 'mouseout', function () {
onTickHoverExit(label, labelOptions);
});
H.addEvent(object.element, 'click', function () {
tick.toggleCollapse();
});
object.attachedTreeGridEvents = true;
}
});
}
}
});
extend(GridAxisTick.prototype, /** @lends Highcharts.Tick.prototype */{
/**
* Collapse the grid cell. Used when axis is of type treegrid.
* @param {boolean} [redraw=true] Whether to redraw the chart or wait for
* an explicit call to {@link Highcharts.Chart#redraw}
* @sample {gantt} gantt/treegrid-axis/collapsed-dynamically/demo.js
* Dynamically collapse
*/
collapse: function (redraw) {
var tick = this,
axis = tick.axis,
pos = tick.pos,
node = axis.mapOfPosToGridNode[pos],
breaks = collapse(axis, node);
axis.setBreaks(breaks, pick(redraw, true));
},
/**
* Expand the grid cell. Used when axis is of type treegrid.
*
* @param {boolean} [redraw=true] Whether to redraw the chart or wait for
* an explicit call to {@link Highcharts.Chart#redraw}
* @sample {gantt} gantt/treegrid-axis/collapsed-dynamically/demo.js
* Dynamically collapse
*/
expand: function (redraw) {
var tick = this,
axis = tick.axis,
pos = tick.pos,
node = axis.mapOfPosToGridNode[pos],
breaks = expand(axis, node);
axis.setBreaks(breaks, pick(redraw, true));
},
/**
* Toggle the collapse/expand state of the grid cell. Used when axis is of
* type treegrid.
*
* @param {boolean} [redraw=true] Whether to redraw the chart or wait for
* an explicit call to {@link Highcharts.Chart#redraw}
* @sample {gantt} gantt/treegrid-axis/collapsed-dynamically/demo.js
* Dynamically collapse
*/
toggleCollapse: function (redraw) {
var tick = this,
axis = tick.axis,
pos = tick.pos,
node = axis.mapOfPosToGridNode[pos],
breaks = toggleCollapse(axis, node);
axis.setBreaks(breaks, pick(redraw, true));
}
});
GridAxis.prototype.updateYNames = function () {
var axis = this,
options = axis.options,
isTreeGrid = options.type === 'treegrid',
uniqueNames = options.uniqueNames,
isYAxis = !axis.isXAxis,
series = axis.series,
numberOfSeries = 0,
treeGrid,
data;
if (isTreeGrid && isYAxis) {
// Concatenate data from all series assigned to this axis.
data = reduce(series, function (arr, s) {
if (s.visible) {
// Push all data to array
each(s.options.data, function (data) {
if (isObject(data)) {
// Set series index on data. Removed again after use.
data.seriesIndex = numberOfSeries;
arr.push(data);
}
});
// Increment series index
if (uniqueNames === true) {
numberOfSeries++;
}
}
return arr;
}, []);
// Calculate categories and the hierarchy for the grid.
treeGrid = getTreeGridFromData(
data,
uniqueNames,
(uniqueNames === true) ? numberOfSeries : 1
);
// Assign values to the axis.
axis.categories = treeGrid.categories;
axis.mapOfPosToGridNode = treeGrid.mapOfPosToGridNode;
// Used on init to start a node as collapsed
axis.collapsedNodes = treeGrid.collapsedNodes;
axis.hasNames = true;
axis.tree = treeGrid.tree;
}
};
// Make utility functions available for testing.
GridAxis.prototype.utils = {
getNode: Tree.getNode
};