Implement tooling to generate multiple plotly schemas

README.md

@@ -43,7 +43,7 @@ func main() {
         },
     }
 
-    offline.Show(fig)
+    grob.Show(fig)
 }
 ```
 
@@ -113,6 +113,92 @@ For strings... This is a little bit more complicated, In AWS package they are us
 
 For numbers... It's similar to strings, Right now you cannot create plots with integer/float numbers with 0 value. I've only encounter problems when trying to remove the margin and can be workaround with an small value like `0.001`. I would like to avoid using interface{} or defining types again to keep the package interface as simple as possible.
 
+### Go Plotly Update to any json schema version
+
+#### Update the config to add a new version
+
+To add a new version, add a new entry in: [schemas.yaml](schemas.yaml)
+
+The documentation for each field can be found in [schema.go](generator%2Fschema.go)
+
+Example entry:
+```yaml
+  -  Name: Plotly 2.31.1
+     Tag: v2.31.1
+     URL: https://raw.githubusercontent.com/plotly/plotly.js/v2.31.1/test/plot-schema.json
+     Path: schemas/v2.31.1/plot-schema.json
+     Generated: generated/v2.31.1/graph_objects
+     CDN: https://cdn.plot.ly/plotly-2.31.1.min.js
+```
+
+The local paths are relative to the project root.
+
+#### run download and regeneration
+
+> [!TIP]
+> Use this script for easier download of plotly json schemas.
+> ```shell
+> go run generator/cmd/downloader/main.go --config="schemas.yaml"
+> ```
+> Then run the generator, which will clean up the generated files in **graph_objects** folder of each version and regenerate the new graph objects. DO NOT REMOVE **graph_objects/plotly.go**
+> ```shell
+> go run generator/cmd/generator/main.go --config="schemas.yaml"
+> ```
+> Alternatively, you can also generate the go package using following command from the project root:
+> ```shell
+> go generate ./...
+> ```
+
+#### changing schemas.yaml locations
+
+Be aware, that the template file [plotly.tmpl](generator%2Ftemplates%2Fplotly.tmpl) also has a go generate directive.
+This directive has relative paths, based on the assumed final path within the project
+
+#### embedding a downloaded plotly js source
+
+In the example: [main.go](examples%2Fbar%2Fmain.go) you find an example to reuse a static plotly js file and pass that reference to the generated html, instead of using a hardcoded CDN reference which would require internet connection.
+```go
+	abs, err := filepath.Abs("asset/plotly-2.29.1.min.js")
+    if err != nil {
+        return
+    }
+	grob.ToHtml(fig, "bar.html", grob.FigOptions{HeadContent: fmt.Sprintf(`<title>Offline Bars</title><script src="%s"></script>`, abs)})
+	grob.Show(fig, grob.FigOptions{HeadContent: fmt.Sprintf(`<title>Offline Bars</title><script src="%s"></script>`, abs)})
+```
+
+#### Missing Files?
+
+if in doubt whether all types and traces have been generated, you can use the jsonviewer tool to introspect the json: 
+https://jsonviewer.stack.hu/
+
+Or use `jq` tool for quick introspection into the json files.
+Example:
+Display all traces in the schema.json file.
+```shell
+jq '.schema.traces | keys' schema.json --sort-keys | less
+```
+
+More on the `jq` tool on: https://jqlang.github.io/jq/manual/
+
+### plotly online editor sandbox
+http://plotly-json-editor.getforge.io/
+
 ## Star History
 
-[![Star History Chart](https://api.star-history.com/svg?repos=Metalblueberry/go-plotly&type=Date)](https://star-history.com/#Metalblueberry/go-plotly&Date)
+[![Star History Chart](https://api.star-history.com/svg?repos=Metalblueberry/go-plotly&type=Date)](https://star-history.com/#Metalblueberry/go-plotly&Date)
+
+## Update Notes:
+
+### Add version v2.29.1 and v2.31.1
+- Added Downloader for schema file
+- added generator for different packages based on plotly version in subfolders for each version
+- enable easier use for different plotly version by new import paths which include the version generated. Example: `grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"`
+- removed go generate directive from the templates which are no longer necessary
+- removed offline package, as each version package needs its own **plot.go**.
+- Replaced all `offline` imports in the examples packages by just calling the `grob` package of the specified version
+- all html's will now refer to the correct plotly version's cdn in the html's head
+- allow defining your own head for the plot, which allows embedding the plotly.js source instead of referencing the CDN. This enables generation of offline plots
+- all types with "`arrayOk: true`" should be defined as `interface{}` to allow the flexibility of javascript and let the user decide whether a single value or a slice is used.
+
+## Official Plotly Release Notes
+For detailed changes please follow the release notes of the original JS repo: https://github.com/plotly/plotly.js/releases

