[−][src]Struct vega_lite_4::FacetEncodingFieldDefBuilder
Builder for FacetEncodingFieldDef
.
Implementations
impl FacetEncodingFieldDefBuilder
[src]
pub fn aggregate<VALUE: Into<Aggregate>>(&mut self, value: VALUE) -> &mut Self
[src]
Aggregation function for the field (e.g., "mean"
, "sum"
, "median"
, "min"
,
"max"
, "count"
).
Default value: undefined
(None)
See also: aggregate
documentation.
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 band<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
For rect-based marks (rect
, bar
, and image
), mark size relative to bandwidth of
band scales, bins or time units.
If set to 1
, the mark size is set to the bandwidth, the bin interval, or the time unit
interval. If set to 0.5
, the mark size is half of the bandwidth or the time unit
interval.
For other marks, relative position on a band of a stacked, binned, time unit or band
scale. If set to 0
, the marks will be positioned at the beginning of the band. If set
to 0.5
, the marks will be positioned in the middle of the band.
pub fn bin<VALUE: Into<AngleBin>>(&mut self, value: VALUE) -> &mut Self
[src]
A flag for binning a quantitative
field, an object defining binning
parameters, or indicating that
the data for x
or y
channel are binned before they are imported into Vega-Lite
("binned"
).
-
If
true
, default binning parameters will be applied. -
If
"binned"
, this indicates that the data for thex
(ory
) channel are already binned. You can map the bin-start field tox
(ory
) and the bin-end field tox2
(ory2
). The scale and axis will be formatted similar to binning in Vega-Lite. To adjust the axis ticks based on the bin step, you can also set the axis'stickMinStep
property.
Default value: false
See also: bin
documentation.
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
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 field<VALUE: Into<Field>>(&mut self, value: VALUE) -> &mut Self
[src]
Required. 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.
See also: field
documentation.
Notes: 1) Dots (.
) and brackets ([
and ]
) can be used to access nested objects
(e.g., "field": "foo.bar"
and "field": "foo['bar']"
). If field names contain dots or
brackets but are not nested, you can use \\
to escape dots and brackets (e.g.,
"a\\.b"
and "a\\[0\\]"
). See more details about escaping in the field
documentation. 2) field
is not
required if aggregate
is count
.
pub fn header<VALUE: Into<Header>>(&mut self, value: VALUE) -> &mut Self
[src]
An object defining properties of a facet's header.
pub fn sort<VALUE: Into<RemovableValue<PurpleSortArray>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
Sort order for the encoded field.
For continuous fields (quantitative or temporal), sort
can be either "ascending"
or
"descending"
.
For discrete fields, sort
can be one of the following: - "ascending"
or
"descending"
-- for sorting by the values' natural order in JavaScript. - A sort field
definition for sorting by
another field. - An array specifying the field values in preferred
order. In this case, the
sort order will obey the values in the array, followed by any unspecified values in their
original order. For discrete time field, values in the sort array can be date-time
definition objects. In addition, for time units "month"
and "day"
,
the values can be the month or day names (case insensitive) or their 3-letter initials
(e.g., "Mon"
, "Tue"
). - null
indicating no sort.
Default value: "ascending"
Note: null
is not supported for row
and column
.
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)
pub fn time_unit<VALUE: Into<TimeUnitUnion>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
Time unit (e.g., year
, yearmonth
, month
, hours
) for a temporal field. or a
temporal field that gets casted as
ordinal.
Default value: undefined
(None)
See also: timeUnit
documentation.
pub fn title<VALUE: Into<RemovableValue<LegendText>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
A title for the field. If null
, the title will be removed.
Default value: derived from the field's name and transformation function
(aggregate
, bin
and timeUnit
). If the field has an aggregate function, the function
is displayed as part of the title (e.g., "Sum of Profit"
). If the field is binned or
has a time unit applied, the applied function is shown in parentheses (e.g., "Profit (binned)"
, "Transaction Date (year-month)"
). Otherwise, the title is simply the field
name.
Notes:
-
You can customize the default field title format by providing the
fieldTitle
property in the config orfieldTitle
function via thecompile
function's options. -
If both field definition's
title
and axis, header, or legendtitle
are defined, axis/header/legend title will be used.
pub fn facet_encoding_field_def_type<VALUE: Into<StandardType>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
The type of measurement ("quantitative"
, "temporal"
, "ordinal"
, or "nominal"
) for
the encoded field or constant value (datum
). It can also be a "geojson"
type for
encoding 'geoshape'.
Vega-Lite automatically infers data types in many cases as discussed below. However, type
is required for a field if: (1) the field is not nominal and the field encoding has no
specified aggregate
(except argmin
and argmax
), bin
, scale type, custom sort
order, nor timeUnit
or (2) if you wish to use an ordinal scale for a field with bin
or timeUnit
.
Default value:
-
For a data
field
,"nominal"
is the default data type unless the field encoding hasaggregate
,channel
,bin
, scale type,sort
, ortimeUnit
that satisfies the following criteria: -"quantitative"
is the default type if (1) the encoded field containsbin
oraggregate
except"argmin"
and"argmax"
, (2) the encoding channel islatitude
orlongitude
channel or (3) if the specified scale type is a quantitative scale. -"temporal"
is the default type if (1) the encoded field containstimeUnit
or (2) the specified scale type is a time or utc scale -ordinal""
is the default type if (1) the encoded field contains a customsort
order, (2) the specified scale type is an ordinal/point/band scale, or (3) the encoding channel isorder
. -
For a constant value in data domain (
datum
): -"quantitative"
if the datum is a number -"nominal"
if the datum is a string -"temporal"
if the datum is a date time object
Note: - Data type
describes the semantics of the data rather than the primitive
data types (number, string, etc.). The same primitive data type can have different types
of measurement. For example, numeric data can represent quantitative, ordinal, or nominal
data. - Data values for a temporal field can be either a date-time string (e.g.,
"2015-03-07 12:32:17"
, "17:01"
, "2015-03-16"
. "2015"
) or a timestamp number
(e.g., 1552199579097
). - When using with
bin
, the type
property can be
either "quantitative"
(for using a linear bin scale) or "ordinal"
(for using an
ordinal bin scale). - When
using with timeUnit
, the type
property can be either "temporal"
(default, for using a temporal scale) or "ordinal"
(for using an ordinal scale).
- When using with
aggregate
, thetype
property refers to the post-aggregation data type. For example, we can calculate countdistinct
of a categorical field"cat"
using{"aggregate": "distinct", "field": "cat"}
. The"type"
of the aggregate output is"quantitative"
. - Secondary channels (e.g.,x2
,y2
,xError
,yError
) do not havetype
as they must have exactly the same type as their primary channels (e.g.,x
,y
).
See also: type
documentation.
pub fn build(&self) -> Result<FacetEncodingFieldDef, String>
[src]
Trait Implementations
impl Clone for FacetEncodingFieldDefBuilder
[src]
pub fn clone(&self) -> FacetEncodingFieldDefBuilder
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Default for FacetEncodingFieldDefBuilder
[src]
pub fn default() -> FacetEncodingFieldDefBuilder
[src]
Auto Trait Implementations
impl RefUnwindSafe for FacetEncodingFieldDefBuilder
[src]
impl Send for FacetEncodingFieldDefBuilder
[src]
impl Sync for FacetEncodingFieldDefBuilder
[src]
impl Unpin for FacetEncodingFieldDefBuilder
[src]
impl UnwindSafe for FacetEncodingFieldDefBuilder
[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>,