[−][src]Struct vega_lite_4::VegaliteBuilder
Builder for Vegalite
.
Implementations
impl VegaliteBuilder
[src]
pub fn schema<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
URL to JSON schema for a Vega-Lite specification. Unless you
have a reason to change this, use https://vega.github.io/schema/vega-lite/v4.json
.
Setting the $schema
property allows automatic validation and autocomplete in editors
that support JSON schema.
pub fn align<VALUE: Into<VegaliteAlign>>(&mut self, value: VALUE) -> &mut Self
[src]
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"
.
pub fn autosize<VALUE: Into<Autosize>>(&mut self, value: VALUE) -> &mut Self
[src]
How the visualization size should be determined. If a string, should be one of "pad"
,
"fit"
or "none"
. Object values can additionally specify parameters for content sizing
and automatic resizing.
Default value: pad
pub fn background<VALUE: Into<Color>>(&mut self, value: VALUE) -> &mut Self
[src]
CSS color property to use as the background of the entire view.
Default value: "white"
pub fn bounds<VALUE: Into<Bounds>>(&mut self, value: VALUE) -> &mut Self
[src]
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 toflush
, 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"
pub fn center<VALUE: Into<Center>>(&mut self, value: VALUE) -> &mut Self
[src]
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
pub fn config<VALUE: Into<Box<Config>>>(&mut self, value: VALUE) -> &mut Self
[src]
Vega-Lite configuration object. This property can only be defined at the top-level of a specification.
pub fn data<VALUE: Into<RemovableValue<UrlData>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
An object 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.
pub fn datasets<VALUE: Into<HashMap<String, InlineDatasetValue>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
A global data store for named datasets. This is a mapping from names to inline datasets.
This can be an array of objects or primitive values or a string. Arrays of primitive
values are ingested as objects with a data
property.
pub fn description<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
Description of this mark for commenting purpose.
pub fn encoding<VALUE: Into<Box<EdEncoding>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
A key-value mapping between encoding channels and definition of fields.
A shared key-value mapping between encoding channels and definition of fields in the underlying layers.
pub fn height<VALUE: Into<HeightUnion>>(&mut self, value: VALUE) -> &mut Self
[src]
The height of a visualization.
- For a plot with a continuous y-field, height should be a number. - For a plot with
either a discrete y-field or no y-field, height can be either a number indicating a fixed
height or an object in the form of
{step: number}
defining the height per discrete step. (No y-field is equivalent to having one discrete step.) - To enable responsive sizing on height, it should be set to"container"
.
Default value: Based on config.view.continuousHeight
for a plot with a continuous
y-field and config.view.discreteHeight
otherwise.
Note: For plots with row
and column
channels, this represents the
height of a single view and the "container"
option cannot be used.
See also: height
documentation.
pub fn mark<VALUE: Into<AnyMark>>(&mut self, value: VALUE) -> &mut Self
[src]
A string describing the mark type (one of "bar"
, "circle"
, "square"
, "tick"
,
"line"
, "area"
, "point"
, "rule"
, "geoshape"
, and "text"
) or a mark
definition object.
pub fn name<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
Name of the visualization for later reference.
pub fn padding<VALUE: Into<Padding>>(&mut self, value: VALUE) -> &mut Self
[src]
The default visualization padding, in pixels, from the edge of the visualization canvas
to the data rectangle. If a number, specifies padding for all sides. If an object, the
value should have the format {"left": 5, "top": 5, "right": 5, "bottom": 5}
to specify
padding for each side of the visualization.
Default value: 5
pub fn params<VALUE: Into<Vec<Parameter>>>(&mut self, value: VALUE) -> &mut Self
[src]
Dynamic variables that parameterize a visualization.
pub fn projection<VALUE: Into<Projection>>(&mut self, value: VALUE) -> &mut Self
[src]
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.
An object defining properties of the geographic projection shared by underlying layers.
pub fn resolve<VALUE: Into<Resolve>>(&mut self, value: VALUE) -> &mut Self
[src]
Scale, axis, and legend resolutions for view composition specifications.
pub fn selection<VALUE: Into<HashMap<String, SelectionDef>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
A key-value mapping between selection names and definitions.
pub fn spacing<VALUE: Into<Spacing>>(&mut self, value: VALUE) -> &mut Self
[src]
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: Depends on "spacing"
property of the view composition
configuration (20
by
default)
The spacing in pixels between sub-views of the concat operator.
Default value: 10
pub fn title<VALUE: Into<TitleUnion>>(&mut self, value: VALUE) -> &mut Self
[src]
Title for the plot.
pub fn transform<VALUE: Into<Vec<Transform>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
An array of data transformations such as filter and new field calculation.
pub fn usermeta<VALUE: Into<HashMap<String, Option<Value>>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
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.
pub fn view<VALUE: Into<ViewBackground>>(&mut self, value: VALUE) -> &mut Self
[src]
An object defining the view background's fill and stroke.
Default value: none (transparent)
pub fn width<VALUE: Into<HeightUnion>>(&mut self, value: VALUE) -> &mut Self
[src]
The width of a visualization.
- For a plot with a continuous x-field, width should be a number. - For a plot with
either a discrete x-field or no x-field, width can be either a number indicating a fixed
width or an object in the form of
{step: number}
defining the width per discrete step. (No x-field is equivalent to having one discrete step.) - To enable responsive sizing on width, it should be set to"container"
.
Default value: Based on config.view.continuousWidth
for a plot with a continuous
x-field and config.view.discreteWidth
otherwise.
Note: For plots with row
and column
channels, this represents the
width of a single view and the "container"
option cannot be used.
See also: width
documentation.
pub fn columns<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The number of columns to include in the view composition layout.
Default value: undefined
-- An infinite number of columns (a single row) will be
assumed. This is equivalent to hconcat
(for concat
) and to using the column
channel
(for facet
and repeat
).
Note:
-
This property is only for: - the general (wrappable)
concat
operator (nothconcat
/vconcat
) - thefacet
andrepeat
operator with one field/repetition definition (without row/column nesting) -
Setting the
columns
to1
is equivalent tovconcat
(forconcat
) and to using therow
channel (forfacet
andrepeat
).
pub fn facet<VALUE: Into<Facet>>(&mut self, value: VALUE) -> &mut Self
[src]
Definition for how to facet the data. One of: 1) a field definition for faceting the
plot by one field 2) An
object that maps row
and column
channels to their field
definitions
pub fn spec<VALUE: Into<Box<VegaliteSpec>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
A specification of the view that gets faceted.
A specification of the view that gets repeated.
pub fn layer<VALUE: Into<Vec<LayerElement>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
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. Instead, use the facet
operator and place a layer inside a
facet.
pub fn repeat<VALUE: Into<RepeatUnion>>(&mut self, value: VALUE) -> &mut Self
[src]
Definition for fields to be repeated. One of: 1) An array of fields to be repeated. If
"repeat"
is an array, the field can be referred to as {"repeat": "repeat"}
. The
repeated views are laid out in a wrapped row. You can set the number of columns to
control the wrapping. 2) An object that maps "row"
and/or "column"
to the listed
fields to be repeated along the particular orientations. The objects {"repeat": "row"}
and {"repeat": "column"}
can be used to refer to the repeated field respectively.
pub fn concat<VALUE: Into<Vec<NormalizedSpec>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
A list of views to be concatenated.
pub fn vconcat<VALUE: Into<Vec<NormalizedSpec>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
A list of views to be concatenated and put into a column.
pub fn hconcat<VALUE: Into<Vec<NormalizedSpec>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
A list of views to be concatenated and put into a row.
pub fn build(&self) -> Result<Vegalite, String>
[src]
Trait Implementations
impl Clone for VegaliteBuilder
[src]
pub fn clone(&self) -> VegaliteBuilder
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Default for VegaliteBuilder
[src]
pub fn default() -> VegaliteBuilder
[src]
Auto Trait Implementations
impl RefUnwindSafe for VegaliteBuilder
[src]
impl Send for VegaliteBuilder
[src]
impl Sync for VegaliteBuilder
[src]
impl Unpin for VegaliteBuilder
[src]
impl UnwindSafe for VegaliteBuilder
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,