Struct vega_lite_4::KeyClassBuilder
source · pub struct KeyClassBuilder { /* private fields */ }
Expand description
Builder for KeyClass
.
Implementations§
source§impl KeyClassBuilder
impl KeyClassBuilder
sourcepub fn aggregate<VALUE: Into<Aggregate>>(&mut self, value: VALUE) -> &mut Self
pub fn aggregate<VALUE: Into<Aggregate>>(&mut self, value: VALUE) -> &mut Self
Aggregation function for the field (e.g., "mean"
, "sum"
, "median"
, "min"
,
"max"
, "count"
).
Default value: undefined
(None)
See also: aggregate
documentation.
sourcepub fn band<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
pub fn band<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
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.
sourcepub fn bin<VALUE: Into<DescriptionBin>>(&mut self, value: VALUE) -> &mut Self
pub fn bin<VALUE: Into<DescriptionBin>>(&mut self, value: VALUE) -> &mut Self
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.
sourcepub fn field<VALUE: Into<Field>>(&mut self, value: VALUE) -> &mut Self
pub fn field<VALUE: Into<Field>>(&mut self, value: VALUE) -> &mut Self
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
.
sourcepub fn time_unit<VALUE: Into<TimeUnitUnion>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn time_unit<VALUE: Into<TimeUnitUnion>>( &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.
sourcepub fn title<VALUE: Into<RemovableValue<LegendText>>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn title<VALUE: Into<RemovableValue<LegendText>>>( &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.
sourcepub fn typed_field_def_type<VALUE: Into<StandardType>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn typed_field_def_type<VALUE: Into<StandardType>>( &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.
Trait Implementations§
source§impl Clone for KeyClassBuilder
impl Clone for KeyClassBuilder
source§fn clone(&self) -> KeyClassBuilder
fn clone(&self) -> KeyClassBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more