Struct vega_lite_4::XErrorClass
source · pub struct XErrorClass {
pub aggregate: Option<Aggregate>,
pub band: Option<f64>,
pub bin: Option<Value>,
pub field: Option<Field>,
pub time_unit: Option<TimeUnitUnion>,
pub title: RemovableValue<LegendText>,
pub value: Option<f64>,
}
Expand description
Error value of x coordinates for error specified "errorbar"
and "errorband"
.
Secondary error value of x coordinates for error specified "errorbar"
and
"errorband"
.
Error value of y coordinates for error specified "errorbar"
and "errorband"
.
Secondary error value of y coordinates for error specified "errorbar"
and
"errorband"
.
A field definition of a secondary channel that shares a scale with another primary
channel. For example, x2
, xError
and xError2
share the same scale with x
.
Definition object for a constant value (primitive value or gradient definition) of an encoding channel.
Fields§
§aggregate: Option<Aggregate>
Aggregation function for the field (e.g., "mean"
, "sum"
, "median"
, "min"
,
"max"
, "count"
).
Default value: undefined
(None)
See also: aggregate
documentation.
band: Option<f64>
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.
bin: Option<Value>
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.
field: Option<Field>
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
.
time_unit: Option<TimeUnitUnion>
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.
title: RemovableValue<LegendText>
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.
value: Option<f64>
A constant value in visual domain (e.g., "red"
/ "#0099ff"
/ gradient
definition for color, values
between 0
to 1
for opacity).
Trait Implementations§
source§impl Clone for XErrorClass
impl Clone for XErrorClass
source§fn clone(&self) -> XErrorClass
fn clone(&self) -> XErrorClass
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more