keep the offline folder, generate for each version

MetalBlueberry · May 18, 2024 · 3b1fe76 · 3b1fe76
1 parent 1640d4c
commit 3b1fe76
Show file tree

Hide file tree

Showing 20 changed files with 101 additions and 79 deletions.
diff --git a/README.md b/README.md
@@ -127,7 +127,7 @@ Example entry:
      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
+     Generated: generated/v2.31.1
      CDN: https://cdn.plot.ly/plotly-2.31.1.min.js
 ```
 

diff --git a/examples/bar/main.go b/examples/bar/main.go
@@ -4,7 +4,8 @@ import (
 	"fmt"
 	"path/filepath"
 
-	grob "github.com/MetalBlueberry/go-plotly/generated/v2.29.1/graph_objects"
+	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
+	"github.com/MetalBlueberry/go-plotly/generated/v2.31.1/offline"
 )
 
 func main() {
@@ -32,14 +33,14 @@ func main() {
 	}
 
 	// by default, using the cdn reference, downloading the plotly js on demand
-	grob.ToHtml(fig, "bar.html")
-	grob.Show(fig)
+	offline.ToHtml(fig, "bar.html")
+	offline.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)})
+	offline.ToHtml(fig, "bar.html", offline.FigOptions{HeadContent: fmt.Sprintf(`<title>Offline Bars</title><script src="%s"></script>`, abs)})
+	offline.Show(fig, offline.FigOptions{HeadContent: fmt.Sprintf(`<title>Offline Bars</title><script src="%s"></script>`, abs)})
 }
diff --git a/examples/bar_custom/main.go b/examples/bar_custom/main.go
@@ -7,6 +7,7 @@ import (
 	"github.com/lucasb-eyer/go-colorful"
 
 	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
+	"github.com/MetalBlueberry/go-plotly/generated/v2.31.1/offline"
 )
 
 func main() {
@@ -77,8 +78,8 @@ func main() {
 		Layout: layout,
 	}
 
-	grob.ToHtml(fig, "bar_custom.html")
-	grob.Show(fig)
+	offline.ToHtml(fig, "bar_custom.html")
+	offline.Show(fig)
 }
 
 func toString(in []int) []string {

diff --git a/examples/colorscale/main.go b/examples/colorscale/main.go
@@ -5,6 +5,7 @@ import (
 	"math"
 
 	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
+	"github.com/MetalBlueberry/go-plotly/generated/v2.31.1/offline"
 )
 
 type ColorScale struct {
@@ -65,7 +66,7 @@ func main() {
 			},
 		},
 	}
-	grob.Show(fig)
+	offline.Show(fig)
 }
 
 func linspace(start, stop float64, points int) []float64 {

diff --git a/examples/range_slider/main.go b/examples/range_slider/main.go
@@ -7,6 +7,7 @@ import (
 	"github.com/go-gota/gota/dataframe"
 
 	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
+	"github.com/MetalBlueberry/go-plotly/generated/v2.31.1/offline"
 )
 
 func main() {
@@ -126,8 +127,8 @@ func main() {
 		},
 	}
 
-	grob.ToHtml(fig, "range_slider.html")
-	grob.Show(fig)
+	offline.ToHtml(fig, "range_slider.html")
+	offline.Show(fig)
 }
 
 // Button is a custom type for the cases where the autogenerated code falls short.

diff --git a/examples/responsive/main.go b/examples/responsive/main.go
@@ -2,6 +2,7 @@ package main
 
 import (
 	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
+	"github.com/MetalBlueberry/go-plotly/generated/v2.31.1/offline"
 )
 
 func main() {
@@ -31,6 +32,6 @@ func main() {
 		},
 	}
 
-	grob.ToHtml(fig, "bar.html")
-	grob.Show(fig)
+	offline.ToHtml(fig, "bar.html")
+	offline.Show(fig)
 }
diff --git a/examples/scatter/main.go b/examples/scatter/main.go
@@ -4,6 +4,7 @@ import (
 	"math"
 
 	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
+	"github.com/MetalBlueberry/go-plotly/generated/v2.31.1/offline"
 )
 
 func main() {
@@ -47,8 +48,8 @@ func main() {
 		},
 	}
 
-	grob.ToHtml(fig, "scatter.html")
-	grob.Show(fig)
+	offline.ToHtml(fig, "scatter.html")
+	offline.Show(fig)
 }
 
 func linspace(start, stop float64, points int) []float64 {

diff --git a/examples/scatter3d/main.go b/examples/scatter3d/main.go
@@ -4,6 +4,7 @@ import (
 	"math"
 
 	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
+	"github.com/MetalBlueberry/go-plotly/generated/v2.31.1/offline"
 )
 
 func main() {
@@ -37,8 +38,8 @@ func main() {
 		},
 	}
 
-	grob.ToHtml(fig, "scatter3d.html")
-	grob.Show(fig)
+	offline.ToHtml(fig, "scatter3d.html")
+	offline.Show(fig)
 }
 
 func linspace(start, stop float64, points int) []float64 {

diff --git a/examples/shapes/main.go b/examples/shapes/main.go
@@ -2,6 +2,7 @@ package main
 
 import (
 	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
+	"github.com/MetalBlueberry/go-plotly/generated/v2.31.1/offline"
 )
 
 func main() {
@@ -58,8 +59,8 @@ func main() {
 		},
 	}
 
-	grob.ToHtml(fig, "bar.html")
-	grob.Show(fig)
+	offline.ToHtml(fig, "bar.html")
+	offline.Show(fig)
 }
 
 type LineShape struct {

diff --git a/examples/subplots_share_axes/main.go b/examples/subplots_share_axes/main.go
@@ -2,6 +2,7 @@ package main
 
 import (
 	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
+	"github.com/MetalBlueberry/go-plotly/generated/v2.31.1/offline"
 )
 
 func main() {
@@ -93,6 +94,6 @@ func main() {
 		},
 	}
 
-	grob.ToHtml(fig, "subplots_share_axes.html")
-	grob.Show(fig)
+	offline.ToHtml(fig, "subplots_share_axes.html")
+	offline.Show(fig)
 }
diff --git a/examples/transforms/main.go b/examples/transforms/main.go
@@ -2,6 +2,7 @@ package main
 
 import (
 	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
+	"github.com/MetalBlueberry/go-plotly/generated/v2.31.1/offline"
 )
 
 func main() {
@@ -28,6 +29,6 @@ func main() {
 		},
 	}
 
-	grob.ToHtml(fig, "bar.html")
-	grob.Show(fig)
+	offline.ToHtml(fig, "bar.html")
+	offline.Show(fig)
 }
diff --git a/examples/unmarshal/main.go b/examples/unmarshal/main.go
@@ -5,6 +5,7 @@ import (
 	"math"
 
 	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
+	"github.com/MetalBlueberry/go-plotly/generated/v2.31.1/offline"
 )
 
 func main() {
@@ -30,7 +31,7 @@ func main() {
 	// Demonstrates that a json representation can be loaded
 	recoveredFig := &grob.Fig{}
 	json.Unmarshal(bytes, recoveredFig)
-	grob.Show(recoveredFig)
+	offline.Show(recoveredFig)
 }
 
 func linspace(start, stop float64, points int) []float64 {

diff --git a/examples/waterfall_bar_chart/main.go b/examples/waterfall_bar_chart/main.go
@@ -2,6 +2,7 @@ package main
 
 import (
 	grob "github.com/MetalBlueberry/go-plotly/generated/v2.31.1/graph_objects"
+	"github.com/MetalBlueberry/go-plotly/generated/v2.31.1/offline"
 )
 
 func main() {
@@ -208,8 +209,8 @@ func main() {
 		Layout: layout,
 	}
 
-	grob.ToHtml(fig, "waterfall.html")
-	grob.Show(fig)
+	offline.ToHtml(fig, "waterfall.html")
+	offline.Show(fig)
 }
 
 type Annotation struct {

diff --git a/generated/v2.19.0/graph_objects/plot_gen.go → generated/v2.19.0/offline/plot_gen.go b/generated/v2.19.0/graph_objects/plot_gen.go → generated/v2.19.0/offline/plot_gen.go
@@ -1,4 +1,4 @@
-package grob
+package offline
 
 import (
 	"bytes"
@@ -12,6 +12,8 @@ import (
 
 	"github.com/pkg/browser"
 	"github.com/pkg/errors"
+
+	grob "github.com/MetalBlueberry/go-plotly/generated/v2.19.0/graph_objects"
 )
 
 // FigOptions enables users to pass their custom cdn or local plotly file reference to allow building offline solutions
@@ -25,22 +27,22 @@ type Options struct {
 }
 
 // ToWriter saves the figure as standalone HTML. It still requires internet to load plotly.js from CDN.
-func ToWriter(fig *Fig, w io.Writer, options ...FigOptions) {
+func ToWriter(fig *grob.Fig, w io.Writer, options ...FigOptions) {
 	_, err := w.Write(figToBuffer(fig, options...).Bytes())
 	if err != nil {
 		panic(errors.New(fmt.Sprintf("failed to write figure to passed writer: %v", err)))
 	}
 }
 
 // ToHtml saves the figure as standalone HTML. It still requires internet to load plotly.js from CDN.
-func ToHtml(fig *Fig, path string, options ...FigOptions) {
+func ToHtml(fig *grob.Fig, path string, options ...FigOptions) {
 	buf := figToBuffer(fig, options...)
 	os.WriteFile(path, buf.Bytes(), os.ModePerm)
 }
 
 // Show displays the figure in your browser.
 // Use serve if you want a persistent view
-func Show(fig *Fig, options ...FigOptions) {
+func Show(fig *grob.Fig, options ...FigOptions) {
 	buf := figToBuffer(fig, options...)
 	browser.OpenReader(buf)
 }
@@ -59,7 +61,7 @@ func computeFigOptions(options ...FigOptions) string {
 }
 
 // figToBuffer with optional parameter options, only the first argument is evaluated
-func figToBuffer(fig *Fig, options ...FigOptions) *bytes.Buffer {
+func figToBuffer(fig *grob.Fig, options ...FigOptions) *bytes.Buffer {
 	var headContent string = computeFigOptions(options...)
 
 	figBytes, err := json.Marshal(fig)
@@ -77,7 +79,7 @@ func figToBuffer(fig *Fig, options ...FigOptions) *bytes.Buffer {
 
 // Serve creates a local web server that displays the image using plotly.js
 // Is a good alternative to Show to avoid creating tmp files.
-func Serve(fig *Fig, opt ...Options) {
+func Serve(fig *grob.Fig, opt ...Options) {
 	opts := computeOptions(Options{
 		FigOptions: FigOptions{HeadContent: cdnUrl},
 		Addr:       "localhost:8080",

diff --git a/generated/v2.29.1/graph_objects/plot_gen.go → generated/v2.29.1/offline/plot_gen.go b/generated/v2.29.1/graph_objects/plot_gen.go → generated/v2.29.1/offline/plot_gen.go
@@ -1,4 +1,4 @@
-package grob
+package offline
 
 import (
 	"bytes"
@@ -12,6 +12,8 @@ import (
 
 	"github.com/pkg/browser"
 	"github.com/pkg/errors"
+
+	grob "github.com/MetalBlueberry/go-plotly/generated/v2.29.1/graph_objects"
 )
 
 // FigOptions enables users to pass their custom cdn or local plotly file reference to allow building offline solutions
@@ -25,22 +27,22 @@ type Options struct {
 }
 
 // ToWriter saves the figure as standalone HTML. It still requires internet to load plotly.js from CDN.
-func ToWriter(fig *Fig, w io.Writer, options ...FigOptions) {
+func ToWriter(fig *grob.Fig, w io.Writer, options ...FigOptions) {
 	_, err := w.Write(figToBuffer(fig, options...).Bytes())
 	if err != nil {
 		panic(errors.New(fmt.Sprintf("failed to write figure to passed writer: %v", err)))
 	}
 }
 
 // ToHtml saves the figure as standalone HTML. It still requires internet to load plotly.js from CDN.
-func ToHtml(fig *Fig, path string, options ...FigOptions) {
+func ToHtml(fig *grob.Fig, path string, options ...FigOptions) {
 	buf := figToBuffer(fig, options...)
 	os.WriteFile(path, buf.Bytes(), os.ModePerm)
 }
 
 // Show displays the figure in your browser.
 // Use serve if you want a persistent view
-func Show(fig *Fig, options ...FigOptions) {
+func Show(fig *grob.Fig, options ...FigOptions) {
 	buf := figToBuffer(fig, options...)
 	browser.OpenReader(buf)
 }
@@ -59,7 +61,7 @@ func computeFigOptions(options ...FigOptions) string {
 }
 
 // figToBuffer with optional parameter options, only the first argument is evaluated
-func figToBuffer(fig *Fig, options ...FigOptions) *bytes.Buffer {
+func figToBuffer(fig *grob.Fig, options ...FigOptions) *bytes.Buffer {
 	var headContent string = computeFigOptions(options...)
 
 	figBytes, err := json.Marshal(fig)
@@ -77,7 +79,7 @@ func figToBuffer(fig *Fig, options ...FigOptions) *bytes.Buffer {
 
 // Serve creates a local web server that displays the image using plotly.js
 // Is a good alternative to Show to avoid creating tmp files.
-func Serve(fig *Fig, opt ...Options) {
+func Serve(fig *grob.Fig, opt ...Options) {
 	opts := computeOptions(Options{
 		FigOptions: FigOptions{HeadContent: cdnUrl},
 		Addr:       "localhost:8080",