Add Chart.withLayoutImage(s), adapt Chart.withShape(s)

Author: kMutagene

src/Plotly.NET/CSharpLayer/GenericChartExtensions.fs

@@ -493,12 +493,15 @@ module GenericChartExtensions =
         member this.WithConfig (config:Config) =
             GenericChart.setConfig config this
 
+        [<CompiledName("WithAnnotation")>]
+        [<Extension>]
+        member this.WithAnnotation(annotation:Annotation, [<Optional;DefaultParameterValue(true)>]?Append:bool) =
+            this |> Chart.withAnnotation(annotation, ?Append = Append)
+
         [<CompiledName("WithAnnotations")>]
         [<Extension>]
-        member this.WithAnnotations(annotations:seq<Annotation>) =
-            this
-            |> GenericChart.mapLayout 
-                (Layout.style (Annotations = annotations))
+        member this.WithAnnotations(annotations:Annotation seq, [<Optional;DefaultParameterValue(true)>]?Append:bool) =
+            this |> Chart.withAnnotations(annotations, ?Append = Append)
 
         // Set the title of a Chart
         [<CompiledName("WithTitle")>]
@@ -574,19 +577,13 @@ module GenericChartExtensions =
             //(`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`)  
         [<CompiledName("WithShape")>]
         [<Extension>]
-        member this.WithShape(shape:Shape) =
-            let layout = 
-                GenericChart.getLayout this
-                |> Layout.style (Shapes=[shape])
-            GenericChart.setLayout layout this
+        member this.WithShape(shape:Shape, [<Optional;DefaultParameterValue(true)>]?Append:bool) =
+            this |> Chart.withShape(shape, ?Append = Append)
 
         [<CompiledName("WithShapes")>]
         [<Extension>]
-        member this.WithShapes(shapes:Shape seq) =
-            let layout = 
-                GenericChart.getLayout this
-                |> Layout.style (Shapes=shapes)
-            GenericChart.setLayout layout this
+        member this.WithShapes(shapes:Shape seq, [<Optional;DefaultParameterValue(true)>]?Append:bool) =
+            this |> Chart.withShapes(shapes, ?Append = Append)
 
         // ############################################################
         // ####################### Apply to DisplayOptions
@@ -664,3 +661,13 @@ module GenericChartExtensions =
         member this.WithTernary(ternary:Ternary, [<Optional;DefaultParameterValue(null)>] ?Id) =
             this |> Chart.withTernary(ternary,?Id=Id)
 
+    
+        [<CompiledName("WithLayoutImage")>]
+        [<Extension>]
+        member this.WithLayoutImage(image:LayoutImage, [<Optional;DefaultParameterValue(true)>]?Append:bool) =
+            this |> Chart.withLayoutImage(image, ?Append = Append)
+
+        [<CompiledName("WithLayoutImages")>]
+        [<Extension>]
+        member this.WithLayoutImages(images:seq<LayoutImage>, [<Optional;DefaultParameterValue(true)>]?Append:bool) =
+            this |> Chart.withLayoutImages(images, ?Append = Append)

src/Plotly.NET/ChartAPI/Chart.fs

