-
Notifications
You must be signed in to change notification settings - Fork 954
/
Axis.cs
1935 lines (1648 loc) · 75.9 KB
/
Axis.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// --------------------------------------------------------------------------------------------------------------------
// <copyright file="Axis.cs" company="OxyPlot">
// Copyright (c) 2014 OxyPlot contributors
// </copyright>
// <summary>
// Provides an abstract base class for axes.
// </summary>
// --------------------------------------------------------------------------------------------------------------------
namespace OxyPlot.Axes
{
using System;
using System.Collections.Generic;
using System.Linq;
using OxyPlot.Series;
using OxyPlot.Utilities;
/// <summary>
/// Provides an abstract base class for axes.
/// </summary>
public abstract class Axis : PlotElement
{
/// <summary>
/// Exponent function.
/// </summary>
protected static readonly Func<double, double> Exponent = x => Math.Floor(ThresholdRound(Math.Log(Math.Abs(x), 10)));
/// <summary>
/// Mantissa function.
/// </summary>
protected static readonly Func<double, double> Mantissa = x => ThresholdRound(x / Math.Pow(10, Exponent(x)));
/// <summary>
/// Rounds a value if the difference between the rounded value and the original value is less than 1e-6.
/// </summary>
protected static readonly Func<double, double> ThresholdRound = x => Math.Abs(Math.Round(x) - x) < 1e-6 ? Math.Round(x) : x;
/// <summary>
/// The offset.
/// </summary>
private double offset;
/// <summary>
/// The scale.
/// </summary>
private double scale;
/// <summary>
/// The position of the axis.
/// </summary>
private AxisPosition position;
/// <summary>
/// Initializes a new instance of the <see cref="Axis" /> class.
/// </summary>
protected Axis()
{
this.Position = AxisPosition.Left;
this.PositionTier = 0;
this.IsAxisVisible = true;
this.Layer = AxisLayer.BelowSeries;
this.ViewMaximum = double.NaN;
this.ViewMinimum = double.NaN;
this.AbsoluteMaximum = double.MaxValue;
this.AbsoluteMinimum = double.MinValue;
this.Minimum = double.NaN;
this.Maximum = double.NaN;
this.MinorStep = double.NaN;
this.MajorStep = double.NaN;
this.MinimumMinorStep = 0;
this.MinimumMajorStep = 0;
this.MinimumMajorIntervalCount = 2;
this.MaximumMajorIntervalCount = double.MaxValue;
this.MinimumPadding = 0.01;
this.MaximumPadding = 0.01;
this.MinimumRange = 0;
this.MaximumRange = double.PositiveInfinity;
this.MinimumDataMargin = 0;
this.MaximumDataMargin = 0;
this.MinimumMargin = 0;
this.MaximumMargin = 0;
this.TickStyle = TickStyle.Outside;
this.TicklineColor = OxyColors.Black;
this.MinorTicklineColor = OxyColors.Automatic;
this.AxislineStyle = LineStyle.None;
this.AxislineColor = OxyColors.Black;
this.AxislineThickness = 1.0;
this.MajorGridlineStyle = LineStyle.None;
this.MajorGridlineColor = OxyColor.FromArgb(0x40, 0, 0, 0);
this.MajorGridlineThickness = 1;
this.MinorGridlineStyle = LineStyle.None;
this.MinorGridlineColor = OxyColor.FromArgb(0x20, 0, 0, 0x00);
this.MinorGridlineThickness = 1;
this.ExtraGridlineStyle = LineStyle.Solid;
this.ExtraGridlineColor = OxyColors.Black;
this.ExtraGridlineThickness = 1;
this.MinorTickSize = 4;
this.MajorTickSize = 7;
this.StartPosition = 0;
this.EndPosition = 1;
this.TitlePosition = 0.5;
this.TitleFormatString = "{0} [{1}]";
this.TitleClippingLength = 0.9;
this.TitleColor = OxyColors.Automatic;
this.TitleFontSize = double.NaN;
this.TitleFontWeight = FontWeights.Normal;
this.ClipTitle = true;
this.Angle = 0;
this.IsZoomEnabled = true;
this.IsPanEnabled = true;
this.FilterMinValue = double.MinValue;
this.FilterMaxValue = double.MaxValue;
this.FilterFunction = null;
this.IntervalLength = 60;
this.AxisDistance = 0;
this.AxisTitleDistance = 4;
this.AxisTickToLabelDistance = 4;
this.DataMaximum = double.NaN;
this.DataMinimum = double.NaN;
}
/// <summary>
/// Occurs when the axis has been changed (by zooming, panning or resetting).
/// </summary>
[Obsolete("May be removed in v4.0 (#111)")]
public event EventHandler<AxisChangedEventArgs> AxisChanged;
/// <summary>
/// Occurs when the transform changed (size or axis range was changed).
/// </summary>
[Obsolete("May be removed in v4.0 (#111)")]
public event EventHandler TransformChanged;
/// <summary>
/// Gets or sets the absolute maximum. This is only used for the UI control. It will not be possible to zoom/pan beyond this limit. The default value is <c>double.MaxValue</c>.
/// </summary>
public double AbsoluteMaximum { get; set; }
/// <summary>
/// Gets or sets the absolute minimum. This is only used for the UI control. It will not be possible to zoom/pan beyond this limit. The default value is <c>double.MinValue</c>.
/// </summary>
public double AbsoluteMinimum { get; set; }
/// <summary>
/// Gets or sets the actual major step.
/// </summary>
public double ActualMajorStep { get; protected set; }
/// <summary>
/// Gets or sets the minimum number of major intervals on the axis.
/// </summary>
/// <remarks>Non-integer values are accepted.</remarks>
public double MinimumMajorIntervalCount { get; set; }
/// <summary>
/// Gets or sets the minimum number of major intervals on the axis.
/// </summary>
/// <remarks>Non-integer values are accepted.
/// The maximum will be bounded acording to the <see cref="IntervalLength" />.
/// The <see cref="MinimumMajorIntervalCount" /> takes precedence over the <see cref="MaximumMajorIntervalCount" /> when determining the major step.</remarks>
public double MaximumMajorIntervalCount { get; set; }
/// <summary>
/// Gets or sets the actual maximum value of the axis.
/// </summary>
/// <remarks>If <see cref="ViewMaximum" /> is not <c>NaN</c>, this value will be defined by <see cref="ViewMaximum" />.
/// Otherwise, if <see cref="Maximum" /> is not <c>NaN</c>, this value will be defined by <see cref="Maximum" />.
/// Otherwise, this value will be defined by the maximum (+padding) of the data.</remarks>
public double ActualMaximum { get; protected set; }
/// <summary>
/// Gets or sets the actual minimum value of the axis.
/// </summary>
/// <remarks>If <see cref="ViewMinimum" /> is not <c>NaN</c>, this value will be defined by <see cref="ViewMinimum" />.
/// Otherwise, if <see cref="Minimum" /> is not <c>NaN</c>, this value will be defined by <see cref="Minimum" />.
/// Otherwise this value will be defined by the minimum (+padding) of the data.</remarks>
public double ActualMinimum { get; protected set; }
/// <summary>
/// Gets or sets the maximum displayed value on the axis, as determined by the <see cref="ActualMaximum"/> and <see cref="MaximumDataMargin"/>.
/// </summary>
/// <remarks>
/// The value is refreshed by <see cref="UpdateTransform(OxyRect)"/>, which is called before any plot elements are rendered.
/// </remarks>
public double ClipMaximum { get; protected set; }
/// <summary>
/// Gets or sets the minimum displayed value on the axis, as determined by the <see cref="ActualMinimum"/> and <see cref="MinimumDataMargin"/>.
/// </summary>
/// <remarks>
/// The value is refreshed by <see cref="UpdateTransform(OxyRect)"/>, which is called before any plot elements are rendered.
/// </remarks>
public double ClipMinimum { get; protected set; }
/// <summary>
/// Gets or sets the actual minor step.
/// </summary>
public double ActualMinorStep { get; protected set; }
/// <summary>
/// Gets or sets the actual string format being used.
/// </summary>
public string ActualStringFormat { get; protected set; }
/// <summary>
/// Gets the actual title of the axis.
/// </summary>
/// <remarks>If the <see cref="Unit" /> property is set, the <see cref="TitleFormatString" /> property is used to format the actual title.</remarks>
public string ActualTitle
{
get
{
if (this.Unit != null)
{
return string.Format(this.TitleFormatString, this.Title, this.Unit);
}
return this.Title;
}
}
/// <summary>
/// Gets or sets the orientation angle (degrees) for the axis labels. The default value is <c>0</c>.
/// </summary>
public double Angle { get; set; }
/// <summary>
/// Gets or sets the distance from the end of the tick lines to the labels. The default value is <c>4</c>.
/// </summary>
public double AxisTickToLabelDistance { get; set; }
/// <summary>
/// Gets or sets the minimum distance from the axis labels to the axis title. The default value is <c>4</c>.
/// </summary>
public double AxisTitleDistance { get; set; }
/// <summary>
/// Gets or sets the distance between the plot area and the axis. The default value is <c>0</c>.
/// </summary>
public double AxisDistance { get; set; }
/// <summary>
/// Gets or sets the color of the axis line. The default value is <see cref="OxyColors.Black" />.
/// </summary>
public OxyColor AxislineColor { get; set; }
/// <summary>
/// Gets or sets the line style of the axis line. The default value is <see cref="LineStyle.None" />.
/// </summary>
public LineStyle AxislineStyle { get; set; }
/// <summary>
/// Gets or sets the thickness of the axis line. The default value is <c>1</c>.
/// </summary>
public double AxislineThickness { get; set; }
/// <summary>
/// Gets or sets a value indicating whether to clip the axis title. The default value is <c>true</c>.
/// </summary>
public bool ClipTitle { get; set; }
/// <summary>
/// Gets or sets a value indicating whether to crop gridlines with perpendicular axes Start/EndPositions. The default value is <c>false</c>.
/// </summary>
public bool CropGridlines { get; set; }
/// <summary>
/// Gets or sets the maximum value of the data displayed on this axis.
/// </summary>
public double DataMaximum { get; protected set; }
/// <summary>
/// Gets or sets the minimum value of the data displayed on this axis.
/// </summary>
public double DataMinimum { get; protected set; }
/// <summary>
/// Gets or sets the end position of the axis on the plot area. The default value is <c>1</c>.
/// </summary>
/// <remarks>The position is defined by a fraction in the range from <c>0</c> to <c>1</c>, where <c>0</c> is at the bottom/left
/// and <c>1</c> is at the top/right. </remarks>
public double EndPosition { get; set; }
/// <summary>
/// Gets or sets the color of the extra gridlines. The default value is <see cref="OxyColors.Black"/>.
/// </summary>
public OxyColor ExtraGridlineColor { get; set; }
/// <summary>
/// Gets or sets the line style of the extra gridlines. The default value is <see cref="LineStyle.Solid"/>.
/// </summary>
public LineStyle ExtraGridlineStyle { get; set; }
/// <summary>
/// Gets or sets the thickness of the extra gridlines. The default value is <c>1</c>.
/// </summary>
public double ExtraGridlineThickness { get; set; }
/// <summary>
/// Gets or sets the values for the extra gridlines. The default value is <c>null</c>.
/// </summary>
public double[] ExtraGridlines { get; set; }
/// <summary>
/// Gets or sets the filter function. The default value is <c>null</c>.
/// </summary>
public Func<double, bool> FilterFunction { get; set; }
/// <summary>
/// Gets or sets the maximum value that can be shown using this axis. Values greater or equal to this value will not be shown. The default value is <c>double.MaxValue</c>.
/// </summary>
public double FilterMaxValue { get; set; }
/// <summary>
/// Gets or sets the minimum value that can be shown using this axis. Values smaller or equal to this value will not be shown. The default value is <c>double.MinValue</c>.
/// </summary>
public double FilterMinValue { get; set; }
/// <summary>
/// Gets or sets the maximum length (screen space) of the intervals. The available length of the axis will be divided by this length to get the approximate number of major intervals on the axis. The default value is <c>60</c>.
/// </summary>
public double IntervalLength { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this axis is visible. The default value is <c>true</c>.
/// </summary>
public bool IsAxisVisible { get; set; }
/// <summary>
/// Gets or sets a value indicating whether panning is enabled. The default value is <c>true</c>.
/// </summary>
public bool IsPanEnabled { get; set; }
/// <summary>
/// Gets a value indicating whether this axis is reversed. It is reversed if <see cref="StartPosition" /> > <see cref="EndPosition" />.
/// </summary>
public bool IsReversed
{
get
{
return this.StartPosition > this.EndPosition;
}
}
/// <summary>
/// Gets or sets a value indicating whether zooming is enabled. The default value is <c>true</c>.
/// </summary>
public bool IsZoomEnabled { get; set; }
/// <summary>
/// Gets or sets the key of the axis. This can be used to specify an axis if you have defined multiple axes in a plot. The default value is <c>null</c>.
/// </summary>
public string Key { get; set; }
/// <summary>
/// Gets or sets the formatting function for the labels. The default value is <c>null</c>.
/// </summary>
/// <remarks>This function can be used instead of overriding the <see cref="FormatValue" /> method.</remarks>
public Func<double, string> LabelFormatter { get; set; }
/// <summary>
/// Gets or sets the layer of the axis. The default value is <see cref="AxisLayer.BelowSeries"/>.
/// </summary>
public AxisLayer Layer { get; set; }
/// <summary>
/// Gets or sets the color of the major gridlines. The default value is <c>#40000000</c>.
/// </summary>
public OxyColor MajorGridlineColor { get; set; }
/// <summary>
/// Gets or sets the line style of the major gridlines. The default value is <see cref="LineStyle.None"/>.
/// </summary>
public LineStyle MajorGridlineStyle { get; set; }
/// <summary>
/// Gets or sets the thickness of the major gridlines. The default value is <c>1</c>.
/// </summary>
public double MajorGridlineThickness { get; set; }
/// <summary>
/// Gets or sets the interval between major ticks. The default value is <c>double.NaN</c>.
/// </summary>
public double MajorStep { get; set; }
/// <summary>
/// Gets or sets the size of the major ticks. The default value is <c>7</c>.
/// </summary>
public double MajorTickSize { get; set; }
/// <summary>
/// Gets or sets the maximum value of the axis. The default value is <c>double.NaN</c>.
/// </summary>
public double Maximum { get; set; }
/// <summary>
/// Gets or sets the 'padding' fraction of the maximum value. The default value is <c>0.01</c>.
/// </summary>
/// <remarks> A value of 0.01 gives 1% more space on the maximum end of the axis. This property is not used if the <see cref="Maximum" /> property is set.</remarks>
public double MaximumPadding { get; set; }
/// <summary>
/// Gets or sets the screen-space data margin at the maximum. The default value is <c>0</c>.
/// </summary>
/// <value>The number of device independent units to included between the <see cref="ClipMaximum"/> and <see cref="ActualMaximum"/>.</value>
public double MaximumDataMargin { get; set; }
/// <summary>
/// Gets or sets the screen-space margin at the maximum. The default value is <c>0</c>.
/// </summary>
/// <value>The number of device independent units to be left empty between the axis and the <see cref="EndPosition"/>.</value>
public double MaximumMargin { get; set; }
/// <summary>
/// Gets or sets the maximum range of the axis. Setting this property ensures that <c>ActualMaximum-ActualMinimum < MaximumRange</c>. The default value is <c>double.PositiveInfinity</c>.
/// </summary>
public double MaximumRange { get; set; }
/// <summary>
/// Gets or sets the minimum value of the axis. The default value is <c>double.NaN</c>.
/// </summary>
public double Minimum { get; set; }
/// <summary>
/// Gets or sets the minimum value for the interval between major ticks. The default value is <c>0</c>.
/// </summary>
public double MinimumMajorStep { get; set; }
/// <summary>
/// Gets or sets the minimum value for the interval between minor ticks. The default value is <c>0</c>.
/// </summary>
public double MinimumMinorStep { get; set; }
/// <summary>
/// Gets or sets the 'padding' fraction of the minimum value. The default value is <c>0.01</c>.
/// </summary>
/// <remarks>A value of 0.01 gives 1% more space on the minimum end of the axis. This property is not used if the <see cref="Minimum" /> property is set.</remarks>
public double MinimumPadding { get; set; }
/// <summary>
/// Gets or sets the screen-space data margin at the minimum. The default value is <c>0</c>.
/// </summary>
/// <value>The number of device independent units to included between the <see cref="ClipMinimum"/> and <see cref="ActualMinimum"/>.</value>
public double MinimumDataMargin { get; set; }
/// <summary>
/// Gets or sets the screen-space margin at the minimum. The default value is <c>0</c>.
/// </summary>
/// <value>The number of device independent units to be left empty between the axis the <see cref="StartPosition"/>.</value>
public double MinimumMargin { get; set; }
/// <summary>
/// Gets or sets the minimum range of the axis. Setting this property ensures that <c>ActualMaximum-ActualMinimum > MinimumRange</c>. The default value is <c>0</c>.
/// </summary>
public double MinimumRange { get; set; }
/// <summary>
/// Gets or sets the color of the minor gridlines. The default value is <c>#20000000</c>.
/// </summary>
public OxyColor MinorGridlineColor { get; set; }
/// <summary>
/// Gets or sets the line style of the minor gridlines. The default value is <see cref="LineStyle.None"/>.
/// </summary>
public LineStyle MinorGridlineStyle { get; set; }
/// <summary>
/// Gets or sets the thickness of the minor gridlines. The default value is <c>1</c>.
/// </summary>
public double MinorGridlineThickness { get; set; }
/// <summary>
/// Gets or sets the interval between minor ticks. The default value is <c>double.NaN</c>.
/// </summary>
public double MinorStep { get; set; }
/// <summary>
/// Gets or sets the color of the minor ticks. The default value is <see cref="OxyColors.Automatic"/>.
/// </summary>
/// <remarks>If the value is <see cref="OxyColors.Automatic"/>, the value of
/// <see cref="Axis.TicklineColor"/> will be used.</remarks>
public OxyColor MinorTicklineColor { get; set; }
/// <summary>
/// Gets or sets the size of the minor ticks. The default value is <c>4</c>.
/// </summary>
public double MinorTickSize { get; set; }
/// <summary>
/// Gets the offset. This is used to transform between data and screen coordinates.
/// </summary>
public double Offset
{
get
{
return this.offset;
}
}
/// <summary>
/// Gets or sets the position of the axis. The default value is <see cref="AxisPosition.Left"/>.
/// </summary>
public AxisPosition Position
{
get
{
return this.position;
}
set
{
this.position = value;
}
}
/// <summary>
/// Gets or sets a value indicating whether the axis should be positioned at the zero-crossing of the related axis. The default value is <c>false</c>.
/// </summary>
public bool PositionAtZeroCrossing { get; set; }
/// <summary>
/// Gets or sets the position tier which defines in which tier the axis is displayed. The default value is <c>0</c>.
/// </summary>
/// <remarks>The bigger the value the further afar is the axis from the graph.</remarks>
public int PositionTier { get; set; }
/// <summary>
/// Gets the scaling factor of the axis. This is used to transform between data and screen coordinates.
/// </summary>
public double Scale
{
get
{
return this.scale;
}
}
/// <summary>
/// Gets or sets the screen coordinate of the maximum end of the axis.
/// </summary>
public ScreenPoint ScreenMax { get; protected set; }
/// <summary>
/// Gets or sets the screen coordinate of the minimum end of the axis.
/// </summary>
public ScreenPoint ScreenMin { get; protected set; }
/// <summary>
/// Gets or sets the start position of the axis on the plot area. The default value is <c>0</c>.
/// </summary>
/// <remarks>The position is defined by a fraction in the range from <c>0</c> to <c>1</c>, where <c>0</c> is at the bottom/left
/// and <c>1</c> is at the top/right. </remarks>
public double StartPosition { get; set; }
/// <summary>
/// Gets or sets the string format used for formatting the axis values. The default value is <c>null</c>.
/// </summary>
public string StringFormat { get; set; }
/// <summary>
/// Gets or sets the tick style for major and minor ticks. The default value is <see cref="OxyPlot.Axes.TickStyle.Outside"/>.
/// </summary>
public TickStyle TickStyle { get; set; }
/// <summary>
/// Gets or sets the color of the major and minor ticks. The default value is <see cref="OxyColors.Black"/>.
/// </summary>
public OxyColor TicklineColor { get; set; }
/// <summary>
/// Gets or sets the title of the axis. The default value is <c>null</c>.
/// </summary>
public string Title { get; set; }
/// <summary>
/// Gets or sets the length of the title clipping rectangle (fraction of the available length of the axis). The default value is <c>0.9</c>.
/// </summary>
public double TitleClippingLength { get; set; }
/// <summary>
/// Gets or sets the color of the title. The default value is <see cref="OxyColors.Automatic"/>.
/// </summary>
/// <remarks>If the value is <c>null</c>, the <see cref="PlotModel.TextColor" /> will be used.</remarks>
public OxyColor TitleColor { get; set; }
/// <summary>
/// Gets or sets the title font. The default value is <c>null</c>.
/// </summary>
public string TitleFont { get; set; }
/// <summary>
/// Gets or sets the size of the title font. The default value is <c>double.NaN</c>.
/// </summary>
public double TitleFontSize { get; set; }
/// <summary>
/// Gets or sets the weight of the title font. The default value is <see cref="FontWeights.Normal"/>.
/// </summary>
public double TitleFontWeight { get; set; }
/// <summary>
/// Gets or sets the format string used for formatting the title and unit when <see cref="Unit" /> is defined.
/// The default value is "{0} [{1}]", where {0} refers to the <see cref="Title" /> and {1} refers to the <see cref="Unit" />.
/// </summary>
/// <remarks>If <see cref="Unit" /> is <c>null</c>, the actual title is defined by <see cref="Title" /> only.</remarks>
public string TitleFormatString { get; set; }
/// <summary>
/// Gets or sets the position of the title. The default value is <c>0.5</c>.
/// </summary>
/// <remarks>The position is defined by a fraction in the range <c>0</c> to <c>1</c>.</remarks>
public double TitlePosition { get; set; }
/// <summary>
/// Gets or sets the unit of the axis. The default value is <c>null</c>.
/// </summary>
/// <remarks>The <see cref="TitleFormatString" /> is used to format the title including this unit.</remarks>
public string Unit { get; set; }
/// <summary>
/// Gets or sets a value indicating whether to use superscript exponential format. The default value is <c>false</c>.
/// </summary>
/// <remarks>
/// This format will convert 1.5E+03 to 1.5·10^{3} and render the superscript properly.
/// If <see cref="StringFormat" /> is <c>null</c>, 1.0E+03 will be converted to 10^{3}, otherwise it will use the format string for the mantissa.
/// </remarks>
public bool UseSuperExponentialFormat { get; set; }
/// <summary>
/// Gets or sets the desired margins such that the axis text ticks will not be clipped.
/// The actual margins may be smaller or larger than the desired margins if they are set manually.
/// </summary>
public OxyThickness DesiredMargin { get; protected set; }
/// <summary>
/// Gets or sets the position tier max shift.
/// </summary>
internal double PositionTierMaxShift { get; set; }
/// <summary>
/// Gets or sets the position tier min shift.
/// </summary>
internal double PositionTierMinShift { get; set; }
/// <summary>
/// Gets or sets the size of the position tier.
/// </summary>
internal double PositionTierSize { get; set; }
/// <summary>
/// Gets the actual color of the title.
/// </summary>
protected internal OxyColor ActualTitleColor
{
get
{
return this.TitleColor.GetActualColor(this.PlotModel.TextColor);
}
}
/// <summary>
/// Gets the actual title font.
/// </summary>
protected internal string ActualTitleFont
{
get
{
return this.TitleFont ?? this.PlotModel.DefaultFont;
}
}
/// <summary>
/// Gets the actual size of the title font.
/// </summary>
protected internal double ActualTitleFontSize
{
get
{
return !double.IsNaN(this.TitleFontSize) ? this.TitleFontSize : this.ActualFontSize;
}
}
/// <summary>
/// Gets the actual title font weight.
/// </summary>
protected internal double ActualTitleFontWeight
{
get
{
return !double.IsNaN(this.TitleFontWeight) ? this.TitleFontWeight : this.ActualFontWeight;
}
}
/// <summary>
/// Gets or sets the current view's maximum. This value is used when the user zooms or pans.
/// </summary>
/// <value>The view maximum.</value>
protected double ViewMaximum { get; set; }
/// <summary>
/// Gets or sets the current view's minimum. This value is used when the user zooms or pans.
/// </summary>
/// <value>The view minimum.</value>
protected double ViewMinimum { get; set; }
/// <summary>
/// Converts the value of the specified object to a double precision floating point number. DateTime objects are converted using DateTimeAxis.ToDouble and TimeSpan objects are converted using TimeSpanAxis.ToDouble.
/// </summary>
/// <param name="value">The value.</param>
/// <returns>The floating point number value.</returns>
public static double ToDouble(object value)
{
if (value is DateTime)
{
return DateTimeAxis.ToDouble((DateTime)value);
}
if (value is TimeSpan)
{
return TimeSpanAxis.ToDouble((TimeSpan)value);
}
return Convert.ToDouble(value);
}
/// <summary>
/// Transforms the specified point from screen space to data space.
/// </summary>
/// <param name="p">The point.</param>
/// <param name="xaxis">The x axis.</param>
/// <param name="yaxis">The y axis.</param>
/// <returns>The data point.</returns>
public static DataPoint InverseTransform(ScreenPoint p, Axis xaxis, Axis yaxis)
{
return xaxis.InverseTransform(p.x, p.y, yaxis);
}
/// <summary>
/// Formats the value to be used on the axis.
/// </summary>
/// <param name="x">The value.</param>
/// <returns>The formatted value.</returns>
public string FormatValue(double x)
{
if (this.LabelFormatter != null)
{
return this.LabelFormatter(x);
}
return this.FormatValueOverride(x);
}
/// <summary>
/// Gets the coordinates used to draw ticks and tick labels (numbers or category names).
/// </summary>
/// <param name="majorLabelValues">The major label values.</param>
/// <param name="majorTickValues">The major tick values.</param>
/// <param name="minorTickValues">The minor tick values.</param>
public virtual void GetTickValues(
out IList<double> majorLabelValues, out IList<double> majorTickValues, out IList<double> minorTickValues)
{
minorTickValues = this.CreateTickValues(this.ClipMinimum, this.ClipMaximum, this.ActualMinorStep);
majorTickValues = this.CreateTickValues(this.ClipMinimum, this.ClipMaximum, this.ActualMajorStep);
majorLabelValues = majorTickValues;
minorTickValues = AxisUtilities.FilterRedundantMinorTicks(majorTickValues, minorTickValues);
}
/// <summary>
/// Gets the value from an axis coordinate, converts from a coordinate <see cref="double" /> value to the actual data type.
/// </summary>
/// <param name="x">The coordinate.</param>
/// <returns>The converted value.</returns>
/// <remarks>Examples: The <see cref="DateTimeAxis" /> returns the <see cref="DateTime" /> and <see cref="CategoryAxis" /> returns category strings.</remarks>
public virtual object GetValue(double x)
{
return x;
}
/// <summary>
/// Inverse transform the specified screen point.
/// </summary>
/// <param name="x">The x coordinate.</param>
/// <param name="y">The y coordinate.</param>
/// <param name="yaxis">The y-axis.</param>
/// <returns>The data point.</returns>
public virtual DataPoint InverseTransform(double x, double y, Axis yaxis)
{
return new DataPoint(this.InverseTransform(x), yaxis != null ? yaxis.InverseTransform(y) : 0);
}
/// <summary>
/// Inverse transforms the specified screen coordinate. This method can only be used with non-polar coordinate systems.
/// </summary>
/// <param name="sx">The screen coordinate.</param>
/// <returns>The value.</returns>
public virtual double InverseTransform(double sx)
{
return (sx / this.scale) + this.offset;
}
/// <summary>
/// Determines whether the axis is horizontal.
/// </summary>
/// <returns><c>true</c> if the axis is horizontal; otherwise, <c>false</c> .</returns>
public bool IsHorizontal()
{
return this.position == AxisPosition.Top || this.position == AxisPosition.Bottom;
}
/// <summary>
/// Determines whether the specified value is valid.
/// </summary>
/// <param name="value">The value.</param>
/// <returns><c>true</c> if the specified value is valid; otherwise, <c>false</c> .</returns>
public bool IsValidValue(double value)
{
#pragma warning disable 1718
// ReSharper disable EqualExpressionComparison
// ReSharper disable CompareOfFloatsByEqualityOperator
return value == value &&
value != 1.0 / 0.0 &&
value != -1.0 / 0.0 &&
value < this.FilterMaxValue &&
value > this.FilterMinValue &&
(this.FilterFunction == null || this.FilterFunction(value));
// ReSharper restore CompareOfFloatsByEqualityOperator
// ReSharper restore EqualExpressionComparison
#pragma warning restore 1718
}
/// <summary>
/// Determines whether the axis is vertical.
/// </summary>
/// <returns><c>true</c> if the axis is vertical; otherwise, <c>false</c> .</returns>
public bool IsVertical()
{
return this.position == AxisPosition.Left || this.position == AxisPosition.Right;
}
/// <summary>
/// Determines whether the axis is used for X/Y values.
/// </summary>
/// <returns><c>true</c> if it is an XY axis; otherwise, <c>false</c> .</returns>
public abstract bool IsXyAxis();
/// <summary>
/// Determines whether the axis is logarithmic.
/// </summary>
/// <returns><c>true</c> if it is a logarithmic axis; otherwise, <c>false</c> .</returns>
public virtual bool IsLogarithmic()
{
return false;
}
/// <summary>
/// Measures the size of the axis and updates <see cref="DesiredMargin"/> accordingly. This takes into account the axis title as well as tick labels
/// potentially exceeding the axis range.
/// </summary>
/// <param name="rc">The render context.</param>
public virtual void Measure(IRenderContext rc)
{
if (this.Position == AxisPosition.None)
{
this.DesiredMargin = new OxyThickness(0);
return;
}
this.GetTickValues(out var majorLabelValues, out _, out _);
var maximumTextSize = new OxySize();
foreach (var v in majorLabelValues)
{
var s = this.FormatValue(v);
var size = rc.MeasureText(s, this.ActualFont, this.ActualFontSize, this.ActualFontWeight, this.Angle);
maximumTextSize = maximumTextSize.Include(size);
}
var titleTextSize = rc.MeasureText(this.ActualTitle, this.ActualTitleFont, this.ActualTitleFontSize, this.ActualTitleFontWeight);
var marginLeft = 0d;
var marginTop = 0d;
var marginRight = 0d;
var marginBottom = 0d;
var minOuterMargin = Math.Max(0, this.IsReversed ? this.MaximumMargin : this.MinimumMargin);
var maxOuterMargin = Math.Max(0, this.IsReversed ? this.MinimumMargin : this.MaximumMargin);
var margin = this.TickStyle switch
{
TickStyle.Outside => this.MajorTickSize,
TickStyle.Crossing => this.MajorTickSize * 0.75,
_ => 0
};
margin += this.AxisDistance + this.AxisTickToLabelDistance;
if (titleTextSize.Height > 0)
{
margin += this.AxisTitleDistance + titleTextSize.Height;
}
switch (this.Position)
{
case AxisPosition.Left:
marginLeft = margin + maximumTextSize.Width;
break;
case AxisPosition.Right:
marginRight = margin + maximumTextSize.Width;
break;
case AxisPosition.Top:
marginTop = margin + maximumTextSize.Height;
break;
case AxisPosition.Bottom:
marginBottom = margin + maximumTextSize.Height;
break;
case AxisPosition.All:
marginLeft = marginRight = margin + maximumTextSize.Width;
marginTop = marginBottom = margin + maximumTextSize.Height;
break;
default:
throw new InvalidOperationException();
}
if (this.IsPanEnabled || this.IsZoomEnabled)
{
var reachesMinPosition = Math.Min(this.StartPosition, this.EndPosition) < 0.01;
var reachesMaxPosition = Math.Max(this.StartPosition, this.EndPosition) > 0.99;
switch (this.Position)
{
case AxisPosition.Left:
case AxisPosition.Right:
if (reachesMinPosition)
{
marginBottom = Math.Max(0, (maximumTextSize.Height / 2) - minOuterMargin);
}
if (reachesMaxPosition)
{
marginTop = Math.Max(0, (maximumTextSize.Height / 2) - maxOuterMargin);
}
break;
case AxisPosition.Top:
case AxisPosition.Bottom:
if (reachesMinPosition)
{
marginLeft = Math.Max(0, (maximumTextSize.Width / 2) - minOuterMargin);
}
if (reachesMaxPosition)
{
marginRight = Math.Max(0, (maximumTextSize.Width / 2) - maxOuterMargin);
}
break;
}
}
else if (majorLabelValues.Count > 0)
{
var minLabel = majorLabelValues.Min();
var maxLabel = majorLabelValues.Max();
var minLabelText = this.FormatValue(minLabel);
var maxLabelText = this.FormatValue(maxLabel);
var minLabelSize = rc.MeasureText(minLabelText, this.ActualFont, this.ActualFontSize, this.ActualFontWeight, this.Angle);
var maxLabelSize = rc.MeasureText(maxLabelText, this.ActualFont, this.ActualFontSize, this.ActualFontWeight, this.Angle);
var minLabelPosition = this.Transform(minLabel);
var maxLabelPosition = this.Transform(maxLabel);
if (minLabelPosition > maxLabelPosition)
{
Helpers.Swap(ref minLabelPosition, ref maxLabelPosition);
Helpers.Swap(ref minLabelSize, ref maxLabelSize);
}
switch (this.Position)
{
case AxisPosition.Left: