HighchartsHeatmap::setAnimationLimit()   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 heatmap.
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 HighchartsHeatmap 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
     */
54
    private $borderColor = "#ffffff";
55
56
    /**
57
     * Border radius.
58
     *
59
     * @var integer
60
     */
61
    private $borderRadius = 0;
62
63
    /**
64
     * Border width.
65
     *
66
     * @var integer
67
     */
68
    private $borderWidth = 1;
69
70
    /**
71
     * Class name.
72
     *
73
     * @var string
74
     * @since 5.0.0
75
     */
76
    private $className;
77
78
    /**
79
     * Color.
80
     *
81
     * @var string
82
     * @since 4.0
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
     * Colsize.
112
     *
113
     * @var integer
114
     * @since 4.0
115
     */
116
    private $colsize = 1;
117
118
    /**
119
     * Crisp.
120
     *
121
     * @var boolean
122
     * @since 5.0.10
123
     */
124
    private $crisp = true;
125
126
    /**
127
     * Crop threshold.
128
     *
129
     * @var integer
130
     */
131
    private $cropThreshold = 50;
132
133
    /**
134
     * Cursor.
135
     *
136
     * @var string
137
     */
138
    private $cursor;
139
140
    /**
141
     * Data labels.
142
     *
143
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsDataLabels
144
     */
145
    private $dataLabels;
146
147
    /**
148
     * Description.
149
     *
150
     * @var string
151
     * @since 5.0.0
152
     */
153
    private $description;
154
155
    /**
156
     * Enable mouse tracking.
157
     *
158
     * @var boolean
159
     */
160
    private $enableMouseTracking = true;
161
162
    /**
163
     * Events.
164
     *
165
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsEvents
166
     */
167
    private $events;
168
169
    /**
170
     * Expose element to a11y.
171
     *
172
     * @var boolean
173
     * @since 5.0.12
174
     */
175
    private $exposeElementToA11y;
176
177
    /**
178
     * Find nearest point by.
179
     *
180
     * @var string
181
     * @since 5.0.10
182
     */
183
    private $findNearestPointBy;
184
185
    /**
186
     * Get extremes from all.
187
     *
188
     * @var boolean
189
     * @since 4.1.6
190
     */
191
    private $getExtremesFromAll = false;
192
193
    /**
194
     * Keys.
195
     *
196
     * @var array
197
     * @since 4.1.6
198
     */
199
    private $keys;
200
201
    /**
202
     * Linked to.
203
     *
204
     * @var string
205
     * @since 3.0
206
     */
207
    private $linkedTo;
208
209
    /**
210
     * Max point width.
211
     *
212
     * @var integer
213
     * @since 4.1.8
214
     */
215
    private $maxPointWidth;
216
217
    /**
218
     * Point.
219
     *
220
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsPoint
221
     */
222
    private $point;
223
224
    /**
225
     * Point description formatter.
226
     *
227
     * @var string
228
     * @since 5.0.12
229
     */
230
    private $pointDescriptionFormatter;
231
232
    /**
233
     * Rowsize.
234
     *
235
     * @var integer
236
     * @since 4.0
237
     */
238
    private $rowsize = 1;
239
240
    /**
241
     * Selected.
242
     *
243
     * @var boolean
244
     * @since 1.2.0
245
     */
246
    private $selected = false;
247
248
    /**
249
     * Shadow.
250
     *
251
     * @var boolean|array
252
     */
253
    private $shadow = false;
254
255
    /**
256
     * Show checkbox.
257
     *
258
     * @var boolean
259
     * @since 1.2.0
260
     */
261
    private $showCheckbox = false;
262
263
    /**
264
     * Show in legend.
265
     *
266
     * @var boolean
267
     */
268
    private $showInLegend = true;
269
270
    /**
271
     * Skip keyboard navigation.
272
     *
273
     * @var boolean
274
     * @since 5.0.12
275
     */
276
    private $skipKeyboardNavigation;
277
278
    /**
279
     * States.
280
     *
281
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsStates
282
     */
283
    private $states;
284
285
    /**
286
     * Sticky tracking.
287
     *
288
     * @var boolean
289
     * @since 2.0
290
     */
291
    private $stickyTracking = true;
292
293
    /**
294
     * Tooltip.
295
     *
296
     * @var array
297
     * @since 2.3
298
     */
299
    private $tooltip;
300
301
    /**
302
     * Turbo threshold.
303
     *
304
     * @var integer
305
     * @since 2.2
306
     */