@@ -823,6 +823,14 @@ type Chart =
                 |> GenericChart.mapLayout 
                     (Layout.style (Annotations = annotations'))
 
+    [<CompiledName("WithAnnotation")>]
+    static member withAnnotation
+        (
+            annotation: Annotation,
+            [<Optional;DefaultParameterValue(true)>] ?Append: bool
+        ) =
+            Chart.withAnnotations([annotation], ?Append = Append)
+
     // Set the title of a Chart
     [<CompiledName("WithTitle")>]
     static member withTitle(title,[<Optional;DefaultParameterValue(null)>] ?TitleFont) =
@@ -911,23 +919,45 @@ type Chart =
 //Specifies the shape type to be drawn. If "line", a line is drawn from (`x0`,`y0`) to (`x1`,`y1`) If "circle", a circle is drawn from 
 //((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) If "rect", a rectangle is drawn linking 
 //(`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`)  
-    [<CompiledName("WithShape")>]
-    static member withShape(shape:Shape) =
-        (fun (ch:GenericChart) ->
-            let layout = 
-                GenericChart.getLayout ch
-                |> Layout.style (Shapes=[shape])
-            GenericChart.setLayout layout ch)
+    
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="shapes">The shapes to add to the input charts layout</param>
+    /// <param name="Append">If true, the input annotations will be appended to existing annotations, otherwise existing annotations will be removed (default: true)</param>
+    [<CompiledName("WithShapes")>]
+    static member withShapes
+        (
+            shapes:seq<Shape>,
+            [<Optional;DefaultParameterValue(true)>] ?Append: bool
+        ) =
+            let append = defaultArg Append true
 
+            fun (ch:GenericChart) -> 
+                
+                let shapes' = 
 
-    [<CompiledName("WithShapes")>]
-    static member withShapes(shapes:Shape seq) =
-        (fun (ch:GenericChart) ->
-            let layout = 
-                GenericChart.getLayout ch
-                |> Layout.style (Shapes=shapes)
-            GenericChart.setLayout layout ch)
+                    if append then
+
+                        let layout = GenericChart.getLayout ch
+
+                        layout.TryGetTypedValue<seq<Shape>>("shapes")
+                        |> Option.defaultValue Seq.empty
+                        |> Seq.append shapes
+
+                    else shapes
+
+                ch
+                |> GenericChart.mapLayout 
+                    (Layout.style (Shapes = shapes'))
 
+    [<CompiledName("WithShape")>]
+    static member withShape
+        (
+            shape: Shape,
+            [<Optional;DefaultParameterValue(true)>] ?Append: bool
+        ) =
+            Chart.withShapes([shape], ?Append = Append)
 
     // ####################### 
     /// Create a combined chart with the given charts merged
@@ -1491,3 +1521,43 @@ type Chart =
 
             GenericChart.setLayout updatedLayout ch
         )
+
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="images">The images to add to the input charts layout</param>
+    /// <param name="Append">If true, the input images will be appended to existing annotations, otherwise existing annotations will be removed (default: true)</param>
+    [<CompiledName("WithImages")>]
+    static member withLayoutImages
+        (
+            images:seq<LayoutImage>,
+            [<Optional;DefaultParameterValue(true)>] ?Append: bool
+        ) =
+            let append = defaultArg Append true
+
+            fun (ch:GenericChart) -> 
+                
+                let images' = 
+
+                    if append then
+
+                        let layout = GenericChart.getLayout ch
+
+                        layout.TryGetTypedValue<seq<LayoutImage>>("images")
+                        |> Option.defaultValue Seq.empty
+                        |> Seq.append images
+
+                    else images
+
+                ch
+                |> GenericChart.mapLayout 
+                    (Layout.style (Images = images'))
+
+    [<CompiledName("WithLayoutImage")>]
+    static member withLayoutImage
+        (
+            image: LayoutImage,
+            [<Optional;DefaultParameterValue(true)>] ?Append: bool
+        ) =
+
+            Chart.withLayoutImages([image], ?Append = Append)

src/Plotly.NET/Playground.fsx

@@ -16,6 +16,7 @@
 
 #I "Layout/ObjectAbstractions/Common"
 
+#load "LayoutImage.fs"
 #load "Button.fs"
 #load "RangeSelector.fs"
 #load "RangeSlider.fs"
@@ -153,6 +154,23 @@ open FSharpAux
 open System
 open System.IO
 
+Chart.Line([0.; 0.5; 1.; 2.; 2.2], y=[1.23; 2.5; 0.42; 3.; 1.])
+|> Chart.withLayoutImage(
+    LayoutImage.init(
+        Source="https://fsharp.org/img/logo/fsharp.svg",
+        XRef="x",
+        YRef="y",
+        X=0,
+        Y=3,
+        SizeX=2,
+        SizeY=2,
+        Sizing=StyleParam.LayoutImageSizing.Stretch,
+        Opacity=0.5,
+        Layer=StyleParam.Layer.Below
+    )
+)
+|> Chart.show
+
 let imagebase64 =
     System.Convert.ToBase64String(File.ReadAllBytes(@"C:\Users\schne\Pictures\Untitled.jpg"))