HighchartsGauge::setShowInLegend()   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\Series;
13
14
use JsonSerializable;
15
use WBW\Library\Core\Utility\Argument\ArrayUtility;
16
17
/**
18
 * Highcharts gauge.
19
 *
20
 * @author webeweb <https://github.com/webeweb/>
21
 * @package WBW\Bundle\HighchartsBundle\API\Chart\Series
22
 * @version 5.0.14
23
 * @final
24
 */
25
final class HighchartsGauge implements JsonSerializable {
26
27
    /**
28
     * Animation.
29
     *
30
     * @var boolean
31
     */
32
    private $animation = true;
33
34
    /**
35
     * Animation limit.
36
     *
37
     * @var integer
38
     */
39
    private $animationLimit;
40
41
    /**
42
     * Class name.
43
     *
44
     * @var string
45
     * @since 5.0.0
46
     */
47
    private $className;
48
49
    /**
50
     * Color.
51
     *
52
     * @var string
53
     */
54
    private $color;
55
56
    /**
57
     * Color index.
58
     *
59
     * @var integer
60
     * @since 5.0.0
61
     */
62
    private $colorIndex;
63
64
    /**
65
     * Cursor.
66
     *
67
     * @var string
68
     */
69
    private $cursor;
70
71
    /**
72
     * Data.
73
     *
74
     * @var array
75
     */
76
    private $data;
77
78
    /**
79
     * Data labels.
80
     *
81
     * @var array
82
     * @since 2.3.0
83
     */
84
    private $dataLabels;
85
86
    /**
87
     * Description.
88
     *
89
     * @var string
90
     * @since 5.0.0
91
     */
92
    private $description;
93
94
    /**
95
     * Dial.
96
     *
97
     * @var array
98
     * @since 2.3.0
99
     */
100
    private $dial;
101
102
    /**
103
     * Enable mouse tracking.
104
     *
105
     * @var boolean
106
     */
107
    private $enableMouseTracking = true;
108
109
    /**
110
     * Events.
111
     *
112
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\Series\Gauge\HighchartsEvents
113
     */
114
    private $events;
115
116
    /**
117
     * Expose element to a11y.
118
     *
119
     * @var boolean
120
     * @since 5.0.12
121
     */
122
    private $exposeElementToA11y;
123
124
    /**
125
     * Find nearest point by.
126
     *
127
     * @var string
128
     * @since 5.0.10
129
     */
130
    private $findNearestPointBy;
131
132
    /**
133
     * Get extremes from all.
134
     *
135
     * @var boolean
136
     * @since 4.1.6
137
     */
138
    private $getExtremesFromAll = false;
139
140
    /**
141
     * Id.
142
     *
143
     * @var string
144
     * @since 1.2.0
145
     */
146
    private $id;
147
148
    /**
149
     * Index.
150
     *
151
     * @var integer
152
     * @since 2.3.0
153
     */
154
    private $index;
155
156
    /**
157
     * Keys.
158
     *
159
     * @var array
160
     * @since 4.1.6
161
     */
162
    private $keys;
163
164
    /**
165
     * Legend index.
166
     *
167
     * @var integer
168
     */
169
    private $legendIndex;
170
171
    /**
172
     * Linked to.
173
     *
174
     * @var string
175
     * @since 3.0
176
     */
177
    private $linkedTo;
178
179
    /**
180
     * Name.
181
     *
182
     * @var string
183
     */
184
    private $name;
185
186
    /**
187
     * Negative color.
188
     *
189
     * @var string
190
     * @since 3.0
191
     */
192
    private $negativeColor;
193
194
    /**
195
     * Overshoot.
196
     *
197
     * @var integer
198
     * @since 3.0.10
199
     */
200
    private $overshoot = 0;
201
202
    /**
203
     * Pivot.
204
     *
205
     * @var array
206
     * @since 2.3.0
207
     */
208
    private $pivot;
209
210
    /**
211
     * Point.
212
     *
213
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\Series\Gauge\HighchartsPoint
214
     */
215
    private $point;
216
217
    /**
218
     * Point description formatter.
219
     *
220
     * @var string
221
     * @since 5.0.12
222
     */
223
    private $pointDescriptionFormatter;
224
225
    /**
226
     * Selected.
227
     *
228
     * @var boolean
229
     * @since 1.2.0
230
     */
231
    private $selected = false;
232
233
    /**
234
     * Show checkbox.
235
     *
236
     * @var boolean
237
     * @since 1.2.0
238
     */
239
    private $showCheckbox = false;
240
241
    /**
242
     * Show in legend.
243
     *
244
     * @var boolean
245
     * @since 2.3.0
246
     */
247
    private $showInLegend;
248
249
    /**
250
     * Skip keyboard navigation.
251
     *
252
     * @var boolean
253
     * @since 5.0.12
254
     */
255
    private $skipKeyboardNavigation;
256
257
    /**
258
     * Sticky tracking.
259
     *
260
     * @var boolean
261
     * @since 2.0
262
     */
263
    private $stickyTracking = true;
264
265
    /**
266
     * Threshold.
267
     *
268
     * @var integer
269
     * @since 3.0
270
     */
271
    private $threshold = 0;
272
273
    /**
274
     * Tooltip.
275
     *
276
     * @var array
277
     * @since 2.3
278
     */
279
    private $tooltip;
280
281
    /**
282
     * Type.
283
     *
284
     * @var string
285
     */
286
    private $type;
287
288
    /**
289
     * Visible.
290
     *
291
     * @var boolean
292
     */
293
    private $visible = true;
294
295
    /**
296
     * Wrap.
297
     *
298
     * @var boolean
299
     * @since 3.0
300
     */
301
    private $wrap = true;
302
303
    /**
304
     * X axis.
305
     *
306
     * @var integer|string
307
     */
308
    private $xAxis = "0";
309
310
    /**
311
     * Y axis.
312
     *
313
     * @var integer|string
314
     */
315
    private $yAxis = "0";
316
317
    /**
318
     * Z index.
319
     *
320
     * @var integer
321
     */
322
    private $zIndex;
323
324
    /**
325
     * Constructor.
326
     *
327
     * @param boolean $ignoreDefaultValues Ignore the default values.
328
     */
329
    public function __construct($ignoreDefaultValues = true) {
330
        if (true === $ignoreDefaultValues) {
331
            $this->clear();
332
        }
333
    }
334
335
    /**
336
     * Clear.
337
     *
338
     * @return void
339
     */
340
    public function clear() {
341
342
        // Clear the animation.
343
        $this->animation = null;
344
345
        // Clear the animation limit.
346
        $this->animationLimit = null;
347
348
        // Clear the class name.
349
        $this->className = null;
350
351
        // Clear the color.
352
        $this->color = null;
353
354
        // Clear the color index.
355
        $this->colorIndex = null;
356
357
        // Clear the cursor.
358
        $this->cursor = null;
359
360
        // Clear the data.
361
        $this->data = 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 $data.

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...
362
363
        // Clear the data labels.
364
        $this->dataLabels = 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 $dataLabels.

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...
365
366
        // Clear the description.
367
        $this->description = null;
368
369
        // Clear the dial.
370
        $this->dial = 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 $dial.

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...
371
372
        // Clear the enable mouse tracking.
373
        $this->enableMouseTracking = null;
374
375
        // Clear the events.
376
        if (null !== $this->events) {
377
            $this->events->clear();
378
        }
379
380
        // Clear the expose element to a11y.
381
        $this->exposeElementToA11y = null;
382
383
        // Clear the find nearest point by.
384
        $this->findNearestPointBy = null;
385
386
        // Clear the get extremes from all.
387
        $this->getExtremesFromAll = null;
388
389
        // Clear the id.
390
        $this->id = null;
391
392
        // Clear the index.
393
        $this->index = null;
394
395
        // Clear the keys.
396
        $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...
397
398
        // Clear the legend index.
399
        $this->legendIndex = null;
400
401
        // Clear the linked to.
402
        $this->linkedTo = null;
403
404
        // Clear the name.
405
        $this->name = null;
406
407
        // Clear the negative color.
408
        $this->negativeColor = null;
409
410
        // Clear the overshoot.
411
        $this->overshoot = null;
412
413
        // Clear the pivot.
414
        $this->pivot = 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 $pivot.

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...
415
416
        // Clear the point.
417
        if (null !== $this->point) {
418
            $this->point->clear();
419
        }
420
421
        // Clear the point description formatter.
422
        $this->pointDescriptionFormatter = null;
423
424
        // Clear the selected.
425
        $this->selected = null;
426
427
        // Clear the show checkbox.
428
        $this->showCheckbox = null;
429
430
        // Clear the show in legend.
431
        $this->showInLegend = null;
432
433
        // Clear the skip keyboard navigation.
434
        $this->skipKeyboardNavigation = null;
435
436
        // Clear the sticky tracking.
437
        $this->stickyTracking = null;
438
439
        // Clear the threshold.
440
        $this->threshold = null;
441
442
        // Clear the tooltip.
443
        $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...
444
445
        // Clear the type.
446
        $this->type = null;
447
448
        // Clear the visible.
449
        $this->visible = null;
450
451
        // Clear the wrap.
452
        $this->wrap = null;
453
454
        // Clear the x axis.
455
        $this->xAxis = null;
456
457
        // Clear the y axis.
458
        $this->yAxis = null;
459
460
        // Clear the z index.
461
        $this->zIndex = null;
462
    }
463
464
    /**
465
     * Get the animation.
466
     *
467
     * @return boolean Returns the animation.
468
     */
469
    public function getAnimation() {
470
        return $this->animation;
471
    }
472
473
    /**
474
     * Get the animation limit.
475
     *
476
     * @return integer Returns the animation limit.
477
     */
478
    public function getAnimationLimit() {
479
        return $this->animationLimit;
480
    }
481
482
    /**
483
     * Get the class name.
484
     *
485
     * @return string Returns the class name.
486
     */
487
    public function getClassName() {
488
        return $this->className;
489
    }
490
491
    /**
492
     * Get the color.
493
     *
494
     * @return string Returns the color.
495
     */
496
    public function getColor() {
497
        return $this->color;
498
    }
499
500
    /**
501
     * Get the color index.
502
     *
503
     * @return integer Returns the color index.
504
     */
505
    public function getColorIndex() {
506
        return $this->colorIndex;
507
    }
508
509
    /**
510
     * Get the cursor.
511
     *
512
     * @return string Returns the cursor.
513
     */
514
    public function getCursor() {
515
        return $this->cursor;
516
    }
517
518
    /**
519
     * Get the data.
520
     *
521
     * @return array Returns the data.
522
     */
523
    public function getData() {
524
        return $this->data;
525
    }
526
527
    /**
528
     * Get the data labels.
529
     *
530
     * @return array Returns the data labels.
531
     */
532
    public function getDataLabels() {
533
        return $this->dataLabels;
534
    }
535
536
    /**
537
     * Get the description.
538
     *
539
     * @return string Returns the description.
540
     */
541
    public function getDescription() {
542
        return $this->description;
543
    }
544
545
    /**
546
     * Get the dial.
547
     *
548
     * @return array Returns the dial.
549
     */
550
    public function getDial() {
551
        return $this->dial;
552
    }
553
554
    /**
555
     * Get the enable mouse tracking.
556
     *
557
     * @return boolean Returns the enable mouse tracking.
558
     */
559
    public function getEnableMouseTracking() {
560
        return $this->enableMouseTracking;
561
    }
562
563
    /**
564
     * Get the events.
565
     *
566
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\Gauge\HighchartsEvents Returns the events.
567
     */
568
    public function getEvents() {
569
        return $this->events;
570
    }
571
572
    /**
573
     * Get the expose element to a11y.
574
     *
575
     * @return boolean Returns the expose element to a11y.
576
     */
577
    public function getExposeElementToA11y() {
578
        return $this->exposeElementToA11y;
579
    }
580
581
    /**
582
     * Get the find nearest point by.
583
     *
584
     * @return string Returns the find nearest point by.
585
     */
586
    public function getFindNearestPointBy() {
587
        return $this->findNearestPointBy;
588
    }
589
590
    /**
591
     * Get the get extremes from all.
592
     *
593
     * @return boolean Returns the get extremes from all.
594
     */
595
    public function getGetExtremesFromAll() {
596
        return $this->getExtremesFromAll;
597
    }
598
599
    /**
600
     * Get the id.
601
     *
602
     * @return string Returns the id.
603
     */
604
    public function getId() {
605
        return $this->id;
606
    }
607
608
    /**
609
     * Get the index.
610
     *
611
     * @return integer Returns the index.
612
     */
613
    public function getIndex() {
614
        return $this->index;
615
    }
616
617
    /**
618
     * Get the keys.
619
     *
620
     * @return array Returns the keys.
621
     */
622
    public function getKeys() {
623
        return $this->keys;
624
    }
625
626
    /**
627
     * Get the legend index.
628
     *
629
     * @return integer Returns the legend index.
630
     */
631
    public function getLegendIndex() {
632
        return $this->legendIndex;
633
    }
634
635
    /**
636
     * Get the linked to.
637
     *
638
     * @return string Returns the linked to.
639
     */
640
    public function getLinkedTo() {
641
        return $this->linkedTo;
642
    }
643
644
    /**
645
     * Get the name.
646
     *
647
     * @return string Returns the name.
648
     */
649
    public function getName() {
650
        return $this->name;
651
    }
652
653
    /**
654
     * Get the negative color.
655
     *
656
     * @return string Returns the negative color.
657
     */
658
    public function getNegativeColor() {
659
        return $this->negativeColor;
660
    }
661
662
    /**
663
     * Get the overshoot.
664
     *
665
     * @return integer Returns the overshoot.
666
     */
667
    public function getOvershoot() {
668
        return $this->overshoot;
669
    }
670
671
    /**
672
     * Get the pivot.
673
     *
674
     * @return array Returns the pivot.
675
     */
676
    public function getPivot() {
677
        return $this->pivot;
678
    }
679
680
    /**
681
     * Get the point.
682
     *
683
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\Gauge\HighchartsPoint Returns the point.
684
     */
685
    public function getPoint() {
686
        return $this->point;
687
    }
688
689
    /**
690
     * Get the point description formatter.
691
     *
692
     * @return string Returns the point description formatter.
693
     */
694
    public function getPointDescriptionFormatter() {
695
        return $this->pointDescriptionFormatter;
696
    }
697
698
    /**
699
     * Get the selected.
700
     *
701
     * @return boolean Returns the selected.
702
     */
703
    public function getSelected() {
704
        return $this->selected;
705
    }
706
707
    /**
708
     * Get the show checkbox.
709
     *
710
     * @return boolean Returns the show checkbox.
711
     */
712
    public function getShowCheckbox() {
713
        return $this->showCheckbox;
714
    }
715
716
    /**
717
     * Get the show in legend.
718
     *
719
     * @return boolean Returns the show in legend.
720
     */
721
    public function getShowInLegend() {
722
        return $this->showInLegend;
723
    }
724
725
    /**
726
     * Get the skip keyboard navigation.
727
     *
728
     * @return boolean Returns the skip keyboard navigation.
729
     */
730
    public function getSkipKeyboardNavigation() {
731
        return $this->skipKeyboardNavigation;
732
    }
733
734
    /**
735
     * Get the sticky tracking.
736
     *
737
     * @return boolean Returns the sticky tracking.
738
     */
739
    public function getStickyTracking() {
740
        return $this->stickyTracking;
741
    }
742
743
    /**
744
     * Get the threshold.
745
     *
746
     * @return integer Returns the threshold.
747
     */
748
    public function getThreshold() {
749
        return $this->threshold;
750
    }
751
752
    /**
753
     * Get the tooltip.
754
     *
755
     * @return array Returns the tooltip.
756
     */
757
    public function getTooltip() {
758
        return $this->tooltip;
759
    }
760
761
    /**
762
     * Get the type.
763
     *
764
     * @return string Returns the type.
765
     */
766
    public function getType() {
767
        return $this->type;
768
    }
769
770
    /**
771
     * Get the visible.
772
     *
773
     * @return boolean Returns the visible.
774
     */
775
    public function getVisible() {
776
        return $this->visible;
777
    }
778
779
    /**
780
     * Get the wrap.
781
     *
782
     * @return boolean Returns the wrap.
783
     */
784
    public function getWrap() {
785
        return $this->wrap;
786
    }
787
788
    /**
789
     * Get the x axis.
790
     *
791
     * @return integer|string Returns the x axis.
792
     */
793
    public function getXAxis() {
794
        return $this->xAxis;
795
    }
796
797
    /**
798
     * Get the y axis.
799
     *
800
     * @return integer|string Returns the y axis.
801
     */
802
    public function getYAxis() {
803
        return $this->yAxis;
804
    }
805
806
    /**
807
     * Get the z index.
808
     *
809
     * @return integer Returns the z index.
810
     */
811
    public function getZIndex() {
812
        return $this->zIndex;
813
    }
814
815
    /**
816
     * Serialize this instance.
817
     *
818
     * @return array Returns an array representing this instance.
819
     */
820
    public function jsonSerialize() {
821
        return $this->toArray();
822
    }
823
824
    /**
825
     * Create a new events.
826
     *
827
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\Gauge\HighchartsEvents Returns the events.
828
     */
829
    public function newEvents() {
830
        $this->events = new \WBW\Bundle\HighchartsBundle\API\Chart\Series\Gauge\HighchartsEvents();
831
        return $this->events;
832
    }
833
834
    /**
835
     * Create a new point.
836
     *
837
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\Gauge\HighchartsPoint Returns the point.
838
     */
839
    public function newPoint() {
840
        $this->point = new \WBW\Bundle\HighchartsBundle\API\Chart\Series\Gauge\HighchartsPoint();
841
        return $this->point;
842
    }
843
844
    /**
845
     * Set the animation.
846
     *
847
     * @param boolean $animation The animation.
848
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
849
     */
850
    public function setAnimation($animation) {
851
        $this->animation = $animation;
852
        return $this;
853
    }
854
855
    /**
856
     * Set the animation limit.
857
     *
858
     * @param integer $animationLimit The animation limit.
859
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
860
     */
861
    public function setAnimationLimit($animationLimit) {
862
        $this->animationLimit = $animationLimit;
863
        return $this;
864
    }
865
866
    /**
867
     * Set the class name.
868
     *
869
     * @param string $className The class name.
870
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
871
     */
872
    public function setClassName($className) {
873
        $this->className = $className;
874
        return $this;
875
    }
876
877
    /**
878
     * Set the color.
879
     *
880
     * @param string $color The color.
881
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
882
     */
883
    public function setColor($color) {
884
        $this->color = $color;
885
        return $this;
886
    }
887
888
    /**
889
     * Set the color index.
890
     *
891
     * @param integer $colorIndex The color index.
892
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
893
     */
894
    public function setColorIndex($colorIndex) {
895
        $this->colorIndex = $colorIndex;
896
        return $this;
897
    }
898
899
    /**
900
     * Set the cursor.
901
     *
902
     * @param string $cursor The cursor.
903
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
904
     */
905
    public function setCursor($cursor) {
906
        switch ($cursor) {
907
            case null:
908
            case "crosshair":
909
            case "default":
910
            case "help":
911
            case "none":
912
            case "pointer":
913
            $this->cursor = $cursor;
914
            break;
915
        }
916
        return $this;
917
    }
918
919
    /**
920
     * Set the data.
921
     *
922
     * @param array $data The data.
923
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
924
     */
925
    public function setData(array $data = null) {
926
        $this->data = $data;
0 ignored issues
show
Documentation Bug introduced by
It seems like $data can be null. However, the property $data 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...
927
        return $this;
928
    }
929
930
    /**
931
     * Set the data labels.
932
     *
933
     * @param array $dataLabels The data labels.
934
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
935
     */
936
    public function setDataLabels(array $dataLabels = null) {
937
        $this->dataLabels = $dataLabels;
0 ignored issues
show
Documentation Bug introduced by
It seems like $dataLabels can be null. However, the property $dataLabels 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...
938
        return $this;
939
    }
940
941
    /**
942
     * Set the description.
943
     *
944
     * @param string $description The description.
945
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
946
     */
947
    public function setDescription($description) {
948
        $this->description = $description;
949
        return $this;
950
    }
951
952
    /**
953
     * Set the dial.
954
     *
955
     * @param array $dial The dial.
956
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
957
     */
958
    public function setDial(array $dial = null) {
959
        $this->dial = $dial;
0 ignored issues
show
Documentation Bug introduced by
It seems like $dial can be null. However, the property $dial 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...
960
        return $this;
961
    }
962
963
    /**
964
     * Set the enable mouse tracking.
965
     *
966
     * @param boolean $enableMouseTracking The enable mouse tracking.
967
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
968
     */
969
    public function setEnableMouseTracking($enableMouseTracking) {
970
        $this->enableMouseTracking = $enableMouseTracking;
971
        return $this;
972
    }
973
974
    /**
975
     * Set the events.
976
     *
977
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\Series\Gauge\HighchartsEvents $events The events.
978
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
979
     */
980
    public function setEvents(\WBW\Bundle\HighchartsBundle\API\Chart\Series\Gauge\HighchartsEvents $events = null) {
981
        $this->events = $events;
982
        return $this;
983
    }
984
985
    /**
986
     * Set the expose element to a11y.
987
     *
988
     * @param boolean $exposeElementToA11y The expose element to a11y.
989
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
990
     */
991
    public function setExposeElementToA11y($exposeElementToA11y) {
992
        $this->exposeElementToA11y = $exposeElementToA11y;
993
        return $this;
994
    }
995
996
    /**
997
     * Set the find nearest point by.
998
     *
999
     * @param string $findNearestPointBy The find nearest point by.
1000
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1001
     */
1002
    public function setFindNearestPointBy($findNearestPointBy) {
1003
        switch ($findNearestPointBy) {
1004
            case "x":
1005
            case "xy":
1006
            $this->findNearestPointBy = $findNearestPointBy;
1007
            break;
1008
        }
1009
        return $this;
1010
    }
1011
1012
    /**
1013
     * Set the get extremes from all.
1014
     *
1015
     * @param boolean $getExtremesFromAll The get extremes from all.
1016
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1017
     */
1018
    public function setGetExtremesFromAll($getExtremesFromAll) {
1019
        $this->getExtremesFromAll = $getExtremesFromAll;
1020
        return $this;
1021
    }
1022
1023
    /**
1024
     * Set the id.
1025
     *
1026
     * @param string $id The id.
1027
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1028
     */
1029
    public function setId($id) {
1030
        $this->id = $id;
1031
        return $this;
1032
    }
1033
1034
    /**
1035
     * Set the index.
1036
     *
1037
     * @param integer $index The index.
1038
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1039
     */
1040
    public function setIndex($index) {
1041
        $this->index = $index;
1042
        return $this;
1043
    }
1044
1045
    /**
1046
     * Set the keys.
1047
     *
1048
     * @param array $keys The keys.
1049
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1050
     */
1051
    public function setKeys(array $keys = null) {
1052
        $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...
1053
        return $this;
1054
    }
1055
1056
    /**
1057
     * Set the legend index.
1058
     *
1059
     * @param integer $legendIndex The legend index.
1060
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1061
     */
1062
    public function setLegendIndex($legendIndex) {
1063
        $this->legendIndex = $legendIndex;
1064
        return $this;
1065
    }
1066
1067
    /**
1068
     * Set the linked to.
1069
     *
1070
     * @param string $linkedTo The linked to.
1071
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1072
     */
1073
    public function setLinkedTo($linkedTo) {
1074
        $this->linkedTo = $linkedTo;
1075
        return $this;
1076
    }
1077
1078
    /**
1079
     * Set the name.
1080
     *
1081
     * @param string $name The name.
1082
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1083
     */
1084
    public function setName($name) {
1085
        $this->name = $name;
1086
        return $this;
1087
    }
1088
1089
    /**
1090
     * Set the negative color.
1091
     *
1092
     * @param string $negativeColor The negative color.
1093
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1094
     */
1095
    public function setNegativeColor($negativeColor) {
1096
        $this->negativeColor = $negativeColor;
1097
        return $this;
1098
    }
1099
1100
    /**
1101
     * Set the overshoot.
1102
     *
1103
     * @param integer $overshoot The overshoot.
1104
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1105
     */
1106
    public function setOvershoot($overshoot) {
1107
        $this->overshoot = $overshoot;
1108
        return $this;
1109
    }
1110
1111
    /**
1112
     * Set the pivot.
1113
     *
1114
     * @param array $pivot The pivot.
1115
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1116
     */
1117
    public function setPivot(array $pivot = null) {
1118
        $this->pivot = $pivot;
0 ignored issues
show
Documentation Bug introduced by
It seems like $pivot can be null. However, the property $pivot 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...
1119
        return $this;
1120
    }
1121
1122
    /**
1123
     * Set the point.
1124
     *
1125
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\Series\Gauge\HighchartsPoint $point The point.
1126
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1127
     */
1128
    public function setPoint(\WBW\Bundle\HighchartsBundle\API\Chart\Series\Gauge\HighchartsPoint $point = null) {
1129
        $this->point = $point;
1130
        return $this;
1131
    }
1132
1133
    /**
1134
     * Set the point description formatter.
1135
     *
1136
     * @param string $pointDescriptionFormatter The point description formatter.
1137
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1138
     */
1139
    public function setPointDescriptionFormatter($pointDescriptionFormatter) {
1140
        $this->pointDescriptionFormatter = $pointDescriptionFormatter;
1141
        return $this;
1142
    }
1143
1144
    /**
1145
     * Set the selected.
1146
     *
1147
     * @param boolean $selected The selected.
1148
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1149
     */
1150
    public function setSelected($selected) {
1151
        $this->selected = $selected;
1152
        return $this;
1153
    }
1154
1155
    /**
1156
     * Set the show checkbox.
1157
     *
1158
     * @param boolean $showCheckbox The show checkbox.
1159
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1160
     */
1161
    public function setShowCheckbox($showCheckbox) {
1162
        $this->showCheckbox = $showCheckbox;
1163
        return $this;
1164
    }
1165
1166
    /**
1167
     * Set the show in legend.
1168
     *
1169
     * @param boolean $showInLegend The show in legend.
1170
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1171
     */
1172
    public function setShowInLegend($showInLegend) {
1173
        $this->showInLegend = $showInLegend;
1174
        return $this;
1175
    }
1176
1177
    /**
1178
     * Set the skip keyboard navigation.
1179
     *
1180
     * @param boolean $skipKeyboardNavigation The skip keyboard navigation.
1181
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1182
     */
1183
    public function setSkipKeyboardNavigation($skipKeyboardNavigation) {
1184
        $this->skipKeyboardNavigation = $skipKeyboardNavigation;
1185
        return $this;
1186
    }
1187
1188
    /**
1189
     * Set the sticky tracking.
1190
     *
1191
     * @param boolean $stickyTracking The sticky tracking.
1192
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1193
     */
1194
    public function setStickyTracking($stickyTracking) {
1195
        $this->stickyTracking = $stickyTracking;
1196
        return $this;
1197
    }
1198
1199
    /**
1200
     * Set the threshold.
1201
     *
1202
     * @param integer $threshold The threshold.
1203
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1204
     */
1205
    public function setThreshold($threshold) {
1206
        $this->threshold = $threshold;
1207
        return $this;
1208
    }
1209
1210
    /**
1211
     * Set the tooltip.
1212
     *
1213
     * @param array $tooltip The tooltip.
1214
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1215
     */
1216
    public function setTooltip(array $tooltip = null) {
1217
        $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...
1218
        return $this;
1219
    }
1220
1221
    /**
1222
     * Set the type.
1223
     *
1224
     * @param string $type The type.
1225
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1226
     */
1227
    public function setType($type) {
1228
        switch ($type) {
1229
            case null:
1230
            case "area":
1231
            case "arearange":
1232
            case "areaspline":
1233
            case "areasplinerange":
1234
            case "boxplot":
1235
            case "bubble":
1236
            case "column":
1237
            case "columnrange":
1238
            case "errorbar":
1239
            case "funnel":
1240
            case "gauge":
1241
            case "line":
1242
            case "pie":
1243
            case "scatter":
1244
            case "spline":
1245
            case "waterfall":
1246
            $this->type = $type;
1247
            break;
1248
        }
1249
        return $this;
1250
    }
1251
1252
    /**
1253
     * Set the visible.
1254
     *
1255
     * @param boolean $visible The visible.
1256
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1257
     */
1258
    public function setVisible($visible) {
1259
        $this->visible = $visible;
1260
        return $this;
1261
    }
1262
1263
    /**
1264
     * Set the wrap.
1265
     *
1266
     * @param boolean $wrap The wrap.
1267
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1268
     */
1269
    public function setWrap($wrap) {
1270
        $this->wrap = $wrap;
1271
        return $this;
1272
    }
1273
1274
    /**
1275
     * Set the x axis.
1276
     *
1277
     * @param integer|string $xAxis The x axis.
1278
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1279
     */
1280
    public function setXAxis($xAxis) {
1281
        $this->xAxis = $xAxis;
1282
        return $this;
1283
    }
1284
1285
    /**
1286
     * Set the y axis.
1287
     *
1288
     * @param integer|string $yAxis The y axis.
1289
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1290
     */
1291
    public function setYAxis($yAxis) {
1292
        $this->yAxis = $yAxis;
1293
        return $this;
1294
    }
1295
1296
    /**
1297
     * Set the z index.
1298
     *
1299
     * @param integer $zIndex The z index.
1300
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Series\HighchartsGauge Returns the highcharts gauge.
1301
     */
1302
    public function setZIndex($zIndex) {
1303
        $this->zIndex = $zIndex;
1304
        return $this;
1305
    }
1306
1307
    /**
1308
     * Convert into an array representing this instance.
1309
     *
1310
     * @return array Returns an array representing this instance.
1311
     */
1312
    public function toArray() {
1313
1314
        // Initialize the output.
1315
        $output = [];
1316
1317
        // Set the animation.
1318
        ArrayUtility::set($output, "animation", $this->animation, [null]);
1319
1320
        // Set the animation limit.
1321
        ArrayUtility::set($output, "animationLimit", $this->animationLimit, [null]);
1322
1323
        // Set the class name.
1324
        ArrayUtility::set($output, "className", $this->className, [null]);
1325
1326
        // Set the color.
1327
        ArrayUtility::set($output, "color", $this->color, [null]);
1328
1329
        // Set the color index.
1330
        ArrayUtility::set($output, "colorIndex", $this->colorIndex, [null]);
1331
1332
        // Set the cursor.
1333
        ArrayUtility::set($output, "cursor", $this->cursor, [null]);
1334
1335
        // Set the data.
1336
        ArrayUtility::set($output, "data", $this->data, [null]);
1337
1338
        // Set the data labels.
1339
        ArrayUtility::set($output, "dataLabels", $this->dataLabels, [null]);
1340
1341
        // Set the description.
1342
        ArrayUtility::set($output, "description", $this->description, [null]);
1343
1344
        // Set the dial.
1345
        ArrayUtility::set($output, "dial", $this->dial, [null]);
1346
1347
        // Set the enable mouse tracking.
1348
        ArrayUtility::set($output, "enableMouseTracking", $this->enableMouseTracking, [null]);
1349
1350
        // Set the events.
1351
        if (null !== $this->events) {
1352
            ArrayUtility::set($output, "events", $this->events->toArray(), []);
1353
        }
1354
1355
        // Set the expose element to a11y.
1356
        ArrayUtility::set($output, "exposeElementToA11y", $this->exposeElementToA11y, [null]);
1357
1358
        // Set the find nearest point by.
1359
        ArrayUtility::set($output, "findNearestPointBy", $this->findNearestPointBy, [null]);
1360
1361
        // Set the get extremes from all.
1362
        ArrayUtility::set($output, "getExtremesFromAll", $this->getExtremesFromAll, [null]);
1363
1364
        // Set the id.
1365
        ArrayUtility::set($output, "id", $this->id, [null]);
1366
1367
        // Set the index.
1368
        ArrayUtility::set($output, "index", $this->index, [null]);
1369
1370
        // Set the keys.
1371
        ArrayUtility::set($output, "keys", $this->keys, [null]);
1372
1373
        // Set the legend index.
1374
        ArrayUtility::set($output, "legendIndex", $this->legendIndex, [null]);
1375
1376
        // Set the linked to.
1377
        ArrayUtility::set($output, "linkedTo", $this->linkedTo, [null]);
1378
1379
        // Set the name.
1380
        ArrayUtility::set($output, "name", $this->name, [null]);
1381
1382
        // Set the negative color.
1383
        ArrayUtility::set($output, "negativeColor", $this->negativeColor, [null]);
1384
1385
        // Set the overshoot.
1386
        ArrayUtility::set($output, "overshoot", $this->overshoot, [null]);
1387
1388
        // Set the pivot.
1389
        ArrayUtility::set($output, "pivot", $this->pivot, [null]);
1390
1391
        // Set the point.
1392
        if (null !== $this->point) {
1393
            ArrayUtility::set($output, "point", $this->point->toArray(), []);
1394
        }
1395
1396
        // Set the point description formatter.
1397
        ArrayUtility::set($output, "pointDescriptionFormatter", $this->pointDescriptionFormatter, [null]);
1398
1399
        // Set the selected.
1400
        ArrayUtility::set($output, "selected", $this->selected, [null]);
1401
1402
        // Set the show checkbox.
1403
        ArrayUtility::set($output, "showCheckbox", $this->showCheckbox, [null]);
1404
1405
        // Set the show in legend.
1406
        ArrayUtility::set($output, "showInLegend", $this->showInLegend, [null]);
1407
1408
        // Set the skip keyboard navigation.
1409
        ArrayUtility::set($output, "skipKeyboardNavigation", $this->skipKeyboardNavigation, [null]);
1410
1411
        // Set the sticky tracking.
1412
        ArrayUtility::set($output, "stickyTracking", $this->stickyTracking, [null]);
1413
1414
        // Set the threshold.
1415
        ArrayUtility::set($output, "threshold", $this->threshold, [null]);
1416
1417
        // Set the tooltip.
1418
        ArrayUtility::set($output, "tooltip", $this->tooltip, [null]);
1419
1420
        // Set the type.
1421
        ArrayUtility::set($output, "type", $this->type, [null]);
1422
1423
        // Set the visible.
1424
        ArrayUtility::set($output, "visible", $this->visible, [null]);
1425
1426
        // Set the wrap.
1427
        ArrayUtility::set($output, "wrap", $this->wrap, [null]);
1428
1429
        // Set the x axis.
1430
        ArrayUtility::set($output, "xAxis", $this->xAxis, [null]);
1431
1432
        // Set the y axis.
1433
        ArrayUtility::set($output, "yAxis", $this->yAxis, [null]);
1434
1435
        // Set the z index.
1436
        ArrayUtility::set($output, "zIndex", $this->zIndex, [null]);
1437
1438
        // Return the output.
1439
        return $output;
1440
    }
1441
1442
}
1443