307
    private $turboThreshold = 1000;
308
309
    /**
310
     * Visible.
311
     *
312
     * @var boolean
313
     */
314
    private $visible = true;
315
316
    /**
317
     * Zone axis.
318
     *
319
     * @var string
320
     * @since 4.1.0
321
     */
322
    private $zoneAxis = "y";
323
324
    /**
325
     * Zones.
326
     *
327
     * @var array
328
     * @since 4.1.0
329
     */
330
    private $zones;
331
332
    /**
333
     * Constructor.
334
     *
335
     * @param boolean $ignoreDefaultValues Ignore the default values.
336
     */
337
    public function __construct($ignoreDefaultValues = true) {
338
        if (true === $ignoreDefaultValues) {
339
            $this->clear();
340
        }
341
    }
342
343
    /**
344
     * Clear.
345
     *
346
     * @return void
347
     */
348
    public function clear() {
349
350
        // Clear the allow point select.
351
        $this->allowPointSelect = null;
352
353
        // Clear the animation.
354
        $this->animation = null;
355
356
        // Clear the animation limit.
357
        $this->animationLimit = null;
358
359
        // Clear the border color.
360
        $this->borderColor = null;
361
362
        // Clear the border radius.
363
        $this->borderRadius = null;
364
365
        // Clear the border width.
366
        $this->borderWidth = null;
367
368
        // Clear the class name.
369
        $this->className = null;
370
371
        // Clear the color.
372
        $this->color = null;
373
374
        // Clear the color by point.
375
        $this->colorByPoint = null;
376
377
        // Clear the color index.
378
        $this->colorIndex = null;
379
380
        // Clear the colors.
381
        $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...
382
383
        // Clear the colsize.
384
        $this->colsize = null;
385
386
        // Clear the crisp.
387
        $this->crisp = null;
388
389
        // Clear the crop threshold.
390
        $this->cropThreshold = null;
391
392
        // Clear the cursor.
393
        $this->cursor = null;
394
395
        // Clear the data labels.
396
        if (null !== $this->dataLabels) {
397
            $this->dataLabels->clear();
398
        }
399
400
        // Clear the description.
401
        $this->description = null;
402
403
        // Clear the enable mouse tracking.
404
        $this->enableMouseTracking = null;
405
406
        // Clear the events.
407
        if (null !== $this->events) {
408
            $this->events->clear();
409
        }
410
411
        // Clear the expose element to a11y.
412
        $this->exposeElementToA11y = null;
413
414
        // Clear the find nearest point by.
415
        $this->findNearestPointBy = null;
416
417
        // Clear the get extremes from all.
418
        $this->getExtremesFromAll = null;
419
420
        // Clear the keys.
421
        $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...
422
423
        // Clear the linked to.
424
        $this->linkedTo = null;
425
426
        // Clear the max point width.
427
        $this->maxPointWidth = null;
428
429
        // Clear the point.
430
        if (null !== $this->point) {
431
            $this->point->clear();
432
        }
433
434
        // Clear the point description formatter.
435
        $this->pointDescriptionFormatter = null;
436
437
        // Clear the rowsize.
438
        $this->rowsize = null;
439
440
        // Clear the selected.
441
        $this->selected = null;
442
443
        // Clear the shadow.
444
        $this->shadow = null;
445
446
        // Clear the show checkbox.
447
        $this->showCheckbox = null;
448
449
        // Clear the show in legend.
450
        $this->showInLegend = null;
451
452
        // Clear the skip keyboard navigation.
453
        $this->skipKeyboardNavigation = null;
454
455
        // Clear the states.
456
        if (null !== $this->states) {
457
            $this->states->clear();
458
        }
459
460
        // Clear the sticky tracking.
461
        $this->stickyTracking = null;
462
463
        // Clear the tooltip.
464
        $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...
465
466
        // Clear the turbo threshold.
467
        $this->turboThreshold = null;
468
469
        // Clear the visible.
470
        $this->visible = null;
471
472
        // Clear the zone axis.
473
        $this->zoneAxis = null;
474
475
        // Clear the zones.
476
        $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...
477
    }
478
479
    /**
480
     * Get the allow point select.
481
     *
482
     * @return boolean Returns the allow point select.
483
     */
484
    public function getAllowPointSelect() {
485
        return $this->allowPointSelect;
486
    }
487
488
    /**
489
     * Get the animation.
490
     *
491
     * @return boolean Returns the animation.
492
     */
