plotlyjs v 2.15: Add angle, angleref and standoff to marker and add backoff to line

kMutagene · kMutagene · commit 7b8ff1a1983d · 2023-02-08T13:55:07.000+01:00
diff --git a/src/Plotly.NET/ChartAPI/GenericChart.fs b/src/Plotly.NET/ChartAPI/GenericChart.fs
@@ -15,7 +15,7 @@ module HTML =
     <head>
         <!-- Plotly.js -->
         <meta http-equiv="X-UA-Compatible" content="IE=11" >
-        <script src="https://cdn.plot.ly/plotly-2.14.0.min.js"></script>
+        <script src="https://cdn.plot.ly/plotly-2.15.1.min.js"></script>
         [ADDITIONAL_HEAD_TAGS]
         <style>
         .container {
@@ -58,7 +58,7 @@ module HTML =
         newScript.AppendLine(
             @"
             var renderPlotly_[SCRIPTID] = function() {
-            var fsharpPlotlyRequire = requirejs.config({context:'fsharp-plotly',paths:{plotly:'https://cdn.plot.ly/plotly-2.14.0.min'}}) || require;
+            var fsharpPlotlyRequire = requirejs.config({context:'fsharp-plotly',paths:{plotly:'https://cdn.plot.ly/plotly-2.15.1.min'}}) || require;
             fsharpPlotlyRequire(['plotly'], function(Plotly) {"
         )
         |> ignore
diff --git a/src/Plotly.NET/CommonAbstractions/Line.fs b/src/Plotly.NET/CommonAbstractions/Line.fs
@@ -11,6 +11,7 @@ type Line() =
     /// <summary>
     /// Returns a new Line object with the given styling.
     /// </summary>
+    /// <param name="BackOff">Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With "auto" the lines would trim before markers if `marker.angleref` is set to "previous".</param>
     /// <param name="AutoColorScale">Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.</param>
     /// <param name="CAuto">Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.</param>
     /// <param name="CMax">Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.</param>
@@ -32,6 +33,7 @@ type Line() =
     /// <param name="OutlierWidth">Sets the width of the outline of outliers</param>
     static member init
         (
+            [<Optional; DefaultParameterValue(null)>] ?BackOff: StyleParam.BackOff,
             [<Optional; DefaultParameterValue(null)>] ?AutoColorScale: bool,
             [<Optional; DefaultParameterValue(null)>] ?CAuto: bool,
             [<Optional; DefaultParameterValue(null)>] ?CMax: float,
@@ -54,6 +56,7 @@ type Line() =
         ) =
         Line()
         |> Line.style (
+            ?BackOff = BackOff,
             ?AutoColorScale = AutoColorScale,
             ?CAuto = CAuto,
             ?CMax = CMax,
@@ -78,6 +81,7 @@ type Line() =
     /// <summary>
     /// Returns a function that applies the given styles to a Line object.
     /// </summary>
+    /// <param name="BackOff">Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With "auto" the lines would trim before markers if `marker.angleref` is set to "previous".</param>
     /// <param name="AutoColorScale">Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.</param>
     /// <param name="CAuto">Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.</param>
     /// <param name="CMax">Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.</param>
@@ -99,6 +103,7 @@ type Line() =
     /// <param name="OutlierWidth">Sets the width of the outline of outliers</param>
     static member style
         (
+            [<Optional; DefaultParameterValue(null)>] ?BackOff: StyleParam.BackOff,
             [<Optional; DefaultParameterValue(null)>] ?AutoColorScale: bool,
             [<Optional; DefaultParameterValue(null)>] ?CAuto: bool,
             [<Optional; DefaultParameterValue(null)>] ?CMax: float,
@@ -120,6 +125,7 @@ type Line() =
             [<Optional; DefaultParameterValue(null)>] ?OutlierWidth: float
         ) =
         (fun (line: Line) ->
+            BackOff |> DynObj.setValueOptBy line "backoff" StyleParam.BackOff.convert
             Color |> DynObj.setValueOpt line "color"
             (Width, MultiWidth) |> DynObj.setSingleOrMultiOpt line "width"
             Shape |> DynObj.setValueOptBy line "shape" StyleParam.Shape.convert
diff --git a/src/Plotly.NET/CommonAbstractions/StyleParams.fs b/src/Plotly.NET/CommonAbstractions/StyleParams.fs
@@ -13,6 +13,20 @@ module StyleParam =
 // #A#
 //--------------------------
 
+    [<RequireQualifiedAccess>]
+    type AngleRef =
+        | Previous
+        | Up
+
+        static member toString =
+            function
+            | Previous -> "previous"
+            | Up -> "up"
+
+        static member convert = AngleRef.toString >> box
+        override this.ToString() = this |> AngleRef.toString
+        member this.Convert() = this |> AngleRef.convert
+
     [<RequireQualifiedAccess>]
     type ArrowSide =
         | Start
@@ -292,6 +306,22 @@ module StyleParam =
 // #B#
 //--------------------------
 
+    [<RequireQualifiedAccess>]
+    type BackOff =
+        | Auto
+        | Value of int
+        | Array of seq<int>
+
+        static member convert =
+            function
+            | Auto -> box "auto"
+            | Value v -> box v
+            | Array a -> box a
+
+
+        member this.Convert() = this |> BackOff.convert
+
+
     [<RequireQualifiedAccess>]
     type BoxPoints =
         | Outliers
diff --git a/src/Plotly.NET/Traces/ObjectAbstractions/Marker.fs b/src/Plotly.NET/Traces/ObjectAbstractions/Marker.fs
@@ -13,6 +13,8 @@ type Marker() =
     /// <summary>
     /// Returns a new Marker object with the given styling.
     /// </summary>
+    /// <param name="Angle">Sets the marker angle in respect to `angleref`.</param>
+    /// <param name="AngleRef">Sets the reference for marker angle. With "previous", angle 0 points along the line from the previous point to this one. With "up", angle 0 points toward the top of the screen.</param>
     /// <param name="AutoColorScale">Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.</param>
     /// <param name="CAuto">Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.</param>
     /// <param name="CMax">Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.</param>
@@ -36,6 +38,8 @@ type Marker() =
     /// <param name="SizeMin">Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.</param>
     /// <param name="SizeMode">Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.</param>
     /// <param name="SizeRef">Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.</param>
+    /// <param name="StandOff">Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.</param>
+    /// <param name="MultiStandOff">Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.</param>
     /// <param name="Symbol">Sets the marker symbol.</param>
     /// <param name="MultiSymbol">Sets the individual marker symbols.</param>
     /// <param name="Symbol3D">Sets the marker symbol for 3d traces.</param>
@@ -44,6 +48,8 @@ type Marker() =
     /// <param name="OutlierWidth">Sets the width of the outlier sample points.</param>
     static member init
         (
+            [<Optional; DefaultParameterValue(null)>] ?Angle: float,
+            [<Optional; DefaultParameterValue(null)>] ?AngleRef: StyleParam.AngleRef,
             [<Optional; DefaultParameterValue(null)>] ?AutoColorScale: bool,
             [<Optional; DefaultParameterValue(null)>] ?CAuto: bool,
             [<Optional; DefaultParameterValue(null)>] ?CMax: float,
@@ -67,6 +73,8 @@ type Marker() =
             [<Optional; DefaultParameterValue(null)>] ?SizeMin: int,
             [<Optional; DefaultParameterValue(null)>] ?SizeMode: StyleParam.MarkerSizeMode,
             [<Optional; DefaultParameterValue(null)>] ?SizeRef: int,
+            [<Optional; DefaultParameterValue(null)>] ?StandOff: float,
+            [<Optional; DefaultParameterValue(null)>] ?MultiStandOff: seq<float>,
             [<Optional; DefaultParameterValue(null)>] ?Symbol: StyleParam.MarkerSymbol,
             [<Optional; DefaultParameterValue(null)>] ?MultiSymbol: seq<StyleParam.MarkerSymbol>,
             [<Optional; DefaultParameterValue(null)>] ?Symbol3D: StyleParam.MarkerSymbol3D,
@@ -76,6 +84,8 @@ type Marker() =
         ) =
         Marker()
         |> Marker.style (
+            ?Angle=Angle,
+            ?AngleRef=AngleRef,
             ?AutoColorScale = AutoColorScale,
             ?CAuto = CAuto,
             ?CMax = CMax,
@@ -104,12 +114,16 @@ type Marker() =
             ?ShowScale = ShowScale,
             ?SizeMin = SizeMin,
             ?SizeMode = SizeMode,
-            ?SizeRef = SizeRef
+            ?SizeRef = SizeRef,
+            ?StandOff = StandOff,
+            ?MultiStandOff = MultiStandOff
         )
 
     /// <summary>
     /// Returns a function that applies the given styles to a Marker object.
     /// </summary>
+    /// <param name="Angle">Sets the marker angle in respect to `angleref`.</param>
+    /// <param name="AngleRef">Sets the reference for marker angle. With "previous", angle 0 points along the line from the previous point to this one. With "up", angle 0 points toward the top of the screen.</param>
     /// <param name="AutoColorScale">Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.</param>
     /// <param name="CAuto">Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.</param>
     /// <param name="CMax">Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.</param>
@@ -133,6 +147,8 @@ type Marker() =
     /// <param name="SizeMin">Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.</param>
     /// <param name="SizeMode">Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.</param>
     /// <param name="SizeRef">Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.</param>
+    /// <param name="StandOff">Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.</param>
+    /// <param name="MultiStandOff">Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.</param>
     /// <param name="Symbol">Sets the marker symbol.</param>
     /// <param name="MultiSymbol">Sets the individual marker symbols.</param>
     /// <param name="Symbol3D">Sets the marker symbol for 3d traces.</param>
@@ -141,6 +157,8 @@ type Marker() =
     /// <param name="OutlierWidth">Sets the width of the outlier sample points.</param>
     static member style
         (
+            [<Optional; DefaultParameterValue(null)>] ?Angle: float,
+            [<Optional; DefaultParameterValue(null)>] ?AngleRef: StyleParam.AngleRef,
             [<Optional; DefaultParameterValue(null)>] ?AutoColorScale: bool,
             [<Optional; DefaultParameterValue(null)>] ?CAuto: bool,
             [<Optional; DefaultParameterValue(null)>] ?CMax: float,
@@ -164,6 +182,8 @@ type Marker() =
             [<Optional; DefaultParameterValue(null)>] ?SizeMin: int,
             [<Optional; DefaultParameterValue(null)>] ?SizeMode: StyleParam.MarkerSizeMode,
             [<Optional; DefaultParameterValue(null)>] ?SizeRef: int,
+            [<Optional; DefaultParameterValue(null)>] ?StandOff: float,
+            [<Optional; DefaultParameterValue(null)>] ?MultiStandOff: seq<float>,
             [<Optional; DefaultParameterValue(null)>] ?Symbol: StyleParam.MarkerSymbol,
             [<Optional; DefaultParameterValue(null)>] ?MultiSymbol: seq<StyleParam.MarkerSymbol>,
             [<Optional; DefaultParameterValue(null)>] ?Symbol3D: StyleParam.MarkerSymbol3D,
@@ -173,6 +193,8 @@ type Marker() =
         ) =
         (fun (marker: Marker) ->
 
+            Angle |> DynObj.setValueOpt marker "angle"
+            AngleRef |> DynObj.setValueOptBy marker "angleref" StyleParam.AngleRef.convert
             AutoColorScale |> DynObj.setValueOpt marker "autocolorscale"
             CAuto |> DynObj.setValueOpt marker "cauto"
             CMax |> DynObj.setValueOpt marker "cmax"
@@ -198,5 +220,6 @@ type Marker() =
             SizeMin |> DynObj.setValueOpt marker "sizemin"
             SizeMode |> DynObj.setValueOpt marker "sizemode"
             SizeRef |> DynObj.setValueOpt marker "sizeref"
+            (StandOff, MultiStandOff) |> DynObj.setSingleOrMultiOpt marker "standoff"
 
             marker)
diff --git a/tests/Plotly.NET.Tests/HtmlCodegen/SimpleTests.fs b/tests/Plotly.NET.Tests/HtmlCodegen/SimpleTests.fs
@@ -20,7 +20,7 @@ let simpleChart =
 let ``Html layout tests`` =
     testList "SimpleTests.Simple tests" [
         testCase "Expecting plotly js" ( fun () ->
-            "https://cdn.plot.ly/plotly-2.14.0.min"
+            "https://cdn.plot.ly/plotly-2.15.1.min"
             |> chartGeneratedContains simpleChart
         );
         testCase "Expecting data" ( fun () ->
@@ -36,7 +36,7 @@ let ``Html layout tests`` =
             |> chartGeneratedContains simpleChart
         );
         testCase "Expecting require config" (fun () ->
-            "var fsharpPlotlyRequire = requirejs.config({context:'fsharp-plotly',paths:{plotly:'https://cdn.plot.ly/plotly-2.14.0.min'}}) || require;"
+            "var fsharpPlotlyRequire = requirejs.config({context:'fsharp-plotly',paths:{plotly:'https://cdn.plot.ly/plotly-2.15.1.min'}}) || require;"
             |> chartGeneratedContains simpleChart
         );
         testCase "Expecting html tags in embedded page only" (fun () ->
