[−][src]Struct vega_lite_3::Y2ClassBuilder
Builder for Y2Class
.
Methods
impl Y2ClassBuilder
[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)
pub fn bin<VALUE: Into<Value>>(&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
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.
Note: 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.
Note: field
is not required if aggregate
is count
.
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)
pub fn title<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
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 value<VALUE: Into<YValue>>(&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<Y2Class, String>
[src]
Trait Implementations
impl Clone for Y2ClassBuilder
[src]
fn clone(&self) -> Y2ClassBuilder
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Default for Y2ClassBuilder
[src]
fn default() -> Y2ClassBuilder
[src]
Auto Trait Implementations
impl Send for Y2ClassBuilder
impl Sync for Y2ClassBuilder
Blanket Implementations
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> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for 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>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,