trait Facet extends View
A facet is a trellis plot (or small multiple) of a series of similar plots that displays different subsets of the same data, facilitating comparison across subsets.
The facet channels (facet, row, and column) are encoding channels that serves as macros for a facet specification. Vega-Lite automatically translates this shortcut to use the facet operator.
- Alphabetic
- By Inheritance
- Facet
- View
- VegaLite
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Facet, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def angle(value: JsValue): View
Sets the angle value.
Sets the angle value.
- Definition Classes
- View
- def angle(field: JsValue, type: String, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", scale: JsValue = JsUndefined, legend: JsValue = JsUndefined, condition: JsValue = JsUndefined): View
Sets the angle property.
Sets the angle property.
- Definition Classes
- View
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def autosize(type: String = "pad", resize: Boolean = false, contains: String = "content"): VegaLite
Sets the overall size of the visualization.
Sets the overall size of the visualization. The total size of a Vega-Lite visualization may be determined by multiple factors: specified width, height, and padding values, as well as content such as axes, legends, and titles.
- resize
A boolean flag indicating if autosize layout should be re-calculated on every view update.
- contains
Determines how size calculation should be performed, one of "content" or "padding". The default setting ("content") interprets the width and height settings as the data rectangle (plotting) dimensions, to which padding is then added. In contrast, the "padding" setting includes the padding within the view size calculations, such that the width and height settings indicate the total intended size of the view.
- Definition Classes
- VegaLite
- def background(color: String): VegaLite
CSS color property to use as the background of the entire view.
CSS color property to use as the background of the entire view.
- Definition Classes
- VegaLite
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def color(value: JsValue): View
Sets the color value.
Sets the color value.
- Definition Classes
- View
- def color(field: JsValue, type: String, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", scale: JsValue = JsUndefined, legend: JsValue = JsUndefined, condition: JsValue = JsUndefined): View
Sets the color property.
Sets the color property.
- Definition Classes
- View
- def column(field: String, type: String = "quantitative", bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", align: String = "all", center: Boolean = false, spacing: Option[Int] = None): Facet
A field definition for the horizontal facet of trellis plots.
- def config(properties: JsObject): VegaLite
Sets Vega-Lite configuration object that lists configuration properties of a visualization for creating a consistent theme.
Sets Vega-Lite configuration object that lists configuration properties of a visualization for creating a consistent theme. This property can only be defined at the top-level of a specification.
- Definition Classes
- VegaLite
- def data(url: String, format: JsValue = JsUndefined): VegaLite
Sets the url of the data source.
Sets the url of the data source.
- url
An URL from which to load the data set.
- format
Type of input data: "json", "csv", "tsv", "dsv". Default value: The default format type is determined by the extension of the file URL. If no extension is detected, "json" will be used by default.
- Definition Classes
- VegaLite
- def data(df: DataFrame): VegaLite
Sets a data frame describing the data source.
Sets a data frame describing the data source.
- Definition Classes
- VegaLite
- def data(rows: JsObject*): VegaLite
Sets an array of objects describing the data source.
Sets an array of objects describing the data source.
- Definition Classes
- VegaLite
- def data(json: JsArray): VegaLite
Sets a JSON array describing the data source.
Sets a JSON array describing the data source. Set to null to ignore the parent’s data source. If no data is set, it is derived from the parent.
- Definition Classes
- VegaLite
- def description(description: String): VegaLite
Sets the description of this mark for commenting purpose.
Sets the description of this mark for commenting purpose.
- Definition Classes
- VegaLite
- def embed: String
Returns the HTML of plot specification with Vega Embed.
Returns the HTML of plot specification with Vega Embed.
- Definition Classes
- VegaLite
- def encode(x: String, y: String, color: Option[(String, String)] = None): View
Sets the channels x and y (quantitative), and optional color with default properties.
Sets the channels x and y (quantitative), and optional color with default properties.
- Definition Classes
- View
- def ensuring(cond: (Facet) => Boolean, msg: => Any): Facet
- def ensuring(cond: (Facet) => Boolean): Facet
- def ensuring(cond: Boolean, msg: => Any): Facet
- def ensuring(cond: Boolean): Facet
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def facet(field: String, type: String = "quantitative", bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", align: String = "all", center: Boolean = false, spacing: Option[Int] = None, columns: Option[Int] = None): Facet
A field definition for the (flexible) facet of trellis plots.
A field definition for the (flexible) facet of trellis plots. If either row or column is specified, this channel will be ignored.
- field
A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.
- bin
A flag for binning a quantitative field.
- If true, default binning parameters will be applied.
- If "binned", this indicates that the data for the x (or y) channel are already binned.
- timeUnit
Time unit (e.g., year, yearmonth, month, hours) for a temporal field, or a temporal field that gets casted as ordinal.
- align
The alignment to apply to row/column facet’s subplot. The supported string values are "all", "each", and "none".
- For "none", a flow layout will be used, in which adjacent subviews are simply placed one after the other.
- For "each", subviews will be aligned into a clean grid structure, but each row or column may be of variable size.
- For "all", subviews will be aligned and each row or column will be sized identically based on the maximum observed size. String values for this property will be applied to both grid rows and columns.
- center
Boolean flag indicating if facet’s subviews should be centered relative to their respective rows or columns.
- spacing
The spacing in pixels between facet’s sub-views.
- columns
The number of columns to include in the view composition layout.
- def fill(value: JsValue): View
Sets the fill value.
Sets the fill value.
- Definition Classes
- View
- def fill(field: JsValue, type: String, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", scale: JsValue = JsUndefined, legend: JsValue = JsUndefined, condition: JsValue = JsUndefined): View
Sets the fill property.
Sets the fill property.
- Definition Classes
- View
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def height(height: String): View
Sets the top-level height properties to "container" to indicate that the height of the plot should be the same as its surrounding container.
Sets the top-level height properties to "container" to indicate that the height of the plot should be the same as its surrounding container. The width and height can be set independently, for example, you can have a responsive width and a fixed height by setting width to "container" and height to a number.
After setting width or height to "container", you need to ensure that the container’s width or height is determined outside the plot. For example, the container can be a
element that has style width: 100%; height: 300px. When the container is not available or its size is not defined (e.g., in server-side rendering), the default width and height are config.view.continuousWidth and config.view.continuousHeight, respectively.
- Definition Classes
- View
- def height(height: Int): View
Sets the height of the data rectangle (plotting) dimensions.
Sets the height of the data rectangle (plotting) dimensions.
- Definition Classes
- View
- def heightStep(step: Int): View
For a discrete y-field, sets the height per discrete step..
For a discrete y-field, sets the height per discrete step..
- Definition Classes
- View
- def iframe(id: String = java.util.UUID.randomUUID.toString): String
Returns the HTML wrapped in an iframe to render in notebooks.
Returns the HTML wrapped in an iframe to render in notebooks.
- id
the iframe HTML id.
- Definition Classes
- VegaLite
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def latitude(field: JsValue, type: String = "quantitative", bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = ""): View
Sets the latitude field.
Sets the latitude field.
- Definition Classes
- View
- def latitude2(field: JsValue, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = ""): View
Sets the latitude2 field.
Sets the latitude2 field.
- Definition Classes
- View
- def longitude(field: JsValue, type: String = "quantitative", bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = ""): View
Sets the longitude field.
Sets the longitude field.
- Definition Classes
- View
- def longitude2(field: JsValue, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = ""): View
Sets the longitude2 field.
Sets the longitude2 field.
- Definition Classes
- View
- def mark(mark: String): View
Sets the mark property of a string (one of "bar", "circle", "square", "tick", "line", "area", "point", "rule", "geoshape", and "text").
Sets the mark property of a string (one of "bar", "circle", "square", "tick", "line", "area", "point", "rule", "geoshape", and "text").
- Definition Classes
- View
- def mark(mark: JsObject): View
Sets the mark definition object.
Sets the mark definition object. Marks are the basic visual building block of a visualization. They provide basic shapes whose properties (such as position, size, and color) can be used to visually encode data, either from a data field, or a constant value.
- Definition Classes
- View
- def name(name: String): VegaLite
Sets the name of the visualization for later reference.
Sets the name of the visualization for later reference.
- Definition Classes
- VegaLite
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def opacity(value: JsValue): View
Sets the opacity value.
Sets the opacity value.
- Definition Classes
- View
- def opacity(field: JsValue, type: String, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", scale: JsValue = JsUndefined, legend: JsValue = JsUndefined, condition: JsValue = JsUndefined): View
Sets the opacity property.
Sets the opacity property.
- Definition Classes
- View
- def padding(left: Int, top: Int, right: Int, bottom: Int): VegaLite
Specifies padding for each side.
Specifies padding for each side. The visualization padding, in pixels, is from the edge of the visualization canvas to the data rectangle.
- Definition Classes
- VegaLite
- def padding(size: Int): VegaLite
Specifies padding for all sides.
Specifies padding for all sides. The visualization padding, in pixels, is from the edge of the visualization canvas to the data rectangle.
- Definition Classes
- VegaLite
- def projection(projection: JsObject): View
Sets geographic projection, which will be applied to shape path for "geoshape" marks and to latitude and "longitude" channels for other marks.
Sets geographic projection, which will be applied to shape path for "geoshape" marks and to latitude and "longitude" channels for other marks.
A cartographic projection maps longitude and latitude pairs to x, y coordinates. As with Vega, one can use projections in Vega-Lite to layout both geographic points (such as locations on a map) represented by longitude and latitude coordinates, or to project geographic regions (such as countries and states) represented using the GeoJSON format. Projections are specified at the unit specification level, alongside encoding. Geographic coordinate data can then be mapped to longitude and latitude channels (and longitude2 and latitude2 for ranged marks).
- Definition Classes
- View
- def radius(field: JsValue, type: String = "quantitative", bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = "", scale: JsValue = JsUndefined, sort: Option[String] = None, stack: JsValue = JsUndefined): View
Sets the radius field.
Sets the radius field.
- Definition Classes
- View
- def radius2(field: JsValue, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = ""): View
Sets the radius2 field.
Sets the radius2 field.
- Definition Classes
- View
- def row(field: String, type: String = "quantitative", bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", align: String = "all", center: Boolean = false, spacing: Option[Int] = None): Facet
A field definition for the vertical facet of trellis plots.
- def selection(selections: (String, String)*): View
Selections are the basic building block in Vega-Lite’s grammar of interaction.
Selections are the basic building block in Vega-Lite’s grammar of interaction. They map user input (e.g., mouse moves and clicks, touch presses, etc.) into data queries, which can subsequently be used to drive conditional encoding rules, filter data points, or determine scale domains.
The simplest definition of selection consists of a name and a type. The selection type determines the default events that trigger a selection and the resultant data query.
Vega-Lite currently supports three selection types:
- "single" to select a single discrete data value on click. - "multi" to select multiple discrete data value; the first value is selected on click and additional values toggled on shift-click. - "interval" to select a continuous range of data values on drag.
- selections
(name, type) pairs
- Definition Classes
- View
- def setProperty(prop: String, field: JsValue, type: String, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", scale: JsValue = JsUndefined, legend: JsValue = JsUndefined, condition: JsValue = JsUndefined): View
Sets a mark property.
Sets a mark property.
- Definition Classes
- View
- def setPropertyDatum(prop: String, datum: JsValue): View
Sets a mark property by datum.
Sets a mark property by datum.
- Definition Classes
- View
- def setPropertyValue(prop: String, value: JsValue): View
Sets a mark property by value.
Sets a mark property by value.
- Definition Classes
- View
- def shape(value: JsValue): View
Sets the shape value.
Sets the shape value.
- Definition Classes
- View
- def shape(field: JsValue, type: String, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", scale: JsValue = JsUndefined, legend: JsValue = JsUndefined, condition: JsValue = JsUndefined): View
Sets the shape property.
Sets the shape property.
- Definition Classes
- View
- def size(value: JsValue): View
Sets the size value.
Sets the size value.
- Definition Classes
- View
- def size(field: JsValue, type: String, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", scale: JsValue = JsUndefined, legend: JsValue = JsUndefined, condition: JsValue = JsUndefined): View
Sets the size property.
Sets the size property.
- Definition Classes
- View
- def stroke(value: JsValue): View
Sets the stroke value.
Sets the stroke value.
- Definition Classes
- View
- def stroke(field: JsValue, type: String, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", scale: JsValue = JsUndefined, legend: JsValue = JsUndefined, condition: JsValue = JsUndefined): View
Sets the stroke property.
Sets the stroke property.
- Definition Classes
- View
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def text(value: JsValue): View
Sets the text value.
Sets the text value.
- Definition Classes
- View
- def text(field: JsValue, type: String, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", scale: JsValue = JsUndefined, legend: JsValue = JsUndefined, condition: JsValue = JsUndefined): View
Sets the text property.
Sets the text property.
- Definition Classes
- View
- def theta(field: JsValue, type: String = "quantitative", bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = "", scale: JsValue = JsUndefined, sort: Option[String] = None, stack: JsValue = JsUndefined): View
Sets the theta field.
Sets the theta field.
- Definition Classes
- View
- def theta2(field: JsValue, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = ""): View
Sets the theta2 field.
Sets the theta2 field.
- Definition Classes
- View
- def title(title: String): VegaLite
Sets a descriptive title to a chart.
Sets a descriptive title to a chart.
- Definition Classes
- VegaLite
- def toString(): String
- Definition Classes
- VegaLite → AnyRef → Any
- def transform(transforms: JsObject*): VegaLite
An array of data transformations such as filter and new field calculation.
An array of data transformations such as filter and new field calculation. Data transformations in Vega-Lite are described via either view-level transforms (the transform property) or field transforms inside encoding (bin, timeUnit, aggregate, sort, and stack).
When both types of transforms are specified, the view-level transforms are executed first based on the order in the array. Then the inline transforms are executed in this order: bin, timeUnit, aggregate, sort, and stack.
- Definition Classes
- VegaLite
- def transform(transforms: JsArray): VegaLite
An array of data transformations such as filter and new field calculation.
An array of data transformations such as filter and new field calculation. Data transformations in Vega-Lite are described via either view-level transforms (the transform property) or field transforms inside encoding (bin, timeUnit, aggregate, sort, and stack).
When both types of transforms are specified, the view-level transforms are executed first based on the order in the array. Then the inline transforms are executed in this order: bin, timeUnit, aggregate, sort, and stack.
- Definition Classes
- VegaLite
- def usermeta(data: JsValue): VegaLite
Optional metadata that will be passed to Vega.
Optional metadata that will be passed to Vega. This object is completely ignored by Vega and Vega-Lite and can be used for custom metadata.
- Definition Classes
- VegaLite
- def view(background: JsObject): View
Sets the view background’s fill and stroke.
Sets the view background’s fill and stroke. The background property of a top-level view specification defines the background of the whole visualization canvas. Meanwhile, the view property of a single-view or layer specification can define the background of the view.
- Definition Classes
- View
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def width(width: String): View
Sets the top-level width properties to "container" to indicate that the width of the plot should be the same as its surrounding container.
Sets the top-level width properties to "container" to indicate that the width of the plot should be the same as its surrounding container. The width and height can be set independently, for example, you can have a responsive width and a fixed height by setting width to "container" and height to a number.
After setting width or height to "container", you need to ensure that the container’s width or height is determined outside the plot. For example, the container can be a
element that has style width: 100%; height: 300px. When the container is not available or its size is not defined (e.g., in server-side rendering), the default width and height are config.view.continuousWidth and config.view.continuousHeight, respectively.
- Definition Classes
- View
- def width(width: Int): View
Sets the width of the data rectangle (plotting) dimensions.
Sets the width of the data rectangle (plotting) dimensions.
- Definition Classes
- View
- def widthStep(step: Int): View
For a discrete x-field, sets the width per discrete step.
For a discrete x-field, sets the width per discrete step.
- Definition Classes
- View
- def x(field: JsValue, type: String, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = "", scale: JsValue = JsUndefined, axis: JsValue = JsUndefined, sort: Option[String] = None, band: Option[Double] = None, impute: JsValue = JsUndefined, stack: JsValue = JsUndefined): View
Sets the x field.
Sets the x field.
- Definition Classes
- View
- def x(datum: JsValue): View
Sets the x channel as a datum field.
Sets the x channel as a datum field.
- Definition Classes
- View
- def x2(field: JsValue, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = ""): View
Sets the x2 field.
Sets the x2 field.
- Definition Classes
- View
- def xError(field: JsValue, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = ""): View
Sets the xError field.
Sets the xError field.
- Definition Classes
- View
- def xError2(field: JsValue, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = ""): View
Sets the xError2 field.
Sets the xError2 field.
- Definition Classes
- View
- def y(field: JsValue, type: String, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = "", scale: JsValue = JsUndefined, axis: JsValue = JsUndefined, sort: Option[String] = None, band: Option[Double] = None, impute: JsValue = JsUndefined, stack: JsValue = JsUndefined): View
Sets the y field.
Sets the y field.
- Definition Classes
- View
- def y(datum: JsValue): View
Sets the y channel as a datum field.
Sets the y channel as a datum field.
- Definition Classes
- View
- def y2(field: JsValue, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = ""): View
Sets the y2 field.
Sets the y2 field.
- Definition Classes
- View
- def yError(field: JsValue, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = ""): View
Sets the yError field.
Sets the yError field.
- Definition Classes
- View
- def yError2(field: JsValue, bin: Either[Boolean, JsObject] = Left(false), timeUnit: String = "", aggregate: String = "", title: String = ""): View
Sets the yError2 field.
Sets the yError2 field.
- Definition Classes
- View
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Facet toStringFormat[Facet] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Facet, B)
- Implicit
- This member is added by an implicit conversion from Facet toArrowAssoc[Facet] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Smile (Statistical Machine Intelligence and Learning Engine) is a fast and comprehensive machine learning, NLP, linear algebra, graph, interpolation, and visualization system in Java and Scala. With advanced data structures and algorithms, Smile delivers state-of-art performance.
Smile covers every aspect of machine learning, including classification, regression, clustering, association rule mining, feature selection, manifold learning, multidimensional scaling, genetic algorithms, missing value imputation, efficient nearest neighbor search, etc.