493
    public function getAnimation() {
494
        return $this->animation;
495
    }
496
497
    /**
498
     * Get the animation limit.
499
     *
500
     * @return integer Returns the animation limit.
501
     */
502
    public function getAnimationLimit() {
503
        return $this->animationLimit;
504
    }
505
506
    /**
507
     * Get the border color.
508
     *
509
     * @return string Returns the border color.
510
     */
511
    public function getBorderColor() {
512
        return $this->borderColor;
513
    }
514
515
    /**
516
     * Get the border radius.
517
     *
518
     * @return integer Returns the border radius.
519
     */
520
    public function getBorderRadius() {
521
        return $this->borderRadius;
522
    }
523
524
    /**
525
     * Get the border width.
526
     *
527
     * @return integer Returns the border width.
528
     */
529
    public function getBorderWidth() {
530
        return $this->borderWidth;
531
    }
532
533
    /**
534
     * Get the class name.
535
     *
536
     * @return string Returns the class name.
537
     */
538
    public function getClassName() {
539
        return $this->className;
540
    }
541
542
    /**
543
     * Get the color.
544
     *
545
     * @return string Returns the color.
546
     */
547
    public function getColor() {
548
        return $this->color;
549
    }
550
551
    /**
552
     * Get the color by point.
553
     *
554
     * @return boolean Returns the color by point.
555
     */
556
    public function getColorByPoint() {
557
        return $this->colorByPoint;
558
    }
559
560
    /**
561
     * Get the color index.
562
     *
563
     * @return integer Returns the color index.
564
     */
565
    public function getColorIndex() {
566
        return $this->colorIndex;
567
    }
568
569
    /**
570
     * Get the colors.
571
     *
572
     * @return array Returns the colors.
573
     */
574
    public function getColors() {
575
        return $this->colors;
576
    }
577
578
    /**
579
     * Get the colsize.
580
     *
581
     * @return integer Returns the colsize.
582
     */
583
    public function getColsize() {
584
        return $this->colsize;
585
    }
586
587
    /**
588
     * Get the crisp.
589
     *
590
     * @return boolean Returns the crisp.
591
     */
592
    public function getCrisp() {
593
        return $this->crisp;
594
    }
595
596
    /**
597
     * Get the crop threshold.
598
     *
599
     * @return integer Returns the crop threshold.
600
     */
601
    public function getCropThreshold() {
602
        return $this->cropThreshold;
603
    }
604
605
    /**
606
     * Get the cursor.
607
     *
608
     * @return string Returns the cursor.
609
     */
610
    public function getCursor() {
611
        return $this->cursor;
612
    }
613
614
    /**
615
     * Get the data labels.
616
     *
617
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsDataLabels Returns the data labels.
618
     */
619
    public function getDataLabels() {
620
        return $this->dataLabels;
621
    }
622
623
    /**
624
     * Get the description.
625
     *
626
     * @return string Returns the description.
627
     */
628
    public function getDescription() {
629
        return $this->description;
630
    }
631
632
    /**
633
     * Get the enable mouse tracking.
634
     *
635
     * @return boolean Returns the enable mouse tracking.
636
     */
637
    public function getEnableMouseTracking() {
638
        return $this->enableMouseTracking;
639
    }
640
641
    /**
642
     * Get the events.
643
     *
644
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsEvents Returns the events.
645
     */
646
    public function getEvents() {
647
        return $this->events;
648
    }
649
650
    /**
651
     * Get the expose element to a11y.
652
     *
653
     * @return boolean Returns the expose element to a11y.
654
     */
655
    public function getExposeElementToA11y() {
656
        return $this->exposeElementToA11y;
657
    }
658
659
    /**
660
     * Get the find nearest point by.
661
     *
662
     * @return string Returns the find nearest point by.
663
     */
664
    public function getFindNearestPointBy() {
665
        return $this->findNearestPointBy;
666
    }
667
668
    /**
669
     * Get the get extremes from all.
670
     *
671
     * @return boolean Returns the get extremes from all.
672
     */
673
    public function getGetExtremesFromAll() {
674
        return $this->getExtremesFromAll;
675
    }
676
677
    /**
678
     * Get the keys.
679
     *
680
     * @return array Returns the keys.
681
     */
682
    public function getKeys() {
683
        return $this->keys;
684
    }
685
686
    /**
687
     * Get the linked to.
688
     *
689
     * @return string Returns the linked to.
690
     */
691
    public function getLinkedTo() {
692
        return $this->linkedTo;
693
    }
