HighchartsZAxis::newEvents()   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 0
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;
13
14
use JsonSerializable;
15
use WBW\Library\Core\Utility\Argument\ArrayUtility;
16
17
/**
18
 * Highcharts z axis.
19
 *
20
 * @author webeweb <https://github.com/webeweb/>
21
 * @package WBW\Bundle\HighchartsBundle\API\Chart
22
 * @version 5.0.14
23
 * @final
24
 */
25
final class HighchartsZAxis implements JsonSerializable {
26
27
    /**
28
     * Allow decimals.
29
     *
30
     * @var boolean
31
     * @since 2.0
32
     */
33
    private $allowDecimals = true;
34
35
    /**
36
     * Alternate grid color.
37
     *
38
     * @var string
39
     */
40
    private $alternateGridColor;
41
42
    /**
43
     * Categories.
44
     *
45
     * @var array
46
     */
47
    private $categories;
48
49
    /**
50
     * Ceiling.
51
     *
52
     * @var integer
53
     * @since 4.0
54
     */
55
    private $ceiling;
56
57
    /**
58
     * Class name.
59
     *
60
     * @var string
61
     * @since 5.0.0
62
     */
63
    private $className;
64
65
    /**
66
     * Crosshair.
67
     *
68
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsCrosshair
69
     * @since 4.1
70
     */
71
    private $crosshair;
72
73
    /**
74
     * Date time label formats.
75
     *
76
     * @var array
77
     */
78
    private $dateTimeLabelFormats;
79
80
    /**
81
     * Description.
82
     *
83
     * @var string
84
     * @since 5.0.0
85
     */
86
    private $description;
87
88
    /**
89
     * End on tick.
90
     *
91
     * @var boolean
92
     * @since 1.2.0
93
     */
94
    private $endOnTick = false;
95
96
    /**
97
     * Events.
98
     *
99
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsEvents
100
     */
101
    private $events;
102
103
    /**
104
     * Floor.
105
     *
106
     * @var integer
107
     * @since 4.0
108
     */
109
    private $floor;
110
111
    /**
112
     * Grid line color.
113
     *
114
     * @var string
115
     */
116
    private $gridLineColor = "#e6e6e6";
117
118
    /**
119
     * Grid line dash style.
120
     *
121
     * @var string
122
     * @since 1.2
123
     */
124
    private $gridLineDashStyle = "Solid";
125
126
    /**
127
     * Grid line width.
128
     *
129
     * @var integer
130
     */
131
    private $gridLineWidth = 0;
132
133
    /**
134
     * Grid z index.
135
     *
136
     * @var integer
137
     */
138
    private $gridZIndex = 1;
139
140
    /**
141
     * Id.
142
     *
143
     * @var string
144
     * @since 1.2.0
145
     */
146
    private $id;
147
148
    /**
149
     * Labels.
150
     *
151
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsLabels
152
     */
153
    private $labels;
154
155
    /**
156
     * Line color.
157
     *
158
     * @var string
159
     */
160
    private $lineColor = "#ccd6eb";
161
162
    /**
163
     * Line width.
164
     *
165
     * @var integer
166
     */
167
    private $lineWidth = 1;
168
169
    /**
170
     * Linked to.
171
     *
172
     * @var integer
173
     * @since 2.0.2
174
     */
175
    private $linkedTo;
176
177
    /**
178
     * Max.
179
     *
180
     * @var integer
181
     */
182
    private $max;
183
184
    /**
185
     * Max padding.
186
     *
187
     * @var integer
188
     * @since 1.2.0
189
     */
190
    private $maxPadding = 0.01;
191
192
    /**
193
     * Max zoom.
194
     *
195
     * @var integer
196
     * @deprecated
197
     */
198
    private $maxZoom;
199
200
    /**
201
     * Min.
202
     *
203
     * @var integer
204
     */
205
    private $min;
206
207
    /**
208
     * Min padding.
209
     *
210
     * @var integer
211
     * @since 1.2.0
212
     */
213
    private $minPadding = 0.01;
214
215
    /**
216
     * Min range.
217
     *
218
     * @var integer
219
     */
220
    private $minRange;
221
222
    /**
223
     * Min tick interval.
224
     *
225
     * @var integer
226
     * @since 2.3.0
227
     */
228
    private $minTickInterval;
229
230
    /**
231
     * Minor grid line color.
232
     *
233
     * @var string
234
     */
235
    private $minorGridLineColor = "#f2f2f2";
236
237
    /**
238
     * Minor grid line dash style.
239
     *
240
     * @var string
241
     * @since 1.2
242
     */
243
    private $minorGridLineDashStyle = "Solid";
244
245
    /**
246
     * Minor grid line width.
247
     *
248
     * @var integer
249
     */
250
    private $minorGridLineWidth = 1;
251
252
    /**
253
     * Minor tick color.
254
     *
255
     * @var string
256
     */
257
    private $minorTickColor = "#999999";
258
259
    /**
260
     * Minor tick interval.
261
     *
262
     * @var string|integer
263
     */
264
    private $minorTickInterval;
265
266
    /**
267
     * Minor tick length.
268
     *
269
     * @var integer
270
     */
271
    private $minorTickLength = 2;
272
273
    /**
274
     * Minor tick position.
275
     *
276
     * @var string
277
     */
278
    private $minorTickPosition = "outside";
279
280
    /**
281
     * Minor tick width.
282
     *
283
     * @var integer
284
     */
285
    private $minorTickWidth = 0;
286
287
    /**
288
     * Offset.
289
     *
290
     * @var integer
291
     */
292
    private $offset = 0;
293
294
    /**
295
     * Opposite.
296
     *
297
     * @var boolean
298
     */
299
    private $opposite = false;
300
301
    /**
302
     * Plot bands.
303
     *
304
     * @var array
305
     */
306
    private $plotBands;
307
308
    /**
309
     * Plot lines.
310
     *
311
     * @var array
312
     */
313
    private $plotLines;
314
315
    /**
316
     * Reversed.
317
     *
318
     * @var boolean
319
     */
320
    private $reversed = false;
321
322
    /**
323
     * Show empty.
324
     *
325
     * @var boolean
326
     * @since 1.1
327
     */
328
    private $showEmpty = true;
329
330
    /**
331
     * Show first label.
332
     *
333
     * @var boolean
334
     */
335
    private $showFirstLabel = true;
336
337
    /**
338
     * Show last label.
339
     *
340
     * @var boolean
341
     */
342
    private $showLastLabel = true;
343
344
    /**
345
     * Soft max.
346
     *
347
     * @var integer
348
     * @since 5.0.1
349
     */
350
    private $softMax;
351
352
    /**
353
     * Soft min.
354
     *
355
     * @var integer
356
     * @since 5.0.1
357
     */
358
    private $softMin;
359
360
    /**
361
     * Start of week.
362
     *
363
     * @var integer
364
     */
365
    private $startOfWeek = 1;
366
367
    /**
368
     * Start on tick.
369
     *
370
     * @var boolean
371
     * @since 1.2.0
372
     */
373
    private $startOnTick = false;
374
375
    /**
376
     * Tick amount.
377
     *
378
     * @var integer
379
     * @since 4.1.0
380
     */
381
    private $tickAmount;
382
383
    /**
384
     * Tick color.
385
     *
386
     * @var string
387
     */
388
    private $tickColor = "#ccd6eb";
389
390
    /**
391
     * Tick interval.
392
     *
393
     * @var integer
394
     */
395
    private $tickInterval;
396
397
    /**
398
     * Tick length.
399
     *
400
     * @var integer
401
     */
402
    private $tickLength = 10;
403
404
    /**
405
     * Tick pixel interval.
406
     *
407
     * @var integer
408
     */
409
    private $tickPixelInterval;
410
411
    /**
412
     * Tick position.
413
     *
414
     * @var string
415
     */
416
    private $tickPosition = "outside";
417
418
    /**
419
     * Tick positioner.
420
     *
421
     * @var string
422
     */
423
    private $tickPositioner;
424
425
    /**
426
     * Tick positions.
427
     *
428
     * @var array
429
     */
430
    private $tickPositions;
431
432
    /**
433
     * Tick width.
434
     *
435
     * @var integer
436
     */
437
    private $tickWidth = 1;
438
439
    /**
440
     * Tickmark placement.
441
     *
442
     * @var string
443
     */
444
    private $tickmarkPlacement;
445
446
    /**
447
     * Title.
448
     *
449
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsTitle
450
     */
451
    private $title;
452
453
    /**
454
     * Type.
455
     *
456
     * @var string
457
     */
458
    private $type = "linear";
459
460
    /**
461
     * Unique names.
462
     *
463
     * @var boolean
464
     * @since 4.2.7
465
     */
466
    private $uniqueNames = true;
467
468
    /**
469
     * Units.
470
     *
471
     * @var array
472
     */
473
    private $units;
474
475
    /**
476
     * Visible.
477
     *
478
     * @var boolean
479
     * @since 4.1.9
480
     */
481
    private $visible = true;
482
483
    /**
484
     * Constructor.
485
     *
486
     * @param boolean $ignoreDefaultValues Ignore the default values.
487
     */
488
    public function __construct($ignoreDefaultValues = true) {
489
        if (true === $ignoreDefaultValues) {
490
            $this->clear();
491
        }
492
    }
493
494
    /**
495
     * Clear.
496
     *
497
     * @return void
498
     */
499
    public function clear() {
500
501
        // Clear the allow decimals.
502
        $this->allowDecimals = null;
503
504
        // Clear the alternate grid color.
505
        $this->alternateGridColor = null;
506
507
        // Clear the categories.
508
        $this->categories = 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 $categories.

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...
509
510
        // Clear the ceiling.
511
        $this->ceiling = null;
512
513
        // Clear the class name.
514
        $this->className = null;
515
516
        // Clear the crosshair.
517
        if (null !== $this->crosshair) {
518
            $this->crosshair->clear();
519
        }
520
521
        // Clear the date time label formats.
522
        $this->dateTimeLabelFormats = 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 $dateTimeLabelFormats.

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...
523
524
        // Clear the description.
525
        $this->description = null;
526
527
        // Clear the end on tick.
528
        $this->endOnTick = null;
529
530
        // Clear the events.
531
        if (null !== $this->events) {
532
            $this->events->clear();
533
        }
534
535
        // Clear the floor.
536
        $this->floor = null;
537
538
        // Clear the grid line color.
539
        $this->gridLineColor = null;
540
541
        // Clear the grid line dash style.
542
        $this->gridLineDashStyle = null;
543
544
        // Clear the grid line width.
545
        $this->gridLineWidth = null;
546
547
        // Clear the grid z index.
548
        $this->gridZIndex = null;
549
550
        // Clear the id.
551
        $this->id = null;
552
553
        // Clear the labels.
554
        if (null !== $this->labels) {
555
            $this->labels->clear();
556
        }
557
558
        // Clear the line color.
559
        $this->lineColor = null;
560
561
        // Clear the line width.
562
        $this->lineWidth = null;
563
564
        // Clear the linked to.
565
        $this->linkedTo = null;
566
567
        // Clear the max.
568
        $this->max = null;
569
570
        // Clear the max padding.
571
        $this->maxPadding = null;
572
573
        // Clear the max zoom.
574
        $this->maxZoom = null;
0 ignored issues
show
Deprecated Code introduced by
The property WBW\Bundle\HighchartsBun...ghchartsZAxis::$maxZoom has been deprecated.

This property has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead.

Loading history...
575
576
        // Clear the min.
577
        $this->min = null;
578
579
        // Clear the min padding.
580
        $this->minPadding = null;
581
582
        // Clear the min range.
583
        $this->minRange = null;
584
585
        // Clear the min tick interval.
586
        $this->minTickInterval = null;
587
588
        // Clear the minor grid line color.
589
        $this->minorGridLineColor = null;
590
591
        // Clear the minor grid line dash style.
592
        $this->minorGridLineDashStyle = null;
593
594
        // Clear the minor grid line width.
595
        $this->minorGridLineWidth = null;
596
597
        // Clear the minor tick color.
598
        $this->minorTickColor = null;
599
600
        // Clear the minor tick interval.
601
        $this->minorTickInterval = null;
602
603
        // Clear the minor tick length.
604
        $this->minorTickLength = null;
605
606
        // Clear the minor tick position.
607
        $this->minorTickPosition = null;
608
609
        // Clear the minor tick width.
610
        $this->minorTickWidth = null;
611
612
        // Clear the offset.
613
        $this->offset = null;
614
615
        // Clear the opposite.
616
        $this->opposite = null;
617
618
        // Clear the plot bands.
619
        $this->plotBands = 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 $plotBands.

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...
620
621
        // Clear the plot lines.
622
        $this->plotLines = 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 $plotLines.

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...
623
624
        // Clear the reversed.
625
        $this->reversed = null;
626
627
        // Clear the show empty.
628
        $this->showEmpty = null;
629
630
        // Clear the show first label.
631
        $this->showFirstLabel = null;
632
633
        // Clear the show last label.
634
        $this->showLastLabel = null;
635
636
        // Clear the soft max.
637
        $this->softMax = null;
638
639
        // Clear the soft min.
640
        $this->softMin = null;
641
642
        // Clear the start of week.
643
        $this->startOfWeek = null;
644
645
        // Clear the start on tick.
646
        $this->startOnTick = null;
647
648
        // Clear the tick amount.
649
        $this->tickAmount = null;
650
651
        // Clear the tick color.
652
        $this->tickColor = null;
653
654
        // Clear the tick interval.
655
        $this->tickInterval = null;
656
657
        // Clear the tick length.
658
        $this->tickLength = null;
659
660
        // Clear the tick pixel interval.
661
        $this->tickPixelInterval = null;
662
663
        // Clear the tick position.
664
        $this->tickPosition = null;
665
666
        // Clear the tick positioner.
667
        $this->tickPositioner = null;
668
669
        // Clear the tick positions.
670
        $this->tickPositions = 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 $tickPositions.

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...
671
672
        // Clear the tick width.
673
        $this->tickWidth = null;
674
675
        // Clear the tickmark placement.
676
        $this->tickmarkPlacement = null;
677
678
        // Clear the title.
679
        if (null !== $this->title) {
680
            $this->title->clear();
681
        }
682
683
        // Clear the type.
684
        $this->type = null;
685
686
        // Clear the unique names.
687
        $this->uniqueNames = null;
688
689
        // Clear the units.
690
        $this->units = 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 $units.

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...
691
692
        // Clear the visible.
693
        $this->visible = null;
694
    }
695
696
    /**
697
     * Get the allow decimals.
698
     *
699
     * @return boolean Returns the allow decimals.
700
     */
701
    public function getAllowDecimals() {
702
        return $this->allowDecimals;
703
    }
704
705
    /**
706
     * Get the alternate grid color.
707
     *
708
     * @return string Returns the alternate grid color.
709
     */
710
    public function getAlternateGridColor() {
711
        return $this->alternateGridColor;
712
    }
713
714
    /**
715
     * Get the categories.
716
     *
717
     * @return array Returns the categories.
718
     */
719
    public function getCategories() {
720
        return $this->categories;
721
    }
722
723
    /**
724
     * Get the ceiling.
725
     *
726
     * @return integer Returns the ceiling.
727
     */
728
    public function getCeiling() {
729
        return $this->ceiling;
730
    }
731
732
    /**
733
     * Get the class name.
734
     *
735
     * @return string Returns the class name.
736
     */
737
    public function getClassName() {
738
        return $this->className;
739
    }
740
741
    /**
742
     * Get the crosshair.
743
     *
744
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsCrosshair Returns the crosshair.
745
     */
746
    public function getCrosshair() {
747
        return $this->crosshair;
748
    }
749
750
    /**
751
     * Get the date time label formats.
752
     *
753
     * @return array Returns the date time label formats.
754
     */
755
    public function getDateTimeLabelFormats() {
756
        return $this->dateTimeLabelFormats;
757
    }
758
759
    /**
760
     * Get the description.
761
     *
762
     * @return string Returns the description.
763
     */
764
    public function getDescription() {
765
        return $this->description;
766
    }
767
768
    /**
769
     * Get the end on tick.
770
     *
771
     * @return boolean Returns the end on tick.
772
     */
773
    public function getEndOnTick() {
774
        return $this->endOnTick;
775
    }
776
777
    /**
778
     * Get the events.
779
     *
780
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsEvents Returns the events.
781
     */
782
    public function getEvents() {
783
        return $this->events;
784
    }
785
786
    /**
787
     * Get the floor.
788
     *
789
     * @return integer Returns the floor.
790
     */
791
    public function getFloor() {
792
        return $this->floor;
793
    }
794
795
    /**
796
     * Get the grid line color.
797
     *
798
     * @return string Returns the grid line color.
799
     */
800
    public function getGridLineColor() {
801
        return $this->gridLineColor;
802
    }
803
804
    /**
805
     * Get the grid line dash style.
806
     *
807
     * @return string Returns the grid line dash style.
808
     */
809
    public function getGridLineDashStyle() {
810
        return $this->gridLineDashStyle;
811
    }
812
813
    /**
814
     * Get the grid line width.
815
     *
816
     * @return integer Returns the grid line width.
817
     */
818
    public function getGridLineWidth() {
819
        return $this->gridLineWidth;
820
    }
821
822
    /**
823
     * Get the grid z index.
824
     *
825
     * @return integer Returns the grid z index.
826
     */
827
    public function getGridZIndex() {
828
        return $this->gridZIndex;
829
    }
830
831
    /**
832
     * Get the id.
833
     *
834
     * @return string Returns the id.
835
     */
836
    public function getId() {
837
        return $this->id;
838
    }
839
840
    /**
841
     * Get the labels.
842
     *
843
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsLabels Returns the labels.
844
     */
845
    public function getLabels() {
846
        return $this->labels;
847
    }
848
849
    /**
850
     * Get the line color.
851
     *
852
     * @return string Returns the line color.
853
     */
854
    public function getLineColor() {
855
        return $this->lineColor;
856
    }
857
858
    /**
859
     * Get the line width.
860
     *
861
     * @return integer Returns the line width.
862
     */
863
    public function getLineWidth() {
864
        return $this->lineWidth;
865
    }
866
867
    /**
868
     * Get the linked to.
869
     *
870
     * @return integer Returns the linked to.
871
     */
872
    public function getLinkedTo() {
873
        return $this->linkedTo;
874
    }
875
876
    /**
877
     * Get the max.
878
     *
879
     * @return integer Returns the max.
880
     */
881
    public function getMax() {
882
        return $this->max;
883
    }
884
885
    /**
886
     * Get the max padding.
887
     *
888
     * @return integer Returns the max padding.
889
     */
890
    public function getMaxPadding() {
891
        return $this->maxPadding;
892
    }
893
894
    /**
895
     * Get the max zoom.
896
     *
897
     * @return integer Returns the max zoom.
898
     * @deprecated
899
     */
900
    public function getMaxZoom() {
901
        return $this->maxZoom;
0 ignored issues
show
Deprecated Code introduced by
The property WBW\Bundle\HighchartsBun...ghchartsZAxis::$maxZoom has been deprecated.

This property has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead.

Loading history...
902
    }
903
904
    /**
905
     * Get the min.
906
     *
907
     * @return integer Returns the min.
908
     */
909
    public function getMin() {
910
        return $this->min;
911
    }
912
913
    /**
914
     * Get the min padding.
915
     *
916
     * @return integer Returns the min padding.
917
     */
918
    public function getMinPadding() {
919
        return $this->minPadding;
920
    }
921
922
    /**
923
     * Get the min range.
924
     *
925
     * @return integer Returns the min range.
926
     */
927
    public function getMinRange() {
928
        return $this->minRange;
929
    }
930
931
    /**
932
     * Get the min tick interval.
933
     *
934
     * @return integer Returns the min tick interval.
935
     */
936
    public function getMinTickInterval() {
937
        return $this->minTickInterval;
938
    }
939
940
    /**
941
     * Get the minor grid line color.
942
     *
943
     * @return string Returns the minor grid line color.
944
     */
945
    public function getMinorGridLineColor() {
946
        return $this->minorGridLineColor;
947
    }
948
949
    /**
950
     * Get the minor grid line dash style.
951
     *
952
     * @return string Returns the minor grid line dash style.
953
     */
954
    public function getMinorGridLineDashStyle() {
955
        return $this->minorGridLineDashStyle;
956
    }
957
958
    /**
959
     * Get the minor grid line width.
960
     *
961
     * @return integer Returns the minor grid line width.
962
     */
963
    public function getMinorGridLineWidth() {
964
        return $this->minorGridLineWidth;
965
    }
966
967
    /**
968
     * Get the minor tick color.
969
     *
970
     * @return string Returns the minor tick color.
971
     */
972
    public function getMinorTickColor() {
973
        return $this->minorTickColor;
974
    }
975
976
    /**
977
     * Get the minor tick interval.
978
     *
979
     * @return string|integer Returns the minor tick interval.
980
     */
981
    public function getMinorTickInterval() {
982
        return $this->minorTickInterval;
983
    }
984
985
    /**
986
     * Get the minor tick length.
987
     *
988
     * @return integer Returns the minor tick length.
989
     */
990
    public function getMinorTickLength() {
991
        return $this->minorTickLength;
992
    }
993
994
    /**
995
     * Get the minor tick position.
996
     *
997
     * @return string Returns the minor tick position.
998
     */
999
    public function getMinorTickPosition() {
1000
        return $this->minorTickPosition;
1001
    }
1002
1003
    /**
1004
     * Get the minor tick width.
1005
     *
1006
     * @return integer Returns the minor tick width.
1007
     */
1008
    public function getMinorTickWidth() {
1009
        return $this->minorTickWidth;
1010
    }
1011
1012
    /**
1013
     * Get the offset.
1014
     *
1015
     * @return integer Returns the offset.
1016
     */
1017
    public function getOffset() {
1018
        return $this->offset;
1019
    }
1020
1021
    /**
1022
     * Get the opposite.
1023
     *
1024
     * @return boolean Returns the opposite.
1025
     */
1026
    public function getOpposite() {
1027
        return $this->opposite;
1028
    }
1029
1030
    /**
1031
     * Get the plot bands.
1032
     *
1033
     * @return array Returns the plot bands.
1034
     */
1035
    public function getPlotBands() {
1036
        return $this->plotBands;
1037
    }
1038
1039
    /**
1040
     * Get the plot lines.
1041
     *
1042
     * @return array Returns the plot lines.
1043
     */
1044
    public function getPlotLines() {
1045
        return $this->plotLines;
1046
    }
1047
1048
    /**
1049
     * Get the reversed.
1050
     *
1051
     * @return boolean Returns the reversed.
1052
     */
1053
    public function getReversed() {
1054
        return $this->reversed;
1055
    }
1056
1057
    /**
1058
     * Get the show empty.
1059
     *
1060
     * @return boolean Returns the show empty.
1061
     */
1062
    public function getShowEmpty() {
1063
        return $this->showEmpty;
1064
    }
1065
1066
    /**
1067
     * Get the show first label.
1068
     *
1069
     * @return boolean Returns the show first label.
1070
     */
1071
    public function getShowFirstLabel() {
1072
        return $this->showFirstLabel;
1073
    }
1074
1075
    /**
1076
     * Get the show last label.
1077
     *
1078
     * @return boolean Returns the show last label.
1079
     */
1080
    public function getShowLastLabel() {
1081
        return $this->showLastLabel;
1082
    }
1083
1084
    /**
1085
     * Get the soft max.
1086
     *
1087
     * @return integer Returns the soft max.
1088
     */
1089
    public function getSoftMax() {
1090
        return $this->softMax;
1091
    }
1092
1093
    /**
1094
     * Get the soft min.
1095
     *
1096
     * @return integer Returns the soft min.
1097
     */
1098
    public function getSoftMin() {
1099
        return $this->softMin;
1100
    }
1101
1102
    /**
1103
     * Get the start of week.
1104
     *
1105
     * @return integer Returns the start of week.
1106
     */
1107
    public function getStartOfWeek() {
1108
        return $this->startOfWeek;
1109
    }
1110
1111
    /**
1112
     * Get the start on tick.
1113
     *
1114
     * @return boolean Returns the start on tick.
1115
     */
1116
    public function getStartOnTick() {
1117
        return $this->startOnTick;
1118
    }
1119
1120
    /**
1121
     * Get the tick amount.
1122
     *
1123
     * @return integer Returns the tick amount.
1124
     */
1125
    public function getTickAmount() {
1126
        return $this->tickAmount;
1127
    }
1128
1129
    /**
1130
     * Get the tick color.
1131
     *
1132
     * @return string Returns the tick color.
1133
     */
1134
    public function getTickColor() {
1135
        return $this->tickColor;
1136
    }
1137
1138
    /**
1139
     * Get the tick interval.
1140
     *
1141
     * @return integer Returns the tick interval.
1142
     */
1143
    public function getTickInterval() {
1144
        return $this->tickInterval;
1145
    }
1146
1147
    /**
1148
     * Get the tick length.
1149
     *
1150
     * @return integer Returns the tick length.
1151
     */
1152
    public function getTickLength() {
1153
        return $this->tickLength;
1154
    }
1155
1156
    /**
1157
     * Get the tick pixel interval.
1158
     *
1159
     * @return integer Returns the tick pixel interval.
1160
     */
1161
    public function getTickPixelInterval() {
1162
        return $this->tickPixelInterval;
1163
    }
1164
1165
    /**
1166
     * Get the tick position.
1167
     *
1168
     * @return string Returns the tick position.
1169
     */
1170
    public function getTickPosition() {
1171
        return $this->tickPosition;
1172
    }
1173
1174
    /**
1175
     * Get the tick positioner.
1176
     *
1177
     * @return string Returns the tick positioner.
1178
     */
1179
    public function getTickPositioner() {
1180
        return $this->tickPositioner;
1181
    }
1182
1183
    /**
1184
     * Get the tick positions.
1185
     *
1186
     * @return array Returns the tick positions.
1187
     */
1188
    public function getTickPositions() {
1189
        return $this->tickPositions;
1190
    }
1191
1192
    /**
1193
     * Get the tick width.
1194
     *
1195
     * @return integer Returns the tick width.
1196
     */
1197
    public function getTickWidth() {
1198
        return $this->tickWidth;
1199
    }
1200
1201
    /**
1202
     * Get the tickmark placement.
1203
     *
1204
     * @return string Returns the tickmark placement.
1205
     */
1206
    public function getTickmarkPlacement() {
1207
        return $this->tickmarkPlacement;
1208
    }
1209
1210
    /**
1211
     * Get the title.
1212
     *
1213
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsTitle Returns the title.
1214
     */
1215
    public function getTitle() {
1216
        return $this->title;
1217
    }
1218
1219
    /**
1220
     * Get the type.
1221
     *
1222
     * @return string Returns the type.
1223
     */
1224
    public function getType() {
1225
        return $this->type;
1226
    }
1227
1228
    /**
1229
     * Get the unique names.
1230
     *
1231
     * @return boolean Returns the unique names.
1232
     */
1233
    public function getUniqueNames() {
1234
        return $this->uniqueNames;
1235
    }
1236
1237
    /**
1238
     * Get the units.
1239
     *
1240
     * @return array Returns the units.
1241
     */
1242
    public function getUnits() {
1243
        return $this->units;
1244
    }
1245
1246
    /**
1247
     * Get the visible.
1248
     *
1249
     * @return boolean Returns the visible.
1250
     */
1251
    public function getVisible() {
1252
        return $this->visible;
1253
    }
1254
1255
    /**
1256
     * Serialize this instance.
1257
     *
1258
     * @return array Returns an array representing this instance.
1259
     */
1260
    public function jsonSerialize() {
1261
        return $this->toArray();
1262
    }
1263
1264
    /**
1265
     * Create a new crosshair.
1266
     *
1267
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsCrosshair Returns the crosshair.
1268
     */
1269
    public function newCrosshair() {
1270
        $this->crosshair = new \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsCrosshair();
1271
        return $this->crosshair;
1272
    }
1273
1274
    /**
1275
     * Create a new events.
1276
     *
1277
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsEvents Returns the events.
1278
     */
1279
    public function newEvents() {
1280
        $this->events = new \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsEvents();
1281
        return $this->events;
1282
    }
1283
1284
    /**
1285
     * Create a new labels.
1286
     *
1287
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsLabels Returns the labels.
1288
     */
1289
    public function newLabels() {
1290
        $this->labels = new \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsLabels();
1291
        return $this->labels;
1292
    }
1293
1294
    /**
1295
     * Create a new title.
1296
     *
1297
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsTitle Returns the title.
1298
     */
1299
    public function newTitle() {
1300
        $this->title = new \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsTitle();
1301
        return $this->title;
1302
    }
1303
1304
    /**
1305
     * Set the allow decimals.
1306
     *
1307
     * @param boolean $allowDecimals The allow decimals.
1308
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1309
     */
1310
    public function setAllowDecimals($allowDecimals) {
1311
        $this->allowDecimals = $allowDecimals;
1312
        return $this;
1313
    }
1314
1315
    /**
1316
     * Set the alternate grid color.
1317
     *
1318
     * @param string $alternateGridColor The alternate grid color.
1319
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1320
     */
1321
    public function setAlternateGridColor($alternateGridColor) {
1322
        $this->alternateGridColor = $alternateGridColor;
1323
        return $this;
1324
    }
1325
1326
    /**
1327
     * Set the categories.
1328
     *
1329
     * @param array $categories The categories.
1330
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1331
     */
1332
    public function setCategories(array $categories = null) {
1333
        $this->categories = $categories;
0 ignored issues
show
Documentation Bug introduced by
It seems like $categories can be null. However, the property $categories 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...
1334
        return $this;
1335
    }
1336
1337
    /**
1338
     * Set the ceiling.
1339
     *
1340
     * @param integer $ceiling The ceiling.
1341
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1342
     */
1343
    public function setCeiling($ceiling) {
1344
        $this->ceiling = $ceiling;
1345
        return $this;
1346
    }
1347
1348
    /**
1349
     * Set the class name.
1350
     *
1351
     * @param string $className The class name.
1352
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1353
     */
1354
    public function setClassName($className) {
1355
        $this->className = $className;
1356
        return $this;
1357
    }
1358
1359
    /**
1360
     * Set the crosshair.
1361
     *
1362
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsCrosshair $crosshair The crosshair.
1363
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1364
     */
1365
    public function setCrosshair(\WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsCrosshair $crosshair = null) {
1366
        $this->crosshair = $crosshair;
1367
        return $this;
1368
    }
1369
1370
    /**
1371
     * Set the date time label formats.
1372
     *
1373
     * @param array $dateTimeLabelFormats The date time label formats.
1374
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1375
     */
1376
    public function setDateTimeLabelFormats(array $dateTimeLabelFormats = null) {
1377
        $this->dateTimeLabelFormats = $dateTimeLabelFormats;
0 ignored issues
show
Documentation Bug introduced by
It seems like $dateTimeLabelFormats can be null. However, the property $dateTimeLabelFormats 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...
1378
        return $this;
1379
    }
1380
1381
    /**
1382
     * Set the description.
1383
     *
1384
     * @param string $description The description.
1385
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1386
     */
1387
    public function setDescription($description) {
1388
        $this->description = $description;
1389
        return $this;
1390
    }
1391
1392
    /**
1393
     * Set the end on tick.
1394
     *
1395
     * @param boolean $endOnTick The end on tick.
1396
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1397
     */
1398
    public function setEndOnTick($endOnTick) {
1399
        $this->endOnTick = $endOnTick;
1400
        return $this;
1401
    }
1402
1403
    /**
1404
     * Set the events.
1405
     *
1406
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsEvents $events The events.
1407
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1408
     */
1409
    public function setEvents(\WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsEvents $events = null) {
1410
        $this->events = $events;
1411
        return $this;
1412
    }
1413
1414
    /**
1415
     * Set the floor.
1416
     *
1417
     * @param integer $floor The floor.
1418
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1419
     */
1420
    public function setFloor($floor) {
1421
        $this->floor = $floor;
1422
        return $this;
1423
    }
1424
1425
    /**
1426
     * Set the grid line color.
1427
     *
1428
     * @param string $gridLineColor The grid line color.
1429
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1430
     */
1431
    public function setGridLineColor($gridLineColor) {
1432
        $this->gridLineColor = $gridLineColor;
1433
        return $this;
1434
    }
1435
1436
    /**
1437
     * Set the grid line dash style.
1438
     *
1439
     * @param string $gridLineDashStyle The grid line dash style.
1440
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1441
     */
1442
    public function setGridLineDashStyle($gridLineDashStyle) {
1443
        switch ($gridLineDashStyle) {
1444
            case "Dash":
1445
            case "DashDot":
1446
            case "Dot":
1447
            case "LongDash":
1448
            case "LongDashDot":
1449
            case "LongDashDotDot":
1450
            case "ShortDash":
1451
            case "ShortDashDot":
1452
            case "ShortDashDotDot":
1453
            case "ShortDot":
1454
            case "Solid":
1455
            $this->gridLineDashStyle = $gridLineDashStyle;
1456
            break;
1457
        }
1458
        return $this;
1459
    }
1460
1461
    /**
1462
     * Set the grid line width.
1463
     *
1464
     * @param integer $gridLineWidth The grid line width.
1465
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1466
     */
1467
    public function setGridLineWidth($gridLineWidth) {
1468
        $this->gridLineWidth = $gridLineWidth;
1469
        return $this;
1470
    }
1471
1472
    /**
1473
     * Set the grid z index.
1474
     *
1475
     * @param integer $gridZIndex The grid z index.
1476
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1477
     */
1478
    public function setGridZIndex($gridZIndex) {
1479
        $this->gridZIndex = $gridZIndex;
1480
        return $this;
1481
    }
1482
1483
    /**
1484
     * Set the id.
1485
     *
1486
     * @param string $id The id.
1487
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1488
     */
1489
    public function setId($id) {
1490
        $this->id = $id;
1491
        return $this;
1492
    }
1493
1494
    /**
1495
     * Set the labels.
1496
     *
1497
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsLabels $labels The labels.
1498
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1499
     */
1500
    public function setLabels(\WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsLabels $labels = null) {
1501
        $this->labels = $labels;
1502
        return $this;
1503
    }
1504
1505
    /**
1506
     * Set the line color.
1507
     *
1508
     * @param string $lineColor The line color.
1509
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1510
     */
1511
    public function setLineColor($lineColor) {
1512
        $this->lineColor = $lineColor;
1513
        return $this;
1514
    }
1515
1516
    /**
1517
     * Set the line width.
1518
     *
1519
     * @param integer $lineWidth The line width.
1520
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1521
     */
1522
    public function setLineWidth($lineWidth) {
1523
        $this->lineWidth = $lineWidth;
1524
        return $this;
1525
    }
1526
1527
    /**
1528
     * Set the linked to.
1529
     *
1530
     * @param integer $linkedTo The linked to.
1531
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1532
     */
1533
    public function setLinkedTo($linkedTo) {
1534
        $this->linkedTo = $linkedTo;
1535
        return $this;
1536
    }
1537
1538
    /**
1539
     * Set the max.
1540
     *
1541
     * @param integer $max The max.
1542
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1543
     */
1544
    public function setMax($max) {
1545
        $this->max = $max;
1546
        return $this;
1547
    }
1548
1549
    /**
1550
     * Set the max padding.
1551
     *
1552
     * @param integer $maxPadding The max padding.
1553
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1554
     */
1555
    public function setMaxPadding($maxPadding) {
1556
        $this->maxPadding = $maxPadding;
1557
        return $this;
1558
    }
1559
1560
    /**
1561
     * Set the max zoom.
1562
     *
1563
     * @param integer $maxZoom The max zoom.
1564
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1565
     * @deprecated
1566
     */
1567
    public function setMaxZoom($maxZoom) {
1568
        $this->maxZoom = $maxZoom;
0 ignored issues
show
Deprecated Code introduced by
The property WBW\Bundle\HighchartsBun...ghchartsZAxis::$maxZoom has been deprecated.

This property has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead.

Loading history...
1569
        return $this;
1570
    }
1571
1572
    /**
1573
     * Set the min.
1574
     *
1575
     * @param integer $min The min.
1576
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1577
     */
1578
    public function setMin($min) {
1579
        $this->min = $min;
1580
        return $this;
1581
    }
1582
1583
    /**
1584
     * Set the min padding.
1585
     *
1586
     * @param integer $minPadding The min padding.
1587
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1588
     */
1589
    public function setMinPadding($minPadding) {
1590
        $this->minPadding = $minPadding;
1591
        return $this;
1592
    }
1593
1594
    /**
1595
     * Set the min range.
1596
     *
1597
     * @param integer $minRange The min range.
1598
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1599
     */
1600
    public function setMinRange($minRange) {
1601
        $this->minRange = $minRange;
1602
        return $this;
1603
    }
1604
1605
    /**
1606
     * Set the min tick interval.
1607
     *
1608
     * @param integer $minTickInterval The min tick interval.
1609
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1610
     */
1611
    public function setMinTickInterval($minTickInterval) {
1612
        $this->minTickInterval = $minTickInterval;
1613
        return $this;
1614
    }
1615
1616
    /**
1617
     * Set the minor grid line color.
1618
     *
1619
     * @param string $minorGridLineColor The minor grid line color.
1620
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1621
     */
1622
    public function setMinorGridLineColor($minorGridLineColor) {
1623
        $this->minorGridLineColor = $minorGridLineColor;
1624
        return $this;
1625
    }
1626
1627
    /**
1628
     * Set the minor grid line dash style.
1629
     *
1630
     * @param string $minorGridLineDashStyle The minor grid line dash style.
1631
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1632
     */
1633
    public function setMinorGridLineDashStyle($minorGridLineDashStyle) {
1634
        switch ($minorGridLineDashStyle) {
1635
            case "Dash":
1636
            case "DashDot":
1637
            case "Dot":
1638
            case "LongDash":
1639
            case "LongDashDot":
1640
            case "LongDashDotDot":
1641
            case "ShortDash":
1642
            case "ShortDashDot":
1643
            case "ShortDashDotDot":
1644
            case "ShortDot":
1645
            case "Solid":
1646
            $this->minorGridLineDashStyle = $minorGridLineDashStyle;
1647
            break;
1648
        }
1649
        return $this;
1650
    }
1651
1652
    /**
1653
     * Set the minor grid line width.
1654
     *
1655
     * @param integer $minorGridLineWidth The minor grid line width.
1656
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1657
     */
1658
    public function setMinorGridLineWidth($minorGridLineWidth) {
1659
        $this->minorGridLineWidth = $minorGridLineWidth;
1660
        return $this;
1661
    }
1662
1663
    /**
1664
     * Set the minor tick color.
1665
     *
1666
     * @param string $minorTickColor The minor tick color.
1667
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1668
     */
1669
    public function setMinorTickColor($minorTickColor) {
1670
        $this->minorTickColor = $minorTickColor;
1671
        return $this;
1672
    }
1673
1674
    /**
1675
     * Set the minor tick interval.
1676
     *
1677
     * @param string|integer $minorTickInterval The minor tick interval.
1678
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1679
     */
1680
    public function setMinorTickInterval($minorTickInterval) {
1681
        $this->minorTickInterval = $minorTickInterval;
1682
        return $this;
1683
    }
1684
1685
    /**
1686
     * Set the minor tick length.
1687
     *
1688
     * @param integer $minorTickLength The minor tick length.
1689
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1690
     */
1691
    public function setMinorTickLength($minorTickLength) {
1692
        $this->minorTickLength = $minorTickLength;
1693
        return $this;
1694
    }
1695
1696
    /**
1697
     * Set the minor tick position.
1698
     *
1699
     * @param string $minorTickPosition The minor tick position.
1700
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1701
     */
1702
    public function setMinorTickPosition($minorTickPosition) {
1703
        switch ($minorTickPosition) {
1704
            case "inside":
1705
            case "outside":
1706
            $this->minorTickPosition = $minorTickPosition;
1707
            break;
1708
        }
1709
        return $this;
1710
    }
1711
1712
    /**
1713
     * Set the minor tick width.
1714
     *
1715
     * @param integer $minorTickWidth The minor tick width.
1716
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1717
     */
1718
    public function setMinorTickWidth($minorTickWidth) {
1719
        $this->minorTickWidth = $minorTickWidth;
1720
        return $this;
1721
    }
1722
1723
    /**
1724
     * Set the offset.
1725
     *
1726
     * @param integer $offset The offset.
1727
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1728
     */
1729
    public function setOffset($offset) {
1730
        $this->offset = $offset;
1731
        return $this;
1732
    }
1733
1734
    /**
1735
     * Set the opposite.
1736
     *
1737
     * @param boolean $opposite The opposite.
1738
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1739
     */
1740
    public function setOpposite($opposite) {
1741
        $this->opposite = $opposite;
1742
        return $this;
1743
    }
1744
1745
    /**
1746
     * Set the plot bands.
1747
     *
1748
     * @param array $plotBands The plot bands.
1749
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1750
     */
1751
    public function setPlotBands(array $plotBands = null) {
1752
        $this->plotBands = $plotBands;
0 ignored issues
show
Documentation Bug introduced by
It seems like $plotBands can be null. However, the property $plotBands 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...
1753
        return $this;
1754
    }
1755
1756
    /**
1757
     * Set the plot lines.
1758
     *
1759
     * @param array $plotLines The plot lines.
1760
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1761
     */
1762
    public function setPlotLines(array $plotLines = null) {
1763
        $this->plotLines = $plotLines;
0 ignored issues
show
Documentation Bug introduced by
It seems like $plotLines can be null. However, the property $plotLines 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...
1764
        return $this;
1765
    }
1766
1767
    /**
1768
     * Set the reversed.
1769
     *
1770
     * @param boolean $reversed The reversed.
1771
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1772
     */
1773
    public function setReversed($reversed) {
1774
        $this->reversed = $reversed;
1775
        return $this;
1776
    }
1777
1778
    /**
1779
     * Set the show empty.
1780
     *
1781
     * @param boolean $showEmpty The show empty.
1782
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1783
     */
1784
    public function setShowEmpty($showEmpty) {
1785
        $this->showEmpty = $showEmpty;
1786
        return $this;
1787
    }
1788
1789
    /**
1790
     * Set the show first label.
1791
     *
1792
     * @param boolean $showFirstLabel The show first label.
1793
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1794
     */
1795
    public function setShowFirstLabel($showFirstLabel) {
1796
        $this->showFirstLabel = $showFirstLabel;
1797
        return $this;
1798
    }
1799
1800
    /**
1801
     * Set the show last label.
1802
     *
1803
     * @param boolean $showLastLabel The show last label.
1804
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1805
     */
1806
    public function setShowLastLabel($showLastLabel) {
1807
        $this->showLastLabel = $showLastLabel;
1808
        return $this;
1809
    }
1810
1811
    /**
1812
     * Set the soft max.
1813
     *
1814
     * @param integer $softMax The soft max.
1815
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1816
     */
1817
    public function setSoftMax($softMax) {
1818
        $this->softMax = $softMax;
1819
        return $this;
1820
    }
1821
1822
    /**
1823
     * Set the soft min.
1824
     *
1825
     * @param integer $softMin The soft min.
1826
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1827
     */
1828
    public function setSoftMin($softMin) {
1829
        $this->softMin = $softMin;
1830
        return $this;
1831
    }
1832
1833
    /**
1834
     * Set the start of week.
1835
     *
1836
     * @param integer $startOfWeek The start of week.
1837
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1838
     */
1839
    public function setStartOfWeek($startOfWeek) {
1840
        $this->startOfWeek = $startOfWeek;
1841
        return $this;
1842
    }
1843
1844
    /**
1845
     * Set the start on tick.
1846
     *
1847
     * @param boolean $startOnTick The start on tick.
1848
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1849
     */
1850
    public function setStartOnTick($startOnTick) {
1851
        $this->startOnTick = $startOnTick;
1852
        return $this;
1853
    }
1854
1855
    /**
1856
     * Set the tick amount.
1857
     *
1858
     * @param integer $tickAmount The tick amount.
1859
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1860
     */
1861
    public function setTickAmount($tickAmount) {
1862
        $this->tickAmount = $tickAmount;
1863
        return $this;
1864
    }
1865
1866
    /**
1867
     * Set the tick color.
1868
     *
1869
     * @param string $tickColor The tick color.
1870
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1871
     */
1872
    public function setTickColor($tickColor) {
1873
        $this->tickColor = $tickColor;
1874
        return $this;
1875
    }
1876
1877
    /**
1878
     * Set the tick interval.
1879
     *
1880
     * @param integer $tickInterval The tick interval.
1881
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1882
     */
1883
    public function setTickInterval($tickInterval) {
1884
        $this->tickInterval = $tickInterval;
1885
        return $this;
1886
    }
1887
1888
    /**
1889
     * Set the tick length.
1890
     *
1891
     * @param integer $tickLength The tick length.
1892
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1893
     */
1894
    public function setTickLength($tickLength) {
1895
        $this->tickLength = $tickLength;
1896
        return $this;
1897
    }
1898
1899
    /**
1900
     * Set the tick pixel interval.
1901
     *
1902
     * @param integer $tickPixelInterval The tick pixel interval.
1903
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1904
     */
1905
    public function setTickPixelInterval($tickPixelInterval) {
1906
        $this->tickPixelInterval = $tickPixelInterval;
1907
        return $this;
1908
    }
1909
1910
    /**
1911
     * Set the tick position.
1912
     *
1913
     * @param string $tickPosition The tick position.
1914
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1915
     */
1916
    public function setTickPosition($tickPosition) {
1917
        switch ($tickPosition) {
1918
            case "inside":
1919
            case "outside":
1920
            $this->tickPosition = $tickPosition;
1921
            break;
1922
        }
1923
        return $this;
1924
    }
1925
1926
    /**
1927
     * Set the tick positioner.
1928
     *
1929
     * @param string $tickPositioner The tick positioner.
1930
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1931
     */
1932
    public function setTickPositioner($tickPositioner) {
1933
        $this->tickPositioner = $tickPositioner;
1934
        return $this;
1935
    }
1936
1937
    /**
1938
     * Set the tick positions.
1939
     *
1940
     * @param array $tickPositions The tick positions.
1941
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1942
     */
1943
    public function setTickPositions(array $tickPositions = null) {
1944
        $this->tickPositions = $tickPositions;
0 ignored issues
show
Documentation Bug introduced by
It seems like $tickPositions can be null. However, the property $tickPositions 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...
1945
        return $this;
1946
    }
1947
1948
    /**
1949
     * Set the tick width.
1950
     *
1951
     * @param integer $tickWidth The tick width.
1952
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1953
     */
1954
    public function setTickWidth($tickWidth) {
1955
        $this->tickWidth = $tickWidth;
1956
        return $this;
1957
    }
1958
1959
    /**
1960
     * Set the tickmark placement.
1961
     *
1962
     * @param string $tickmarkPlacement The tickmark placement.
1963
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1964
     */
1965
    public function setTickmarkPlacement($tickmarkPlacement) {
1966
        switch ($tickmarkPlacement) {
1967
            case null:
1968
            case "between":
1969
            case "on":
1970
            $this->tickmarkPlacement = $tickmarkPlacement;
1971
            break;
1972
        }
1973
        return $this;
1974
    }
1975
1976
    /**
1977
     * Set the title.
1978
     *
1979
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsTitle $title The title.
1980
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1981
     */
1982
    public function setTitle(\WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsTitle $title = null) {
1983
        $this->title = $title;
1984
        return $this;
1985
    }
1986
1987
    /**
1988
     * Set the type.
1989
     *
1990
     * @param string $type The type.
1991
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
1992
     */
1993
    public function setType($type) {
1994
        switch ($type) {
1995
            case "category":
1996
            case "datetime":
1997
            case "linear":
1998
            case "logarithmic":
1999
            $this->type = $type;
2000
            break;
2001
        }
2002
        return $this;
2003
    }
2004
2005
    /**
2006
     * Set the unique names.
2007
     *
2008
     * @param boolean $uniqueNames The unique names.
2009
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
2010
     */
2011
    public function setUniqueNames($uniqueNames) {
2012
        $this->uniqueNames = $uniqueNames;
2013
        return $this;
2014
    }
2015
2016
    /**
2017
     * Set the units.
2018
     *
2019
     * @param array $units The units.
2020
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
2021
     */
2022
    public function setUnits(array $units = null) {
2023
        $this->units = $units;
0 ignored issues
show
Documentation Bug introduced by
It seems like $units can be null. However, the property $units 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...
2024
        return $this;
2025
    }
2026
2027
    /**
2028
     * Set the visible.
2029
     *
2030
     * @param boolean $visible The visible.
2031
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsZAxis Returns the highcharts z axis.
2032
     */
2033
    public function setVisible($visible) {
2034
        $this->visible = $visible;
2035
        return $this;
2036
    }
2037
2038
    /**
2039
     * Convert into an array representing this instance.
2040
     *
2041
     * @return array Returns an array representing this instance.
2042
     */
2043
    public function toArray() {
2044
2045
        // Initialize the output.
2046
        $output = [];
2047
2048
        // Set the allow decimals.
2049
        ArrayUtility::set($output, "allowDecimals", $this->allowDecimals, [null]);
2050
2051
        // Set the alternate grid color.
2052
        ArrayUtility::set($output, "alternateGridColor", $this->alternateGridColor, [null]);
2053
2054
        // Set the categories.
2055
        ArrayUtility::set($output, "categories", $this->categories, [null]);
2056
2057
        // Set the ceiling.
2058
        ArrayUtility::set($output, "ceiling", $this->ceiling, [null]);
2059
2060
        // Set the class name.
2061
        ArrayUtility::set($output, "className", $this->className, [null]);
2062
2063
        // Set the crosshair.
2064
        if (null !== $this->crosshair) {
2065
            ArrayUtility::set($output, "crosshair", $this->crosshair->toArray(), []);
2066
        }
2067
2068
        // Set the date time label formats.
2069
        ArrayUtility::set($output, "dateTimeLabelFormats", $this->dateTimeLabelFormats, [null]);
2070
2071
        // Set the description.
2072
        ArrayUtility::set($output, "description", $this->description, [null]);
2073
2074
        // Set the end on tick.
2075
        ArrayUtility::set($output, "endOnTick", $this->endOnTick, [null]);
2076
2077
        // Set the events.
2078
        if (null !== $this->events) {
2079
            ArrayUtility::set($output, "events", $this->events->toArray(), []);
2080
        }
2081
2082
        // Set the floor.
2083
        ArrayUtility::set($output, "floor", $this->floor, [null]);
2084
2085
        // Set the grid line color.
2086
        ArrayUtility::set($output, "gridLineColor", $this->gridLineColor, [null]);
2087
2088
        // Set the grid line dash style.
2089
        ArrayUtility::set($output, "gridLineDashStyle", $this->gridLineDashStyle, [null]);
2090
2091
        // Set the grid line width.
2092
        ArrayUtility::set($output, "gridLineWidth", $this->gridLineWidth, [null]);
2093
2094
        // Set the grid z index.
2095
        ArrayUtility::set($output, "gridZIndex", $this->gridZIndex, [null]);
2096
2097
        // Set the id.
2098
        ArrayUtility::set($output, "id", $this->id, [null]);
2099
2100
        // Set the labels.
2101
        if (null !== $this->labels) {
2102
            ArrayUtility::set($output, "labels", $this->labels->toArray(), []);
2103
        }
2104
2105
        // Set the line color.
2106
        ArrayUtility::set($output, "lineColor", $this->lineColor, [null]);
2107
2108
        // Set the line width.
2109
        ArrayUtility::set($output, "lineWidth", $this->lineWidth, [null]);
2110
2111
        // Set the linked to.
2112
        ArrayUtility::set($output, "linkedTo", $this->linkedTo, [null]);
2113
2114
        // Set the max.
2115
        ArrayUtility::set($output, "max", $this->max, [null]);
2116
2117
        // Set the max padding.
2118
        ArrayUtility::set($output, "maxPadding", $this->maxPadding, [null]);
2119
2120
        // Set the max zoom.
2121
        ArrayUtility::set($output, "maxZoom", $this->maxZoom, [null]);
0 ignored issues
show
Deprecated Code introduced by
The property WBW\Bundle\HighchartsBun...ghchartsZAxis::$maxZoom has been deprecated.

This property has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead.

Loading history...
2122
2123
        // Set the min.
2124
        ArrayUtility::set($output, "min", $this->min, [null]);
2125
2126
        // Set the min padding.
2127
        ArrayUtility::set($output, "minPadding", $this->minPadding, [null]);
2128
2129
        // Set the min range.
2130
        ArrayUtility::set($output, "minRange", $this->minRange, [null]);
2131
2132
        // Set the min tick interval.
2133
        ArrayUtility::set($output, "minTickInterval", $this->minTickInterval, [null]);
2134
2135
        // Set the minor grid line color.
2136
        ArrayUtility::set($output, "minorGridLineColor", $this->minorGridLineColor, [null]);
2137
2138
        // Set the minor grid line dash style.
2139
        ArrayUtility::set($output, "minorGridLineDashStyle", $this->minorGridLineDashStyle, [null]);
2140
2141
        // Set the minor grid line width.
2142
        ArrayUtility::set($output, "minorGridLineWidth", $this->minorGridLineWidth, [null]);
2143
2144
        // Set the minor tick color.
2145
        ArrayUtility::set($output, "minorTickColor", $this->minorTickColor, [null]);
2146
2147
        // Set the minor tick interval.
2148
        ArrayUtility::set($output, "minorTickInterval", $this->minorTickInterval, [null]);
2149
2150
        // Set the minor tick length.
2151
        ArrayUtility::set($output, "minorTickLength", $this->minorTickLength, [null]);
2152
2153
        // Set the minor tick position.
2154
        ArrayUtility::set($output, "minorTickPosition", $this->minorTickPosition, [null]);
2155
2156
        // Set the minor tick width.
2157
        ArrayUtility::set($output, "minorTickWidth", $this->minorTickWidth, [null]);
2158
2159
        // Set the offset.
2160
        ArrayUtility::set($output, "offset", $this->offset, [null]);
2161
2162
        // Set the opposite.
2163
        ArrayUtility::set($output, "opposite", $this->opposite, [null]);
2164
2165
        // Set the plot bands.
2166
        ArrayUtility::set($output, "plotBands", $this->plotBands, [null]);
2167
2168
        // Set the plot lines.
2169
        ArrayUtility::set($output, "plotLines", $this->plotLines, [null]);
2170
2171
        // Set the reversed.
2172
        ArrayUtility::set($output, "reversed", $this->reversed, [null]);
2173
2174
        // Set the show empty.
2175
        ArrayUtility::set($output, "showEmpty", $this->showEmpty, [null]);
2176
2177
        // Set the show first label.
2178
        ArrayUtility::set($output, "showFirstLabel", $this->showFirstLabel, [null]);
2179
2180
        // Set the show last label.
2181
        ArrayUtility::set($output, "showLastLabel", $this->showLastLabel, [null]);
2182
2183
        // Set the soft max.
2184
        ArrayUtility::set($output, "softMax", $this->softMax, [null]);
2185
2186
        // Set the soft min.
2187
        ArrayUtility::set($output, "softMin", $this->softMin, [null]);
2188
2189
        // Set the start of week.
2190
        ArrayUtility::set($output, "startOfWeek", $this->startOfWeek, [null]);
2191
2192
        // Set the start on tick.
2193
        ArrayUtility::set($output, "startOnTick", $this->startOnTick, [null]);
2194
2195
        // Set the tick amount.
2196
        ArrayUtility::set($output, "tickAmount", $this->tickAmount, [null]);
2197
2198
        // Set the tick color.
2199
        ArrayUtility::set($output, "tickColor", $this->tickColor, [null]);
2200
2201
        // Set the tick interval.
2202
        ArrayUtility::set($output, "tickInterval", $this->tickInterval, [null]);
2203
2204
        // Set the tick length.
2205
        ArrayUtility::set($output, "tickLength", $this->tickLength, [null]);
2206
2207
        // Set the tick pixel interval.
2208
        ArrayUtility::set($output, "tickPixelInterval", $this->tickPixelInterval, [null]);
2209
2210
        // Set the tick position.
2211
        ArrayUtility::set($output, "tickPosition", $this->tickPosition, [null]);
2212
2213
        // Set the tick positioner.
2214
        ArrayUtility::set($output, "tickPositioner", $this->tickPositioner, [null]);
2215
2216
        // Set the tick positions.
2217
        ArrayUtility::set($output, "tickPositions", $this->tickPositions, [null]);
2218
2219
        // Set the tick width.
2220
        ArrayUtility::set($output, "tickWidth", $this->tickWidth, [null]);
2221
2222
        // Set the tickmark placement.
2223
        ArrayUtility::set($output, "tickmarkPlacement", $this->tickmarkPlacement, [null]);
2224
2225
        // Set the title.
2226
        if (null !== $this->title) {
2227
            ArrayUtility::set($output, "title", $this->title->toArray(), []);
2228
        }
2229
2230
        // Set the type.
2231
        ArrayUtility::set($output, "type", $this->type, [null]);
2232
2233
        // Set the unique names.
2234
        ArrayUtility::set($output, "uniqueNames", $this->uniqueNames, [null]);
2235
2236
        // Set the units.
2237
        ArrayUtility::set($output, "units", $this->units, [null]);
2238
2239
        // Set the visible.
2240
        ArrayUtility::set($output, "visible", $this->visible, [null]);
2241
2242
        // Return the output.
2243
        return $output;
2244
    }
2245
2246
}
2247