-
Notifications
You must be signed in to change notification settings - Fork 101
Expand file tree
/
Copy pathChart2D_Funnel.fs
More file actions
733 lines (693 loc) · 41.9 KB
/
Chart2D_Funnel.fs
File metadata and controls
733 lines (693 loc) · 41.9 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
namespace Plotly.NET
open Plotly.NET.LayoutObjects
open Plotly.NET.TraceObjects
open DynamicObj
open System
open System.IO
open System.Runtime.CompilerServices
open System.Runtime.InteropServices
[<AutoOpen>]
module Chart2D_Funnel =
[<Extension>]
type Chart =
[<Extension>]
static member Funnel
(
x: seq<#IConvertible>,
y: seq<#IConvertible>,
?Name: string,
?ShowLegend: bool,
?Opacity: float,
?Width: float,
?Offset: float,
?Text: #IConvertible,
?MultiText: seq<#IConvertible>,
?TextPosition: StyleParam.TextPosition,
?MultiTextPosition: seq<StyleParam.TextPosition>,
?Orientation: StyleParam.Orientation,
?AlignmentGroup: string,
?OffsetGroup: string,
?MarkerColor: Color,
?MarkerOutline: Line,
?Marker: Marker,
?TextInfo: StyleParam.TextInfo,
?ConnectorLineColor: Color,
?ConnectorLineStyle: StyleParam.DrawingStyle,
?ConnectorFillColor: Color,
?ConnectorLine: Line,
?Connector: FunnelConnector,
?InsideTextFont: Font,
?OutsideTextFont: Font,
?UseDefaults: bool
) =
let useDefaults =
defaultArg UseDefaults true
let marker =
Marker
|> Option.defaultValue (TraceObjects.Marker.init ())
|> TraceObjects.Marker.style (?Color = MarkerColor, ?Outline = MarkerOutline)
let connectorLine =
ConnectorLine
|> Option.map (Plotly.NET.Line.style (?Color = ConnectorLineColor, ?Dash = ConnectorLineStyle))
let connector =
Connector
|> Option.defaultValue (TraceObjects.FunnelConnector.init ())
|> TraceObjects.FunnelConnector.style (?FillColor = ConnectorFillColor, ?Line = connectorLine)
Trace2D.initFunnel (
Trace2DStyle.Funnel(
?Name = Name,
?ShowLegend = ShowLegend,
?Opacity = Opacity,
X = x,
Y = y,
?Width = Width,
?Offset = Offset,
?Text = Text,
?MultiText = MultiText,
?TextPosition = TextPosition,
?MultiTextPosition = MultiTextPosition,
?Orientation = Orientation,
?AlignmentGroup = AlignmentGroup,
?OffsetGroup = OffsetGroup,
Marker = marker,
?TextInfo = TextInfo,
Connector = connector,
?InsideTextFont = InsideTextFont,
?OutsideTextFont = OutsideTextFont
)
)
|> GenericChart.ofTraceObject useDefaults
/// <summary>
/// Creates a Funnel chart from encoded x and y coordinates.
///
/// Funnel charts visualize stages in a process using length-encoded bars. This trace can be used to show data in either a part-to-whole representation wherein each item appears in a single stage, or in a "drop-off" representation wherein each item appears in each stage it traversed. See also the "funnelarea" trace type for a different approach to visualizing funnel data.
/// </summary>
/// <param name="xEncoded">Sets the x coordinates of the plotted data as an encoded typed array.</param>
/// <param name="yEncoded">Sets the y coordinates of the plotted data as an encoded typed array.</param>
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>
/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>
/// <param name="Opacity">Sets the Opacity of the trace.</param>
/// <param name="Width">Sets the bar width (in position axis units).</param>
/// <param name="Offset">Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead.</param>
/// <param name="Text">Sets a text associated with each datum</param>
/// <param name="MultiText">Sets individual text for each datum</param>
/// <param name="TextPosition">Sets the position of text associated with each datum</param>
/// <param name="MultiTextPosition">Sets the position of text associated with individual datum</param>
/// <param name="Orientation">Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.</param>
/// <param name="AlignmentGroup">Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.</param>
/// <param name="OffsetGroup">Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.</param>
/// <param name="MarkerColor">Sets the color of the bars.</param>
/// <param name="MarkerOutline">Sets the color of the bar outline.</param>
/// <param name="Marker">Sets the marker (use this for more finegrained control than the other marker-associated arguments)</param>
/// <param name="TextInfo">Determines which trace information appear on the graph. In the case of having multiple funnels, percentages and totals are computed separately (per trace).</param>
/// <param name="ConnectorLineColor">Sets the line color of the funnel connector</param>
/// <param name="ConnectorLineStyle">Sets the line style of the funnel connector</param>
/// <param name="ConnectorFillColor">Sets the fill color of the funnel connector</param>
/// <param name="ConnectorLine">Sets the line of the funnel connector (use this for more finegrained control than the other connector line associated arguments).</param>
/// <param name="Connector">Sets the funnel connector (use this for more finegrained control than the other connector-associated arguments).</param>
/// <param name="InsideTextFont">Sets the font used for `text` lying inside the bar.</param>
/// <param name="OutsideTextFont">Sets the font used for `text` lying outside the bar.</param>
/// <param name="UseDefaults">If set to false, ignore the global default settings set in `Defaults`</param>
[<Extension>]
static member Funnel
(
xEncoded: EncodedTypedArray,
yEncoded: EncodedTypedArray,
?Name: string,
?ShowLegend: bool,
?Opacity: float,
?Width: float,
?Offset: float,
?Text: #IConvertible,
?MultiText: seq<#IConvertible>,
?TextPosition: StyleParam.TextPosition,
?MultiTextPosition: seq<StyleParam.TextPosition>,
?Orientation: StyleParam.Orientation,
?AlignmentGroup: string,
?OffsetGroup: string,
?MarkerColor: Color,
?MarkerOutline: Line,
?Marker: Marker,
?TextInfo: StyleParam.TextInfo,
?ConnectorLineColor: Color,
?ConnectorLineStyle: StyleParam.DrawingStyle,
?ConnectorFillColor: Color,
?ConnectorLine: Line,
?Connector: FunnelConnector,
?InsideTextFont: Font,
?OutsideTextFont: Font,
?UseDefaults: bool
) =
let useDefaults =
defaultArg UseDefaults true
let marker =
Marker
|> Option.defaultValue (TraceObjects.Marker.init ())
|> TraceObjects.Marker.style (?Color = MarkerColor, ?Outline = MarkerOutline)
let connectorLine =
ConnectorLine
|> Option.map (Plotly.NET.Line.style (?Color = ConnectorLineColor, ?Dash = ConnectorLineStyle))
let connector =
Connector
|> Option.defaultValue (TraceObjects.FunnelConnector.init ())
|> TraceObjects.FunnelConnector.style (?FillColor = ConnectorFillColor, ?Line = connectorLine)
Trace2D.initFunnel (
Trace2DStyle.Funnel(
?Name = Name,
?ShowLegend = ShowLegend,
?Opacity = Opacity,
XEncoded = xEncoded,
YEncoded = yEncoded,
?Width = Width,
?Offset = Offset,
?Text = Text,
?MultiText = MultiText,
?TextPosition = TextPosition,
?MultiTextPosition = MultiTextPosition,
?Orientation = Orientation,
?AlignmentGroup = AlignmentGroup,
?OffsetGroup = OffsetGroup,
Marker = marker,
?TextInfo = TextInfo,
Connector = connector,
?InsideTextFont = InsideTextFont,
?OutsideTextFont = OutsideTextFont
)
)
|> GenericChart.ofTraceObject useDefaults
/// <summary>
/// Creates a stacked Funnel chart, a variation of the funnel chart where multiple funnel bars of each stage are stacked on top of each other.
/// To create this type of chart, combine multiple of these charts via `Chart.combine`.
///
/// Funnel charts visualize stages in a process using length-encoded bars. This trace can be used to show data in either a part-to-whole representation wherein each item appears in a single stage, or in a "drop-off" representation wherein each item appears in each stage it traversed. See also the "funnelarea" trace type for a different approach to visualizing funnel data.
/// </summary>
/// <param name="x">Sets the x coordinates of the plotted data.</param>
/// <param name="y">Sets the y coordinates of the plotted data.</param>
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>
/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>
/// <param name="Opacity">Sets the Opacity of the trace.</param>
/// <param name="Width">Sets the bar width (in position axis units).</param>
/// <param name="Offset">Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead.</param>
/// <param name="Text">Sets a text associated with each datum</param>
/// <param name="MultiText">Sets individual text for each datum</param>
/// <param name="TextPosition">Sets the position of text associated with each datum</param>
/// <param name="MultiTextPosition">Sets the position of text associated with individual datum</param>
/// <param name="Orientation">Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.</param>
/// <param name="AlignmentGroup">Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.</param>
/// <param name="OffsetGroup">Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.</param>
/// <param name="MarkerColor">Sets the color of the bars.</param>
/// <param name="MarkerOutline">Sets the color of the bar outline.</param>
/// <param name="Marker">Sets the marker (use this for more finegrained control than the other marker-associated arguments)</param>
/// <param name="TextInfo">Determines which trace information appear on the graph. In the case of having multiple funnels, percentages and totals are computed separately (per trace).</param>
/// <param name="ConnectorLineColor">Sets the line color of the funnel connector</param>
/// <param name="ConnectorLineStyle">Sets the line style of the funnel connector</param>
/// <param name="ConnectorFillColor">Sets the fill color of the funnel connector</param>
/// <param name="ConnectorLine">Sets the line of the funnel connector (use this for more finegrained control than the other connector line associated arguments).</param>
/// <param name="Connector">Sets the funnel connector (use this for more finegrained control than the other connector-associated arguments).</param>
/// <param name="InsideTextFont">Sets the font used for `text` lying inside the bar.</param>
/// <param name="OutsideTextFont">Sets the font used for `text` lying outside the bar.</param>
/// <param name="UseDefaults">If set to false, ignore the global default settings set in `Defaults`</param>
static member StackedFunnel
(
x: seq<#IConvertible>,
y: seq<#IConvertible>,
?Name: string,
?ShowLegend: bool,
?Opacity: float,
?Width: float,
?Offset: float,
?Text: #IConvertible,
?MultiText: seq<#IConvertible>,
?TextPosition: StyleParam.TextPosition,
?MultiTextPosition: seq<StyleParam.TextPosition>,
?Orientation: StyleParam.Orientation,
?AlignmentGroup: string,
?OffsetGroup: string,
?MarkerColor: Color,
?MarkerOutline: Line,
?Marker: Marker,
?TextInfo: StyleParam.TextInfo,
?ConnectorLineColor: Color,
?ConnectorLineStyle: StyleParam.DrawingStyle,
?ConnectorFillColor: Color,
?ConnectorLine: Line,
?Connector: FunnelConnector,
?InsideTextFont: Font,
?OutsideTextFont: Font,
?UseDefaults: bool
) =
Chart.Funnel(
x = x,
y = y,
?Name = Name,
?ShowLegend = ShowLegend,
?Opacity = Opacity,
?Width = Width,
?Offset = Offset,
?Text = Text,
?MultiText = MultiText,
?TextPosition = TextPosition,
?MultiTextPosition = MultiTextPosition,
?Orientation = Orientation,
?AlignmentGroup = AlignmentGroup,
?OffsetGroup = OffsetGroup,
?MarkerColor = MarkerColor,
?MarkerOutline = MarkerOutline,
?Marker = Marker,
?TextInfo = TextInfo,
?ConnectorLineColor = ConnectorLineColor,
?ConnectorLineStyle = ConnectorLineStyle,
?ConnectorFillColor = ConnectorFillColor,
?ConnectorLine = ConnectorLine,
?Connector = Connector,
?InsideTextFont = InsideTextFont,
?OutsideTextFont = OutsideTextFont,
?UseDefaults = UseDefaults
)
|> GenericChart.mapLayout (Layout.style (FunnelMode = StyleParam.FunnelMode.Stack))
/// <summary>Creates a stacked funnel chart from encoded x and y coordinates.</summary>
[<Extension>]
static member StackedFunnel
(
xEncoded: EncodedTypedArray,
yEncoded: EncodedTypedArray,
?Name: string,
?ShowLegend: bool,
?Opacity: float,
?Width: float,
?Offset: float,
?Text: #IConvertible,
?MultiText: seq<#IConvertible>,
?TextPosition: StyleParam.TextPosition,
?MultiTextPosition: seq<StyleParam.TextPosition>,
?Orientation: StyleParam.Orientation,
?AlignmentGroup: string,
?OffsetGroup: string,
?MarkerColor: Color,
?MarkerOutline: Line,
?Marker: Marker,
?TextInfo: StyleParam.TextInfo,
?ConnectorLineColor: Color,
?ConnectorLineStyle: StyleParam.DrawingStyle,
?ConnectorFillColor: Color,
?ConnectorLine: Line,
?Connector: FunnelConnector,
?InsideTextFont: Font,
?OutsideTextFont: Font,
?UseDefaults: bool
) =
Chart.Funnel(
xEncoded = xEncoded,
yEncoded = yEncoded,
?Name = Name,
?ShowLegend = ShowLegend,
?Opacity = Opacity,
?Width = Width,
?Offset = Offset,
?Text = Text,
?MultiText = MultiText,
?TextPosition = TextPosition,
?MultiTextPosition = MultiTextPosition,
?Orientation = Orientation,
?AlignmentGroup = AlignmentGroup,
?OffsetGroup = OffsetGroup,
?MarkerColor = MarkerColor,
?MarkerOutline = MarkerOutline,
?Marker = Marker,
?TextInfo = TextInfo,
?ConnectorLineColor = ConnectorLineColor,
?ConnectorLineStyle = ConnectorLineStyle,
?ConnectorFillColor = ConnectorFillColor,
?ConnectorLine = ConnectorLine,
?Connector = Connector,
?InsideTextFont = InsideTextFont,
?OutsideTextFont = OutsideTextFont,
?UseDefaults = UseDefaults
)
|> GenericChart.mapLayout (Layout.style (FunnelMode = StyleParam.FunnelMode.Stack))
/// <summary>
/// Creates a waterfall chart.
///
/// Waterfall charts are special bar charts that help visualizing the cumulative effect of sequentially introduced positive or negative values
/// </summary>
/// <param name="x">Sets the x coordinates of the plotted data.</param>
/// <param name="y">Sets the y coordinates of the plotted data.</param>
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>
/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>
/// <param name="IncreasingColor">Sets the color of increasing values</param>
/// <param name="Increasing">Sets the style options of increasing values (use this for more finegrained control than the other increasing-associated arguments).</param>
/// <param name="DecreasingColor">Sets the color of decreasing values</param>
/// <param name="Decreasing">Sets the style options of decreasing values (use this for more finegrained control than the other increasing-associated arguments).</param>
/// <param name="TotalsColor">Sets the color of total values</param>
/// <param name="Totals">Sets the style options of total values (use this for more finegrained control than the other increasing-associated arguments).</param>
/// <param name="Base">Sets where the bar base is drawn (in position axis units).</param>
/// <param name="Width">Sets the bar width (in position axis units).</param>
/// <param name="MultiWidth">Sets the individual bar width of each datum (in position axis units).</param>
/// <param name="Opacity">Sets the opacity of the trace.</param>
/// <param name="Text">Sets a text associated with each datum</param>
/// <param name="MultiText">Sets individual text for each datum</param>
/// <param name="TextPosition">Sets the position of text associated with each datum</param>
/// <param name="MultiTextPosition">Sets the position of text associated with individual datum</param>
/// <param name="TextFont">Sets the font used for `text`.</param>
/// <param name="Connector">Sets the waterfall connector of this trace</param>
/// <param name="Measure">An array containing types of measures. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed.</param>
/// <param name="AlignmentGroup">Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.</param>
/// <param name="OffsetGroup">Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.</param>
/// <param name="Orientation">Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.</param>
/// <param name="UseDefaults">If set to false, ignore the global default settings set in `Defaults`</param>
[<Extension>]
static member Waterfall
(
x: seq<#IConvertible>,
y: seq<#IConvertible>,
?Name: string,
?ShowLegend: bool,
?IncreasingColor: Color,
?Increasing: FinanceMarker,
?DecreasingColor: Color,
?Decreasing: FinanceMarker,
?TotalsColor: Color,
?Totals: FinanceMarker,
?Base: float,
?Width: float,
?MultiWidth: seq<float>,
?Opacity: float,
?Text: #IConvertible,
?MultiText: seq<#IConvertible>,
?TextPosition: StyleParam.TextPosition,
?MultiTextPosition: seq<StyleParam.TextPosition>,
?TextFont: Font,
?Connector: WaterfallConnector,
?Measure: StyleParam.WaterfallMeasure seq,
?AlignmentGroup: string,
?OffsetGroup: string,
?Orientation: StyleParam.Orientation,
?UseDefaults: bool
) =
let useDefaults =
defaultArg UseDefaults true
let increasing =
Increasing
|> Option.defaultValue (FinanceMarker.init ())
|> FinanceMarker.style (?FillColor = IncreasingColor)
let decreasing =
Decreasing
|> Option.defaultValue (FinanceMarker.init ())
|> FinanceMarker.style (?FillColor = DecreasingColor)
let totals =
Totals
|> Option.defaultValue (FinanceMarker.init ())
|> FinanceMarker.style (?FillColor = TotalsColor)
Trace2D.initWaterfall (
Trace2DStyle.Waterfall(
X = x,
Y = y,
?Name = Name,
?ShowLegend = ShowLegend,
Increasing = increasing,
Decreasing = decreasing,
Totals = totals,
?Base = Base,
?Width = Width,
?MultiWidth = MultiWidth,
?Opacity = Opacity,
?Text = Text,
?MultiText = MultiText,
?TextPosition = TextPosition,
?MultiTextPosition = MultiTextPosition,
?TextFont = TextFont,
?Connector = Connector,
?Measure = Measure,
?AlignmentGroup = AlignmentGroup,
?OffsetGroup = OffsetGroup,
?Orientation = Orientation
)
)
|> GenericChart.ofTraceObject useDefaults
/// <summary>
/// Creates a waterfall chart from encoded x and y coordinates.
///
/// Waterfall charts are special bar charts that help visualizing the cumulative effect of sequentially introduced positive or negative values
/// </summary>
/// <param name="xEncoded">Sets the x coordinates of the plotted data as an encoded typed array.</param>
/// <param name="yEncoded">Sets the y coordinates of the plotted data as an encoded typed array.</param>
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>
/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>
/// <param name="IncreasingColor">Sets the color of increasing values</param>
/// <param name="Increasing">Sets the style options of increasing values (use this for more finegrained control than the other increasing-associated arguments).</param>
/// <param name="DecreasingColor">Sets the color of decreasing values</param>
/// <param name="Decreasing">Sets the style options of decreasing values (use this for more finegrained control than the other increasing-associated arguments).</param>
/// <param name="TotalsColor">Sets the color of total values</param>
/// <param name="Totals">Sets the style options of total values (use this for more finegrained control than the other increasing-associated arguments).</param>
/// <param name="Base">Sets where the bar base is drawn (in position axis units).</param>
/// <param name="Width">Sets the bar width (in position axis units).</param>
/// <param name="MultiWidthEncoded">Sets the individual bar width for each bar as an encoded typed array.</param>
/// <param name="Opacity">Sets the opacity of the trace.</param>
/// <param name="Text">Sets a text associated with each datum</param>
/// <param name="MultiText">Sets individual text for each datum</param>
/// <param name="TextPosition">Sets the position of text associated with each datum</param>
/// <param name="MultiTextPosition">Sets the position of text associated with individual datum</param>
/// <param name="TextFont">Sets the font used for `text`.</param>
/// <param name="Connector">Sets the waterfall connector of this trace</param>
/// <param name="Measure">An array containing types of measures. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed.</param>
/// <param name="AlignmentGroup">Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.</param>
/// <param name="OffsetGroup">Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.</param>
/// <param name="Orientation">Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.</param>
/// <param name="UseDefaults">If set to false, ignore the global default settings set in `Defaults`</param>
[<Extension>]
static member Waterfall
(
xEncoded: EncodedTypedArray,
yEncoded: EncodedTypedArray,
?Name: string,
?ShowLegend: bool,
?IncreasingColor: Color,
?Increasing: FinanceMarker,
?DecreasingColor: Color,
?Decreasing: FinanceMarker,
?TotalsColor: Color,
?Totals: FinanceMarker,
?Base: float,
?Width: float,
?MultiWidthEncoded: EncodedTypedArray,
?Opacity: float,
?Text: #IConvertible,
?MultiText: seq<#IConvertible>,
?TextPosition: StyleParam.TextPosition,
?MultiTextPosition: seq<StyleParam.TextPosition>,
?TextFont: Font,
?Connector: WaterfallConnector,
?Measure: StyleParam.WaterfallMeasure seq,
?AlignmentGroup: string,
?OffsetGroup: string,
?Orientation: StyleParam.Orientation,
?UseDefaults: bool
) =
let useDefaults =
defaultArg UseDefaults true
let increasing =
Increasing
|> Option.defaultValue (FinanceMarker.init ())
|> FinanceMarker.style (?FillColor = IncreasingColor)
let decreasing =
Decreasing
|> Option.defaultValue (FinanceMarker.init ())
|> FinanceMarker.style (?FillColor = DecreasingColor)
let totals =
Totals
|> Option.defaultValue (FinanceMarker.init ())
|> FinanceMarker.style (?FillColor = TotalsColor)
Trace2D.initWaterfall (
Trace2DStyle.Waterfall(
XEncoded = xEncoded,
YEncoded = yEncoded,
?Name = Name,
?ShowLegend = ShowLegend,
Increasing = increasing,
Decreasing = decreasing,
Totals = totals,
?Base = Base,
?Width = Width,
?MultiWidthEncoded = MultiWidthEncoded,
?Opacity = Opacity,
?Text = Text,
?MultiText = MultiText,
?TextPosition = TextPosition,
?MultiTextPosition = MultiTextPosition,
?TextFont = TextFont,
?Connector = Connector,
?Measure = Measure,
?AlignmentGroup = AlignmentGroup,
?OffsetGroup = OffsetGroup,
?Orientation = Orientation
)
)
|> GenericChart.ofTraceObject useDefaults
/// <summary>
/// Creates a waterfall chart.
///
/// Waterfall charts are special bar charts that help visualizing the cumulative effect of sequentially introduced positive or negative values
/// </summary>
/// <param name="xy">Sets the x and y coordinates of the plotted data.</param>
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>
/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>
/// <param name="IncreasingColor">Sets the color of increasing values</param>
/// <param name="Increasing">Sets the style options of increasing values (use this for more finegrained control than the other increasing-associated arguments).</param>
/// <param name="DecreasingColor">Sets the color of decreasing values</param>
/// <param name="Decreasing">Sets the style options of decreasing values (use this for more finegrained control than the other increasing-associated arguments).</param>
/// <param name="TotalsColor">Sets the color of total values</param>
/// <param name="Totals">Sets the style options of total values (use this for more finegrained control than the other increasing-associated arguments).</param>
/// <param name="Base">Sets where the bar base is drawn (in position axis units).</param>
/// <param name="Width">Sets the bar width (in position axis units).</param>
/// <param name="MultiWidth">Sets the individual bar width of each datum (in position axis units).</param>
/// <param name="Opacity">Sets the opacity of the trace.</param>
/// <param name="Text">Sets a text associated with each datum</param>
/// <param name="MultiText">Sets individual text for each datum</param>
/// <param name="TextPosition">Sets the position of text associated with each datum</param>
/// <param name="MultiTextPosition">Sets the position of text associated with individual datum</param>
/// <param name="TextFont">Sets the font used for `text`.</param>
/// <param name="Connector">Sets the waterfall connector of this trace</param>
/// <param name="Measure">An array containing types of measures. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed.</param>
/// <param name="AlignmentGroup">Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.</param>
/// <param name="OffsetGroup">Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.</param>
/// <param name="Orientation">Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.</param>
/// <param name="UseDefaults">If set to false, ignore the global default settings set in `Defaults`</param>
[<Extension>]
static member Waterfall
(
xy: seq<#IConvertible * #IConvertible>,
?Name: string,
?ShowLegend: bool,
?IncreasingColor: Color,
?Increasing: FinanceMarker,
?DecreasingColor: Color,
?Decreasing: FinanceMarker,
?TotalsColor: Color,
?Totals: FinanceMarker,
?Base: float,
?Width: float,
?MultiWidth: seq<float>,
?Opacity: float,
?Text: #IConvertible,
?MultiText: seq<#IConvertible>,
?TextPosition: StyleParam.TextPosition,
?MultiTextPosition: seq<StyleParam.TextPosition>,
?TextFont: Font,
?Connector: WaterfallConnector,
?Measure: StyleParam.WaterfallMeasure seq,
?AlignmentGroup: string,
?OffsetGroup: string,
?Orientation: StyleParam.Orientation,
?UseDefaults: bool
) =
let x, y = Seq.unzip xy
Chart.Waterfall(
x = x,
y = y,
?Name = Name,
?ShowLegend = ShowLegend,
?IncreasingColor = IncreasingColor,
?Increasing = Increasing,
?DecreasingColor = DecreasingColor,
?Decreasing = Decreasing,
?TotalsColor = TotalsColor,
?Totals = Totals,
?Base = Base,
?Width = Width,
?MultiWidth = MultiWidth,
?Opacity = Opacity,
?Text = Text,
?MultiText = MultiText,
?TextPosition = TextPosition,
?MultiTextPosition = MultiTextPosition,
?TextFont = TextFont,
?Connector = Connector,
?Measure = Measure,
?AlignmentGroup = AlignmentGroup,
?OffsetGroup = OffsetGroup,
?Orientation = Orientation,
?UseDefaults = UseDefaults
)
/// <summary>
/// Creates a waterfall chart.
///
/// Waterfall charts are special bar charts that help visualizing the cumulative effect of sequentially introduced positive or negative values
/// </summary>
/// <param name="xymeasures">Sets the x and y coordinates of the plotted data, together with a measure for each (x,y) pair that defines the type of computation done for each pair.</param>
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>
/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>
/// <param name="IncreasingColor">Sets the color of increasing values</param>
/// <param name="Increasing">Sets the style options of increasing values (use this for more finegrained control than the other increasing-associated arguments).</param>
/// <param name="DecreasingColor">Sets the color of decreasing values</param>
/// <param name="Decreasing">Sets the style options of decreasing values (use this for more finegrained control than the other increasing-associated arguments).</param>
/// <param name="TotalsColor">Sets the color of total values</param>
/// <param name="Totals">Sets the style options of total values (use this for more finegrained control than the other increasing-associated arguments).</param>
/// <param name="Base">Sets where the bar base is drawn (in position axis units).</param>
/// <param name="Width">Sets the bar width (in position axis units).</param>
/// <param name="MultiWidth">Sets the individual bar width of each datum (in position axis units).</param>
/// <param name="Opacity">Sets the opacity of the trace.</param>
/// <param name="Text">Sets a text associated with each datum</param>
/// <param name="MultiText">Sets individual text for each datum</param>
/// <param name="TextPosition">Sets the position of text associated with each datum</param>
/// <param name="MultiTextPosition">Sets the position of text associated with individual datum</param>
/// <param name="TextFont">Sets the font used for `text`.</param>
/// <param name="Connector">Sets the waterfall connector of this trace</param>
/// <param name="AlignmentGroup">Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.</param>
/// <param name="OffsetGroup">Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.</param>
/// <param name="Orientation">Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.</param>
/// <param name="UseDefaults">If set to false, ignore the global default settings set in `Defaults`</param>
[<Extension>]
static member Waterfall
(
xymeasures: seq<#IConvertible * #IConvertible * StyleParam.WaterfallMeasure>,
?Name: string,
?ShowLegend: bool,
?IncreasingColor: Color,
?Increasing: FinanceMarker,
?DecreasingColor: Color,
?Decreasing: FinanceMarker,
?TotalsColor: Color,
?Totals: FinanceMarker,
?Base: float,
?Width: float,
?MultiWidth: seq<float>,
?Opacity: float,
?Text: #IConvertible,
?MultiText: seq<#IConvertible>,
?TextPosition: StyleParam.TextPosition,
?MultiTextPosition: seq<StyleParam.TextPosition>,
?TextFont: Font,
?Connector: WaterfallConnector,
?AlignmentGroup: string,
?OffsetGroup: string,
?Orientation: StyleParam.Orientation,
?UseDefaults: bool
) =
let x, y, measure = Seq.unzip3 xymeasures
Chart.Waterfall(
x = x,
y = y,
?Name = Name,
?ShowLegend = ShowLegend,
?IncreasingColor = IncreasingColor,
?Increasing = Increasing,
?DecreasingColor = DecreasingColor,
?Decreasing = Decreasing,
?TotalsColor = TotalsColor,
?Totals = Totals,
?Base = Base,
?Width = Width,
?MultiWidth = MultiWidth,
?Opacity = Opacity,
?Text = Text,
?MultiText = MultiText,
?TextPosition = TextPosition,
?MultiTextPosition = MultiTextPosition,
?TextFont = TextFont,
?Connector = Connector,
Measure = measure,
?AlignmentGroup = AlignmentGroup,
?OffsetGroup = OffsetGroup,
?Orientation = Orientation,
?UseDefaults = UseDefaults
)