694
695
    /**
696
     * Get the max point width.
697
     *
698
     * @return integer Returns the max point width.
699
     */
700
    public function getMaxPointWidth() {
701
        return $this->maxPointWidth;
702
    }
703
704
    /**
705
     * Get the point.
706
     *
707
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsPoint Returns the point.
708
     */
709
    public function getPoint() {
710
        return $this->point;
711
    }
712
713
    /**
714
     * Get the point description formatter.
715
     *
716
     * @return string Returns the point description formatter.
717
     */
718
    public function getPointDescriptionFormatter() {
719
        return $this->pointDescriptionFormatter;
720
    }
721
722
    /**
723
     * Get the rowsize.
724
     *
725
     * @return integer Returns the rowsize.
726
     */
727
    public function getRowsize() {
728
        return $this->rowsize;
729
    }
730
731
    /**
732
     * Get the selected.
733
     *
734
     * @return boolean Returns the selected.
735
     */
736
    public function getSelected() {
737
        return $this->selected;
738
    }
739
740
    /**
741
     * Get the shadow.
742
     *
743
     * @return boolean|array Returns the shadow.
744
     */
745
    public function getShadow() {
746
        return $this->shadow;
747
    }
748
749
    /**
750
     * Get the show checkbox.
751
     *
752
     * @return boolean Returns the show checkbox.
753
     */
754
    public function getShowCheckbox() {
755
        return $this->showCheckbox;
756
    }
757
758
    /**
759
     * Get the show in legend.
760
     *
761
     * @return boolean Returns the show in legend.
762
     */
763
    public function getShowInLegend() {
764
        return $this->showInLegend;
765
    }
766
767
    /**
768
     * Get the skip keyboard navigation.
769
     *
770
     * @return boolean Returns the skip keyboard navigation.
771
     */
772
    public function getSkipKeyboardNavigation() {
773
        return $this->skipKeyboardNavigation;
774
    }
775
776
    /**
777
     * Get the states.
778
     *
779
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsStates Returns the states.
780
     */
781
    public function getStates() {
782
        return $this->states;
783
    }
784
785
    /**
786
     * Get the sticky tracking.
787
     *
788
     * @return boolean Returns the sticky tracking.
789
     */
790
    public function getStickyTracking() {
791
        return $this->stickyTracking;
792
    }
793
794
    /**
795
     * Get the tooltip.
796
     *
797
     * @return array Returns the tooltip.
798
     */
799
    public function getTooltip() {
800
        return $this->tooltip;
801
    }
802
803
    /**
804
     * Get the turbo threshold.
805
     *
806
     * @return integer Returns the turbo threshold.
807
     */
808
    public function getTurboThreshold() {
809
        return $this->turboThreshold;
810
    }
811
812
    /**
813
     * Get the visible.
814
     *
815
     * @return boolean Returns the visible.
816
     */
817
    public function getVisible() {
818
        return $this->visible;
819
    }
820
821
    /**
822
     * Get the zone axis.
823
     *
824
     * @return string Returns the zone axis.
825
     */
826
    public function getZoneAxis() {
827
        return $this->zoneAxis;
828
    }
829
830
    /**
831
     * Get the zones.
832
     *
833
     * @return array Returns the zones.
834
     */
835
    public function getZones() {
836
        return $this->zones;
837
    }
838
839
    /**
840
     * Serialize this instance.
841
     *
842
     * @return array Returns an array representing this instance.
843
     */
844
    public function jsonSerialize() {
845
        return $this->toArray();
846
    }
847
848
    /**
849
     * Create a new data labels.
850
     *
851
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsDataLabels Returns the data labels.
852
     */
853
    public function newDataLabels() {
854
        $this->dataLabels = new \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsDataLabels();
855
        return $this->dataLabels;
856
    }
857
858
    /**
859
     * Create a new events.
860
     *
861
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsEvents Returns the events.
862
     */
863
    public function newEvents() {
864
        $this->events = new \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsEvents();
865
        return $this->events;
866
    }
867
868
    /**
869
     * Create a new point.
870
     *
871
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsPoint Returns the point.
872
     */
873
    public function newPoint() {
874
        $this->point = new \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsPoint();
875
        return $this->point;
876
    }
877
878
    /**
879
     * Create a new states.
880
     *
881
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsStates Returns the states.
882
     */
883
    public function newStates() {
884
        $this->states = new \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsStates();
885
        return $this->states;
886
    }
