com.knockdata.spark.highcharts.plotoptions.Area.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spark-highcharts Show documentation
Provide Highcharts Support for Spark either in Zepplin or spark-shell
There is a newer version: 0.6.6
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements.  See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License.  You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.knockdata.spark.highcharts.plotoptions

import com.knockdata.spark.highcharts.model._
import com.knockdata.spark.highcharts.base._

private[highcharts] class Area extends BasePlotOptions with PublicApply {
  def fieldName = "area"

  def allowPointSelect(value: Boolean): this.type = {
    append("allowPointSelect", value)
  }

  // NOT in API
  def ange(value: Any): this.type = {
    append("ange", value)
  }

  def animation(value: Boolean): this.type = {
    append("animation", value)
  }

  def color(value: String): this.type = {
    append("color", value)
  }

  def connectEnds(value: Boolean): this.type = {
    append("connectEnds", value)
  }

  def connectNulls(value: Boolean): this.type = {
    append("connectNulls", value)
  }

  def cropThreshold(value: Int): this.type = {
    append("cropThreshold", value)
  }

  def dashStyle(value: String): this.type = {
    expect(value, "Solid",
      "ShortDash",
      "ShortDot",
      "ShortDashDot",
      "ShortDashDotDot",
      "Dot",
      "Dash",
      "LongDash",
      "DashDot",
      "LongDashDot",
      "LongDashDotDot")
    append("dashStyle", value)
  }

  def dataLabels(values: (String, Any)*): this.type = {
    append("dataLabels", values.toMap)
  }

  def fillColor(value: String): this.type = {
    append("fillColor", value)
  }


  /**
    * Not in Highcharts API, check http://www.highcharts.com/demo/line-time-series
    */
  def fillColorLinearGradient(values: (String, Any)*): this.type = {
    append("fillColor", "linearGradient", values.toMap)
  }

  /**
    * Not in Highcharts API, check http://www.highcharts.com/demo/line-time-series
    */
  def fillColorStops(values: (Int, Any)*): this.type = {
    append("fillColor", "stops",
      values.map {
        case (k, v: String) => k -> placeholdCode(v)
        case (k, v: Code) => k -> placeholdCode(v)
      }.toList)
  }

  def fillOpacity(value: Double): this.type = {
    append("fillOpacity", value)
  }

  def lineColor(value: String): this.type = {
    append("lineColor", value)
  }

  def lineWidth(value: Int): this.type = {
    append("lineWidth", value)
  }

  def linecap(value: String): this.type = {
    // round
    append("linecap", value)
  }

  def linkedTo(value: String): this.type = {
    append("linkedTo", value)
  }

  def marker(values: (String, Any)*): this.type = {
    append("marker", values.toMap)
  }

  def negativeColor(value: String): this.type = {
    append("negativeColor", value)
  }

  def negativeFillColor(value: String): this.type = {
    append("negativeFillColor", value)
  }

  // NOT in API DOC
  def pline(value: Any): this.type = {
    append("pline", value)
  }

  // NOT in API DOC
  def plinerange(value: Any): this.type = {
    append("plinerange", value)
  }

  def pointInterval(value: Int): this.type = {
    append("pointInterval", value)
  }

  def pointIntervalUnit(value: String): this.type = {
    append("pointIntervalUnit", value)
  }

  def pointPlacement(value: String): this.type = {
    // null, "on", "between"
    append("pointPlacement", value)
  }

  def pointPlacement(value: Double): this.type = {
    append("pointPlacement", value)
  }

  def pointStart(value: Int): this.type = {
    append("pointStart", value)
  }

  def shadow(value: Boolean): this.type = {
    append("shadow", value)
  }

  def showCheckbox(value: Boolean): this.type = {
    append("showCheckbox", value)
  }

  def showInLegend(value: Boolean): this.type = {
    append("showInLegend", value)
  }

  def softThreshold(value: Boolean): this.type = {
    append("softThreshold", value)
  }

  def stacking(value: String): this.type = {
    // "normal" to stack by value or "percent".
    append("stacking", value)
  }

  // the value only have one item which is hover
  def states(values: (String, Map[String, Any])*): this.type = {
    val hover = values.collect {
      case ("hover", v) => v
    }.head

    append("states", "hover", hover)
  }

  /**
    * it is states.hover, since only hover in states
    * so just using one function without embedded structure
    */
  def statesHover(values: (String, Any)*): this.type = {
    append("states", "hover", values.toMap)
  }

  def step(value: String): this.type = {
    expect(value, "left", "center", "right")
    append("step", value)
  }

  def threshold(value: Int): this.type = {
    append("threshold", value)
  }

  def trackByArea(value: Boolean): this.type = {
    append("trackByArea", value)
  }

  def turboThreshold(value: Int): this.type = {
    append("turboThreshold", value)
  }
}