Struct vega_lite_4::BinParams
source · pub struct BinParams {
pub anchor: Option<f64>,
pub base: Option<f64>,
pub binned: Option<bool>,
pub divide: Option<Vec<f64>>,
pub extent: Option<BinExtent>,
pub maxbins: Option<f64>,
pub minstep: Option<f64>,
pub nice: Option<bool>,
pub step: Option<f64>,
pub steps: Option<Vec<f64>>,
}
Expand description
Binning properties or boolean flag for determining whether to bin data or not.
Fields§
§anchor: Option<f64>
A value in the binned domain at which to anchor the bins, shifting the bin boundaries if necessary to ensure that a boundary aligns with the anchor value.
Default value: the minimum bin extent value
base: Option<f64>
The number base to use for automatic bin determination (default is base 10).
Default value: 10
binned: Option<bool>
When set to true
, Vega-Lite treats the input data as already binned.
divide: Option<Vec<f64>>
Scale factors indicating allowable subdivisions. The default value is [5, 2], which indicates that for base 10 numbers (the default base), the method may consider dividing bin sizes by 5 and/or 2. For example, for an initial step size of 10, the method can check if bin sizes of 2 (= 10/5), 5 (= 10/2), or 1 (= 10/(5*2)) might also satisfy the given constraints.
Default value: [5, 2]
extent: Option<BinExtent>
A two-element ([min, max]
) array indicating the range of desired bin values.
maxbins: Option<f64>
Maximum number of bins.
Default value: 6
for row
, column
and shape
channels; 10
for other channels
minstep: Option<f64>
A minimum allowable step size (particularly useful for integer values).
nice: Option<bool>
If true, attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.
Default value: true
step: Option<f64>
An exact step size to use between bins.
Note: If provided, options such as maxbins will be ignored.
steps: Option<Vec<f64>>
An array of allowable step sizes to choose from.