887
888
    /**
889
     * Set the allow point select.
890
     *
891
     * @param boolean $allowPointSelect The allow point select.
892
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
893
     */
894
    public function setAllowPointSelect($allowPointSelect) {
895
        $this->allowPointSelect = $allowPointSelect;
896
        return $this;
897
    }
898
899
    /**
900
     * Set the animation.
901
     *
902
     * @param boolean $animation The animation.
903
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
904
     */
905
    public function setAnimation($animation) {
906
        $this->animation = $animation;
907
        return $this;
908
    }
909
910
    /**
911
     * Set the animation limit.
912
     *
913
     * @param integer $animationLimit The animation limit.
914
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
915
     */
916
    public function setAnimationLimit($animationLimit) {
917
        $this->animationLimit = $animationLimit;
918
        return $this;
919
    }
920
921
    /**
922
     * Set the border color.
923
     *
924
     * @param string $borderColor The border color.
925
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
926
     */
927
    public function setBorderColor($borderColor) {
928
        $this->borderColor = $borderColor;
929
        return $this;
930
    }
931
932
    /**
933
     * Set the border radius.
934
     *
935
     * @param integer $borderRadius The border radius.
936
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
937
     */
938
    public function setBorderRadius($borderRadius) {
939
        $this->borderRadius = $borderRadius;
940
        return $this;
941
    }
942
943
    /**
944
     * Set the border width.
945
     *
946
     * @param integer $borderWidth The border width.
947
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
948
     */
949
    public function setBorderWidth($borderWidth) {
950
        $this->borderWidth = $borderWidth;
951
        return $this;
952
    }
953
954
    /**
955
     * Set the class name.
956
     *
957
     * @param string $className The class name.
958
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
959
     */
960
    public function setClassName($className) {
961
        $this->className = $className;
962
        return $this;
963
    }
964
965
    /**
966
     * Set the color.
967
     *
968
     * @param string $color The color.
969
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
970
     */
971
    public function setColor($color) {
972
        $this->color = $color;
973
        return $this;
974
    }
975
976
    /**
977
     * Set the color by point.
978
     *
979
     * @param boolean $colorByPoint The color by point.
980
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
981
     */
982
    public function setColorByPoint($colorByPoint) {
983
        $this->colorByPoint = $colorByPoint;
984
        return $this;
985
    }
986
987
    /**
988
     * Set the color index.
989
     *
990
     * @param integer $colorIndex The color index.
991
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
992
     */
993
    public function setColorIndex($colorIndex) {
994
        $this->colorIndex = $colorIndex;
995
        return $this;
996
    }
997
998
    /**
999
     * Set the colors.
1000
     *
1001
     * @param array $colors The colors.
1002
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1003
     */
1004
    public function setColors(array $colors = null) {
1005
        $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...
1006
        return $this;
1007
    }
1008
1009
    /**
1010
     * Set the colsize.
1011
     *
1012
     * @param integer $colsize The colsize.
1013
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1014
     */
1015
    public function setColsize($colsize) {
1016
        $this->colsize = $colsize;
1017
        return $this;
1018
    }
1019
1020
    /**
1021
     * Set the crisp.
1022
     *
1023
     * @param boolean $crisp The crisp.
1024
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1025
     */
1026
    public function setCrisp($crisp) {
1027
        $this->crisp = $crisp;
1028
        return $this;
1029
    }
1030
1031
    /**
1032
     * Set the crop threshold.
1033
     *
1034
     * @param integer $cropThreshold The crop threshold.
1035
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1036
     */
1037
    public function setCropThreshold($cropThreshold) {
1038
        $this->cropThreshold = $cropThreshold;
1039
        return $this;
1040
    }
1041
1042
    /**
1043
     * Set the cursor.
1044
     *
1045
     * @param string $cursor The cursor.
1046
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1047
     */
1048
    public function setCursor($cursor) {
1049
        switch ($cursor) {
1050
            case null:
1051
            case "crosshair":
1052
            case "default":
1053
            case "help":
1054
            case "none":
1055
            case "pointer":
1056
            $this->cursor = $cursor;
1057
            break;
1058
        }
1059
        return $this;
1060
    }
1061
1062
    /**
1063
     * Set the data labels.
1064
     *
1065
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsDataLabels $dataLabels The data labels.
1066
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1067
     */
1068
    public function setDataLabels(\WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsDataLabels $dataLabels = null) {
1069
        $this->dataLabels = $dataLabels;
1070
        return $this;
1071
    }
