Struct vega_lite_4::SortEncodingSortFieldBuilder

pub struct SortEncodingSortFieldBuilder { /* fields omitted */ }

Builder for SortEncodingSortField.

Methods

impl SortEncodingSortFieldBuilder

pub fn field<VALUE: Into<Field>>(&mut self, value: VALUE) -> &mut Self

The data field to sort by.

Default value: If unspecified, defaults to the field specified in the outer data reference.

pub fn op<VALUE: Into<NonArgAggregateOp>>(&mut self, value: VALUE) -> &mut Self

An aggregate operation to perform on the field prior to sorting (e.g., "count", "mean" and "median"). An aggregation is required when there are multiple values of the sort field for each encoded data field. The input data objects will be aggregated, grouped by the encoded data field.

For a full list of operations, please see the documentation for aggregate.

Default value: "sum" for stacked plots. Otherwise, "mean".

pub fn order<VALUE: Into<RemovableValue<SortOrder>>>(
    &mut self,
    value: VALUE
) -> &mut Self

The sort order. One of "ascending" (default), "descending", or null (no not sort).

pub fn build(&self) -> Result<SortEncodingSortField, String>

Builds a new SortEncodingSortField.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for SortEncodingSortFieldBuilder

fn clone(&self) -> SortEncodingSortFieldBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for SortEncodingSortFieldBuilder

fn default() -> SortEncodingSortFieldBuilder

Returns the "default value" for a type.