pub struct SpecClass {Show 22 fields
pub data: Option<Data>,
pub description: Option<String>,
pub encoding: Option<SpecEncoding>,
pub height: Option<f64>,
pub layer: Option<Vec<LayerSpec>>,
pub name: Option<String>,
pub projection: Option<Projection>,
pub resolve: Option<Resolve>,
pub title: Option<Title>,
pub transform: Option<Vec<Transform>>,
pub width: Option<f64>,
pub mark: Option<AnyMark>,
pub selection: Option<HashMap<String, SelectionDef>>,
pub align: Option<Align>,
pub bounds: Option<Bounds>,
pub center: Option<Center>,
pub facet: Option<FacetMapping>,
pub spacing: Option<Spacing>,
pub spec: Box<Option<SpecClass>>,
pub repeat: Option<Repeat>,
pub vconcat: Option<Vec<Spec>>,
pub hconcat: Option<Vec<Spec>>,
}
Expand description
Layer Spec with encoding and projection
Unit spec that can have a composite mark.
Fields§
§data: Option<Data>
An object describing the data source
description: Option<String>
Description of this mark for commenting purpose.
encoding: Option<SpecEncoding>
A shared key-value mapping between encoding channels and definition of fields in the underlying layers.
A key-value mapping between encoding channels and definition of fields.
height: Option<f64>
The height of a visualization.
Default value:
- If a view’s
autosize
type is"fit"
or its y-channel has a continuous scale, the height will be the value ofconfig.view.height
. - For y-axis with a band or point scale: if
rangeStep
is a numeric value or unspecified, the height is determined by the range step, paddings, and the cardinality of the field mapped to y-channel. Otherwise, if therangeStep
isnull
, the height will be the value ofconfig.view.height
. - If no field is mapped to
y
channel, theheight
will be the value ofrangeStep
.
Note: For plots with row
and column
channels, this represents the
height of a single view.
See also: The documentation for width and height contains more examples.
layer: Option<Vec<LayerSpec>>
Layer or single view specifications to be layered.
Note: Specifications inside layer
cannot use row
and column
channels as
layering facet specifications is not allowed.
name: Option<String>
Name of the visualization for later reference.
projection: Option<Projection>
An object defining properties of the geographic projection shared by underlying layers.
An object defining properties of geographic projection, which will be applied to shape
path for "geoshape"
marks
and to latitude
and "longitude"
channels for other marks.
resolve: Option<Resolve>
Scale, axis, and legend resolutions for layers.
Scale, axis, and legend resolutions for facets.
Scale and legend resolutions for repeated charts.
Scale, axis, and legend resolutions for vertically concatenated charts.
Scale, axis, and legend resolutions for horizontally concatenated charts.
title: Option<Title>
Title for the plot.
transform: Option<Vec<Transform>>
An array of data transformations such as filter and new field calculation.
width: Option<f64>
The width of a visualization.
Default value: This will be determined by the following rules:
- If a view’s
autosize
type is"fit"
or its x-channel has a continuous scale, the width will be the value ofconfig.view.width
. - For x-axis with a band or point scale: if
rangeStep
is a numeric value or unspecified, the width is determined by the range step, paddings, and the cardinality of the field mapped to x-channel. Otherwise, if therangeStep
isnull
, the width will be the value ofconfig.view.width
. - If no field is mapped to
x
channel, thewidth
will be the value ofconfig.scale.textXRangeStep
fortext
mark and the value ofrangeStep
for other marks.
Note: For plots with row
and column
channels, this represents the
width of a single view.
See also: The documentation for width and height contains more examples.
mark: Option<AnyMark>
A string describing the mark type (one of "bar"
, "circle"
, "square"
, "tick"
,
"line"
,
"area"
, "point"
, "rule"
, "geoshape"
, and "text"
) or a mark definition
object.
selection: Option<HashMap<String, SelectionDef>>
A key-value mapping between selection names and definitions.
align: Option<Align>
The alignment to apply to grid rows and columns.
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.
Alternatively, an object value of the form {"row": string, "column": string}
can be
used to supply different alignments for rows and columns.
Default value: "all"
.
bounds: Option<Bounds>
The bounds calculation method to use for determining the extent of a sub-plot. One of
full
(the default) or flush
.
- If set to
full
, the entire calculated bounds (including axes, title, and legend) will be used. - If set to
flush
, only the specified width and height values for the sub-view will be used. Theflush
setting can be useful when attempting to place sub-plots without axes or legends into a uniform grid structure.
Default value: "full"
center: Option<Center>
Boolean flag indicating if subviews should be centered relative to their respective rows or columns.
An object value of the form {"row": boolean, "column": boolean}
can be used to supply
different centering values for rows and columns.
Default value: false
Boolean flag indicating if subviews should be centered relative to their respective rows or columns.
Default value: false
facet: Option<FacetMapping>
An object that describes mappings between row
and column
channels and their field
definitions.
spacing: Option<Spacing>
The spacing in pixels between sub-views of the composition operator.
An object of the form {"row": number, "column": number}
can be used to set
different spacing values for rows and columns.
Default value: 10
The spacing in pixels between sub-views of the concat operator.
Default value: 10
spec: Box<Option<SpecClass>>
A specification of the view that gets faceted.
repeat: Option<Repeat>
An object that describes what fields should be repeated into views that are laid out as a
row
or column
.
vconcat: Option<Vec<Spec>>
A list of views that should be concatenated and put into a column.
hconcat: Option<Vec<Spec>>
A list of views that should be concatenated and put into a row.