1072
1073
    /**
1074
     * Set the description.
1075
     *
1076
     * @param string $description The description.
1077
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1078
     */
1079
    public function setDescription($description) {
1080
        $this->description = $description;
1081
        return $this;
1082
    }
1083
1084
    /**
1085
     * Set the enable mouse tracking.
1086
     *
1087
     * @param boolean $enableMouseTracking The enable mouse tracking.
1088
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1089
     */
1090
    public function setEnableMouseTracking($enableMouseTracking) {
1091
        $this->enableMouseTracking = $enableMouseTracking;
1092
        return $this;
1093
    }
1094
1095
    /**
1096
     * Set the events.
1097
     *
1098
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsEvents $events The events.
1099
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1100
     */
1101
    public function setEvents(\WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsEvents $events = null) {
1102
        $this->events = $events;
1103
        return $this;
1104
    }
1105
1106
    /**
1107
     * Set the expose element to a11y.
1108
     *
1109
     * @param boolean $exposeElementToA11y The expose element to a11y.
1110
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1111
     */
1112
    public function setExposeElementToA11y($exposeElementToA11y) {
1113
        $this->exposeElementToA11y = $exposeElementToA11y;
1114
        return $this;
1115
    }
1116
1117
    /**
1118
     * Set the find nearest point by.
1119
     *
1120
     * @param string $findNearestPointBy The find nearest point by.
1121
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1122
     */
1123
    public function setFindNearestPointBy($findNearestPointBy) {
1124
        switch ($findNearestPointBy) {
1125
            case "x":
1126
            case "xy":
1127
            $this->findNearestPointBy = $findNearestPointBy;
1128
            break;
1129
        }
1130
        return $this;
1131
    }
1132
1133
    /**
1134
     * Set the get extremes from all.
1135
     *
1136
     * @param boolean $getExtremesFromAll The get extremes from all.
1137
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1138
     */
1139
    public function setGetExtremesFromAll($getExtremesFromAll) {
1140
        $this->getExtremesFromAll = $getExtremesFromAll;
1141
        return $this;
1142
    }
1143
1144
    /**
1145
     * Set the keys.
1146
     *
1147
     * @param array $keys The keys.
1148
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1149
     */
1150
    public function setKeys(array $keys = null) {
1151
        $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...
1152
        return $this;
1153
    }
1154
1155
    /**
1156
     * Set the linked to.
1157
     *
1158
     * @param string $linkedTo The linked to.
1159
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1160
     */
1161
    public function setLinkedTo($linkedTo) {
1162
        $this->linkedTo = $linkedTo;
1163
        return $this;
1164
    }
1165
1166
    /**
1167
     * Set the max point width.
1168
     *
1169
     * @param integer $maxPointWidth The max point width.
1170
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1171
     */
1172
    public function setMaxPointWidth($maxPointWidth) {
1173
        $this->maxPointWidth = $maxPointWidth;
1174
        return $this;
1175
    }
1176
1177
    /**
1178
     * Set the point.
1179
     *
1180
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsPoint $point The point.
1181
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1182
     */
1183
    public function setPoint(\WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsPoint $point = null) {
1184
        $this->point = $point;
1185
        return $this;
1186
    }
1187
1188
    /**
1189
     * Set the point description formatter.
1190
     *
1191
     * @param string $pointDescriptionFormatter The point description formatter.
1192
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1193
     */
1194
    public function setPointDescriptionFormatter($pointDescriptionFormatter) {
1195
        $this->pointDescriptionFormatter = $pointDescriptionFormatter;
1196
        return $this;
1197
    }
1198
1199
    /**
1200
     * Set the rowsize.
1201
     *
1202
     * @param integer $rowsize The rowsize.
1203
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1204
     */
1205
    public function setRowsize($rowsize) {
1206
        $this->rowsize = $rowsize;
1207
        return $this;
1208
    }
1209
1210
    /**
1211
     * Set the selected.
1212
     *
1213
     * @param boolean $selected The selected.
1214
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1215
     */
1216
    public function setSelected($selected) {
1217
        $this->selected = $selected;
1218
        return $this;
1219
    }
1220
1221
    /**
1222
     * Set the shadow.
1223
     *
1224
     * @param boolean|array $shadow The shadow.
1225
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1226
     */
1227
    public function setShadow($shadow) {
1228
        $this->shadow = $shadow;
1229
        return $this;
1230
    }
1231
1232
    /**
1233
     * Set the show checkbox.
1234
     *
1235
     * @param boolean $showCheckbox The show checkbox.
1236
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1237
     */
