Class

vegas.DSL

UnitSpecBuilder

Related Doc: package DSL

Permalink

case class UnitSpecBuilder(spec: UnitSpec) extends SpecBuilder with UnitSpecDSL with Product with Serializable

Each layer's sub-spec

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UnitSpecBuilder
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. UnitSpecDSL
  7. ConfigDSL
  8. TransformDSL
  9. DataDSL
  10. UnitEncoderDSL
  11. BaseEncoderDSL
  12. SpecBuilder
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UnitSpecBuilder(spec: UnitSpec)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val _config: PLens[UnitSpecBuilder, UnitSpecBuilder, Option[Config], Option[Config]]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    UnitSpecDSLConfigDSL
  5. val _data: PLens[UnitSpecBuilder, UnitSpecBuilder, Option[Data], Option[Data]]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    UnitSpecDSLDataDSL
  6. def _encoding: PLens[UnitSpecBuilder, UnitSpecBuilder, Option[UnitEncoding], Option[UnitEncoding]]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    UnitSpecDSLUnitEncoderDSL
  7. val _spec: Lens[UnitSpecBuilder, UnitSpec]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    UnitSpecDSL
  8. val _transform: PLens[UnitSpecBuilder, UnitSpecBuilder, Option[Transform], Option[Transform]]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    UnitSpecDSLTransformDSL
  9. def addTransform(field: String, expr: String): UnitSpecBuilder

    Permalink
    Definition Classes
    TransformDSL
  10. def addTransformCalculation(field: String, expr: String): UnitSpecBuilder

    Permalink
    Definition Classes
    TransformDSL
  11. def asCirceJson: Json

    Permalink

    Returns a Circe Json object that represents the spec.

    Returns a Circe Json object that represents the spec. Also see toJson

    Definition Classes
    UnitSpecBuilderSpecBuilder
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def baseEncodeCDWL(lens: Optional[UnitSpecBuilder, Option[ChannelDefWithLegend]])(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, value: OptArg[Any] = NoArg, scale: OptArg[Scale] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, title: OptArg[String] = NoArg, legend: OptArg[Legend] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, sortField: OptArg[SortField] = NoArg, sortOrder: OptArg[SortOrder] = NoArg): UnitSpecBuilder

    Permalink
    Attributes
    protected
    Definition Classes
    BaseEncoderDSL
  14. def baseEncodePCD(lens: Optional[UnitSpecBuilder, Option[PositionChannelDef]])(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, value: OptArg[Any] = NoArg, axis: OptArg[Axis] = NoArg, hideAxis: OptArg[Boolean] = NoArg, scale: OptArg[Scale] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, title: OptArg[String] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, sortField: OptArg[SortField] = NoArg, sortOrder: OptArg[SortOrder] = NoArg): UnitSpecBuilder

    Permalink
    Attributes
    protected
    Definition Classes
    BaseEncoderDSL
  15. def baseEncoderFD(lens: Optional[UnitSpecBuilder, Option[FieldDef]])(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, value: OptArg[Any] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, title: OptArg[String] = NoArg): UnitSpecBuilder

    Permalink
    Attributes
    protected
    Definition Classes
    BaseEncoderDSL
  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def config(viewport: OptArg[Double] = NoArg, background: OptArg[String] = NoArg, numberFormat: OptArg[String] = NoArg, timeFormat: OptArg[String] = NoArg, countTitle: OptArg[String] = NoArg): (UnitSpecBuilder) ⇒ UnitSpecBuilder

    Permalink
    Definition Classes
    ConfigDSL
  18. def configAxis(axisWidth: OptArg[Double] = NoArg, layer: OptArg[String] = NoArg, offset: OptArg[Double] = NoArg, axisColor: OptArg[String] = NoArg, grid: OptArg[Boolean] = NoArg, gridColor: OptArg[String] = NoArg, gridDash: OptArg[List[Double]] = NoArg, gridOpacity: OptArg[Double] = NoArg, gridWidth: OptArg[Double] = NoArg, labels: OptArg[Boolean] = NoArg, labelAngle: OptArg[Double] = NoArg, labelAlign: OptArg[String] = NoArg, labelBaseline: OptArg[String] = NoArg, labelMaxLength: OptArg[Double] = NoArg, shortTimeLabels: OptArg[Boolean] = NoArg, subdivide: OptArg[Double] = NoArg, ticks: OptArg[Double] = NoArg, tickColor: OptArg[String] = NoArg, tickLabelColor: OptArg[String] = NoArg, tickLabelFont: OptArg[String] = NoArg, tickLabelFontSize: OptArg[Double] = NoArg, tickPadding: OptArg[Double] = NoArg, tickSize: OptArg[Double] = NoArg, tickSizeMajor: OptArg[Double] = NoArg, tickSizeMinor: OptArg[Double] = NoArg, tickSizeEnd: OptArg[Double] = NoArg, tickWidth: OptArg[Double] = NoArg, titleColor: OptArg[String] = NoArg, titleFont: OptArg[String] = NoArg, titleFontSize: OptArg[Double] = NoArg, titleFontWeight: OptArg[String] = NoArg, titleOffset: OptArg[Double] = NoArg, titleMaxLength: OptArg[Double] = NoArg, characterWidth: OptArg[Double] = NoArg, properties: OptArg[Properties] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    ConfigDSL
  19. def configCell(width: OptArg[Double] = NoArg, height: OptArg[Double] = NoArg, clip: OptArg[Boolean] = NoArg, fill: OptArg[String] = NoArg, fillOpacity: OptArg[Double] = NoArg, stroke: OptArg[String] = NoArg, strokeOpacity: OptArg[Double] = NoArg, strokeWidth: OptArg[Double] = NoArg, strokeDash: OptArg[List[Double]] = NoArg, strokeDashOffset: OptArg[Double] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    ConfigDSL
  20. def configFacet(scale: OptArg[FacetScaleConfig] = NoArg, axis: OptArg[AxisConfig] = NoArg, grid: OptArg[FacetGridConfig] = NoArg, cell: OptArg[CellConfig] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    ConfigDSL
  21. def configLegend(orient: OptArg[String] = NoArg, offset: OptArg[Double] = NoArg, padding: OptArg[Double] = NoArg, margin: OptArg[Double] = NoArg, gradientStrokeColor: OptArg[String] = NoArg, gradientStrokeWidth: OptArg[Double] = NoArg, gradientHeight: OptArg[Double] = NoArg, gradientWidth: OptArg[Double] = NoArg, labelAlign: OptArg[String] = NoArg, labelBaseline: OptArg[String] = NoArg, labelColor: OptArg[String] = NoArg, labelFont: OptArg[String] = NoArg, labelFontSize: OptArg[Double] = NoArg, labelOffset: OptArg[Double] = NoArg, shortTimeLabels: OptArg[Boolean] = NoArg, symbolColor: OptArg[String] = NoArg, symbolShape: OptArg[String] = NoArg, symbolSize: OptArg[Double] = NoArg, symbolStrokeWidth: OptArg[Double] = NoArg, titleColor: OptArg[String] = NoArg, titleFont: OptArg[String] = NoArg, titleFontSize: OptArg[Double] = NoArg, titleFontWeight: OptArg[String] = NoArg, properties: OptArg[Properties] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    ConfigDSL
  22. def configMark(filled: OptArg[Boolean] = NoArg, color: OptArg[String] = NoArg, fill: OptArg[String] = NoArg, stroke: OptArg[String] = NoArg, opacity: OptArg[Double] = NoArg, fillOpacity: OptArg[Double] = NoArg, strokeOpacity: OptArg[Double] = NoArg, strokeWidth: OptArg[Double] = NoArg, strokeDash: OptArg[List[Double]] = NoArg, strokeDashOffset: OptArg[Double] = NoArg, stacked: OptArg[StackOffset] = NoArg, orient: OptArg[Orient] = NoArg, interpolate: OptArg[Interpolate] = NoArg, tension: OptArg[Double] = NoArg, lineSize: OptArg[Double] = NoArg, ruleSize: OptArg[Double] = NoArg, barSize: OptArg[Double] = NoArg, barThinSize: OptArg[Double] = NoArg, shape: OptArg[Shape] = NoArg, customShape: OptArg[String] = NoArg, size: OptArg[Double] = NoArg, tickSize: OptArg[Double] = NoArg, tickThickness: OptArg[Double] = NoArg, align: OptArg[HorizontalAlign] = NoArg, angle: OptArg[Double] = NoArg, baseline: OptArg[VerticalAlign] = NoArg, dx: OptArg[Double] = NoArg, dy: OptArg[Double] = NoArg, radius: OptArg[Double] = NoArg, theta: OptArg[Double] = NoArg, font: OptArg[String] = NoArg, fontSize: OptArg[Double] = NoArg, fontStyle: OptArg[FontStyle] = NoArg, fontWeight: OptArg[FontWeight] = NoArg, format: OptArg[String] = NoArg, shortTimeLabels: OptArg[Boolean] = NoArg, text: OptArg[String] = NoArg, applyColorToBackground: OptArg[Boolean] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    ConfigDSL
  23. def configOverlay(line: OptArg[Boolean] = NoArg, area: OptArg[AreaOverlay] = NoArg, pointStyle: OptArg[MarkConfig] = NoArg, lineStyle: OptArg[MarkConfig] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    ConfigDSL
  24. def configScale(round: OptArg[Boolean] = NoArg, textBandWidth: OptArg[Double] = NoArg, bandSize: OptArg[Double] = NoArg, bandSizePreset: OptArg[BandSize] = NoArg, opacity: OptArg[List[Double]] = NoArg, padding: OptArg[Double] = NoArg, useRawDomain: OptArg[Boolean] = NoArg, nominalColorRange: OptArg[NominalColorRangeListString] = NoArg, sequentialColorRange: OptArg[SequentialColorRangeListString] = NoArg, shapeRange: OptArg[ShapeRangeListString] = NoArg, barSizeRange: OptArg[List[Double]] = NoArg, fontSizeRange: OptArg[List[Double]] = NoArg, ruleSizeRange: OptArg[List[Double]] = NoArg, tickSizeRange: OptArg[List[Double]] = NoArg, pointSizeRange: OptArg[List[Double]] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    ConfigDSL
  25. def encodeColor(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, value: OptArg[Any] = NoArg, scale: OptArg[Scale] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, title: OptArg[String] = NoArg, legend: OptArg[Legend] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, sortField: OptArg[SortField] = NoArg, sortOrder: OptArg[SortOrder] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    UnitEncoderDSL
  26. def encodeDetail(fields: String*): UnitSpecBuilder

    Permalink
    Definition Classes
    BaseEncoderDSL
  27. def encodeDetailFields(fields: FieldDef*): UnitSpecBuilder

    Permalink
    Definition Classes
    UnitEncoderDSLBaseEncoderDSL
  28. def encodeLabel(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, value: OptArg[Any] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, title: OptArg[String] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    UnitEncoderDSL
  29. def encodeOpacity(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, value: OptArg[Any] = NoArg, scale: OptArg[Scale] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, title: OptArg[String] = NoArg, legend: OptArg[Legend] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, sortField: OptArg[SortField] = NoArg, sortOrder: OptArg[SortOrder] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    UnitEncoderDSL
  30. def encodeShape(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, value: OptArg[Any] = NoArg, scale: OptArg[Scale] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, title: OptArg[String] = NoArg, legend: OptArg[Legend] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, sortField: OptArg[SortField] = NoArg, sortOrder: OptArg[SortOrder] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    UnitEncoderDSL
  31. def encodeSize(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, value: OptArg[Any] = NoArg, scale: OptArg[Scale] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, title: OptArg[String] = NoArg, legend: OptArg[Legend] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, sortField: OptArg[SortField] = NoArg, sortOrder: OptArg[SortOrder] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    UnitEncoderDSL
  32. def encodeText(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, value: OptArg[Any] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, title: OptArg[String] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    UnitEncoderDSL
  33. def encodeX(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, value: OptArg[Any] = NoArg, axis: OptArg[Axis] = NoArg, hideAxis: OptArg[Boolean] = NoArg, scale: OptArg[Scale] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, title: OptArg[String] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, sortField: OptArg[SortField] = NoArg, sortOrder: OptArg[SortOrder] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    UnitEncoderDSL
  34. def encodeX2(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, value: OptArg[Any] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, title: OptArg[String] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    UnitEncoderDSL
  35. def encodeY(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, value: OptArg[Any] = NoArg, axis: OptArg[Axis] = NoArg, hideAxis: OptArg[Boolean] = NoArg, scale: OptArg[Scale] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, title: OptArg[String] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, sortField: OptArg[SortField] = NoArg, sortOrder: OptArg[SortOrder] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    UnitEncoderDSL
  36. def encodeY2(field: OptArg[String] = NoArg, dataType: OptArg[Type] = NoArg, value: OptArg[Any] = NoArg, timeUnit: OptArg[TimeUnit] = NoArg, bin: OptArg[Bin] = NoArg, enableBin: OptArg[Boolean] = NoArg, aggregate: OptArg[AggregateOp] = NoArg, title: OptArg[String] = NoArg): UnitSpecBuilder

    Permalink
    Definition Classes
    UnitEncoderDSL
  37. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  38. def filter(filter: String): UnitSpecBuilder

    Permalink
    Definition Classes
    TransformDSL
  39. def filterInvalid(filterInvalid: Boolean): UnitSpecBuilder

    Permalink
    Definition Classes
    TransformDSL
  40. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  41. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  42. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  43. def mark(mark: Mark): UnitSpecBuilder

    Permalink
    Definition Classes
    UnitSpecDSL
  44. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  45. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  46. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  47. val spec: UnitSpec

    Permalink
  48. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  49. def toJson: String

    Permalink

    Returns a Json string representation of this vega-lite spec

    Returns a Json string representation of this vega-lite spec

    Definition Classes
    UnitSpecBuilderSpecBuilder
  50. def transformFilter(filter: String): UnitSpecBuilder

    Permalink
    Definition Classes
    TransformDSL
  51. def transformFilterInvalid(filterInvalid: Boolean = true): UnitSpecBuilder

    Permalink
    Definition Classes
    TransformDSL
  52. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. def withCaseClasses(values: Seq[Product])(implicit vt: ValueTransformer): UnitSpecBuilder

    Permalink

    Specifies data as a Seq of case-classes.

    Specifies data as a Seq of case-classes. Each field within the case class becomes a row within the data. And each column is named after the field names within the case class.

    Definition Classes
    DataDSL
  56. def withData(values: Seq[Map[String, Any]])(implicit vt: ValueTransformer): UnitSpecBuilder

    Permalink

    Specifies data as a Seq of rows, where each row is specified using a Map of column -> value pairs.

    Specifies data as a Seq of rows, where each row is specified using a Map of column -> value pairs.

    values

    A Seq of Maps, with each Map specifying the column -> value pairs of a row.

    Definition Classes
    DataDSL
  57. def withSeqValues(values: Seq[Seq[Any]])(implicit vt: ValueTransformer): UnitSpecBuilder

    Permalink

    Specifies data as a Seq of Seq data (i.e Array(Array(1,2,3), Array(4,5,6)), where each inner Seq represents a row of data.

    Specifies data as a Seq of Seq data (i.e Array(Array(1,2,3), Array(4,5,6)), where each inner Seq represents a row of data. Column names within the rows are named after their array indexes (0 based). So, for example, to encode this data you'd write:

    encodeX("0", Quant). encodeY("1", Quant). encodeSize("2", Ord).

    values

    A Seq[Seq[Any]] where each inner sequence is treated as a row of data.

    Definition Classes
    DataDSL
  58. def withURL(url: String, formatType: OptArg[DataFormatType] = NoArg): UnitSpecBuilder

    Permalink

    Uses data from an external source as specified by the given URL.

    Uses data from an external source as specified by the given URL.

    url

    The URL for the external data source.

    formatType

    The type of the data (i.e. DataFormat.Json, DataFormat.Csv, etc).

    Definition Classes
    DataDSL
  59. def withValues(values: Seq[Any])(implicit vt: ValueTransformer): UnitSpecBuilder

    Permalink

    Specifies data as a Seq of values (i.e.

    Specifies data as a Seq of values (i.e. Array(1.2, 4.2, 5,6)). The array indices are used to create a column "x", and the array's values to create a column "y". To encode this data you'd use:

    encodeX("x", Ordinal) encodeX("y", ...)

    values

    A Seq[Any] containing the values to use.

    Definition Classes
    DataDSL
  60. def withXY(values: Seq[(Any, Any)])(implicit vt: ValueTransformer): UnitSpecBuilder

    Permalink

    Specifies data as a Seq of x,y values represented by the tuple (Any, Any).

    Specifies data as a Seq of x,y values represented by the tuple (Any, Any). Each column is named "x", "y". To encode the data you'd use:

    encodeX("x", ...). encodeY("y", ...)

    values

    A Seq of (Any, Any) tuples

    Definition Classes
    DataDSL

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from UnitSpecDSL

Inherited from ConfigDSL[UnitSpecBuilder]

Inherited from TransformDSL[UnitSpecBuilder]

Inherited from DataDSL[UnitSpecBuilder]

Inherited from SpecBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped