[−][src]Struct vega_lite_3::TextFieldDefBuilder
Builder for TextFieldDef
.
Methods
impl TextFieldDefBuilder
[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 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 format<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
The text formatting pattern for labels of guides (axes, legends, headers) and text marks.
- If the format type is
"number"
(e.g., for quantitative fields), this is D3's number format pattern. - If the format type is
"time"
(e.g., for temporal fields), this is D3's time format pattern.
See the format documentation for more examples.
Default value: Derived from numberFormat config for number format and from timeFormat config for time format.
pub fn format_type<VALUE: Into<FormatType>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
The format type for labels ("number"
or "time"
).
Default value:
"time"
for temporal fields and ordinal and nomimal fields withtimeUnit
."number"
for quantitative fields as well as ordinal and nomimal fields withouttimeUnit
.
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 text_field_def_type<VALUE: Into<StandardType>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
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 build(&self) -> Result<TextFieldDef, String>
[src]
Trait Implementations
impl Clone for TextFieldDefBuilder
[src]
fn clone(&self) -> TextFieldDefBuilder
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Default for TextFieldDefBuilder
[src]
fn default() -> TextFieldDefBuilder
[src]
Auto Trait Implementations
impl RefUnwindSafe for TextFieldDefBuilder
impl Send for TextFieldDefBuilder
impl Sync for TextFieldDefBuilder
impl Unpin for TextFieldDefBuilder
impl UnwindSafe for TextFieldDefBuilder
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>,