1238
    public function setShowCheckbox($showCheckbox) {
1239
        $this->showCheckbox = $showCheckbox;
1240
        return $this;
1241
    }
1242
1243
    /**
1244
     * Set the show in legend.
1245
     *
1246
     * @param boolean $showInLegend The show in legend.
1247
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1248
     */
1249
    public function setShowInLegend($showInLegend) {
1250
        $this->showInLegend = $showInLegend;
1251
        return $this;
1252
    }
1253
1254
    /**
1255
     * Set the skip keyboard navigation.
1256
     *
1257
     * @param boolean $skipKeyboardNavigation The skip keyboard navigation.
1258
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1259
     */
1260
    public function setSkipKeyboardNavigation($skipKeyboardNavigation) {
1261
        $this->skipKeyboardNavigation = $skipKeyboardNavigation;
1262
        return $this;
1263
    }
1264
1265
    /**
1266
     * Set the states.
1267
     *
1268
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsStates $states The states.
1269
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1270
     */
1271
    public function setStates(\WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\Heatmap\HighchartsStates $states = null) {
1272
        $this->states = $states;
1273
        return $this;
1274
    }
1275
1276
    /**
1277
     * Set the sticky tracking.
1278
     *
1279
     * @param boolean $stickyTracking The sticky tracking.
1280
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1281
     */
1282
    public function setStickyTracking($stickyTracking) {
1283
        $this->stickyTracking = $stickyTracking;
1284
        return $this;
1285
    }
1286
1287
    /**
1288
     * Set the tooltip.
1289
     *
1290
     * @param array $tooltip The tooltip.
1291
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1292
     */
1293
    public function setTooltip(array $tooltip = null) {
1294
        $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...
1295
        return $this;
1296
    }
1297
1298
    /**
1299
     * Set the turbo threshold.
1300
     *
1301
     * @param integer $turboThreshold The turbo threshold.
1302
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1303
     */
1304
    public function setTurboThreshold($turboThreshold) {
1305
        $this->turboThreshold = $turboThreshold;
1306
        return $this;
1307
    }
1308
1309
    /**
1310
     * Set the visible.
1311
     *
1312
     * @param boolean $visible The visible.
1313
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1314
     */
1315
    public function setVisible($visible) {
1316
        $this->visible = $visible;
1317
        return $this;
1318
    }
1319
1320
    /**
1321
     * Set the zone axis.
1322
     *
1323
     * @param string $zoneAxis The zone axis.
1324
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1325
     */
1326
    public function setZoneAxis($zoneAxis) {
1327
        $this->zoneAxis = $zoneAxis;
1328
        return $this;
1329
    }
1330
1331
    /**
1332
     * Set the zones.
1333
     *
1334
     * @param array $zones The zones.
1335
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\PlotOptions\HighchartsHeatmap Returns the highcharts heatmap.
1336
     */
1337
    public function setZones(array $zones = null) {
1338
        $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...
1339
        return $this;
1340
    }
1341
1342
    /**
1343
     * Convert into an array representing this instance.
1344
     *
1345
     * @return array Returns an array representing this instance.
1346
     */
