Struct vega_lite_4::ConfigBuilder

pub struct ConfigBuilder { /* private fields */ }

Builder for Config.

Implementations

impl ConfigBuilder

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

Arc-specific Config

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

Area-Specific Config

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

A boolean flag indicating if ARIA default attributes should be included for marks and guides (SVG output only). If false, the "aria-hidden" attribute will be set for all guides, removing them from the ARIA accessibility tree and Vega-Lite will not generate default descriptions for marks.

Default value: true.

pub fn autosize<VALUE: Into<Box<Autosize>>>( &mut self, value: VALUE ) -> &mut Self

How the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing.

Default value: pad

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

Axis configuration, which determines default properties for all x and y axes. For a full list of axis configuration options, please see the corresponding section of the axis documentation.

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

Config for axes with “band” scales.

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

Config for x-axis along the bottom edge of the chart.

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

Config for axes with “point” or “band” scales.

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

Config for y-axis along the left edge of the chart.

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

Config for axes with “point” scales.

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

Config for quantitative axes.

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

Config for y-axis along the right edge of the chart.

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

Config for temporal axes.

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

Config for x-axis along the top edge of the chart.

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

X-axis specific config.

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

Config for x-axes with “band” scales.

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

Config for x-axes with “point” or “band” scales.

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

Config for x-axes with “point” scales.

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

Config for x-quantitative axes.

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

Config for x-temporal axes.

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

Y-axis specific config.

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

Config for y-axes with “band” scales.

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

Config for y-axes with “point” or “band” scales.

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

Config for y-axes with “point” scales.

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

Config for y-quantitative axes.

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

Config for y-temporal axes.

pub fn background<VALUE: Into<Box<Color>>>(&mut self, value: VALUE) -> &mut Self

CSS color property to use as the background of the entire view.

Default value: "white"

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

Bar-Specific Config

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

Box Config

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

Circle-Specific Config

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

Default configuration for all concatenation and repeat view composition operators (concat, hconcat, vconcat, and repeat)

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

Default axis and legend title for count fields.

Default value: 'Count of Records.

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

Allow the formatType property for text marks and guides to accept a custom formatter function registered as a Vega expression.

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

ErrorBand Config

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

ErrorBar Config

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

Default configuration for the facet view composition operator

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

Defines how Vega-Lite generates title for fields. There are three possible styles: - "verbal" (Default) - displays function in a verbal style (e.g., “Sum of field”, “Year-month of date”, “field (binned)”). - "function" - displays function using parentheses and capitalized texts (e.g., “SUM(field)”, “YEARMONTH(date)”, “BIN(field)”).

• "plain" - displays only the field name without functions (e.g., “field”, “date”, “field”).

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

Default font for all text marks, titles, and labels.

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

Geoshape-Specific Config

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

Header configuration, which determines default properties for all headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

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

Header configuration, which determines default properties for column headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

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

Header configuration, which determines default properties for non-row/column facet headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

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

Header configuration, which determines default properties for row headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

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

Image-specific Config

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

Legend configuration, which determines default properties for all legends. For a full list of legend configuration options, please see the corresponding section of in the legend documentation.

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

Line-Specific Config

pub fn line_break<VALUE: Into<Box<Color>>>(&mut self, value: VALUE) -> &mut Self

A delimiter, such as a newline character, upon which to break text strings into multiple lines. This property provides a global default for text marks, which is overridden by mark or style config settings, and by the lineBreak mark encoding channel. If signal-valued, either string or regular expression (regexp) values are valid.

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

Mark Config

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

D3 Number format for guide labels and text marks. For example "s" for SI units. Use D3’s number format pattern.

pub fn padding<VALUE: Into<Box<Padding>>>(&mut self, value: VALUE) -> &mut Self

The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides. If an object, the value should have the format {"left": 5, "top": 5, "right": 5, "bottom": 5} to specify padding for each side of the visualization.

Default value: 5

pub fn params<VALUE: Into<Vec<Parameter>>>(&mut self, value: VALUE) -> &mut Self

Dynamic variables that parameterize a visualization.

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

Point-Specific Config

pub fn projection<VALUE: Into<Box<Projection>>>( &mut self, value: VALUE ) -> &mut Self

Projection configuration, which determines default properties for all projections. For a full list of projection configuration options, please see the corresponding section of the projection documentation.

pub fn range<VALUE: Into<HashMap<String, RangeValue>>>( &mut self, value: VALUE ) -> &mut Self

An object hash that defines default range arrays or schemes for using with scales. For a full list of scale range configuration options, please see the corresponding section of the scale documentation.

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

Rect-Specific Config

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

Rule-Specific Config

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

Scale configuration determines default properties for all scales. For a full list of scale configuration options, please see the corresponding section of the scale documentation.

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

An object hash for defining default properties for each type of selections.

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

Square-Specific Config

pub fn style<VALUE: Into<HashMap<String, StyleValue>>>( &mut self, value: VALUE ) -> &mut Self

An object hash that defines key-value mappings to determine default properties for marks with a given style. The keys represent styles names; the values have to be valid mark configuration objects.

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

Text-Specific Config

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

Tick-Specific Config

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

Default time format for raw time values (without time units) in text marks, legend labels and header labels.

Default value: "%b %d, %Y" Note: Axes automatically determine the format for each label automatically so this config does not affect axes.

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

Title configuration, which determines default properties for all titles. For a full list of title configuration options, please see the corresponding section of the title documentation.

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

Trail-Specific Config

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

Default properties for single view plots.

pub fn build(&self) -> Result<Config, ConfigBuilderError>

Builds a new Config.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ConfigBuilder

fn clone(&self) -> ConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ConfigBuilder

fn default() -> Self

Returns the “default value” for a type.