examples/bar/main.go

@@ -1,8 +1,10 @@
 package main
 
 import (
-	grob "github.com/MetalBlueberry/go-plotly/graph_objects"
-	"github.com/MetalBlueberry/go-plotly/offline"
+	"fmt"
+	"path/filepath"
+
+	grob "github.com/MetalBlueberry/go-plotly/generated/v2.29.1/graph_objects"
 )
 
 func main() {
@@ -29,6 +31,15 @@ func main() {
 		},
 	}
 
-	offline.ToHtml(fig, "bar.html")
-	offline.Show(fig)
+	// by default, using the cdn reference, downloading the plotly js on demand
+	grob.ToHtml(fig, "bar.html")
+	grob.Show(fig)
+
+	// example for using static assets, which can be embedded into the golang application
+	abs, err := filepath.Abs("asset/plotly-2.29.1.min.js")
+	if err != nil {
+		return
+	}
+	grob.ToHtml(fig, "bar.html", grob.FigOptions{HeadContent: fmt.Sprintf(`<title>Offline Bars</title><script src="%s"></script>`, abs)})
+	grob.Show(fig, grob.FigOptions{HeadContent: fmt.Sprintf(`<title>Offline Bars</title><script src="%s"></script>`, abs)})
 }

examples/bar_custom/main.go

@@ -4,9 +4,9 @@ import (
 	"image/color"
 	"strconv"
 
-	grob "github.com/MetalBlueberry/go-plotly/graph_objects"
-	"github.com/MetalBlueberry/go-plotly/offline"
 	"github.com/lucasb-eyer/go-colorful"
+
+	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
 )
 
 func main() {
@@ -77,8 +77,8 @@ func main() {
 		Layout: layout,
 	}
 
-	offline.ToHtml(fig, "bar_custom.html")
-	offline.Show(fig)
+	grob.ToHtml(fig, "bar_custom.html")
+	grob.Show(fig)
 }
 
 func toString(in []int) []string {

examples/colorscale/main.go

@@ -4,8 +4,7 @@ import (
 	"encoding/json"
 	"math"
 
-	grob "github.com/MetalBlueberry/go-plotly/graph_objects"
-	"github.com/MetalBlueberry/go-plotly/offline"
+	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
 )
 
 type ColorScale struct {
@@ -66,7 +65,7 @@ func main() {
 			},
 		},
 	}
-	offline.Show(fig)
+	grob.Show(fig)
 }
 
 func linspace(start, stop float64, points int) []float64 {

examples/go.mod

@@ -1,12 +1,19 @@
 module github.com/metalblueberry/plotly/examples
 
-go 1.14
+go 1.22
 
 require (
-	github.com/MetalBlueberry/go-plotly v0.0.0-20200503142240-1276ab260dcb
-	github.com/go-gota/gota v0.10.1
+	github.com/MetalBlueberry/go-plotly v0.4.0
+	github.com/go-gota/gota v0.12.0
 	github.com/lucasb-eyer/go-colorful v1.2.0
-	gonum.org/v1/gonum v0.7.0 // indirect
+	github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c
+)
+
+require (
+	github.com/pkg/errors v0.9.1 // indirect
+	golang.org/x/net v0.25.0 // indirect
+	golang.org/x/sys v0.20.0 // indirect
+	gonum.org/v1/gonum v0.15.0 // indirect
 )
 
 replace github.com/MetalBlueberry/go-plotly => ./../