1347
    public function toArray() {
1348
1349
        // Initialize the output.
1350
        $output = [];
1351
1352
        // Set the allow point select.
1353
        ArrayUtility::set($output, "allowPointSelect", $this->allowPointSelect, [null]);
1354
1355
        // Set the animation.
1356
        ArrayUtility::set($output, "animation", $this->animation, [null]);
1357
1358
        // Set the animation limit.
1359
        ArrayUtility::set($output, "animationLimit", $this->animationLimit, [null]);
1360
1361
        // Set the border color.
1362
        ArrayUtility::set($output, "borderColor", $this->borderColor, [null]);
1363
1364
        // Set the border radius.
1365
        ArrayUtility::set($output, "borderRadius", $this->borderRadius, [null]);
1366
1367
        // Set the border width.
1368
        ArrayUtility::set($output, "borderWidth", $this->borderWidth, [null]);
1369
1370
        // Set the class name.
1371
        ArrayUtility::set($output, "className", $this->className, [null]);
1372
1373
        // Set the color.
1374
        ArrayUtility::set($output, "color", $this->color, [null]);
1375
1376
        // Set the color by point.
1377
        ArrayUtility::set($output, "colorByPoint", $this->colorByPoint, [null]);
1378
1379
        // Set the color index.
1380
        ArrayUtility::set($output, "colorIndex", $this->colorIndex, [null]);
1381
1382
        // Set the colors.
1383
        ArrayUtility::set($output, "colors", $this->colors, [null]);
1384
1385
        // Set the colsize.
1386
        ArrayUtility::set($output, "colsize", $this->colsize, [null]);
1387
1388
        // Set the crisp.
1389
        ArrayUtility::set($output, "crisp", $this->crisp, [null]);
1390
1391
        // Set the crop threshold.
1392
        ArrayUtility::set($output, "cropThreshold", $this->cropThreshold, [null]);
1393
1394
        // Set the cursor.
1395
        ArrayUtility::set($output, "cursor", $this->cursor, [null]);
1396
1397
        // Set the data labels.
1398
        if (null !== $this->dataLabels) {
1399
            ArrayUtility::set($output, "dataLabels", $this->dataLabels->toArray(), []);
1400
        }
1401
1402
        // Set the description.
1403
        ArrayUtility::set($output, "description", $this->description, [null]);
1404
1405
        // Set the enable mouse tracking.
1406
        ArrayUtility::set($output, "enableMouseTracking", $this->enableMouseTracking, [null]);
1407
1408
        // Set the events.
1409
        if (null !== $this->events) {
1410
            ArrayUtility::set($output, "events", $this->events->toArray(), []);
1411
        }
1412
1413
        // Set the expose element to a11y.
1414
        ArrayUtility::set($output, "exposeElementToA11y", $this->exposeElementToA11y, [null]);
1415
1416
        // Set the find nearest point by.
1417
        ArrayUtility::set($output, "findNearestPointBy", $this->findNearestPointBy, [null]);
1418
1419
        // Set the get extremes from all.
1420
        ArrayUtility::set($output, "getExtremesFromAll", $this->getExtremesFromAll, [null]);
1421
1422
        // Set the keys.
1423
        ArrayUtility::set($output, "keys", $this->keys, [null]);
1424
1425
        // Set the linked to.
1426
        ArrayUtility::set($output, "linkedTo", $this->linkedTo, [null]);
1427
1428
        // Set the max point width.
1429
        ArrayUtility::set($output, "maxPointWidth", $this->maxPointWidth, [null]);
1430
1431
        // Set the point.
1432
        if (null !== $this->point) {
1433
            ArrayUtility::set($output, "point", $this->point->toArray(), []);
1434
        }
1435
1436
        // Set the point description formatter.
1437
        ArrayUtility::set($output, "pointDescriptionFormatter", $this->pointDescriptionFormatter, [null]);
1438
1439
        // Set the rowsize.
1440
        ArrayUtility::set($output, "rowsize", $this->rowsize, [null]);
1441
1442
        // Set the selected.
1443
        ArrayUtility::set($output, "selected", $this->selected, [null]);
1444
1445
        // Set the shadow.
1446
        ArrayUtility::set($output, "shadow", $this->shadow, [null]);
1447
1448
        // Set the show checkbox.
1449
        ArrayUtility::set($output, "showCheckbox", $this->showCheckbox, [null]);
1450
1451
        // Set the show in legend.
1452
        ArrayUtility::set($output, "showInLegend", $this->showInLegend, [null]);
1453
1454
        // Set the skip keyboard navigation.
1455
        ArrayUtility::set($output, "skipKeyboardNavigation", $this->skipKeyboardNavigation, [null]);
1456
1457
        // Set the states.
1458
        if (null !== $this->states) {
1459
            ArrayUtility::set($output, "states", $this->states->toArray(), []);
1460
        }
1461
1462
        // Set the sticky tracking.
1463
        ArrayUtility::set($output, "stickyTracking", $this->stickyTracking, [null]);
1464
1465
        // Set the tooltip.
1466
        ArrayUtility::set($output, "tooltip", $this->tooltip, [null]);
1467
1468
        // Set the turbo threshold.
1469
        ArrayUtility::set($output, "turboThreshold", $this->turboThreshold, [null]);
1470
1471
        // Set the visible.
1472
        ArrayUtility::set($output, "visible", $this->visible, [null]);
1473
1474
        // Set the zone axis.
1475
        ArrayUtility::set($output, "zoneAxis", $this->zoneAxis, [null]);
1476
1477
        // Set the zones.
1478
        ArrayUtility::set($output, "zones", $this->zones, [null]);
1479
1480
        // Return the output.
1481
        return $output;
1482
    }
1483
1484
}
1485