[−][src]Struct vega_lite_3::Config
Vega-Lite configuration object. This property can only be defined at the top-level of a specification.
Fields
area: Option<AreaConfig>
Area-Specific Config
autosize: Option<Autosize>
Sets 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.
"fit"
is only supported for single and layered views that don't use rangeStep
.
Default value: pad
axis: Option<AxisConfig>
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.
axis_band: Option<AxisConfig>
Specific axis config for axes with "band" scales.
axis_bottom: Option<AxisConfig>
Specific axis config for x-axis along the bottom edge of the chart.
axis_left: Option<AxisConfig>
Specific axis config for y-axis along the left edge of the chart.
axis_right: Option<AxisConfig>
Specific axis config for y-axis along the right edge of the chart.
axis_top: Option<AxisConfig>
Specific axis config for x-axis along the top edge of the chart.
axis_x: Option<AxisConfig>
X-axis specific config.
axis_y: Option<AxisConfig>
Y-axis specific config.
background: Option<String>
CSS color property to use as the background of the whole Vega-Lite view
Default value: none (transparent)
bar: Option<RectConfig>
Bar-Specific Config
boxplot: Option<BoxPlotConfig>
Box Config
circle: Option<MarkConfig>
Circle-Specific Config
concat: Option<CompositionConfig>
Default configuration for all concatenation view composition operators (concat
,
hconcat
, and vconcat
)
count_title: Option<String>
Default axis and legend title for count fields.
Default value: 'Count of Records
.
errorband: Option<ErrorBandConfig>
ErrorBand Config
errorbar: Option<ErrorBarConfig>
ErrorBar Config
facet: Option<CompositionConfig>
Default configuration for the facet
view composition operator
field_title: Option<FieldTitle>
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").
geoshape: Option<MarkConfig>
Geoshape-Specific Config
header: Option<HeaderConfig>
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.
header_column: Option<HeaderConfig>
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.
header_facet: Option<HeaderConfig>
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.
header_row: Option<HeaderConfig>
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.
invalid_values: RemovableValue<InvalidValues>
Defines how Vega-Lite should handle invalid values (null
and NaN
).
- If set to
"filter"
(default), all data items with null values will be skipped (for line, trail, and area marks) or filtered (for other marks). - If
null
, all data items are included. In this case, invalid values will be interpreted as zeroes.
legend: Option<LegendConfig>
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.
line: Option<LineConfig>
Line-Specific Config
mark: Option<MarkConfig>
Mark Config
number_format: Option<String>
D3 Number format for guide labels and text marks. For example "s" for SI units. Use D3's number format pattern.
padding: Option<Padding>
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
point: Option<MarkConfig>
Point-Specific Config
projection: Option<Projection>
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.
range: Option<HashMap<String, RangeValue>>
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.
rect: Option<RectConfig>
Rect-Specific Config
repeat: Option<CompositionConfig>
Default configuration for the repeat
view composition operator
rule: Option<MarkConfig>
Rule-Specific Config
scale: Option<ScaleConfig>
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.
selection: Option<SelectionConfig>
An object hash for defining default properties for each type of selections.
square: Option<MarkConfig>
Square-Specific Config
stack: Option<StackOffset>
Default stack offset for stackable mark.
style: Option<HashMap<String, BaseMarkConfig>>
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.
text: Option<TextConfig>
Text-Specific Config
tick: Option<TickConfig>
Tick-Specific Config
time_format: Option<String>
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 format each label automatically so this config
would not affect axes.
title: Option<BaseTitleConfig>
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.
trail: Option<LineConfig>
Trail-Specific Config
view: Option<ViewConfig>
Default properties for single view plots.
Trait Implementations
impl Clone for Config
[src]
impl Debug for Config
[src]
impl Default for Config
[src]
impl<'de> Deserialize<'de> for Config
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Serialize for Config
[src]
Auto Trait Implementations
impl RefUnwindSafe for Config
impl Send for Config
impl Sync for Config
impl Unpin for Config
impl UnwindSafe for Config
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> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
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>,