HighchartsWaterfall::setStickyTracking()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
1
<?php
2
3
/**
4
 * This file is part of the highcharts-bundle package.
5
 *
6
 * (c) 2017 WEBEWEB
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions;
13
14
use JsonSerializable;
15
use WBW\Library\Core\Utility\Argument\ArrayUtility;
16
17
/**
18
 * Highcharts waterfall.
19
 *
20
 * @author webeweb <https://github.com/webeweb/>
21
 * @package WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions
22
 * @version 5.0.14
23
 * @final
24
 */
25
final class HighchartsWaterfall implements JsonSerializable {
26
27
    /**
28
     * Allow point select.
29
     *
30
     * @var boolean
31
     * @since 1.2.0
32
     */
33
    private $allowPointSelect = false;
34
35
    /**
36
     * Animation.
37
     *
38
     * @var boolean
39
     */
40
    private $animation = true;
41
42
    /**
43
     * Animation limit.
44
     *
45
     * @var integer
46
     */
47
    private $animationLimit;
48
49
    /**
50
     * Border color.
51
     *
52
     * @var string
53
     * @since 3.0
54
     */
55
    private $borderColor = "#333333";
56
57
    /**
58
     * Border radius.
59
     *
60
     * @var integer
61
     */
62
    private $borderRadius = 0;
63
64
    /**
65
     * Border width.
66
     *
67
     * @var integer
68
     */
69
    private $borderWidth = 1;
70
71
    /**
72
     * Class name.
73
     *
74
     * @var string
75
     * @since 5.0.0
76
     */
77
    private $className;
78
79
    /**
80
     * Color.
81
     *
82
     * @var string
83
     */
84
    private $color;
85
86
    /**
87
     * Color by point.
88
     *
89
     * @var boolean
90
     * @since 2.0
91
     */
92
    private $colorByPoint = false;
93
94
    /**
95
     * Color index.
96
     *
97
     * @var integer
98
     * @since 5.0.0
99
     */
100
    private $colorIndex;
101
102
    /**
103
     * Colors.
104
     *
105
     * @var array
106
     * @since 3.0
107
     */
108
    private $colors;
109
110
    /**
111
     * Crisp.
112
     *
113
     * @var boolean
114
     * @since 5.0.10
115
     */
116
    private $crisp = true;
117
118
    /**
119
     * Cursor.
120
     *
121
     * @var string
122
     */
123
    private $cursor;
124
125
    /**
126
     * Dash style.
127
     *
128
     * @var string
129
     * @since 3.0
130
     */
131
    private $dashStyle = "Dot";
132
133
    /**
134
     * Data labels.
135
     *
136
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsDataLabels
137
     */
138
    private $dataLabels;
139
140
    /**
141
     * Depth.
142
     *
143
     * @var integer
144
     * @since 4.0
145
     */
146
    private $depth = 25;
147
148
    /**
149
     * Description.
150
     *
151
     * @var string
152
     * @since 5.0.0
153
     */
154
    private $description;
155
156
    /**
157
     * Edge color.
158
     *
159
     * @var string
160
     */
161
    private $edgeColor;
162
163
    /**
164
     * Edge width.
165
     *
166
     * @var integer
167
     */
168
    private $edgeWidth = 1;
169
170
    /**
171
     * Enable mouse tracking.
172
     *
173
     * @var boolean
174
     */
175
    private $enableMouseTracking = true;
176
177
    /**
178
     * Events.
179
     *
180
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsEvents
181
     */
182
    private $events;
183
184
    /**
185
     * Expose element to a11y.
186
     *
187
     * @var boolean
188
     * @since 5.0.12
189
     */
190
    private $exposeElementToA11y;
191
192
    /**
193
     * Find nearest point by.
194
     *
195
     * @var string
196
     * @since 5.0.10
197
     */
198
    private $findNearestPointBy;
199
200
    /**
201
     * Get extremes from all.
202
     *
203
     * @var boolean
204
     * @since 4.1.6
205
     */
206
    private $getExtremesFromAll = false;
207
208
    /**
209
     * Group padding.
210
     *
211
     * @var integer
212
     */
213
    private $groupPadding = 0.2;
214
215
    /**
216
     * Group z padding.
217
     *
218
     * @var integer
219
     * @since 4.0
220
     */
221
    private $groupZPadding = 1;
222
223
    /**
224
     * Grouping.
225
     *
226
     * @var boolean
227
     * @since 2.3.0
228
     */
229
    private $grouping = true;
230
231
    /**
232
     * Keys.
233
     *
234
     * @var array
235
     * @since 4.1.6
236
     */
237
    private $keys;
238
239
    /**
240
     * Line color.
241
     *
242
     * @var string
243
     * @since 3.0
244
     */
245
    private $lineColor = "#333333";
246
247
    /**
248
     * Line width.
249
     *
250
     * @var integer
251
     */
252
    private $lineWidth = 1;
253
254
    /**
255
     * Linked to.
256
     *
257
     * @var string
258
     * @since 3.0
259
     */
260
    private $linkedTo;
261
262
    /**
263
     * Max point width.
264
     *
265
     * @var integer
266
     * @since 4.1.8
267
     */
268
    private $maxPointWidth;
269
270
    /**
271
     * Min point length.
272
     *
273
     * @var integer
274
     */
275
    private $minPointLength = 0;
276
277
    /**
278
     * Point.
279
     *
280
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsPoint
281
     */
282
    private $point;
283
284
    /**
285
     * Point description formatter.
286
     *
287
     * @var string
288
     * @since 5.0.12
289
     */
290
    private $pointDescriptionFormatter;
291
292
    /**
293
     * Point interval.
294
     *
295
     * @var integer
296
     */
297
    private $pointInterval = 1;
298
299
    /**
300
     * Point interval unit.
301
     *
302
     * @var string
303
     * @since 4.1.0
304
     */
305
    private $pointIntervalUnit;
306
307
    /**
308
     * Point padding.
309
     *
310
     * @var integer
311
     */
312
    private $pointPadding = 0.1;
313
314
    /**
315
     * Point placement.
316
     *
317
     * @var string|integer
318
     * @since 2.3.0
319
     */
320
    private $pointPlacement;
321
322
    /**
323
     * Point range.
324
     *
325
     * @var integer
326
     * @since 2.3
327
     */
328
    private $pointRange;
329
330
    /**
331
     * Point start.
332
     *
333
     * @var integer
334
     */
335
    private $pointStart = 0;
336
337
    /**
338
     * Point width.
339
     *
340
     * @var integer
341
     * @since 1.2.5
342
     */
343
    private $pointWidth;
344
345
    /**
346
     * Selected.
347
     *
348
     * @var boolean
349
     * @since 1.2.0
350
     */
351
    private $selected = false;
352
353
    /**
354
     * Shadow.
355
     *
356
     * @var boolean|array
357
     */
358
    private $shadow = false;
359
360
    /**
361
     * Show checkbox.
362
     *
363
     * @var boolean
364
     * @since 1.2.0
365
     */
366
    private $showCheckbox = false;
367
368
    /**
369
     * Show in legend.
370
     *
371
     * @var boolean
372
     */
373
    private $showInLegend = true;
374
375
    /**
376
     * Skip keyboard navigation.
377
     *
378
     * @var boolean
379
     * @since 5.0.12
380
     */
381
    private $skipKeyboardNavigation;
382
383
    /**
384
     * Soft threshold.
385
     *
386
     * @var boolean
387
     * @since 4.1.9
388
     */
389
    private $softThreshold = true;
390
391
    /**
392
     * States.
393
     *
394
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsStates
395
     */
396
    private $states;
397
398
    /**
399
     * Sticky tracking.
400
     *
401
     * @var boolean
402
     * @since 2.0
403
     */
404
    private $stickyTracking = true;
405
406
    /**
407
     * Threshold.
408
     *
409
     * @var integer
410
     * @since 2.0
411
     */
412
    private $threshold = 0;
413
414
    /**
415
     * Tooltip.
416
     *
417
     * @var array
418
     * @since 2.3
419
     */
420
    private $tooltip;
421
422
    /**
423
     * Up color.
424
     *
425
     * @var string
426
     */
427
    private $upColor;
428
429
    /**
430
     * Visible.
431
     *
432
     * @var boolean
433
     */
434
    private $visible = true;
435
436
    /**
437
     * Zone axis.
438
     *
439
     * @var string
440
     * @since 4.1.0
441
     */
442
    private $zoneAxis = "y";
443
444
    /**
445
     * Zones.
446
     *
447
     * @var array
448
     * @since 4.1.0
449
     */
450
    private $zones;
451
452
    /**
453
     * Constructor.
454
     *
455
     * @param boolean $ignoreDefaultValues Ignore the default values.
456
     */
457
    public function __construct($ignoreDefaultValues = true) {
458
        if (true === $ignoreDefaultValues) {
459
            $this->clear();
460
        }
461
    }
462
463
    /**
464
     * Clear.
465
     *
466
     * @return void
467
     */
468
    public function clear() {
469
470
        // Clear the allow point select.
471
        $this->allowPointSelect = null;
472
473
        // Clear the animation.
474
        $this->animation = null;
475
476
        // Clear the animation limit.
477
        $this->animationLimit = null;
478
479
        // Clear the border color.
480
        $this->borderColor = null;
481
482
        // Clear the border radius.
483
        $this->borderRadius = null;
484
485
        // Clear the border width.
486
        $this->borderWidth = null;
487
488
        // Clear the class name.
489
        $this->className = null;
490
491
        // Clear the color.
492
        $this->color = null;
493
494
        // Clear the color by point.
495
        $this->colorByPoint = null;
496
497
        // Clear the color index.
498
        $this->colorIndex = null;
499
500
        // Clear the colors.
501
        $this->colors = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $colors.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
502
503
        // Clear the crisp.
504
        $this->crisp = null;
505
506
        // Clear the cursor.
507
        $this->cursor = null;
508
509
        // Clear the dash style.
510
        $this->dashStyle = null;
511
512
        // Clear the data labels.
513
        if (null !== $this->dataLabels) {
514
            $this->dataLabels->clear();
515
        }
516
517
        // Clear the depth.
518
        $this->depth = null;
519
520
        // Clear the description.
521
        $this->description = null;
522
523
        // Clear the edge color.
524
        $this->edgeColor = null;
525
526
        // Clear the edge width.
527
        $this->edgeWidth = null;
528
529
        // Clear the enable mouse tracking.
530
        $this->enableMouseTracking = null;
531
532
        // Clear the events.
533
        if (null !== $this->events) {
534
            $this->events->clear();
535
        }
536
537
        // Clear the expose element to a11y.
538
        $this->exposeElementToA11y = null;
539
540
        // Clear the find nearest point by.
541
        $this->findNearestPointBy = null;
542
543
        // Clear the get extremes from all.
544
        $this->getExtremesFromAll = null;
545
546
        // Clear the group padding.
547
        $this->groupPadding = null;
548
549
        // Clear the group z padding.
550
        $this->groupZPadding = null;
551
552
        // Clear the grouping.
553
        $this->grouping = null;
554
555
        // Clear the keys.
556
        $this->keys = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $keys.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
557
558
        // Clear the line color.
559
        $this->lineColor = null;
560
561
        // Clear the line width.
562
        $this->lineWidth = null;
563
564
        // Clear the linked to.
565
        $this->linkedTo = null;
566
567
        // Clear the max point width.
568
        $this->maxPointWidth = null;
569
570
        // Clear the min point length.
571
        $this->minPointLength = null;
572
573
        // Clear the point.
574
        if (null !== $this->point) {
575
            $this->point->clear();
576
        }
577
578
        // Clear the point description formatter.
579
        $this->pointDescriptionFormatter = null;
580
581
        // Clear the point interval.
582
        $this->pointInterval = null;
583
584
        // Clear the point interval unit.
585
        $this->pointIntervalUnit = null;
586
587
        // Clear the point padding.
588
        $this->pointPadding = null;
589
590
        // Clear the point placement.
591
        $this->pointPlacement = null;
592
593
        // Clear the point range.
594
        $this->pointRange = null;
595
596
        // Clear the point start.
597
        $this->pointStart = null;
598
599
        // Clear the point width.
600
        $this->pointWidth = null;
601
602
        // Clear the selected.
603
        $this->selected = null;
604
605
        // Clear the shadow.
606
        $this->shadow = null;
607
608
        // Clear the show checkbox.
609
        $this->showCheckbox = null;
610
611
        // Clear the show in legend.
612
        $this->showInLegend = null;
613
614
        // Clear the skip keyboard navigation.
615
        $this->skipKeyboardNavigation = null;
616
617
        // Clear the soft threshold.
618
        $this->softThreshold = null;
619
620
        // Clear the states.
621
        if (null !== $this->states) {
622
            $this->states->clear();
623
        }
624
625
        // Clear the sticky tracking.
626
        $this->stickyTracking = null;
627
628
        // Clear the threshold.
629
        $this->threshold = null;
630
631
        // Clear the tooltip.
632
        $this->tooltip = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $tooltip.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
633
634
        // Clear the up color.
635
        $this->upColor = null;
636
637
        // Clear the visible.
638
        $this->visible = null;
639
640
        // Clear the zone axis.
641
        $this->zoneAxis = null;
642
643
        // Clear the zones.
644
        $this->zones = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $zones.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
645
    }
646
647
    /**
648
     * Get the allow point select.
649
     *
650
     * @return boolean Returns the allow point select.
651
     */
652
    public function getAllowPointSelect() {
653
        return $this->allowPointSelect;
654
    }
655
656
    /**
657
     * Get the animation.
658
     *
659
     * @return boolean Returns the animation.
660
     */
661
    public function getAnimation() {
662
        return $this->animation;
663
    }
664
665
    /**
666
     * Get the animation limit.
667
     *
668
     * @return integer Returns the animation limit.
669
     */
670
    public function getAnimationLimit() {
671
        return $this->animationLimit;
672
    }
673
674
    /**
675
     * Get the border color.
676
     *
677
     * @return string Returns the border color.
678
     */
679
    public function getBorderColor() {
680
        return $this->borderColor;
681
    }
682
683
    /**
684
     * Get the border radius.
685
     *
686
     * @return integer Returns the border radius.
687
     */
688
    public function getBorderRadius() {
689
        return $this->borderRadius;
690
    }
691
692
    /**
693
     * Get the border width.
694
     *
695
     * @return integer Returns the border width.
696
     */
697
    public function getBorderWidth() {
698
        return $this->borderWidth;
699
    }
700
701
    /**
702
     * Get the class name.
703
     *
704
     * @return string Returns the class name.
705
     */
706
    public function getClassName() {
707
        return $this->className;
708
    }
709
710
    /**
711
     * Get the color.
712
     *
713
     * @return string Returns the color.
714
     */
715
    public function getColor() {
716
        return $this->color;
717
    }
718
719
    /**
720
     * Get the color by point.
721
     *
722
     * @return boolean Returns the color by point.
723
     */
724
    public function getColorByPoint() {
725
        return $this->colorByPoint;
726
    }
727
728
    /**
729
     * Get the color index.
730
     *
731
     * @return integer Returns the color index.
732
     */
733
    public function getColorIndex() {
734
        return $this->colorIndex;
735
    }
736
737
    /**
738
     * Get the colors.
739
     *
740
     * @return array Returns the colors.
741
     */
742
    public function getColors() {
743
        return $this->colors;
744
    }
745
746
    /**
747
     * Get the crisp.
748
     *
749
     * @return boolean Returns the crisp.
750
     */
751
    public function getCrisp() {
752
        return $this->crisp;
753
    }
754
755
    /**
756
     * Get the cursor.
757
     *
758
     * @return string Returns the cursor.
759
     */
760
    public function getCursor() {
761
        return $this->cursor;
762
    }
763
764
    /**
765
     * Get the dash style.
766
     *
767
     * @return string Returns the dash style.
768
     */
769
    public function getDashStyle() {
770
        return $this->dashStyle;
771
    }
772
773
    /**
774
     * Get the data labels.
775
     *
776
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsDataLabels Returns the data labels.
777
     */
778
    public function getDataLabels() {
779
        return $this->dataLabels;
780
    }
781
782
    /**
783
     * Get the depth.
784
     *
785
     * @return integer Returns the depth.
786
     */
787
    public function getDepth() {
788
        return $this->depth;
789
    }
790
791
    /**
792
     * Get the description.
793
     *
794
     * @return string Returns the description.
795
     */
796
    public function getDescription() {
797
        return $this->description;
798
    }
799
800
    /**
801
     * Get the edge color.
802
     *
803
     * @return string Returns the edge color.
804
     */
805
    public function getEdgeColor() {
806
        return $this->edgeColor;
807
    }
808
809
    /**
810
     * Get the edge width.
811
     *
812
     * @return integer Returns the edge width.
813
     */
814
    public function getEdgeWidth() {
815
        return $this->edgeWidth;
816
    }
817
818
    /**
819
     * Get the enable mouse tracking.
820
     *
821
     * @return boolean Returns the enable mouse tracking.
822
     */
823
    public function getEnableMouseTracking() {
824
        return $this->enableMouseTracking;
825
    }
826
827
    /**
828
     * Get the events.
829
     *
830
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsEvents Returns the events.
831
     */
832
    public function getEvents() {
833
        return $this->events;
834
    }
835
836
    /**
837
     * Get the expose element to a11y.
838
     *
839
     * @return boolean Returns the expose element to a11y.
840
     */
841
    public function getExposeElementToA11y() {
842
        return $this->exposeElementToA11y;
843
    }
844
845
    /**
846
     * Get the find nearest point by.
847
     *
848
     * @return string Returns the find nearest point by.
849
     */
850
    public function getFindNearestPointBy() {
851
        return $this->findNearestPointBy;
852
    }
853
854
    /**
855
     * Get the get extremes from all.
856
     *
857
     * @return boolean Returns the get extremes from all.
858
     */
859
    public function getGetExtremesFromAll() {
860
        return $this->getExtremesFromAll;
861
    }
862
863
    /**
864
     * Get the group padding.
865
     *
866
     * @return integer Returns the group padding.
867
     */
868
    public function getGroupPadding() {
869
        return $this->groupPadding;
870
    }
871
872
    /**
873
     * Get the group z padding.
874
     *
875
     * @return integer Returns the group z padding.
876
     */
877
    public function getGroupZPadding() {
878
        return $this->groupZPadding;
879
    }
880
881
    /**
882
     * Get the grouping.
883
     *
884
     * @return boolean Returns the grouping.
885
     */
886
    public function getGrouping() {
887
        return $this->grouping;
888
    }
889
890
    /**
891
     * Get the keys.
892
     *
893
     * @return array Returns the keys.
894
     */
895
    public function getKeys() {
896
        return $this->keys;
897
    }
898
899
    /**
900
     * Get the line color.
901
     *
902
     * @return string Returns the line color.
903
     */
904
    public function getLineColor() {
905
        return $this->lineColor;
906
    }
907
908
    /**
909
     * Get the line width.
910
     *
911
     * @return integer Returns the line width.
912
     */
913
    public function getLineWidth() {
914
        return $this->lineWidth;
915
    }
916
917
    /**
918
     * Get the linked to.
919
     *
920
     * @return string Returns the linked to.
921
     */
922
    public function getLinkedTo() {
923
        return $this->linkedTo;
924
    }
925
926
    /**
927
     * Get the max point width.
928
     *
929
     * @return integer Returns the max point width.
930
     */
931
    public function getMaxPointWidth() {
932
        return $this->maxPointWidth;
933
    }
934
935
    /**
936
     * Get the min point length.
937
     *
938
     * @return integer Returns the min point length.
939
     */
940
    public function getMinPointLength() {
941
        return $this->minPointLength;
942
    }
943
944
    /**
945
     * Get the point.
946
     *
947
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsPoint Returns the point.
948
     */
949
    public function getPoint() {
950
        return $this->point;
951
    }
952
953
    /**
954
     * Get the point description formatter.
955
     *
956
     * @return string Returns the point description formatter.
957
     */
958
    public function getPointDescriptionFormatter() {
959
        return $this->pointDescriptionFormatter;
960
    }
961
962
    /**
963
     * Get the point interval.
964
     *
965
     * @return integer Returns the point interval.
966
     */
967
    public function getPointInterval() {
968
        return $this->pointInterval;
969
    }
970
971
    /**
972
     * Get the point interval unit.
973
     *
974
     * @return string Returns the point interval unit.
975
     */
976
    public function getPointIntervalUnit() {
977
        return $this->pointIntervalUnit;
978
    }
979
980
    /**
981
     * Get the point padding.
982
     *
983
     * @return integer Returns the point padding.
984
     */
985
    public function getPointPadding() {
986
        return $this->pointPadding;
987
    }
988
989
    /**
990
     * Get the point placement.
991
     *
992
     * @return string|integer Returns the point placement.
993
     */
994
    public function getPointPlacement() {
995
        return $this->pointPlacement;
996
    }
997
998
    /**
999
     * Get the point range.
1000
     *
1001
     * @return integer Returns the point range.
1002
     */
1003
    public function getPointRange() {
1004
        return $this->pointRange;
1005
    }
1006
1007
    /**
1008
     * Get the point start.
1009
     *
1010
     * @return integer Returns the point start.
1011
     */
1012
    public function getPointStart() {
1013
        return $this->pointStart;
1014
    }
1015
1016
    /**
1017
     * Get the point width.
1018
     *
1019
     * @return integer Returns the point width.
1020
     */
1021
    public function getPointWidth() {
1022
        return $this->pointWidth;
1023
    }
1024
1025
    /**
1026
     * Get the selected.
1027
     *
1028
     * @return boolean Returns the selected.
1029
     */
1030
    public function getSelected() {
1031
        return $this->selected;
1032
    }
1033
1034
    /**
1035
     * Get the shadow.
1036
     *
1037
     * @return boolean|array Returns the shadow.
1038
     */
1039
    public function getShadow() {
1040
        return $this->shadow;
1041
    }
1042
1043
    /**
1044
     * Get the show checkbox.
1045
     *
1046
     * @return boolean Returns the show checkbox.
1047
     */
1048
    public function getShowCheckbox() {
1049
        return $this->showCheckbox;
1050
    }
1051
1052
    /**
1053
     * Get the show in legend.
1054
     *
1055
     * @return boolean Returns the show in legend.
1056
     */
1057
    public function getShowInLegend() {
1058
        return $this->showInLegend;
1059
    }
1060
1061
    /**
1062
     * Get the skip keyboard navigation.
1063
     *
1064
     * @return boolean Returns the skip keyboard navigation.
1065
     */
1066
    public function getSkipKeyboardNavigation() {
1067
        return $this->skipKeyboardNavigation;
1068
    }
1069
1070
    /**
1071
     * Get the soft threshold.
1072
     *
1073
     * @return boolean Returns the soft threshold.
1074
     */
1075
    public function getSoftThreshold() {
1076
        return $this->softThreshold;
1077
    }
1078
1079
    /**
1080
     * Get the states.
1081
     *
1082
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsStates Returns the states.
1083
     */
1084
    public function getStates() {
1085
        return $this->states;
1086
    }
1087
1088
    /**
1089
     * Get the sticky tracking.
1090
     *
1091
     * @return boolean Returns the sticky tracking.
1092
     */
1093
    public function getStickyTracking() {
1094
        return $this->stickyTracking;
1095
    }
1096
1097
    /**
1098
     * Get the threshold.
1099
     *
1100
     * @return integer Returns the threshold.
1101
     */
1102
    public function getThreshold() {
1103
        return $this->threshold;
1104
    }
1105
1106
    /**
1107
     * Get the tooltip.
1108
     *
1109
     * @return array Returns the tooltip.
1110
     */
1111
    public function getTooltip() {
1112
        return $this->tooltip;
1113
    }
1114
1115
    /**
1116
     * Get the up color.
1117
     *
1118
     * @return string Returns the up color.
1119
     */
1120
    public function getUpColor() {
1121
        return $this->upColor;
1122
    }
1123
1124
    /**
1125
     * Get the visible.
1126
     *
1127
     * @return boolean Returns the visible.
1128
     */
1129
    public function getVisible() {
1130
        return $this->visible;
1131
    }
1132
1133
    /**
1134
     * Get the zone axis.
1135
     *
1136
     * @return string Returns the zone axis.
1137
     */
1138
    public function getZoneAxis() {
1139
        return $this->zoneAxis;
1140
    }
1141
1142
    /**
1143
     * Get the zones.
1144
     *
1145
     * @return array Returns the zones.
1146
     */
1147
    public function getZones() {
1148
        return $this->zones;
1149
    }
1150
1151
    /**
1152
     * Serialize this instance.
1153
     *
1154
     * @return array Returns an array representing this instance.
1155
     */
1156
    public function jsonSerialize() {
1157
        return $this->toArray();
1158
    }
1159
1160
    /**
1161
     * Create a new data labels.
1162
     *
1163
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsDataLabels Returns the data labels.
1164
     */
1165
    public function newDataLabels() {
1166
        $this->dataLabels = new \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsDataLabels();
1167
        return $this->dataLabels;
1168
    }
1169
1170
    /**
1171
     * Create a new events.
1172
     *
1173
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsEvents Returns the events.
1174
     */
1175
    public function newEvents() {
1176
        $this->events = new \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsEvents();
1177
        return $this->events;
1178
    }
1179
1180
    /**
1181
     * Create a new point.
1182
     *
1183
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsPoint Returns the point.
1184
     */
1185
    public function newPoint() {
1186
        $this->point = new \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsPoint();
1187
        return $this->point;
1188
    }
1189
1190
    /**
1191
     * Create a new states.
1192
     *
1193
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsStates Returns the states.
1194
     */
1195
    public function newStates() {
1196
        $this->states = new \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsStates();
1197
        return $this->states;
1198
    }
1199
1200
    /**
1201
     * Set the allow point select.
1202
     *
1203
     * @param boolean $allowPointSelect The allow point select.
1204
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1205
     */
1206
    public function setAllowPointSelect($allowPointSelect) {
1207
        $this->allowPointSelect = $allowPointSelect;
1208
        return $this;
1209
    }
1210
1211
    /**
1212
     * Set the animation.
1213
     *
1214
     * @param boolean $animation The animation.
1215
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1216
     */
1217
    public function setAnimation($animation) {
1218
        $this->animation = $animation;
1219
        return $this;
1220
    }
1221
1222
    /**
1223
     * Set the animation limit.
1224
     *
1225
     * @param integer $animationLimit The animation limit.
1226
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1227
     */
1228
    public function setAnimationLimit($animationLimit) {
1229
        $this->animationLimit = $animationLimit;
1230
        return $this;
1231
    }
1232
1233
    /**
1234
     * Set the border color.
1235
     *
1236
     * @param string $borderColor The border color.
1237
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1238
     */
1239
    public function setBorderColor($borderColor) {
1240
        $this->borderColor = $borderColor;
1241
        return $this;
1242
    }
1243
1244
    /**
1245
     * Set the border radius.
1246
     *
1247
     * @param integer $borderRadius The border radius.
1248
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1249
     */
1250
    public function setBorderRadius($borderRadius) {
1251
        $this->borderRadius = $borderRadius;
1252
        return $this;
1253
    }
1254
1255
    /**
1256
     * Set the border width.
1257
     *
1258
     * @param integer $borderWidth The border width.
1259
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1260
     */
1261
    public function setBorderWidth($borderWidth) {
1262
        $this->borderWidth = $borderWidth;
1263
        return $this;
1264
    }
1265
1266
    /**
1267
     * Set the class name.
1268
     *
1269
     * @param string $className The class name.
1270
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1271
     */
1272
    public function setClassName($className) {
1273
        $this->className = $className;
1274
        return $this;
1275
    }
1276
1277
    /**
1278
     * Set the color.
1279
     *
1280
     * @param string $color The color.
1281
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1282
     */
1283
    public function setColor($color) {
1284
        $this->color = $color;
1285
        return $this;
1286
    }
1287
1288
    /**
1289
     * Set the color by point.
1290
     *
1291
     * @param boolean $colorByPoint The color by point.
1292
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1293
     */
1294
    public function setColorByPoint($colorByPoint) {
1295
        $this->colorByPoint = $colorByPoint;
1296
        return $this;
1297
    }
1298
1299
    /**
1300
     * Set the color index.
1301
     *
1302
     * @param integer $colorIndex The color index.
1303
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1304
     */
1305
    public function setColorIndex($colorIndex) {
1306
        $this->colorIndex = $colorIndex;
1307
        return $this;
1308
    }
1309
1310
    /**
1311
     * Set the colors.
1312
     *
1313
     * @param array $colors The colors.
1314
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1315
     */
1316
    public function setColors(array $colors = null) {
1317
        $this->colors = $colors;
0 ignored issues
show
Documentation Bug introduced by
It seems like $colors can be null. However, the property $colors is declared as array. Maybe change the type of the property to array|null or add a type check?

Our type inference engine has found an assignment of a scalar value (like a string, an integer or null) to a property which is an array.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.

To type hint that a parameter can be either an array or null, you can set a type hint of array and a default value of null. The PHP interpreter will then accept both an array or null for that parameter.

function aContainsB(array $needle = null, array  $haystack) {
    if (!$needle) {
        return false;
    }

    return array_intersect($haystack, $needle) == $haystack;
}

The function can be called with either null or an array for the parameter $needle but will only accept an array as $haystack.

Loading history...
1318
        return $this;
1319
    }
1320
1321
    /**
1322
     * Set the crisp.
1323
     *
1324
     * @param boolean $crisp The crisp.
1325
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1326
     */
1327
    public function setCrisp($crisp) {
1328
        $this->crisp = $crisp;
1329
        return $this;
1330
    }
1331
1332
    /**
1333
     * Set the cursor.
1334
     *
1335
     * @param string $cursor The cursor.
1336
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1337
     */
1338
    public function setCursor($cursor) {
1339
        switch ($cursor) {
1340
            case null:
1341
            case "crosshair":
1342
            case "default":
1343
            case "help":
1344
            case "none":
1345
            case "pointer":
1346
            $this->cursor = $cursor;
1347
            break;
1348
        }
1349
        return $this;
1350
    }
1351
1352
    /**
1353
     * Set the dash style.
1354
     *
1355
     * @param string $dashStyle The dash style.
1356
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1357
     */
1358
    public function setDashStyle($dashStyle) {
1359
        $this->dashStyle = $dashStyle;
1360
        return $this;
1361
    }
1362
1363
    /**
1364
     * Set the data labels.
1365
     *
1366
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsDataLabels $dataLabels The data labels.
1367
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1368
     */
1369
    public function setDataLabels(\WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsDataLabels $dataLabels = null) {
1370
        $this->dataLabels = $dataLabels;
1371
        return $this;
1372
    }
1373
1374
    /**
1375
     * Set the depth.
1376
     *
1377
     * @param integer $depth The depth.
1378
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1379
     */
1380
    public function setDepth($depth) {
1381
        $this->depth = $depth;
1382
        return $this;
1383
    }
1384
1385
    /**
1386
     * Set the description.
1387
     *
1388
     * @param string $description The description.
1389
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1390
     */
1391
    public function setDescription($description) {
1392
        $this->description = $description;
1393
        return $this;
1394
    }
1395
1396
    /**
1397
     * Set the edge color.
1398
     *
1399
     * @param string $edgeColor The edge color.
1400
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1401
     */
1402
    public function setEdgeColor($edgeColor) {
1403
        $this->edgeColor = $edgeColor;
1404
        return $this;
1405
    }
1406
1407
    /**
1408
     * Set the edge width.
1409
     *
1410
     * @param integer $edgeWidth The edge width.
1411
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1412
     */
1413
    public function setEdgeWidth($edgeWidth) {
1414
        $this->edgeWidth = $edgeWidth;
1415
        return $this;
1416
    }
1417
1418
    /**
1419
     * Set the enable mouse tracking.
1420
     *
1421
     * @param boolean $enableMouseTracking The enable mouse tracking.
1422
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1423
     */
1424
    public function setEnableMouseTracking($enableMouseTracking) {
1425
        $this->enableMouseTracking = $enableMouseTracking;
1426
        return $this;
1427
    }
1428
1429
    /**
1430
     * Set the events.
1431
     *
1432
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsEvents $events The events.
1433
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1434
     */
1435
    public function setEvents(\WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsEvents $events = null) {
1436
        $this->events = $events;
1437
        return $this;
1438
    }
1439
1440
    /**
1441
     * Set the expose element to a11y.
1442
     *
1443
     * @param boolean $exposeElementToA11y The expose element to a11y.
1444
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1445
     */
1446
    public function setExposeElementToA11y($exposeElementToA11y) {
1447
        $this->exposeElementToA11y = $exposeElementToA11y;
1448
        return $this;
1449
    }
1450
1451
    /**
1452
     * Set the find nearest point by.
1453
     *
1454
     * @param string $findNearestPointBy The find nearest point by.
1455
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1456
     */
1457
    public function setFindNearestPointBy($findNearestPointBy) {
1458
        switch ($findNearestPointBy) {
1459
            case "x":
1460
            case "xy":
1461
            $this->findNearestPointBy = $findNearestPointBy;
1462
            break;
1463
        }
1464
        return $this;
1465
    }
1466
1467
    /**
1468
     * Set the get extremes from all.
1469
     *
1470
     * @param boolean $getExtremesFromAll The get extremes from all.
1471
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1472
     */
1473
    public function setGetExtremesFromAll($getExtremesFromAll) {
1474
        $this->getExtremesFromAll = $getExtremesFromAll;
1475
        return $this;
1476
    }
1477
1478
    /**
1479
     * Set the group padding.
1480
     *
1481
     * @param integer $groupPadding The group padding.
1482
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1483
     */
1484
    public function setGroupPadding($groupPadding) {
1485
        $this->groupPadding = $groupPadding;
1486
        return $this;
1487
    }
1488
1489
    /**
1490
     * Set the group z padding.
1491
     *
1492
     * @param integer $groupZPadding The group z padding.
1493
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1494
     */
1495
    public function setGroupZPadding($groupZPadding) {
1496
        $this->groupZPadding = $groupZPadding;
1497
        return $this;
1498
    }
1499
1500
    /**
1501
     * Set the grouping.
1502
     *
1503
     * @param boolean $grouping The grouping.
1504
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1505
     */
1506
    public function setGrouping($grouping) {
1507
        $this->grouping = $grouping;
1508
        return $this;
1509
    }
1510
1511
    /**
1512
     * Set the keys.
1513
     *
1514
     * @param array $keys The keys.
1515
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1516
     */
1517
    public function setKeys(array $keys = null) {
1518
        $this->keys = $keys;
0 ignored issues
show
Documentation Bug introduced by
It seems like $keys can be null. However, the property $keys is declared as array. Maybe change the type of the property to array|null or add a type check?

Our type inference engine has found an assignment of a scalar value (like a string, an integer or null) to a property which is an array.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.

To type hint that a parameter can be either an array or null, you can set a type hint of array and a default value of null. The PHP interpreter will then accept both an array or null for that parameter.

function aContainsB(array $needle = null, array  $haystack) {
    if (!$needle) {
        return false;
    }

    return array_intersect($haystack, $needle) == $haystack;
}

The function can be called with either null or an array for the parameter $needle but will only accept an array as $haystack.

Loading history...
1519
        return $this;
1520
    }
1521
1522
    /**
1523
     * Set the line color.
1524
     *
1525
     * @param string $lineColor The line color.
1526
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1527
     */
1528
    public function setLineColor($lineColor) {
1529
        $this->lineColor = $lineColor;
1530
        return $this;
1531
    }
1532
1533
    /**
1534
     * Set the line width.
1535
     *
1536
     * @param integer $lineWidth The line width.
1537
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1538
     */
1539
    public function setLineWidth($lineWidth) {
1540
        $this->lineWidth = $lineWidth;
1541
        return $this;
1542
    }
1543
1544
    /**
1545
     * Set the linked to.
1546
     *
1547
     * @param string $linkedTo The linked to.
1548
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1549
     */
1550
    public function setLinkedTo($linkedTo) {
1551
        $this->linkedTo = $linkedTo;
1552
        return $this;
1553
    }
1554
1555
    /**
1556
     * Set the max point width.
1557
     *
1558
     * @param integer $maxPointWidth The max point width.
1559
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1560
     */
1561
    public function setMaxPointWidth($maxPointWidth) {
1562
        $this->maxPointWidth = $maxPointWidth;
1563
        return $this;
1564
    }
1565
1566
    /**
1567
     * Set the min point length.
1568
     *
1569
     * @param integer $minPointLength The min point length.
1570
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1571
     */
1572
    public function setMinPointLength($minPointLength) {
1573
        $this->minPointLength = $minPointLength;
1574
        return $this;
1575
    }
1576
1577
    /**
1578
     * Set the point.
1579
     *
1580
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsPoint $point The point.
1581
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1582
     */
1583
    public function setPoint(\WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsPoint $point = null) {
1584
        $this->point = $point;
1585
        return $this;
1586
    }
1587
1588
    /**
1589
     * Set the point description formatter.
1590
     *
1591
     * @param string $pointDescriptionFormatter The point description formatter.
1592
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1593
     */
1594
    public function setPointDescriptionFormatter($pointDescriptionFormatter) {
1595
        $this->pointDescriptionFormatter = $pointDescriptionFormatter;
1596
        return $this;
1597
    }
1598
1599
    /**
1600
     * Set the point interval.
1601
     *
1602
     * @param integer $pointInterval The point interval.
1603
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1604
     */
1605
    public function setPointInterval($pointInterval) {
1606
        $this->pointInterval = $pointInterval;
1607
        return $this;
1608
    }
1609
1610
    /**
1611
     * Set the point interval unit.
1612
     *
1613
     * @param string $pointIntervalUnit The point interval unit.
1614
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1615
     */
1616
    public function setPointIntervalUnit($pointIntervalUnit) {
1617
        switch ($pointIntervalUnit) {
1618
            case null:
1619
            case "day":
1620
            case "month":
1621
            case "year":
1622
            $this->pointIntervalUnit = $pointIntervalUnit;
1623
            break;
1624
        }
1625
        return $this;
1626
    }
1627
1628
    /**
1629
     * Set the point padding.
1630
     *
1631
     * @param integer $pointPadding The point padding.
1632
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1633
     */
1634
    public function setPointPadding($pointPadding) {
1635
        $this->pointPadding = $pointPadding;
1636
        return $this;
1637
    }
1638
1639
    /**
1640
     * Set the point placement.
1641
     *
1642
     * @param string|integer $pointPlacement The point placement.
1643
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1644
     */
1645
    public function setPointPlacement($pointPlacement) {
1646
        switch ($pointPlacement) {
1647
            case null:
1648
            case "between":
1649
            case "on":
1650
            $this->pointPlacement = $pointPlacement;
1651
            break;
1652
        }
1653
        return $this;
1654
    }
1655
1656
    /**
1657
     * Set the point range.
1658
     *
1659
     * @param integer $pointRange The point range.
1660
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1661
     */
1662
    public function setPointRange($pointRange) {
1663
        $this->pointRange = $pointRange;
1664
        return $this;
1665
    }
1666
1667
    /**
1668
     * Set the point start.
1669
     *
1670
     * @param integer $pointStart The point start.
1671
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1672
     */
1673
    public function setPointStart($pointStart) {
1674
        $this->pointStart = $pointStart;
1675
        return $this;
1676
    }
1677
1678
    /**
1679
     * Set the point width.
1680
     *
1681
     * @param integer $pointWidth The point width.
1682
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1683
     */
1684
    public function setPointWidth($pointWidth) {
1685
        $this->pointWidth = $pointWidth;
1686
        return $this;
1687
    }
1688
1689
    /**
1690
     * Set the selected.
1691
     *
1692
     * @param boolean $selected The selected.
1693
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1694
     */
1695
    public function setSelected($selected) {
1696
        $this->selected = $selected;
1697
        return $this;
1698
    }
1699
1700
    /**
1701
     * Set the shadow.
1702
     *
1703
     * @param boolean|array $shadow The shadow.
1704
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1705
     */
1706
    public function setShadow($shadow) {
1707
        $this->shadow = $shadow;
1708
        return $this;
1709
    }
1710
1711
    /**
1712
     * Set the show checkbox.
1713
     *
1714
     * @param boolean $showCheckbox The show checkbox.
1715
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1716
     */
1717
    public function setShowCheckbox($showCheckbox) {
1718
        $this->showCheckbox = $showCheckbox;
1719
        return $this;
1720
    }
1721
1722
    /**
1723
     * Set the show in legend.
1724
     *
1725
     * @param boolean $showInLegend The show in legend.
1726
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1727
     */
1728
    public function setShowInLegend($showInLegend) {
1729
        $this->showInLegend = $showInLegend;
1730
        return $this;
1731
    }
1732
1733
    /**
1734
     * Set the skip keyboard navigation.
1735
     *
1736
     * @param boolean $skipKeyboardNavigation The skip keyboard navigation.
1737
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1738
     */
1739
    public function setSkipKeyboardNavigation($skipKeyboardNavigation) {
1740
        $this->skipKeyboardNavigation = $skipKeyboardNavigation;
1741
        return $this;
1742
    }
1743
1744
    /**
1745
     * Set the soft threshold.
1746
     *
1747
     * @param boolean $softThreshold The soft threshold.
1748
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1749
     */
1750
    public function setSoftThreshold($softThreshold) {
1751
        $this->softThreshold = $softThreshold;
1752
        return $this;
1753
    }
1754
1755
    /**
1756
     * Set the states.
1757
     *
1758
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsStates $states The states.
1759
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1760
     */
1761
    public function setStates(\WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Waterfall\HighchartsStates $states = null) {
1762
        $this->states = $states;
1763
        return $this;
1764
    }
1765
1766
    /**
1767
     * Set the sticky tracking.
1768
     *
1769
     * @param boolean $stickyTracking The sticky tracking.
1770
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1771
     */
1772
    public function setStickyTracking($stickyTracking) {
1773
        $this->stickyTracking = $stickyTracking;
1774
        return $this;
1775
    }
1776
1777
    /**
1778
     * Set the threshold.
1779
     *
1780
     * @param integer $threshold The threshold.
1781
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1782
     */
1783
    public function setThreshold($threshold) {
1784
        $this->threshold = $threshold;
1785
        return $this;
1786
    }
1787
1788
    /**
1789
     * Set the tooltip.
1790
     *
1791
     * @param array $tooltip The tooltip.
1792
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1793
     */
1794
    public function setTooltip(array $tooltip = null) {
1795
        $this->tooltip = $tooltip;
0 ignored issues
show
Documentation Bug introduced by
It seems like $tooltip can be null. However, the property $tooltip is declared as array. Maybe change the type of the property to array|null or add a type check?

Our type inference engine has found an assignment of a scalar value (like a string, an integer or null) to a property which is an array.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.

To type hint that a parameter can be either an array or null, you can set a type hint of array and a default value of null. The PHP interpreter will then accept both an array or null for that parameter.

function aContainsB(array $needle = null, array  $haystack) {
    if (!$needle) {
        return false;
    }

    return array_intersect($haystack, $needle) == $haystack;
}

The function can be called with either null or an array for the parameter $needle but will only accept an array as $haystack.

Loading history...
1796
        return $this;
1797
    }
1798
1799
    /**
1800
     * Set the up color.
1801
     *
1802
     * @param string $upColor The up color.
1803
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1804
     */
1805
    public function setUpColor($upColor) {
1806
        $this->upColor = $upColor;
1807
        return $this;
1808
    }
1809
1810
    /**
1811
     * Set the visible.
1812
     *
1813
     * @param boolean $visible The visible.
1814
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1815
     */
1816
    public function setVisible($visible) {
1817
        $this->visible = $visible;
1818
        return $this;
1819
    }
1820
1821
    /**
1822
     * Set the zone axis.
1823
     *
1824
     * @param string $zoneAxis The zone axis.
1825
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1826
     */
1827
    public function setZoneAxis($zoneAxis) {
1828
        $this->zoneAxis = $zoneAxis;
1829
        return $this;
1830
    }
1831
1832
    /**
1833
     * Set the zones.
1834
     *
1835
     * @param array $zones The zones.
1836
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsWaterfall Returns the highcharts waterfall.
1837
     */
1838
    public function setZones(array $zones = null) {
1839
        $this->zones = $zones;
0 ignored issues
show
Documentation Bug introduced by
It seems like $zones can be null. However, the property $zones is declared as array. Maybe change the type of the property to array|null or add a type check?

Our type inference engine has found an assignment of a scalar value (like a string, an integer or null) to a property which is an array.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.

To type hint that a parameter can be either an array or null, you can set a type hint of array and a default value of null. The PHP interpreter will then accept both an array or null for that parameter.

function aContainsB(array $needle = null, array  $haystack) {
    if (!$needle) {
        return false;
    }

    return array_intersect($haystack, $needle) == $haystack;
}

The function can be called with either null or an array for the parameter $needle but will only accept an array as $haystack.

Loading history...
1840
        return $this;
1841
    }
1842
1843
    /**
1844
     * Convert into an array representing this instance.
1845
     *
1846
     * @return array Returns an array representing this instance.
1847
     */
1848
    public function toArray() {
1849
1850
        // Initialize the output.
1851
        $output = [];
1852
1853
        // Set the allow point select.
1854
        ArrayUtility::set($output, "allowPointSelect", $this->allowPointSelect, [null]);
1855
1856
        // Set the animation.
1857
        ArrayUtility::set($output, "animation", $this->animation, [null]);
1858
1859
        // Set the animation limit.
1860
        ArrayUtility::set($output, "animationLimit", $this->animationLimit, [null]);
1861
1862
        // Set the border color.
1863
        ArrayUtility::set($output, "borderColor", $this->borderColor, [null]);
1864
1865
        // Set the border radius.
1866
        ArrayUtility::set($output, "borderRadius", $this->borderRadius, [null]);
1867
1868
        // Set the border width.
1869
        ArrayUtility::set($output, "borderWidth", $this->borderWidth, [null]);
1870
1871
        // Set the class name.
1872
        ArrayUtility::set($output, "className", $this->className, [null]);
1873
1874
        // Set the color.
1875
        ArrayUtility::set($output, "color", $this->color, [null]);
1876
1877
        // Set the color by point.
1878
        ArrayUtility::set($output, "colorByPoint", $this->colorByPoint, [null]);
1879
1880
        // Set the color index.
1881
        ArrayUtility::set($output, "colorIndex", $this->colorIndex, [null]);
1882
1883
        // Set the colors.
1884
        ArrayUtility::set($output, "colors", $this->colors, [null]);
1885
1886
        // Set the crisp.
1887
        ArrayUtility::set($output, "crisp", $this->crisp, [null]);
1888
1889
        // Set the cursor.
1890
        ArrayUtility::set($output, "cursor", $this->cursor, [null]);
1891
1892
        // Set the dash style.
1893
        ArrayUtility::set($output, "dashStyle", $this->dashStyle, [null]);
1894
1895
        // Set the data labels.
1896
        if (null !== $this->dataLabels) {
1897
            ArrayUtility::set($output, "dataLabels", $this->dataLabels->toArray(), []);
1898
        }
1899
1900
        // Set the depth.
1901
        ArrayUtility::set($output, "depth", $this->depth, [null]);
1902
1903
        // Set the description.
1904
        ArrayUtility::set($output, "description", $this->description, [null]);
1905
1906
        // Set the edge color.
1907
        ArrayUtility::set($output, "edgeColor", $this->edgeColor, [null]);
1908
1909
        // Set the edge width.
1910
        ArrayUtility::set($output, "edgeWidth", $this->edgeWidth, [null]);
1911
1912
        // Set the enable mouse tracking.
1913
        ArrayUtility::set($output, "enableMouseTracking", $this->enableMouseTracking, [null]);
1914
1915
        // Set the events.
1916
        if (null !== $this->events) {
1917
            ArrayUtility::set($output, "events", $this->events->toArray(), []);
1918
        }
1919
1920
        // Set the expose element to a11y.
1921
        ArrayUtility::set($output, "exposeElementToA11y", $this->exposeElementToA11y, [null]);
1922
1923
        // Set the find nearest point by.
1924
        ArrayUtility::set($output, "findNearestPointBy", $this->findNearestPointBy, [null]);
1925
1926
        // Set the get extremes from all.
1927
        ArrayUtility::set($output, "getExtremesFromAll", $this->getExtremesFromAll, [null]);
1928
1929
        // Set the group padding.
1930
        ArrayUtility::set($output, "groupPadding", $this->groupPadding, [null]);
1931
1932
        // Set the group z padding.
1933
        ArrayUtility::set($output, "groupZPadding", $this->groupZPadding, [null]);
1934
1935
        // Set the grouping.
1936
        ArrayUtility::set($output, "grouping", $this->grouping, [null]);
1937
1938
        // Set the keys.
1939
        ArrayUtility::set($output, "keys", $this->keys, [null]);
1940
1941
        // Set the line color.
1942
        ArrayUtility::set($output, "lineColor", $this->lineColor, [null]);
1943
1944
        // Set the line width.
1945
        ArrayUtility::set($output, "lineWidth", $this->lineWidth, [null]);
1946
1947
        // Set the linked to.
1948
        ArrayUtility::set($output, "linkedTo", $this->linkedTo, [null]);
1949
1950
        // Set the max point width.
1951
        ArrayUtility::set($output, "maxPointWidth", $this->maxPointWidth, [null]);
1952
1953
        // Set the min point length.
1954
        ArrayUtility::set($output, "minPointLength", $this->minPointLength, [null]);
1955
1956
        // Set the point.
1957
        if (null !== $this->point) {
1958
            ArrayUtility::set($output, "point", $this->point->toArray(), []);
1959
        }
1960
1961
        // Set the point description formatter.
1962
        ArrayUtility::set($output, "pointDescriptionFormatter", $this->pointDescriptionFormatter, [null]);
1963
1964
        // Set the point interval.
1965
        ArrayUtility::set($output, "pointInterval", $this->pointInterval, [null]);
1966
1967
        // Set the point interval unit.
1968
        ArrayUtility::set($output, "pointIntervalUnit", $this->pointIntervalUnit, [null]);
1969
1970
        // Set the point padding.
1971
        ArrayUtility::set($output, "pointPadding", $this->pointPadding, [null]);
1972
1973
        // Set the point placement.
1974
        ArrayUtility::set($output, "pointPlacement", $this->pointPlacement, [null]);
1975
1976
        // Set the point range.
1977
        ArrayUtility::set($output, "pointRange", $this->pointRange, [null]);
1978
1979
        // Set the point start.
1980
        ArrayUtility::set($output, "pointStart", $this->pointStart, [null]);
1981
1982
        // Set the point width.
1983
        ArrayUtility::set($output, "pointWidth", $this->pointWidth, [null]);
1984
1985
        // Set the selected.
1986
        ArrayUtility::set($output, "selected", $this->selected, [null]);
1987
1988
        // Set the shadow.
1989
        ArrayUtility::set($output, "shadow", $this->shadow, [null]);
1990
1991
        // Set the show checkbox.
1992
        ArrayUtility::set($output, "showCheckbox", $this->showCheckbox, [null]);
1993
1994
        // Set the show in legend.
1995
        ArrayUtility::set($output, "showInLegend", $this->showInLegend, [null]);
1996
1997
        // Set the skip keyboard navigation.
1998
        ArrayUtility::set($output, "skipKeyboardNavigation", $this->skipKeyboardNavigation, [null]);
1999
2000
        // Set the soft threshold.
2001
        ArrayUtility::set($output, "softThreshold", $this->softThreshold, [null]);
2002
2003
        // Set the states.
2004
        if (null !== $this->states) {
2005
            ArrayUtility::set($output, "states", $this->states->toArray(), []);
2006
        }
2007
2008
        // Set the sticky tracking.
2009
        ArrayUtility::set($output, "stickyTracking", $this->stickyTracking, [null]);
2010
2011
        // Set the threshold.
2012
        ArrayUtility::set($output, "threshold", $this->threshold, [null]);
2013
2014
        // Set the tooltip.
2015
        ArrayUtility::set($output, "tooltip", $this->tooltip, [null]);
2016
2017
        // Set the up color.
2018
        ArrayUtility::set($output, "upColor", $this->upColor, [null]);
2019
2020
        // Set the visible.
2021
        ArrayUtility::set($output, "visible", $this->visible, [null]);
2022
2023
        // Set the zone axis.
2024
        ArrayUtility::set($output, "zoneAxis", $this->zoneAxis, [null]);
2025
2026
        // Set the zones.
2027
        ArrayUtility::set($output, "zones", $this->zones, [null]);
2028
2029
        // Return the output.
2030
        return $output;
2031
    }
2032
2033
}
2034