Add properties Histogram.{yaxis, hovertext}, layout.Axis.{tickformat, fixedrange} and add Demo for Histogram

Author: Sven Behrens

.git-blame-ignore-revs

@@ -0,0 +1,5 @@
+# activate meaningful git annotations with:
+# git config blame.ignoreRevsFile .git-blame-ignore-revs
+
+# scalafmt
+0ad886c35bdf9c8ad2bfb0501070b8b2ce810710

core/shared/src/main/scala/plotly/Trace.scala

@@ -251,7 +251,10 @@ object Bar {
     cumulative: Option[Cumulative] = None,
     histfunc: Option[HistFunc] = None,
     @since("0.8.2")
-    hovertemplate: Option[OneOrSeq[String]] = None
+    hovertemplate: Option[OneOrSeq[String]] = None,
+    @since("0.8.5")
+    yaxis: Option[String] = None,
+    hovertext: Option[OneOrSeq[String]] = None
 ) extends Trace
 
 object Histogram {

core/shared/src/main/scala/plotly/layout/Axis.scala

@@ -47,7 +47,10 @@ import plotly.element._
     @since("0.8.2")
     width: Option[Int] = None,
     height: Option[Int] = None,
-    autosize: Option[Boolean] = None
+    autosize: Option[Boolean] = None,
+    @since("0.8.5")
+    tickformat: Option[String] = None,
+    fixedrange: Option[Boolean] = None
 )
 
 object Axis {

demo/src/main/scala/plotly/demo/Demo.scala

@@ -43,21 +43,25 @@ import scalatags.JsDom.all.{area => _, _}
       heatmaps.CategoricalAxisHeatmap,
       heatmaps.CustomColorScaleHeatmap,
       heatmaps.AnnotatedHeatmap
+    ),
+    "Histogram" -> Seq(
+      histogram.BasicHistogram,
+      histogram.StyledBasicHistogram
     )
   )
 
   def unindent(source: String): String = {
 
-    val lines         = source.linesIterator.toVector
-    val nonEmptyLines = lines.filter(_.exists(!_.isSpaceChar))
+    val lines                         = source.linesIterator.toVector
+    val nonEmptyLines: Vector[String] = lines.filter(_.exists(!_.isSpaceChar))
 
     if (nonEmptyLines.isEmpty)
       source
     else {
 
-      val dropCount = Stream
+      val dropCount = LazyList
         .from(0)
-        .takeWhile(idx => nonEmptyLines.forall(_(idx) == nonEmptyLines.head(idx)))
+        .takeWhile(idx => nonEmptyLines.forall(str => str(idx) == nonEmptyLines.head(idx)))
         .lastOption
         .fold(0)(_ + 1)
 
@@ -102,7 +106,7 @@ import scalatags.JsDom.all.{area => _, _}
       mainDiv.appendChild(chartTypeElem.render)
 
       for (demo <- chartDemos) {
-        Console.println(s"Rendering demo ${demo.id}")
+        Console.println(s"  Rendering demo ${demo.id}")
 
         val divId = s"demo-${demo.id}"
 

demo/src/main/scala/plotly/demo/histogram/BasicHistogram.scala

@@ -0,0 +1,31 @@
+package plotly.demo.histogram
+
+import plotly.Histogram
+import plotly.demo.DemoChart
+import plotly.layout.Layout
+
+object BasicHistogram extends DemoChart {
+
+  def plotlyDocUrl = "https://plotly.com/javascript/histograms/#basic-histogram"
+  def id           = this.getClass.getSimpleName.dropRight(1)
+  def source       = BasicHistogramSource.source
+
+  // demo source start
+
+  private val categoryCount = 50
+
+  private val indices    = LazyList.from(0).take(categoryCount)
+  private val categories = indices.map(i => s"name-$i")
+  private val values     = indices.map(_ => math.random())
+
+  val data = Seq(Histogram(values, categories))
+
+  val layout = new Layout()
+    .withTitle(id)
+    .withShowlegend(false)
+    .withHeight(400)
+    .withWidth(600)
+
+  // demo source end
+
+}

demo/src/main/scala/plotly/demo/histogram/StyledBasicHistogram.scala

@@ -0,0 +1,46 @@
+package plotly.demo.histogram
+
+import plotly.Histogram
+import plotly.demo.DemoChart
+import plotly.layout.{Axis, Layout, RangeSlider}
+import plotly.element._
+
+object StyledBasicHistogram extends DemoChart {
+
+  def plotlyDocUrl = "https://plotly.com/javascript/histograms/#basic-histogram"
+  def id           = this.getClass.getSimpleName.dropRight(1)
+  def source       = StyledBasicHistogramSource.source
+
+  // demo source start
+
+  private val categoryCount = 50
+
+  private val indices    = LazyList.from(0).take(categoryCount)
+  private val categories = indices.map(i => s"name-$i for $id")
+  private val values     = indices.map(_ => math.random())
+
+  val data = Seq(
+    Histogram(values, categories)
+      .withMarker(new Marker().withColor(Color.StringColor("#004A72")))
+      .withHovertext(categories.map(c => s"$c with hover text"))
+  )
+
+  val xAxis = new Axis()
+    .withRange((0d, 2d))
+    .withRangeslider(RangeSlider())
+
+  val yAxis = new Axis()
+    .withTitle("Count")
+    .withFixedrange(true)
+    .withTickformat(".1f")
+
+  val layout = new Layout()
+    .withXaxis(xAxis)
+    .withYaxis(yAxis)
+    .withTitle(id)
+    .withShowlegend(false)
+    .withHeight(400)
+    .withWidth(600)
+
+  // demo source end
+}

project/Deps.scala

@@ -1,4 +1,3 @@
-
 import sbt._
 
 import org.portablescala.sbtplatformdeps.PlatformDepsPlugin.autoImport._
@@ -7,15 +6,13 @@ object Deps {
 
   import Def.setting
 
-  def almondScalaApi = "sh.almond" %% "jupyter-api" % "0.13.14"
+  def almondScalaApi    = "sh.almond"                 %% "jupyter-api" % "0.13.14"
   def argonautShapeless = setting("com.github.alexarchambault" %%% "argonaut-shapeless_6.3" % "1.3.1")
-  def dataClass = "io.github.alexarchambault" %% "data-class" % "0.2.6"
-  def jodaTime = "joda-time" % "joda-time" % "2.12.7"
-  def rhino = "org.mozilla" % "rhino" % "1.7.14"
-  def shapeless = setting("com.chuusai" %%% "shapeless" % "2.3.7")
-  def scalacheckShapeless = setting("com.github.alexarchambault" %%% "scalacheck-shapeless_1.15" % "1.3.0")
-  def scalajsDom = setting("org.scala-js" %%% "scalajs-dom" % "2.8.0")
-  def scalatags = setting("com.lihaoyi" %%% "scalatags" % "0.13.1")
-  def scalaTest = "org.scalatest" %% "scalatest" % "3.2.18"
+  def dataClass         = "io.github.alexarchambault" %% "data-class"  % "0.2.6"
+  def jodaTime          = "joda-time"                  % "joda-time"   % "2.12.7"
+  def rhino             = "org.mozilla"                % "rhino"       % "1.7.15"
+  def scalajsDom        = setting("org.scala-js" %%% "scalajs-dom" % "2.8.0")
+  def scalatags         = setting("com.lihaoyi" %%% "scalatags" % "0.13.1")
+  def scalaTest         = "org.scalatest"             %% "scalatest"   % "3.2.18"
 
 }

render/js/src/main/scala/plotly/Plotly.scala

@@ -1,53 +1,72 @@
 package plotly
 
-import java.lang.{Boolean => JBoolean, Double => JDouble, Integer => JInt}
-
 import argonaut.Argonaut._
-import argonaut.{Json, PrettyParams}
+import argonaut.{EncodeJson, PrettyParams}
 import plotly.Codecs._
 import plotly.element.Color
 import plotly.internals.BetterPrinter
 import plotly.layout._
 
+import java.lang.{Boolean => JBoolean, Double => JDouble, Integer => JInt}
 import scala.scalajs.js
 import scala.scalajs.js.Dynamic.{global => g}
 import scala.scalajs.js.JSON
 
 object Plotly {
 
   private val printer = BetterPrinter(PrettyParams.nospace.copy(dropNullKeys = true))
-  private def stripNulls(json: Json): js.Any = {
-    // Remove empty objects
-    JSON.parse(printer.render(json))
+
+  // Remove empty objects
+  private def stripNulls[J: EncodeJson](value: J): js.Any = JSON.parse(printer.render(value.asJson))
+
+  trait PlotlyDyn {
+    def plotFn: js.Dynamic
+
+    def apply(div: String, data: Seq[Trace], layout: Layout, config: Config): Unit =
+      plotFn(
+        div,
+        stripNulls(data),
+        stripNulls(layout),
+        stripNulls(config)
+      )
+
+    def apply(div: String, data: Seq[Trace], layout: Layout): Unit =
+      plotFn(
+        div,
+        stripNulls(data),
+        stripNulls(layout)
+      )
+
+    def apply(div: String, data: Seq[Trace]): Unit =
+      plotFn(div, stripNulls(data))
+
+    def apply(div: String, data: Trace, layout: Layout): Unit =
+      plotFn(div, stripNulls(data), stripNulls(layout))
+
+    def apply(div: String, data: Trace): Unit =
+      plotFn(div, stripNulls(data))
   }
 
-  def plot(div: String, data: Seq[Trace], layout: Layout): Unit = {
-    g.Plotly.plot(
-      div,
-      stripNulls(data.asJson),
-      stripNulls(layout.asJson)
-    )
+  object newPlot extends PlotlyDyn {
+    val plotFn: js.Dynamic = g.Plotly.newPlot
   }
 
-  def plot(div: String, data: Seq[Trace]): Unit = {
-    g.Plotly.plot(
-      div,
-      stripNulls(data.asJson)
-    )
+  object plot extends PlotlyDyn {
+    val plotFn: js.Dynamic = g.Plotly.newPlot
   }
 
-  def plot(div: String, data: Trace, layout: Layout): Unit =
-    g.Plotly.plot(
-      div,
-      stripNulls(data.asJson),
-      stripNulls(layout.asJson)
-    )
-
-  def plot(div: String, data: Trace): Unit =
-    g.Plotly.plot(
-      div,
-      stripNulls(data.asJson)
-    )
+  object react extends PlotlyDyn {
+    val plotFn: js.Dynamic = g.Plotly.react
+  }
+
+  def relayout(div: String, layout: Layout): Unit =
+    g.Plotly.relayout(div, stripNulls(layout))
+
+  def purge(div: String): Unit =
+    g.Plotly.purge(div)
+
+  def validate(data: Seq[Trace], layout: Layout, config: Config): Unit =
+    g.Plotly.validate(stripNulls(data), stripNulls(layout))
 
   implicit class TraceOps(val trace: Trace) extends AnyVal {
     def plot(div: String, layout: Layout): Unit =