[−][src]Struct vega_lite_3::XClassBuilder
Builder for XClass
.
Methods
impl XClassBuilder
[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 axis<VALUE: Into<RemovableValue<Axis>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
An object defining properties of axis's gridlines, ticks and labels.
If null
, the axis for the encoding channel will be removed.
Default value: If undefined, default axis properties are applied.
See also: axis
documentation.
pub fn bin<VALUE: Into<FluffyBin>>(&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 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:
- 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. field
is not required ifaggregate
iscount
.
pub fn impute<VALUE: Into<ImputeParams>>(&mut self, value: VALUE) -> &mut Self
[src]
An object defining the properties of the Impute Operation to be applied.
The field value of the other positional channel is taken as key
of the Impute
Operation.
The field of the color
channel if specified is used as groupby
of the Impute
Operation.
See also: impute
documentation.
pub fn scale<VALUE: Into<RemovableValue<Scale>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels.
If null
, the scale will be disabled and the data value will be directly
encoded.
Default value: If undefined, default scale properties are applied.
See also: scale
documentation.
pub fn sort<VALUE: Into<RemovableValue<Sort>>>(
&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-by-encoding
definition for sorting
by another encoding channel. (This type of sort definition is not available for
row
andcolumn
channels.) - 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
.
See also: sort
documentation.
pub fn stack<VALUE: Into<Stack>>(&mut self, value: VALUE) -> &mut Self
[src]
Type of stacking offset if the field should be stacked.
stack
is only applicable for x
and y
channels with continuous domains.
For example, stack
of y
can be used to customize stacking for a vertical bar chart.
stack
can be one of the following values:
"zero"
ortrue
: stacking with baseline offset at zero value of the scale (for creating typical stacked bar and area chart)."normalize"
- stacking with normalized domain (for creating normalized stacked bar and area charts.
-"center"
- stacking with center baseline (for streamgraph).null
orfalse
- No-stacking. This will produce layered bar and area chart.
Default value: zero
for plots with all of the following conditions are true:
(1) the mark is bar
or area
;
(2) the stacked measure channel (x or y) has a linear scale;
(3) At least one of non-position channels mapped to an unaggregated field that is
different from x and y. Otherwise, null
by default.
See also: stack
documentation.
pub fn time_unit<VALUE: Into<TimeUnit>>(&mut self, value: VALUE) -> &mut Self
[src]
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<String>>>(
&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 def_type<VALUE: Into<StandardType>>(&mut self, value: VALUE) -> &mut Self
[src]
The encoded field's type of measurement ("quantitative"
, "temporal"
, "ordinal"
, or
"nominal"
).
It can also be a "geojson"
type for encoding
'geoshape'.
Note:
- 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
). - 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. - When using with
bin
, thetype
property can be either"quantitative"
(for using a linear bin scale) or"ordinal"
(for using an ordinal bin scale). - When using with
timeUnit
, thetype
property can be either"temporal"
(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", "type": "quantitative"}
. The"type"
of the aggregate output is"quantitative"
. - Secondary channels (e.g.,
x2
,y2
,xError
,yError
) do not havetype
as they have exactly the same type as their primary channels (e.g.,x
,y
).
See also: type
documentation.
pub fn value<VALUE: Into<XUnion>>(&mut self, value: VALUE) -> &mut Self
[src]
A constant value in visual domain (e.g., "red"
/ "#0099ff" for color, values between
0
to 1
for opacity).
pub fn build(&self) -> Result<XClass, String>
[src]
Trait Implementations
impl Clone for XClassBuilder
[src]
fn clone(&self) -> XClassBuilder
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Default for XClassBuilder
[src]
fn default() -> XClassBuilder
[src]
Auto Trait Implementations
impl RefUnwindSafe for XClassBuilder
impl Send for XClassBuilder
impl Sync for XClassBuilder
impl Unpin for XClassBuilder
impl UnwindSafe for XClassBuilder
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,
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.
fn to_owned(&self) -> T
[src]
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.
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>,