Skip to content

Commit 28de52f

Browse files
committed
plotlyjs v2.13: Add delta.prefix and delta.suffix to indicator trace (plotly/plotly.js#6246)
1 parent 5c7cadd commit 28de52f

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

src/Plotly.NET/Traces/ObjectAbstractions/Indicator.fs

+32
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,28 @@ type IndicatorSymbol() =
3232
type IndicatorDelta() =
3333
inherit DynamicObj()
3434

35+
/// <summary>
36+
/// Returns a new IndicatorDelta object with the given styles
37+
/// </summary>
38+
/// <param name="Decreasing">Sets the style of decreasing deltas.</param>
39+
/// <param name="Font">Set the font used to display the delta</param>
40+
/// <param name="Increasing">Sets the style of increasing deltas.</param>
41+
/// <param name="Position">Sets the position of delta with respect to the number.</param>
42+
/// <param name="Prefix">Sets a prefix appearing before the delta.</param>
43+
/// <param name="Reference">Sets the reference value to compute the delta. By default, it is set to the current value.</param>
44+
/// <param name="Relative">Show relative change</param>
45+
/// <param name="Suffix">Sets a suffix appearing next to the delta.</param>
46+
/// <param name="ValueFormat">Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.</param>
3547
static member init
3648
(
3749
[<Optional; DefaultParameterValue(null)>] ?Decreasing: IndicatorSymbol,
3850
[<Optional; DefaultParameterValue(null)>] ?Font: Font,
3951
[<Optional; DefaultParameterValue(null)>] ?Increasing: IndicatorSymbol,
4052
[<Optional; DefaultParameterValue(null)>] ?Position: StyleParam.IndicatorDeltaPosition,
53+
[<Optional; DefaultParameterValue(null)>] ?Prefix: string,
4154
[<Optional; DefaultParameterValue(null)>] ?Reference: #IConvertible,
4255
[<Optional; DefaultParameterValue(null)>] ?Relative: bool,
56+
[<Optional; DefaultParameterValue(null)>] ?Suffix: string,
4357
[<Optional; DefaultParameterValue(null)>] ?ValueFormat: string
4458
) =
4559
IndicatorDelta()
@@ -48,19 +62,35 @@ type IndicatorDelta() =
4862
?Font = Font,
4963
?Increasing = Increasing,
5064
?Position = Position,
65+
?Prefix = Prefix,
5166
?Reference = Reference,
5267
?Relative = Relative,
68+
?Suffix = Suffix,
5369
?ValueFormat = ValueFormat
5470
)
5571

72+
/// <summary>
73+
/// Returns a function that applies the given styles to an IndicatorDelta object
74+
/// </summary>
75+
/// <param name="Decreasing">Sets the style of decreasing deltas.</param>
76+
/// <param name="Font">Set the font used to display the delta</param>
77+
/// <param name="Increasing">Sets the style of increasing deltas.</param>
78+
/// <param name="Position">Sets the position of delta with respect to the number.</param>
79+
/// <param name="Prefix">Sets a prefix appearing before the delta.</param>
80+
/// <param name="Reference">Sets the reference value to compute the delta. By default, it is set to the current value.</param>
81+
/// <param name="Relative">Show relative change</param>
82+
/// <param name="Suffix">Sets a suffix appearing next to the delta.</param>
83+
/// <param name="ValueFormat">Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.</param>
5684
static member style
5785
(
5886
[<Optional; DefaultParameterValue(null)>] ?Decreasing: IndicatorSymbol,
5987
[<Optional; DefaultParameterValue(null)>] ?Font: Font,
6088
[<Optional; DefaultParameterValue(null)>] ?Increasing: IndicatorSymbol,
6189
[<Optional; DefaultParameterValue(null)>] ?Position: StyleParam.IndicatorDeltaPosition,
90+
[<Optional; DefaultParameterValue(null)>] ?Prefix: string,
6291
[<Optional; DefaultParameterValue(null)>] ?Reference: #IConvertible,
6392
[<Optional; DefaultParameterValue(null)>] ?Relative: bool,
93+
[<Optional; DefaultParameterValue(null)>] ?Suffix: string,
6494
[<Optional; DefaultParameterValue(null)>] ?ValueFormat: string
6595
) =
6696
(fun (indicatorDelta: IndicatorDelta) ->
@@ -69,8 +99,10 @@ type IndicatorDelta() =
6999
Font |> DynObj.setValueOpt indicatorDelta "font"
70100
Increasing |> DynObj.setValueOpt indicatorDelta "increasing"
71101
Position |> DynObj.setValueOptBy indicatorDelta "position" StyleParam.IndicatorDeltaPosition.convert
102+
Prefix |> DynObj.setValueOpt indicatorDelta "prefix"
72103
Reference |> DynObj.setValueOpt indicatorDelta "reference"
73104
Relative |> DynObj.setValueOpt indicatorDelta "relative"
105+
Suffix |> DynObj.setValueOpt indicatorDelta "suffix"
74106
ValueFormat |> DynObj.setValueOpt indicatorDelta "valueformat"
75107

76108
indicatorDelta)

0 commit comments

Comments
 (0)