Bump documentation, add missing definitions

alexarchambault · alexarchambault · commit 04518d10b81d · 2021-03-12T20:50:30.000+01:00
diff --git a/core/shared/src/main/scala/plotly/Trace.scala b/core/shared/src/main/scala/plotly/Trace.scala
@@ -10,27 +10,29 @@ import plotly.element._
 sealed abstract class Trace extends Product with Serializable
 
 @data(optionSetters = true) class Scatter(
-             x: Option[Sequence] = None,
-             y: Option[Sequence] = None,
-          text: Option[OneOrSeq[String]] = None,
-          mode: Option[ScatterMode] = None,
-        marker: Option[Marker] = None,
-          line: Option[Line] = None,
-  textposition: Option[TextPosition] = None,
-      textfont: Option[TextFont] = None,
-          name: Option[String] = None,
-   connectgaps: Option[Boolean] = None,
-         xaxis: Option[AxisReference] = None,
-         yaxis: Option[AxisReference] = None,
-          fill: Option[Fill] = None,
-       error_x: Option[Error] = None,
-       error_y: Option[Error] = None,
-    showlegend: Option[Boolean] = None,
-     fillcolor: Option[OneOrSeq[Color]] = None,
-     hoverinfo: Option[HoverInfo] = None,
-       hoveron: Option[HoverOn] = None,
-    stackgroup: Option[String] = None,
-     groupnorm: Option[GroupNorm] = None
+              x: Option[Sequence] = None,
+              y: Option[Sequence] = None,
+           text: Option[OneOrSeq[String]] = None,
+           mode: Option[ScatterMode] = None,
+         marker: Option[Marker] = None,
+           line: Option[Line] = None,
+   textposition: Option[TextPosition] = None,
+       textfont: Option[TextFont] = None,
+           name: Option[String] = None,
+    connectgaps: Option[Boolean] = None,
+          xaxis: Option[AxisReference] = None,
+          yaxis: Option[AxisReference] = None,
+           fill: Option[Fill] = None,
+        error_x: Option[Error] = None,
+        error_y: Option[Error] = None,
+     showlegend: Option[Boolean] = None,
+      fillcolor: Option[OneOrSeq[Color]] = None,
+      hoverinfo: Option[HoverInfo] = None,
+        hoveron: Option[HoverOn] = None,
+     stackgroup: Option[String] = None,
+      groupnorm: Option[GroupNorm] = None,
+  @since("0.8.2")
+  hovertemplate: Option[OneOrSeq[String]] = None
 ) extends Trace
 
 object Scatter {
@@ -97,19 +99,21 @@ object Scatter {
 }
 
 @data(optionSetters = true) class Box(
-             y: Option[Sequence] = None,
-             x: Option[Sequence] = None,
-     boxpoints: Option[BoxPoints] = None,
-        jitter: Option[Double] = None,
-      pointpos: Option[Double] = None,
-          name: Option[String] = None,
-        marker: Option[Marker] = None,
-   orientation: Option[Orientation] = None,
-  whiskerwidth: Option[Double] = None,
-       boxmean: Option[BoxMean] = None,
-     fillcolor: Option[OneOrSeq[Color]] = None,
-          line: Option[Line] = None,
-    showlegend: Option[Boolean] = None
+              y: Option[Sequence] = None,
+              x: Option[Sequence] = None,
+      boxpoints: Option[BoxPoints] = None,
+         jitter: Option[Double] = None,
+       pointpos: Option[Double] = None,
+           name: Option[String] = None,
+         marker: Option[Marker] = None,
+    orientation: Option[Orientation] = None,
+   whiskerwidth: Option[Double] = None,
+        boxmean: Option[BoxMean] = None,
+      fillcolor: Option[OneOrSeq[Color]] = None,
+           line: Option[Line] = None,
+     showlegend: Option[Boolean] = None,
+  @since("0.8.2")
+  hovertemplate: Option[OneOrSeq[String]] = None
 ) extends Trace
 
 object Box {
@@ -153,22 +157,24 @@ object Box {
 }
 
 @data(optionSetters = true) class Bar(
-             x: Sequence,
-             y: Sequence,
+              x: Sequence,
+              y: Sequence,
   @since
-          name: Option[String] = None,
-          text: Option[Seq[String]] = None,
-        marker: Option[Marker] = None,
-   orientation: Option[Orientation] = None,
-         xaxis: Option[AxisReference] = None,
-         yaxis: Option[AxisReference] = None,
-       error_y: Option[Error] = None,
-    showlegend: Option[Boolean] = None,
-     hoverinfo: Option[HoverInfo] = None,
-  textposition: Option[BarTextPosition] = None,
-       opacity: Option[Double] = None,
-         width: Option[OneOrSeq[Double]] = None,
-          base: Option[OneOrSeq[Double]] = None
+           name: Option[String] = None,
+           text: Option[Seq[String]] = None,
+         marker: Option[Marker] = None,
+    orientation: Option[Orientation] = None,
+          xaxis: Option[AxisReference] = None,
+          yaxis: Option[AxisReference] = None,
+        error_y: Option[Error] = None,
+     showlegend: Option[Boolean] = None,
+      hoverinfo: Option[HoverInfo] = None,
+   textposition: Option[BarTextPosition] = None,
+        opacity: Option[Double] = None,
+          width: Option[OneOrSeq[Double]] = None,
+           base: Option[OneOrSeq[Double]] = None,
+  @since("0.8.2")
+  hovertemplate: Option[OneOrSeq[String]] = None
 ) extends Trace
 
 object Bar {
@@ -210,17 +216,19 @@ object Bar {
 }
 
 @data(optionSetters = true) class Histogram(
-          x: Option[Sequence] = None,
-          y: Option[Sequence] = None,
-    opacity: Option[Double] = None,
-       name: Option[String] = None,
-   autobinx: Option[Boolean] = None,
-     marker: Option[Marker] = None,
-      xbins: Option[Bins] = None,
-   histnorm: Option[HistNorm] = None,
- showlegend: Option[Boolean] = None,
- cumulative: Option[Cumulative] = None,
-   histfunc: Option[HistFunc] = None
+              x: Option[Sequence] = None,
+              y: Option[Sequence] = None,
+        opacity: Option[Double] = None,
+           name: Option[String] = None,
+       autobinx: Option[Boolean] = None,
+         marker: Option[Marker] = None,
+          xbins: Option[Bins] = None,
+       histnorm: Option[HistNorm] = None,
+     showlegend: Option[Boolean] = None,
+     cumulative: Option[Cumulative] = None,
+       histfunc: Option[HistFunc] = None,
+  @since("0.8.2")
+  hovertemplate: Option[OneOrSeq[String]] = None
 ) extends Trace
 
 object Histogram {
@@ -260,11 +268,13 @@ object Histogram {
 }
 
 @data(optionSetters = true) class Surface(
-          x: Option[Sequence] = None,
-          y: Option[Sequence] = None,
-          z: Option[Sequence] = None,
-  showscale: Option[Boolean] = None,
-    opacity: Option[Double] = None
+              x: Option[Sequence] = None,
+              y: Option[Sequence] = None,
+              z: Option[Sequence] = None,
+      showscale: Option[Boolean] = None,
+        opacity: Option[Double] = None,
+  @since("0.8.2")
+  hovertemplate: Option[OneOrSeq[String]] = None
 ) extends Trace
 
 object Surface {
@@ -286,13 +296,16 @@ object Surface {
 }
 
 @data(optionSetters = true) class Heatmap(
-             y: Option[Sequence] = None,
-             x: Option[Sequence] = None,
-             z: Option[Sequence] = None,
-autocolorscale: Option[Boolean] = None,
-    colorscale: Option[ColorScale] = None,
-     showscale: Option[Boolean] = None,
-          name: Option[String] = None
+              y: Option[Sequence] = None,
+              x: Option[Sequence] = None,
+              z: Option[Sequence] = None,
+ autocolorscale: Option[Boolean] = None,
+     colorscale: Option[ColorScale] = None,
+      showscale: Option[Boolean] = None,
+           name: Option[String] = None,
+  @since("0.8.2")
+  hovertemplate: Option[OneOrSeq[String]] = None,
+    hoverongaps: Option[Boolean] = None
 ) extends Trace
 
 object Heatmap {
diff --git a/core/shared/src/main/scala/plotly/layout/Axis.scala b/core/shared/src/main/scala/plotly/layout/Axis.scala
@@ -43,7 +43,11 @@ import plotly.element._
           nticks: Option[Int] = None,
       automargin: Option[Boolean] = None,
   @since("0.8.0")
-      rangeslider: Option[RangeSlider] = None
+     rangeslider: Option[RangeSlider] = None,
+  @since("0.8.2")
+           width: Option[Int] = None,
+          height: Option[Int] = None,
+        autosize: Option[Boolean] = None
 )
 
 object Axis {
diff --git a/core/shared/src/main/scala/plotly/layout/Grid.scala b/core/shared/src/main/scala/plotly/layout/Grid.scala
@@ -0,0 +1,11 @@
+package plotly.layout
+
+import dataclass.data
+
+@data(optionSetters = true) class Grid(
+      rows: Option[Int]      = None,
+   columns: Option[Int]      = None,
+   pattern: Option[Pattern]  = None,
+  roworder: Option[RowOrder] = None,
+  subplots: Option[Seq[Seq[String]]] = None
+)
diff --git a/core/shared/src/main/scala/plotly/layout/Layout.scala b/core/shared/src/main/scala/plotly/layout/Layout.scala
@@ -36,7 +36,9 @@ import plotly.element._
           scene: Option[Scene] = None,
   @since("0.8.0")
        dragmode: Option[String] = None,
-         shapes: Option[Seq[Shape]] = None
+         shapes: Option[Seq[Shape]] = None,
+  @since("0.8.2")
+           grid: Option[Grid] = None
 )
 
 object Layout {
diff --git a/core/shared/src/main/scala/plotly/layout/Pattern.scala b/core/shared/src/main/scala/plotly/layout/Pattern.scala
@@ -0,0 +1,8 @@
+package plotly.layout
+
+sealed abstract class Pattern(val label: String) extends Product with Serializable
+
+object Pattern {
+  case object Independent extends Pattern("independent")
+  case object     Coupled extends Pattern("coupled")
+}
diff --git a/core/shared/src/main/scala/plotly/layout/RowOrder.scala b/core/shared/src/main/scala/plotly/layout/RowOrder.scala
@@ -0,0 +1,8 @@
+package plotly.layout
+
+sealed abstract class RowOrder(val label: String) extends Product with Serializable
+
+object RowOrder {
+  case object TopToBottom extends RowOrder("top to bottom")
+  case object BottomToTop extends RowOrder("bottom to top")
+}
diff --git a/plotly-documentation b/plotly-documentation
@@ -1 +1 @@
-Subproject commit eae136bb920c7542654a5e13cff04a0de175a08d
+Subproject commit 20b627cf49db521172221c28788509621bc9449e
diff --git a/render/shared/src/main/scala/plotly/internals/ArgonautCodecsInternals.scala b/render/shared/src/main/scala/plotly/internals/ArgonautCodecsInternals.scala
@@ -146,6 +146,9 @@ object ArgonautCodecsInternals extends ArgonautCodecsExtra {
   implicit val hoverOnIsEnum = IsEnum.instance[HoverOn](_.label)
   implicit val groupNormIsEnum = IsEnum.instance[GroupNorm](_.label)
   implicit val histFuncIsEnum = IsEnum.instance[HistFunc](_.label)
+  implicit val tickModeIsEnum = IsEnum.instance[TickMode](_.mode)
+  implicit val patternIsEnum = IsEnum.instance[Pattern](_.label)
+  implicit val rowOrderIsEnum = IsEnum.instance[RowOrder](_.label)
 
   def jsonSumDirectCodecFor(name: String): JsonSumCodec = new JsonSumCodec {
     def encodeEmpty: Nothing =
diff --git a/tests/src/test/scala/plotly/doc/DocumentationTests.scala b/tests/src/test/scala/plotly/doc/DocumentationTests.scala
@@ -68,6 +68,11 @@ object DocumentationTests {
     var dataOpt = Option.empty[Object]
     var layoutOpt = Option.empty[Object]
 
+    def newPlot(div: String, data: Object, layout: Object, other: Object): Unit = {
+      dataOpt = Option(data)
+      layoutOpt = Option(layout)
+    }
+
     def newPlot(div: String, data: Object, layout: Object): Unit = {
       dataOpt = Option(data)
       layoutOpt = Option(layout)
@@ -116,12 +121,20 @@ object DocumentationTests {
       val step = (to - from).toDouble / (count - 1)
       new NativeArrayWithDefault((0 until count).map(n => from + n * step: JDouble).toArray[AnyRef], 0.0: JDouble)
     }
+    def linspace(from: Double, to: Double, count: Int) = {
+      val step = (to - from) / (count - 1)
+      new NativeArrayWithDefault((0 until count).map(n => from + n * step: JDouble).toArray[AnyRef], 0.0: JDouble)
+    }
   }
 
   def linspaceImpl(cx: Context, thisObj: Scriptable, args: Array[Object], funObj: Function): AnyRef =
     args.toSeq.map(x => x: Any) match {
       case Seq(from: Int, to: Int, step: Int) =>
         Numeric.linspace(from, to, step)
+      case Seq(from: Double, to: Int, step: Int) =>
+        Numeric.linspace(from, to.toDouble, step)
+      case Seq(from: Double, to: Double, step: Int) =>
+        Numeric.linspace(from, to, step)
       case other => throw new NoSuchElementException(s"linspace${other.mkString("(", ", ", ")")}")
     }
 
@@ -155,6 +168,7 @@ object DocumentationTests {
       ScriptableObject.putProperty(scope, "document", Document)
       ScriptableObject.putProperty(scope, "numeric", Numeric)
       ScriptableObject.putProperty(scope, "require", require(scope))
+      ScriptableObject.putProperty(scope, "linspace", linspace(scope))
       cx.evaluateString(scope, demo, "<cmd>", 1, null)
       plotly.result(cx, scope)
     } catch {
@@ -233,7 +247,7 @@ class DocumentationTests extends AnyFlatSpec with Matchers {
 //    "financial/ohlc",
     "basic/bubble",
     "basic/area",
-    "layout/sizing",
+    "fundamentals/sizing",
     // TODO? Gauge charts
     // TODO Multiple chart types (needs contour)
     // TODO Shapes (need mock of d3)
@@ -273,6 +287,10 @@ class DocumentationTests extends AnyFlatSpec with Matchers {
         .replace("</br>", "\\n")
         .replace("(...size)", "(size[0])") // rhino doesn't seem to support the spead (...) operator
         .replace("desired_maximum_marker_size**2", "desired_maximum_marker_size*desired_maximum_marker_size")
+        .replace("""function linspace(a,b,n) {
+  return Plotly.d3.range(n).map(function(i){return a+i*(b-a)/(n-1);});
+}
+""", "")
 
       if (content.contains("Plotly.d3.csv"))
         println(s"Ignoring $post (Plotly.d3.csv not implemented)")
