Repository navigation
Expand file tree
/
Copy pathgauge.d.ts
More file actions
1706 lines (1688 loc) · 52.6 KB
/
Copy pathgauge.d.ts
File metadata and controls
1706 lines (1688 loc) · 52.6 KB
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
/**
* Represents the base class of linear and oval gauges.
*/
interface BaseGauge
{
/**
* Registers a single event listener on the element.
* @param {string} eventName The name of the event. See a list of supported events here.
* @param {Function} handler Represents the method that will handle the event specified with eventName.
*/
addEventListener(eventName: string, handler: any, element?: HTMLCanvasElement | any): void;
/**
* Removes a single event listener attached to the element.
* @param {string} eventName The name of the event. See a list of supported events here.
* @param {Function} handler Represents the method that handles the event specified with eventName.
*/
removeEventListener(eventName: string, handler: any, element?: HTMLCanvasElement): void;
repaint(): void;
setWidth(value: number): void;
setHeight(value: number): void;
handleMouse(action: MouseAction, point: Point): void;
/**
* Returns the VisualElement object corresponding to the specified name.
* @param {String} name The name of the object to find.
* @return {VisualElement} The VisualElement object.
*/
getElementByName(name: string): VisualElement;
/**
* A list of scale objects.
* @type {MindFusion.Gauges.BaseScale}
*/
scales: BaseScale[];
stopRepaint: boolean;
/**
* Adds a scale to the gauge.
* @param {MindFusion.Gauges.BaseScale} scale The scale to add.
*/
addScale(scale: BaseScale): void;
/**
* Removes a scale from the gauge.
* @param {MindFusion.Gauges.BaseScale} scale The scale to remove.
*/
removeScale(scale: BaseScale): void;
fromJson(json: any): void;
toJson(): any;
}
/**
* Represents a linear gauge control.
*/
interface LinearGauge extends BaseGauge
{
/**
* Creates and initializes a new LinearGauge from the specified element.
* This method is static and can be called without creating an instance of the class.
* @param {Object} element The DOM element that the LinearGauge should be attached to.
* @returns {MindFusion.Gauges.LinearGauge} A LinearGauge object that represents
* the newly created gauge.
*/
create(element: HTMLCanvasElement, parentEvents: boolean): LinearGauge;
/**
* Gets the orientation of the gauge.
* @returns {MindFusion.Gauges.Orientation} The orientation of the gauge.
*/
getOrientation(): Orientation;
/**
* Sets the orientation of the gauge.
* @param {MindFusion.Gauges.Orientation} value The orientation of the gauge.
*/
setOrientation(value: Orientation): void;
/**
* Returns the specified LinearGauge object. This member is static and can be
* invoked without creating an instance of the class.
* @param {String} id A string that contains the ID of the LinearGauge to find.
* @param {Object} [parent] The component or element that contains the LinearGauge to find.
* @returns {MindFusion.Gauges.LinearGauge} A LinearGauge object that contains
* the gauge requested by id, if found; otherwise, null.
*/
find(id: string, parent?: Object): LinearGauge;
}
/**
* Represents a circular gauge control.
*/
interface OvalGauge extends BaseGauge
{
/**
* Creates and initializes a new OvalGauge from the specified element.
* This method is static and can be called without creating an instance of the class.
* @param {Object} element The DOM element that the OvalGauge should be attached to.
* @returns {MindFusion.Gauges.OvalGauge} A OvalGauge object that represents
* the newly created gauge.
*/
create(element: HTMLCanvasElement, parentEvents: boolean): OvalGauge;
/**
* Gets the visual style of the gauge.
* @returns {MindFusion.Gauges.OvalGaugeStyle} The visual style of the gauge.
*/
getStyle(): OvalGaugeStyle;
/**
* Sets the visual style of the gauge.
* @param {MindFusion.Gauges.OvalGaugeStyle} value The visual style of the gauge.
*/
setStyle(style: OvalGaugeStyle): void;
/**
* Returns the specified OvalGauge object. This member is static and can be
* invoked without creating an instance of the class.
* @param {String} id A string that contains the ID of the OvalGauge to find.
* @param {Object} [parent] The component or element that contains the OvalGauge to find.
* @returns {MindFusion.Gauges.OvalGauge} A OvalGauge object that contains
* the gauge requested by id, if found; otherwise, null.
*/
find(id: string, parent?: Object): OvalGauge;
}
/**
* Represents a scale within a gauge control.
*/
interface BaseScale extends VisualElement
{
/**
* Adds a Pointer object to the pointers collection.
* @param {MindFusion.Gauges.Pointer} pointer The pointer to add.
*/
addPointer(pointer: Pointer): void;
/**
* Removes a Pointer object from the pointers collection.
* @param {MindFusion.Gauges.Pointer} pointer The pointer to remove.
*/
removePointer(pointer: Pointer): void;
/**
* Adds a Range object to the ranges collection.
* @param {MindFusion.Gauges.Range} range The ranges to add.
*/
addRange(pointer: Range): void;
/**
* Removes a Range object from the ranges collection.
* @param {MindFusion.Gauges.Range} range The ranges to remove.
*/
removeRange(pointer: Range): void;
/**
* Gets the settings for the major ticks and their associated labels.
* @returns {MindFusion.Gauges.MajorTickSettings} The settings for the major ticks and their associated labels.
*/
majorTickSettings: TickSettings;
/**
* Gets the settings for the middle ticks and their associated labels.
* @returns {MindFusion.Gauges.MiddleTickSettings} The settings for the middle ticks and their associated labels.
*/
middleTickSettings: TickSettings;
/**
* Gets the settings for the minor ticks and their associated labels.
* @returns {MindFusion.Gauges.MinorTickSettings} The settings for the minor ticks and their associated labels.
*/
minorTickSettings: TickSettings;
fill: Object;
stroke: string;
/**
* A list of pointer objects.
* @type {MindFusion.Gauges.Pointer}
*/
pointers: Pointer[];
/**
* A list of range objects.
* @type {MindFusion.Gauges.Range}
*/
ranges: Range[];
/**
* Gets the minimal value displayed by the scale.
* @returns {Number} The minimal value displayed by the scale.
*/
getMinValue(): number;
/**
* Sets the minimal value displayed by the scale.
* @param {Number} value The minimal value displayed by the scale.
*/
setMinValue(value: number): void;
/**
* Gets the maximal value displayed by the scale.
* @returns {Number} The maximal value displayed by the scale.
*/
getMaxValue(): number;
/**
* Sets the maximal value displayed by the scale.
* @param {Number} value The maximal value displayed by the scale.
*/
setMaxValue(value: number): void;
/**
* Gets the width of the scale at its beginning.
* @returns {MindFusion.Gauges.Length} The width of the scale at its beginning.
*/
getStartWidth(): Length;
/**
* Sets the width of the scale at its beginning.
* @param {MindFusion.Gauges.Length} value The width of the scale at its beginning.
*/
setStartWidth(value: Length): void;
/**
* Gets the width of the scale at its end.
* @returns {MindFusion.Gauges.Length} The width of the scale at its end.
*/
getEndWidth(): Length;
/**
* Sets the width of the scale at its end.
* @param {MindFusion.Gauges.Length} value The width of the scale at its end.
*/
setEndWidth(value: Length): void;
/**
* Gets the logarithm base when FunctionType is set to Logarithmic.
* @returns {Number} The logarithm base when functionType is set to Logarithmic.
*/
getLogarithmBase(): number;
/**
* Sets the logarithm base when FunctionType is set to Logarithmic.
* @param {Number} value The logarithm base when functionType is set to Logarithmic.
*/
setLogarithmBase(value: number): void;
/**
* Gets the type of the function used to calculate the distribution of values along the scale.
* @returns {MindFusion.Gauges.FunctionType} The type of the function used to calculate the distribution of values along the scale.
*/
getFunctionType(): FunctionType;
/**
* Sets the type of the function used to calculate the distribution of values along the scale.
* @param {MindFusion.Gauges.FunctionType} value The type of the function used to calculate the distribution of values along the scale.
*/
setFunctionType(value: FunctionType): void;
/**
* Gets the argument passed to custom functions.
* @returns {Number} The argument passed to custom functions.
*/
getFunctionArgument(): number;
/**
* Sets the argument passed to custom functions.
* @param {Number} value The argument passed to custom functions.
*/
setFunctionArgument(value: number): void;
/**
* Gets the function to be used for distribution of values along the scale when functionType is set to Custom.
* @returns {FunctionDelegate} The function to be used for distribution of values along the scale when functionType is set to Custom.
*/
getCustomFunction(): any;
/**
* Sets the function to be used for distribution of values along the scale when functionType is set to Custom.
* @param {FunctionDelegate} value The function to be used for distribution of values along the scale when functionType is set to Custom.
*/
setCustomFunction(value: any): void;
/**
* Gets the reversed version of the function specified through customFunction.
* @returns {FunctionDelegate} The reversed version of the function specified through CustomFunction.
*/
getReversedCustomFunction(): any;
/**
* Sets the reversed version of the function specified through customFunction.
* @param {FunctionDelegate} value The reversed version of the function specified through CustomFunction.
*/
setReversedCustomFunction(value: any): void;
updateTicksAndLabels(): void;
}
/**
* Represents a linear scale.
*/
interface LinearScale extends BaseScale
{
/**
* Creates an instance of LinearScale.
* @param {MindFusion.Gauges.LinearGauge} [parent] The gauge control this scale belongs to.
*/
new (parent?: LinearGauge): LinearScale;
/**
* Gets the length of the scale.
* @returns {MindFusion.Gauges.Length} The length of the scale.
*/
getScaleLength(): Length;
/**
* Sets the length of the scale.
* @param {MindFusion.Gauges.Length} value The length of the scale.
*/
setScaleLength(value: Length): void;
/**
* Gets the alignment of the scale.
* @returns {MindFusion.Gauges.Alignment} The alignment of the scale.
* @remarks All Inner* values align a vertical scale to the left side and a horizontal
* scale to the top side of the control. All Outer* values align a vertical
* scale to the right side and a horizontal scale to the bottom side of the
* control. All Center* values center the scale along its length.
*/
getScaleAlignment(): Alignment;
/**
* Sets the alignment of the scale.
* @param {MindFusion.Gauges.Alignment} value The alignment of the scale.
* @remarks All Inner* values align a vertical scale to the left side and a horizontal
* scale to the top side of the control. All Outer* values align a vertical
* scale to the right side and a horizontal scale to the bottom side of the
* control. All Center* values center the scale along its length.
*/
setScaleAlignment(value: Alignment): void;
/**
* Gets the orientation of the scale.
* @returns {MindFusion.Gauges.Orientation} The orientation of the scale.
*/
getOrientation(): Orientation;
/**
* Sets the orientation of the scale.
* @param {MindFusion.Gauges.Orientation} value The orientation of the scale.
*/
setOrientation(value: Orientation): void;
/**
* Gets the distance between the left of this scale and the left of its container.
* @returns {MindFusion.Gauges.Length} The distance between the left of this scale and the left of its container.
*/
getLeft(): Length;
/**
* Sets the distance between the left of this scale and the left of its container.
* @param {MindFusion.Gauges.Length} value The distance between the left of this scale and the left of its container.
*/
setLeft(value: Length): void;
/**
* Gets the distance between the top of this scale and the top of its container.
* @returns {MindFusion.Gauges.Length} The distance between the top of this scale and the top of its container.
*/
getTop(): Length;
/**
* Sets the distance between the top of this scale and the top of its container.
* @param {MindFusion.Gauges.Length} value The distance between the top of this scale and the top of its container.
*/
setTop(value: Length): void;
}
/**
* Represents a radial scale.
*/
interface OvalScale extends BaseScale
{
/**
* Creates an instance of OvalScale.
* @param {MindFusion.Gauges.OvalGauge} [parent] The gauge control this scale belongs to.
*/
new (parent?: OvalGauge): OvalScale;
/**
* Gets the center of the scale relative to the scale bounds.
* @returns {MindFusion.Drawing.Point} The center of the scale relative to the scale bounds.
* @remarks A value of (0.5, 0.5) indicates the center of the bounds, a value of (0, 0) indicates the top-left corner.
*/
getScaleRelativeCenter(): Point;
/**
* Sets the center of the scale relative to the scale bounds.
* @param {MindFusion.Drawing.Point} value The center of the scale relative to the scale bounds.
* @remarks A value of (0.5, 0.5) indicates the center of the bounds, a value of (0, 0) indicates the top-left corner.
*/
setScaleRelativeCenter(value: Point): void;
/**
* Gets the radius of the scale relative to the scale bounds.
* @returns {Number} The radius of the scale relative to the scale bounds.
* @remarks A value of 0.5 indicates that the radius is half the size of the scale.
*/
getScaleRelativeRadius(): number;
/**
* Sets the radius of the scale relative to the scale bounds.
* @param {Number} value The radius of the scale relative to the scale bounds.
* @remarks A value of 0.5 indicates that the radius is half the size of the scale.
*/
setScaleRelativeRadius(value: number): void;
/**
* Gets the start angle of the scale.
* @returns {Number} The start angle of the scale.
*/
getStartAngle(): number;
/**
* Sets the start angle of the scale.
* @param {Number} value The start angle of the scale.
*/
setStartAngle(value: number): void;
/**
* Gets the end angle of the scale.
* @returns {Number} The end angle of the scale.
*/
getEndAngle(): number;
/**
* Sets the end angle of the scale.
* @param {Number} value The end angle of the scale.
*/
setEndAngle(value: number): void;
}
/**
* Provides settings for the ticks and labels in a gauge scale.
*/
interface TickSettings
{
fill: Object;
stroke: Object;
fontFamily: string;
fontSize: Length;
fontStyle: string;
/**
* Gets the number of ticks and labels.
* @returns {Number} The number of ticks and labels.
* @remarks This property is mutually exclusive with the Step property. If both are specified the Step property will take precedence.
*/
getCount(): number;
/**
* Sets the number of ticks and labels.
* @param {Number} value The number of ticks and labels.
* @remarks This property is mutually exclusive with the Step property. If both are specified the Step property will take precedence.
*/
setCount(value: number): void;
/**
* Gets the value between adjacent ticks and labels.
* @returns {Number} The value between adjacent ticks and labels.
* @remarks This property is mutually exclusive with the Count property. If both are specified the Step property will take precedence.
*/
getStep(): number;
/**
* Sets the value between adjacent ticks and labels.
* @param {Number} value The value between adjacent ticks and labels.
* @remarks This property is mutually exclusive with the Count property. If both are specified the Step property will take precedence.
*/
setStep(value: number): void;
/**
* Gets the width of a tick.
* @returns {MindFusion.Gauges.Length} The width of a tick.
*/
getTickWidth(): Length;
/**
* Sets the width of a tick.
* @param {MindFusion.Gauges.Length} value The width of a tick.
*/
setTickWidth(value: Length): void;
/**
* Gets the height of a tick.
* @returns {MindFusion.Gauges.Length} The height of a tick.
*/
getTickHeight(): Length;
/**
* Sets the height of a tick.
* @param {MindFusion.Gauges.Length} value The height of a tick.
*/
setTickHeight(value: Length): void;
/**
* Gets the fill brush of the ticks.
* @returns {Object} The fill brush of the ticks.
*/
getFill(): Object;
/**
* Sets the fill brush of the ticks.
* @param {Object} value The fill brush of the ticks.
*/
setFill(value: Object): void;
/**
* Gets the stroke brush of the ticks.
* @returns {Object} The stroke brush of the ticks.
*/
getStroke(): Object;
/**
* Sets the stroke brush of the ticks.
* @param {Object} value The stroke brush of the ticks.
*/
setStroke(value: Object): void;
/**
* Gets a value indicating whether the ticks are visible.
* @returns {Boolean} True if ticks are visible, otherwise false.
*/
getShowTicks(): boolean;
/**
* Sets a value indicating whether the ticks are visible.
* @param {Boolean} value True if ticks are visible, otherwise false.
*/
setShowTicks(value: boolean): void;
/**
* Gets a value indicating whether the labels are visible.
* @returns {Boolean} True if labels are visible, otherwise false.
*/
getShowLabels(): boolean;
/**
* Sets a value indicating whether the labels are visible.
* @param {Boolean} value True if labels are visible, otherwise false.
*/
setShowLabels(value: boolean): void;
/**
* Gets the shape of the ticks.
* @returns {MindFusion.Gauges.TickShape} The shape of the ticks.
*/
getTickShape(): TickShape;
/**
* Sets the shape of the ticks.
* @param {MindFusion.Gauges.TickShape} value The shape of the ticks.
*/
setTickShape(value: TickShape): void;
/**
* Gets the alignment of the ticks relative to the scale.
* @returns {MindFusion.Gauges.Alignment} The alignment of the ticks relative to the scale.
*/
getTickAlignment(): Alignment;
/**
* Sets the alignment of the ticks relative to the scale.
* @param {MindFusion.Gauges.Alignment} value The alignment of the ticks relative to the scale.
*/
setTickAlignment(value: Alignment): void;
/**
* Gets the offset of the ticks relative to their calculated position.
* @returns {MindFusion.Gauges.Length} The offset of the ticks relative to their calculated position.
*/
getTickOffset(): Length;
/**
* Sets the offset of the ticks relative to their calculated position.
* @param {MindFusion.Gauges.Length} value The offset of the ticks relative to their calculated position.
*/
setTickOffset(value: Length): void;
/**
* Gets the alignment of the labels relative to the scale.
* @returns {MindFusion.Gauges.Alignment} The alignment of the labels relative to the scale.
*/
getLabelAlignment(): Alignment;
/**
* Sets the alignment of the labels relative to the scale.
* @param {MindFusion.Gauges.Alignment} value The alignment of the labels relative to the scale.
*/
setLabelAlignment(value: Alignment): void;
/**
* Gets the offset of the labels relative to their calculated position.
* @returns {MindFusion.Gauges.Length} The offset of the labels relative to their calculated position.
*/
getLabelOffset(): Length;
/**
* Sets the offset of the labels relative to their calculated position.
* @param {MindFusion.Gauges.Length} value The offset of the labels relative to their calculated position.
*/
setLabelOffset(value: Length): void;
/**
* Gets the rotation mode of the labels.
* @returns {MindFusion.Gauges.LabelRotation} The rotation mode of the labels.
*/
getLabelRotation(): LabelRotation;
/**
* Sets the rotation mode of the labels.
* @param {MindFusion.Gauges.LabelRotation} value The rotation mode of the labels.
*/
setLabelRotation(value: LabelRotation): void;
/**
* Gets the number recision of the labels.
* @returns {Number} The number recision of the labels.
*/
getNumberPrecision(): number;
/**
* Sets the number recision of the labels.
* @param {Number} value The number recision of the labels.
*/
setNumberPrecision(value: number): void;
/**
* Gets the font family of the labels.
* @returns {String} The font family of the labels.
*/
getFontFamily(): string;
/**
* Sets the font family of the labels.
* @param {String} value The font family of the labels.
*/
setFontFamily(value: string): void;
/**
* Gets the font size of the labels.
* @returns {MindFusion.Gauges.Length} The font size of the labels.
*/
getFontSize(): Length;
/**
* Sets the font size of the labels.
* @param {MindFusion.Gauges.Length} value The font size of the labels.
*/
setFontSize(value: Length): void;
/**
* Gets the font style of the labels.
* @returns {String} The font style of the labels.
*/
getFontStyle(): string;
/**
* Sets the font style of the labels.
* @param {String} value The font style of the labels.
*/
setFontStyle(value: string): void;
/**
* Gets the brush used to paint label texts.
* @returns {Object} The brush used to paint label texts.
*/
getLabelForeground(): Object;
/**
* Sets the brush used to paint label texts.
* @param {Object} value The brush used to paint label texts.
*/
setLabelForeground(value: Object): void;
/**
* Gets a value indicating whether to display a tick for the maxValue of the scale.
* @returns {Boolean} True to display a tick for the maxValue, otherwise false.
*/
getShowMaxValueTick(): boolean;
/**
* Sets a value indicating whether to display a tick for the maxValue of the scale.
* @param {Boolean} value True to display a tick for the maxValue, otherwise false.
*/
setShowMaxValueTick(value: boolean): void;
/**
* Gets an array of CustomInterval objects, which can be used to customize the appearance of the ticks in a particular interval.
* @returns {Array<MindFusion.Gauges.CustomInterval>} An array of CustomInterval objects, which can be used to customize the appearance of the ticks in a particular interval.
*/
getCustomIntervals(): Array<CustomInterval>;
/**
* Adds a CustomInterval object to these settings' customIntervals collection.
* @param {MindFusion.Gauges.CustomInterval} interval The interval to add.
*/
addCustomInterval(value: CustomInterval): void;
/**
* Removes a CustomInterval object from these settings' customIntervals collection.
* @param {MindFusion.Gauges.CustomInterval} interval The interval to remove.
*/
removeCustomInterval(value: CustomInterval): void;
}
/**
* Represents an object with outline and fill, which can render itself to a canvas.
*/
interface VisualElement
{
fill: Object;
stroke: Object;
/**
* Gets the name of this element.
* @returns {String} The name of this element.
* @remarks The name can be used to obtain a reference to the element through a call to the getElementByName method.
*/
getName(): string;
/**
* Sets the name of this element.
* @param {String} value The name of this element.
* @remarks The name can be used to obtain a reference to the element through a call to the getElementByName method.
*/
setName(value: string): void;
/**
* Gets the fill of this element.
* @returns {Object} The fill of this element.
*/
getFill(): Object;
/**
* Sets the fill of this element.
* @param {Object} value The fill of this element.
*/
setFill(value: Object): void;
/**
* Gets the stroke of this element.
* @returns {Object} The stroke of this element.
*/
getStroke(): Object;
/**
* Sets the stroke of this element.
* @param {Object} value The stroke of this element.
*/
setStroke(value: Object): void;
/**
* Gets a value indicating whether this element is visible.
* @returns {Boolean} True if the element is visible, otherwise false.
*/
getIsVisible(): boolean;
/**
* Sets a value indicating whether this element is visible.
* @param {Boolean} value True if the element is visible, otherwise false.
*/
setIsVisible(value: boolean): void;
/**
* Gets the margin of this element.
* @returns {MindFusion.Gauges.Thickness} The margin of this element.
*/
getMargin(): Thickness;
/**
* Sets the margin of this element.
* @param {MindFusion.Gauges.Thickness} value The margin of this element.
*/
setMargin(value: Thickness): void;
/**
* Gets the normalized x position of this element, relative to its parent.
* @returns {Number} The normalized x position of this element, relative to its parent.
*/
getX(): number;
/**
* Sets the normalized x position of this element, relative to its parent.
* @param {Number} value The normalized x position of this element, relative to its parent.
*/
setX(value: number): void;
/**
* Gets the normalized y position of this element, relative to its parent.
* @returns {Number} The normalized y position of this element, relative to its parent.
*/
getY(): number;
/**
* Sets the normalized y position of this element, relative to its parent.
* @param {Number} value The normalized y position of this element, relative to its parent.
*/
setY(value: number): void;
/**
* Gets the bounding rectangle of this element.
* @returns {MindFusion.Drawing.Rect} The bounding rectangle of this element.
*/
getBounds(): Rect;
/**
* Sets the bounding rectangle of this element.
* @param {MindFusion.Drawing.Rect} value The bounding rectangle of this element.
*/
setBounds(value: Rect): void;
/**
* Gets the size of this element.
* @returns {MindFusion.Drawing.Size} The size of this element.
*/
getSize(): Size;
/**
* Gets a value indicating whether the metrics of this element are expressed as relative or absolute quantities.
* @returns {Boolean} True if the metrics are relative, otherwise false.
*/
getRelativeCoordinates(): boolean;
/**
* Sets a value indicating whether the metrics of this element are expressed as relative or absolute quantities.
* @param {Boolean} value True if the metrics are relative, otherwise false.
*/
setRelativeCoordinates(value: boolean): void;
/**
* Gets the rendering size of the element.
* @returns {MindFusion.Drawing.Size} The rendering size of the element.
*/
getRenderSize(): Size;
/**
* Sets the rendering size of the element.
* @param {MIndFusion.Drawing.Size} value The rendering size of the element.
*/
setRenderSize(value: Size): void;
}
/**
* Represents a needle (or arrow) within a gauge scale.
*/
interface Pointer extends VisualElement
{
/**
* Creates an instance of Pointer class.
*/
new (): Pointer;
isInteractive: boolean;
/**
* Gets the value this pointer points to.
* @returns {Number} The value this pointer points to.
*/
getValue(): number;
/**
* Sets the value this pointer points to.
* @param {Number} value The value this pointer points to.
*/
setValue(value: number): void;
/**
* Gets a value indicating whether the pointer position should be affected by user interactions.
* @returns {Boolean} True if the pointer is interactive, otherwise false.
*/
getIsInteractive(): boolean;
/**
* Sets a value indicating whether the pointer position should be affected by user interactions.
* @param {Boolean} value True if the pointer is interactive, otherwise false.
*/
setIsInteractive(value: boolean): void;
/**
* Gets the width of the pointer.
* @returns {MindFusion.Gauges.Length} The width of the pointer.
*/
getPointerWidth(): Length;
/**
* Sets the width of the pointer.
* @param {MindFusion.Gauges.Length} value The width of the pointer.
*/
setPointerWidth(value: Length): void;
/**
* Gets the height of the pointer.
* @returns {MindFusion.Gauges.Length} The height of the pointer.
*/
getPointerHeight(): Length;
/**
* Sets the height of the pointer.
* @param {MindFusion.Gauges.Length} value The height of the pointer.
*/
setPointerHeight(value: Length): void;
/**
* Gets the offset of the pointer along the direction it points to.
* @returns {MindFusion.Gauges.Length} The offset of the pointer along the direction it points to.
*/
getPointerOffset(): Length;
/**
* Sets the offset of the pointer along the direction it points to.
* @param {MindFusion.Gauges.Length} value The offset of the pointer along the direction it points to.
*/
setPointerOffset(value: Length): void;
/**
* Gets the alignment of the pointer relative to the scale.
* @returns {MindFusion.Gauges.Alignment} The alignment of the pointer relative to the scale.
* @remarks This property is ignored in oval gauges where the pointer is always pinned to the center of the gauge.
*/
getAlignment(): Alignment;
/**
* Sets the alignment of the pointer relative to the scale.
* @param {MindFusion.Gauges.Alignment} value The alignment of the pointer relative to the scale.
* @remarks This property is ignored in oval gauges where the pointer is always pinned to the center of the gauge.
*/
setAlignment(value: Alignment): void;
/**
* Gets a value indicating whether the pointer value can be changed only discretely(the pointer Value can be only integer).
* @returns {Boolean} True if the pointer is discrete, otherwise false.
*/
getIsDiscrete(): boolean;
/**
* Sets a value indicating whether the pointer value can be changed only discretely(the pointer Value can be only integer).
* @param {Boolean} value True if the pointer is discrete, otherwise false.
*/
setIsDiscrete(value: boolean): void;
/**
* Gets the shape of the pointer.
* @returns {MindFusion.Gauges.PointerShape} The shape of the pointer.
*/
getShape(): PointerShape;
/**
* Sets the shape of the pointer.
* @param {MindFusion.Gauges.PointerShape} value The shape of the pointer.
*/
setShape(value: PointerShape): void;
/**
* Gets the definition of the pointer shape when Shape is set to Custom.
* @returns {String} The definition of the pointer shape when Shape is set to Custom.
*/
getCustomShape(): string;
/**
* Sets the definition of the pointer shape when Shape is set to Custom.
* @param {String} value The definition of the pointer shape when Shape is set to Custom.
*/
setCustomShape(value: string): void;
}
/**
* Represents a range within a gauge scale.
*/
interface Range extends VisualElement
{
/**
* Creates an instance of Range class.
*/
new (): Range;
/**
* Gets the start value of this range.
* @returns {Number} The start value of this range.
*/
getMinValue(): number;
/**
* Sets the start value of this range.
* @param {Number} value The start value of this range.
*/
setMinValue(value: number): void;
/**
* Gets the end value of this range.
* @returns {Number} The end value of this range.
*/
getMaxValue(): number;
/**
* Sets the end value of this range.
* @param {Number} value The end value of this range.
*/
setMaxValue(value: number): void;
/**
* Gets the alignment of this range relative to the scale it is associated with.
* @returns {MindFusion.Gauges.Alignment} The alignment of this range relative to the scale it is associated with.
*/
getAlignment(): Alignment;
/**
* Sets the alignment of this range relative to the scale it is associated with.
* @param {MindFusion.Gauges.Alignment} value The alignment of this range relative to the scale it is associated with.
*/
setAlignment(value: Alignment): void;
/**
* Gets the width of this range at its start.
* @returns {MindFusion.Gauges.Length} The width of this range at its start.
*/
getStartWidth(): Length;
/**
* Sets the width of this range at its start.
* @param {MindFusion.Gauges.Length} value The width of this range at its start.
*/
setStartWidth(value: Length): void;
/**
* Gets the width of this range at its end.
* @returns {MindFusion.Gauges.Length} The width of this range at its end.
*/
getEndWidth(): Length;
/**
* Sets the width of this range at its end.
* @param {MindFusion.Gauges.Length} value The width of this range at its end.
*/
setEndWidth(value: Length): void;
/**
* Gets the offset of the range from the position calculated according to its alignment.
* @returns {MindFusion.Gauges.Length} The offset of the range from the position calculated according to its alignment.
*/
getOffset(): Length;
/**
* Sets the offset of the range from the position calculated according to its alignment.
* @param {MindFusion.Gauges.Length} value The offset of the range from the position calculated according to its alignment.
*/
setOffset(value: Length): void;
/**
* Gets a value indicating whether to draw a stroke in the beginning of this range.
* @returns {Boolean} True if there should be a stroke in the beginning of this range, otherwise false.
*/
getCapStart(): boolean;
/**
* Sets a value indicating whether to draw a stroke in the beginning of this range.
* @param {Boolean} value True if there should be a stroke in the beginning of this range, otherwise false.
*/
setCapStart(value: boolean): void;
/**
* Gets a value indicating whether to draw a stroke in the end of this range.
* @returns {Boolean} True if there should be a stroke in the end of this range, otherwise false.
*/
getCapEnd(): boolean;
/**
* Sets a value indicating whether to draw a stroke in the end of this range.
* @param {Boolean} value True if there should be a stroke in the end of this range, otherwise false.
*/
setCapEnd(value: boolean): void;
/**
* Gets a value indicating whether to draw a stroke at the inside of this range.
* @returns {Boolean} True if there should be a stroke at the inside of this range, otherwise false.
*/
getStrokeInside(): boolean;
/**
* Sets a value indicating whether to draw a stroke at the inside of this range.
* @param {Boolean} value True if there should be a stroke at the inside of this range, otherwise false.
*/
setStrokeInside(value: boolean): void;
/**
* Gets a value indicating whether to draw a stroke at the outside of this range.
* @returns {Boolean} True if there should be a stroke at the outside of this range, otherwise false.
*/
getStrokeOutside(): boolean;
/**
* Sets a value indicating whether to draw a stroke at the outside of this range.
* @param {Boolean} value True if there should be a stroke at the outside of this range, otherwise false.
*/
setStrokeOutside(value: boolean): void;
/**
* Gets a value indicating whether the start and end width of the range will be automatically adjusted to match the width of the scale.
* @returns {Boolean} True if the range is autosized, otherwise false.
* @remarks If this property is set to true the values of startWidth and endWidth properties are ignored.
*/
getAutoSize(): boolean;
/**
* Sets a value indicating whether the start and end width of the range will be automatically adjusted to match the width of the scale.
* @param {Boolean} value True if the range is autosized, otherwise false.
* @remarks If this property is set to true the values of startWidth and endWidth properties are ignored.
*/
setAutoSize(value: boolean): void;
}
/**
* pecifies distance expressed either absolutely, through pixels, or relatively, through a percentage of the container's size.
*/
interface Length
{
/**
* Creates an instance of Length class.
* @param {Number} value A number specifying the initial length value.
* @param {MindFusion.Gauges.LengthType} [type] A member of the LengthType enumeration specifying the length type.
*/
new (value: number, type?: LengthType): Length;
/**
* Calculates the absolute length corresponding to the specified argument, relative to the the specified area.
*/
getAbsoluteLength(space: number);
/**
* Gets the value representing this length.
* @returns {Number} The value representing this length.
*/
getValue(): number;
/**
* Sets the value representing this length.
* @param {Number} value The value representing this length.
*/
setValue(value: number): void;
/**
* Gets the type of this length.
* @returns {MindFusion.Gauges.LengthType} The type of this length.
*/
getType(): LengthType;
/**
* Sets the type of this length.
* @param {MindFusion.Gauges.LengthType} value The type of this length.
*/
setType(value: LengthType): void;