[][src]Crate vega_lite_4

This crate provides a thin wrapper over Vega-Lite v4, as well as a few helpers to help ingest data from various sources and builders to help build graphs. See examples for more help on how to use it.

Documentation Disclaimer

Most of this crate has been generated from the json schema of Vega-Lite, so is the documentation on Vega-Lite types. A lot of struct are documented as accepting a string but are actually not. See FontWeight for an example. Those are usually converted to an enum, or may have a String variant wrapping the actual string (for example, Month). In those cases, From<String> is implemented for the enum, and will automatically wrap the string in the correct variant.

Structs

AggregatedFieldDef
AggregatedFieldDefBuilder

Builder for AggregatedFieldDef.

AmbitiousExprRef
AmbitiousExprRefBuilder

Builder for AmbitiousExprRef.

AngleClass

Rotation angle of point and text marks.

AngleClassBuilder

Builder for AngleClass.

AreaConfig

Area-Specific Config

AreaConfigBuilder

Builder for AreaConfig.

ArgmDef
ArgmDefBuilder

Builder for ArgmDef.

AutoSizeParams
AutoSizeParamsBuilder

Builder for AutoSizeParams.

Axis
AxisBuilder

Builder for Axis.

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.

AxisConfigBuilder

Builder for AxisConfig.

AxisResolveMap
AxisResolveMapBuilder

Builder for AxisResolveMap.

BackgroundExprRef
BackgroundExprRefBuilder

Builder for BackgroundExprRef.

BarConfig

Bar-Specific Config

BarConfigBuilder

Builder for BarConfig.

BaseTitleNoValueRefs

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.

BaseTitleNoValueRefsBuilder

Builder for BaseTitleNoValueRefs.

BinExtentClass
BinExtentClassBuilder

Builder for BinExtentClass.

BinParams

Binning properties or boolean flag for determining whether to bin data or not.

BinParamsBuilder

Builder for BinParams.

Binding

Binds the parameter to an external input element such as a slider, selection list or radio button group.

BindingBuilder

Builder for Binding.

BoxPlotConfig

Box Config

BoxPlotConfigBuilder

Builder for BoxPlotConfig.

BrushConfig

An interval selection also adds a rectangle mark to depict the extents of the interval. The mark property can be used to customize the appearance of the mark.

BrushConfigBuilder

Builder for BrushConfig.

ClearDerivedStream
ClearDerivedStreamBuilder

Builder for ClearDerivedStream.

ColorClass

Color of the marks – either fill or stroke color based on the filled property of mark definition. By default, color represents fill color for "area", "bar", "tick", "text", "trail", "circle", and "square" / stroke color for "line" and "point".

ColorClassBuilder

Builder for ColorClass.

CompositionConfig

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

CompositionConfigBuilder

Builder for CompositionConfig.

ConditionClass
ConditionClassBuilder

Builder for ConditionClass.

ConditionCondition
ConditionConditionBuilder

Builder for ConditionCondition.

ConditionConditionClass
ConditionConditionClassBuilder

Builder for ConditionConditionClass.

Conditional
ConditionalBuilder

Builder for Conditional.

ConditionalPredicateValueDefAlignNullExprRef
ConditionalPredicateValueDefAlignNullExprRefBuilder

Builder for ConditionalPredicateValueDefAlignNullExprRef.

ConditionalPredicateValueDefColorNullExprRef
ConditionalPredicateValueDefColorNullExprRefBuilder

Builder for ConditionalPredicateValueDefColorNullExprRef.

ConditionalPredicateValueDefFontStyleNullExprRef
ConditionalPredicateValueDefFontStyleNullExprRefBuilder

Builder for ConditionalPredicateValueDefFontStyleNullExprRef.

ConditionalPredicateValueDefFontWeightNullExprRef
ConditionalPredicateValueDefFontWeightNullExprRefBuilder

Builder for ConditionalPredicateValueDefFontWeightNullExprRef.

ConditionalPredicateValueDefGradientStringNullExprRefClass
ConditionalPredicateValueDefGradientStringNullExprRefClassBuilder

Builder for ConditionalPredicateValueDefGradientStringNullExprRefClass.

ConditionalPredicateValueDefNumberClass
ConditionalPredicateValueDefNumberClassBuilder

Builder for ConditionalPredicateValueDefNumberClass.

ConditionalPredicateValueDefNumberExprRefClass
ConditionalPredicateValueDefNumberExprRefClassBuilder

Builder for ConditionalPredicateValueDefNumberExprRefClass.

ConditionalPredicateValueDefNumberNullExprRef
ConditionalPredicateValueDefNumberNullExprRefBuilder

Builder for ConditionalPredicateValueDefNumberNullExprRef.

ConditionalPredicateValueDefNumberNullExprRefElement
ConditionalPredicateValueDefNumberNullExprRefElementBuilder

Builder for ConditionalPredicateValueDefNumberNullExprRefElement.

ConditionalPredicateValueDefStringNullExprRef
ConditionalPredicateValueDefStringNullExprRefBuilder

Builder for ConditionalPredicateValueDefStringNullExprRef.

ConditionalPredicateValueDefStringNullExprRefClass
ConditionalPredicateValueDefStringNullExprRefClassBuilder

Builder for ConditionalPredicateValueDefStringNullExprRefClass.

ConditionalPredicateValueDefTextBaselineNullExprRef
ConditionalPredicateValueDefTextBaselineNullExprRefBuilder

Builder for ConditionalPredicateValueDefTextBaselineNullExprRef.

ConditionalSelectionValueDefNumberExprRefClass
ConditionalSelectionValueDefNumberExprRefClassBuilder

Builder for ConditionalSelectionValueDefNumberExprRefClass.

ConditionalValueDefGradientStringNullExprRef
ConditionalValueDefGradientStringNullExprRefBuilder

Builder for ConditionalValueDefGradientStringNullExprRef.

ConditionalValueDefNumber
ConditionalValueDefNumberBuilder

Builder for ConditionalValueDefNumber.

ConditionalValueDefNumberExprRef
ConditionalValueDefNumberExprRefBuilder

Builder for ConditionalValueDefNumberExprRef.

ConditionalValueDefNumberExprRefElement
ConditionalValueDefNumberExprRefElementBuilder

Builder for ConditionalValueDefNumberExprRefElement.

ConditionalValueDefStringNullExprRef
ConditionalValueDefStringNullExprRefBuilder

Builder for ConditionalValueDefStringNullExprRef.

ConditionalValueDefTextExprRef
ConditionalValueDefTextExprRefBuilder

Builder for ConditionalValueDefTextExprRef.

Config

Vega-Lite configuration object. This property can only be defined at the top-level of a specification.

ConfigBuilder

Builder for Config.

CunningExprRef
CunningExprRefBuilder

Builder for CunningExprRef.

Data

Secondary data source to lookup in.

DataBuilder

Builder for Data.

DataFormat

An object that specifies the format for parsing the data.

DataFormatBuilder

Builder for DataFormat.

DateTime

Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided, month has higher precedence. day cannot be combined with other date. We accept string for month and day names.

DateTimeBuilder

Builder for DateTime.

Def
DefBuilder

Builder for Def.

DescriptionClass

A text description of this mark for ARIA accessibility (SVG output only). For SVG output the "aria-label" attribute will be set to this description.

DescriptionClassBuilder

Builder for DescriptionClass.

DiscreteHeightClass
DiscreteHeightClassBuilder

Builder for DiscreteHeightClass.

DiscreteWidthClass
DiscreteWidthClassBuilder

Builder for DiscreteWidthClass.

DomainDateTime

Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided, month has higher precedence. day cannot be combined with other date. We accept string for month and day names.

DomainDateTimeBuilder

Builder for DomainDateTime.

DomainMaxDateTime

Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided, month has higher precedence. day cannot be combined with other date. We accept string for month and day names.

DomainMaxDateTimeBuilder

Builder for DomainMaxDateTime.

DomainUnionWith
DomainUnionWithBuilder

Builder for DomainUnionWith.

EdEncoding

A key-value mapping between encoding channels and definition of fields.

EdEncodingBuilder

Builder for EdEncoding.

EncodingSortField

A sort definition for sorting a discrete scale in an encoding field definition.

EncodingSortFieldBuilder

Builder for EncodingSortField.

EncodingSortFieldFieldName

A sort definition for sorting a discrete scale in an encoding field definition.

EncodingSortFieldFieldNameBuilder

Builder for EncodingSortFieldFieldName.

EqualDateTime

Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided, month has higher precedence. day cannot be combined with other date. We accept string for month and day names.

EqualDateTimeBuilder

Builder for EqualDateTime.

ErrorBandConfig

ErrorBand Config

ErrorBandConfigBuilder

Builder for ErrorBandConfig.

ErrorBarConfig

ErrorBar Config

ErrorBarConfigBuilder

Builder for ErrorBarConfig.

ExprRef
ExprRefBuilder

Builder for ExprRef.

Facet

Definition for how to facet the data. One of: 1) a field definition for faceting the plot by one field 2) An object that maps row and column channels to their field definitions

FacetBuilder

Builder for Facet.

FacetEncodingFieldDef

A field definition for the (flexible) facet of trellis plots.

FacetEncodingFieldDefBuilder

Builder for FacetEncodingFieldDef.

FacetFieldDef

A field definition for the horizontal facet of trellis plots.

FacetFieldDefBuilder

Builder for FacetFieldDef.

FacetFieldDefFieldName

A field definition for the horizontal facet of trellis plots.

FacetFieldDefFieldNameBuilder

Builder for FacetFieldDefFieldName.

FacetFieldName

Definition for how to facet the data. One of: 1) a field definition for faceting the plot by one field 2) An object that maps row and column channels to their field definitions

FacetFieldNameBuilder

Builder for FacetFieldName.

FieldOrDatumDefWithConditionStringFieldDefString

A FieldDef with Condition { condition: {value: ...}, field: ..., ... }

FieldOrDatumDefWithConditionStringFieldDefStringBuilder

Builder for FieldOrDatumDefWithConditionStringFieldDefString.

FillClass

Color of the marks – either fill or stroke color based on the filled property of mark definition. By default, color represents fill color for "area", "bar", "tick", "text", "trail", "circle", and "square" / stroke color for "line" and "point".

FillClassBuilder

Builder for FillClass.

FillOpacityClass

Rotation angle of point and text marks.

FillOpacityClassBuilder

Builder for FillOpacityClass.

FluffyBinding

Binds the parameter to an external input element such as a slider, selection list or radio button group.

FluffyBindingBuilder

Builder for FluffyBinding.

FluffyConditionalExprRef
FluffyConditionalExprRefBuilder

Builder for FluffyConditionalExprRef.

FluffyConditionalPredicateValueDefNumberNullExprRef
FluffyConditionalPredicateValueDefNumberNullExprRefBuilder

Builder for FluffyConditionalPredicateValueDefNumberNullExprRef.

FluffyConditionalValueDefStringExprRef
FluffyConditionalValueDefStringExprRefBuilder

Builder for FluffyConditionalValueDefStringExprRef.

FluffyExprRef
FluffyExprRefBuilder

Builder for FluffyExprRef.

FluffyLinearGradient
FluffyLinearGradientBuilder

Builder for FluffyLinearGradient.

FluffyTooltipContent
FluffyTooltipContentBuilder

Builder for FluffyTooltipContent.

GradientStop
GradientStopBuilder

Builder for GradientStop.

GraticuleParams
GraticuleParamsBuilder

Builder for GraticuleParams.

GridColorExprRef
GridColorExprRefBuilder

Builder for GridColorExprRef.

GridDashOffsetExprRef
GridDashOffsetExprRefBuilder

Builder for GridDashOffsetExprRef.

GridOpacityExprRef
GridOpacityExprRefBuilder

Builder for GridOpacityExprRef.

GridWidthExprRef
GridWidthExprRefBuilder

Builder for GridWidthExprRef.

GtDateTime

Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided, month has higher precedence. day cannot be combined with other date. We accept string for month and day names.

GtDateTimeBuilder

Builder for GtDateTime.

Header

An object defining properties of a facet's header.

HeaderBuilder

Builder for Header.

HeaderConfig

Header configuration, which determines default properties for all headers.

HeaderConfigBuilder

Builder for HeaderConfig.

HilariousExprRef
HilariousExprRefBuilder

Builder for HilariousExprRef.

HrefClass

A text description of this mark for ARIA accessibility (SVG output only). For SVG output the "aria-label" attribute will be set to this description.

HrefClassBuilder

Builder for HrefClass.

ImputeParams
ImputeParamsBuilder

Builder for ImputeParams.

ImputeSequence
ImputeSequenceBuilder

Builder for ImputeSequence.

IndecentExprRef
IndecentExprRefBuilder

Builder for IndecentExprRef.

IndigoExprRef
IndigoExprRefBuilder

Builder for IndigoExprRef.

IntervalSelectionConfig

The default definition for an interval selection. All properties and transformations for an interval selection definition (except type) may be specified here.

IntervalSelectionConfigBuilder

Builder for IntervalSelectionConfig.

JoinAggregateFieldDef
JoinAggregateFieldDefBuilder

Builder for JoinAggregateFieldDef.

KeyClass

Field Def without scale (and without bin: "binned" support).

KeyClassBuilder

Builder for KeyClass.

Latitude2Class

Latitude-2 position for geographically projected ranged "area", "bar", "rect", and "rule".

Latitude2ClassBuilder

Builder for Latitude2Class.

LatitudeClass

Latitude position of geographically projected marks.

LatitudeClassBuilder

Builder for LatitudeClass.

LayerElement

A specification of the view that gets repeated.

LayerElementBuilder

Builder for LayerElement.

LayerEncoding

A shared key-value mapping between encoding channels and definition of fields in the underlying layers.

LayerEncodingBuilder

Builder for LayerEncoding.

Legend

Properties of a legend or boolean flag for determining whether to show it.

LegendBuilder

Builder for Legend.

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.

LegendConfigBuilder

Builder for LegendConfig.

LegendResolveMap
LegendResolveMapBuilder

Builder for LegendResolveMap.

LegendStreamBinding
LegendStreamBindingBuilder

Builder for LegendStreamBinding.

LineConfig

Line-Specific Config

LineConfigBuilder

Builder for LineConfig.

Longitude2Class

Latitude-2 position for geographically projected ranged "area", "bar", "rect", and "rule".

Longitude2ClassBuilder

Builder for Longitude2Class.

LongitudeClass

Latitude position of geographically projected marks.

LongitudeClassBuilder

Builder for LongitudeClass.

Lookup

Data source or selection for secondary data reference.

LookupBuilder

Builder for Lookup.

MagentaExprRef
MagentaExprRefBuilder

Builder for MagentaExprRef.

MarkConfig

Circle-Specific Config

MarkConfigBuilder

Builder for MarkConfig.

MarkConfigExprOrSignalRef
MarkConfigExprOrSignalRefBuilder

Builder for MarkConfigExprOrSignalRef.

MarkPropDefNumber

Stroke dash of the marks.

MarkPropDefNumberBuilder

Builder for MarkPropDefNumber.

MarkPropDefStringNullTypeForShape

Shape of the mark.

MarkPropDefStringNullTypeForShapeBuilder

Builder for MarkPropDefStringNullTypeForShape.

MultiSelectionConfig

The default definition for a multi selection. All properties and transformations for a multi selection definition (except type) may be specified here.

MultiSelectionConfigBuilder

Builder for MultiSelectionConfig.

NiceTimeIntervalStep
NiceTimeIntervalStepBuilder

Builder for NiceTimeIntervalStep.

NormalizedSpec

Any specification in Vega-Lite.

NormalizedSpecBuilder

Builder for NormalizedSpec.

NormalizedSpecSpec

A specification of the view that gets repeated.

NormalizedSpecSpecBuilder

Builder for NormalizedSpecSpec.

OnDerivedStream
OnDerivedStreamBuilder

Builder for OnDerivedStream.

OpacityClass

Rotation angle of point and text marks.

OpacityClassBuilder

Builder for OpacityClass.

OrderDef
OrderDefBuilder

Builder for OrderDef.

OrderFieldDef
OrderFieldDefBuilder

Builder for OrderFieldDef.

OverlayMarkDef
OverlayMarkDefBuilder

Builder for OverlayMarkDef.

Parameter
ParameterBuilder

Builder for Parameter.

Predicate
PredicateBuilder

Builder for Predicate.

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.

ProjectionBuilder

Builder for Projection.

PurpleBinding

Binds the parameter to an external input element such as a slider, selection list or radio button group.

PurpleBindingBuilder

Builder for PurpleBinding.

PurpleConditionalExprRef
PurpleConditionalExprRefBuilder

Builder for PurpleConditionalExprRef.

PurpleConditionalPredicateValueDefFontStyleNullExprRef
PurpleConditionalPredicateValueDefFontStyleNullExprRefBuilder

Builder for PurpleConditionalPredicateValueDefFontStyleNullExprRef.

PurpleConditionalPredicateValueDefFontWeightNullExprRef
PurpleConditionalPredicateValueDefFontWeightNullExprRefBuilder

Builder for PurpleConditionalPredicateValueDefFontWeightNullExprRef.

PurpleConditionalPredicateValueDefNumberNullExprRef
PurpleConditionalPredicateValueDefNumberNullExprRefBuilder

Builder for PurpleConditionalPredicateValueDefNumberNullExprRef.

PurpleConditionalPredicateValueDefStringNullExprRef
PurpleConditionalPredicateValueDefStringNullExprRefBuilder

Builder for PurpleConditionalPredicateValueDefStringNullExprRef.

PurpleConditionalValueDefStringExprRef
PurpleConditionalValueDefStringExprRefBuilder

Builder for PurpleConditionalValueDefStringExprRef.

PurpleExprRef
PurpleExprRefBuilder

Builder for PurpleExprRef.

PurpleLinearGradient
PurpleLinearGradientBuilder

Builder for PurpleLinearGradient.

PurpleTooltipContent
PurpleTooltipContentBuilder

Builder for PurpleTooltipContent.

Radius2Class

Latitude-2 position for geographically projected ranged "area", "bar", "rect", and "rule".

Radius2ClassBuilder

Builder for Radius2Class.

RadiusClass

The outer radius in pixels of arc marks.

RadiusClassBuilder

Builder for RadiusClass.

RangeClass
RangeClassBuilder

Builder for RangeClass.

RangeDateTime

Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided, month has higher precedence. day cannot be combined with other date. We accept string for month and day names.

RangeDateTimeBuilder

Builder for RangeDateTime.

RangeRange
RangeRangeBuilder

Builder for RangeRange.

RectConfig

Arc-specific Config

RectConfigBuilder

Builder for RectConfig.

RepeatMapping

Definition for fields to be repeated. One of: 1) An array of fields to be repeated. If "repeat" is an array, the field can be referred to as {"repeat": "repeat"}. The repeated views are laid out in a wrapped row. You can set the number of columns to control the wrapping. 2) An object that maps "row" and/or "column" to the listed fields to be repeated along the particular orientations. The objects {"repeat": "row"} and {"repeat": "column"} can be used to refer to the repeated field respectively.

RepeatMappingBuilder

Builder for RepeatMapping.

RepeatRef

Reference to a repeated value.

RepeatRefBuilder

Builder for RepeatRef.

RepeatRefClass

Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided, month has higher precedence. day cannot be combined with other date. We accept string for month and day names.

RepeatRefClassBuilder

Builder for RepeatRefClass.

Resolve

Scale, axis, and legend resolutions for view composition specifications.

ResolveBuilder

Builder for Resolve.

RowColBoolean
RowColBooleanBuilder

Builder for RowColBoolean.

RowColLayoutAlign
RowColLayoutAlignBuilder

Builder for RowColLayoutAlign.

RowColNumber
RowColNumberBuilder

Builder for RowColNumber.

RowColumnEncodingFieldDef

A field definition for the horizontal facet of trellis plots.

RowColumnEncodingFieldDefBuilder

Builder for RowColumnEncodingFieldDef.

Scale
ScaleBinParams
ScaleBinParamsBuilder

Builder for ScaleBinParams.

ScaleBuilder

Builder for Scale.

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.

ScaleConfigBuilder

Builder for ScaleConfig.

ScaleResolveMap
ScaleResolveMapBuilder

Builder for ScaleResolveMap.

SchemeParams
SchemeParamsBuilder

Builder for SchemeParams.

Selection
SelectionBuilder

Builder for Selection.

SelectionConfig

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

SelectionConfigBuilder

Builder for SelectionConfig.

SelectionDef
SelectionDefBuilder

Builder for SelectionDef.

SequenceParams

Generate a sequence of numbers.

SequenceParamsBuilder

Builder for SequenceParams.

SingleSelectionConfig

The default definition for a single selection. All properties and transformations for a single selection definition (except type) may be specified here.

SingleSelectionConfigBuilder

Builder for SingleSelectionConfig.

SizeClass

Rotation angle of point and text marks.

SizeClassBuilder

Builder for SizeClass.

SortEncodingSortField

A sort definition for sorting a discrete scale in an encoding field definition.

SortEncodingSortFieldBuilder

Builder for SortEncodingSortField.

SortField

A sort definition for transform

SortFieldBuilder

Builder for SortField.

Spec

A specification of the view that gets repeated.

SpecBuilder

Builder for Spec.

SpecEncoding

A key-value mapping between encoding channels and definition of fields.

SpecEncodingBuilder

Builder for SpecEncoding.

SphereClass
SphereClassBuilder

Builder for SphereClass.

Step
StepBuilder

Builder for Step.

StickyExprRef
StickyExprRefBuilder

Builder for StickyExprRef.

StickyLinearGradient
StickyLinearGradientBuilder

Builder for StickyLinearGradient.

Stream
StreamBuilder

Builder for Stream.

StringFieldDef
StringFieldDefBuilder

Builder for StringFieldDef.

StrokeClass

Color of the marks – either fill or stroke color based on the filled property of mark definition. By default, color represents fill color for "area", "bar", "tick", "text", "trail", "circle", and "square" / stroke color for "line" and "point".

StrokeClassBuilder

Builder for StrokeClass.

StrokeOpacityClass

Rotation angle of point and text marks.

StrokeOpacityClassBuilder

Builder for StrokeOpacityClass.

StrokeWidthClass

Rotation angle of point and text marks.

StrokeWidthClassBuilder

Builder for StrokeWidthClass.

StyleValue

Arc-specific Config

StyleValueBuilder

Builder for StyleValue.

TentacledExprRef
TentacledExprRefBuilder

Builder for TentacledExprRef.

TentacledLinearGradient
TentacledLinearGradientBuilder

Builder for TentacledLinearGradient.

TextDef

Text of the text mark.

TextDefBuilder

Builder for TextDef.

Theta2Class

Latitude-2 position for geographically projected ranged "area", "bar", "rect", and "rule".

Theta2ClassBuilder

Builder for Theta2Class.

ThetaClass

The outer radius in pixels of arc marks.

ThetaClassBuilder

Builder for ThetaClass.

TickConfig

Tick-Specific Config

TickConfigBuilder

Builder for TickConfig.

TickCountTimeIntervalStep
TickCountTimeIntervalStepBuilder

Builder for TickCountTimeIntervalStep.

TimeUnitParams
TimeUnitParamsBuilder

Builder for TimeUnitParams.

TitleParams
TitleParamsBuilder

Builder for TitleParams.

Transform
TransformBuilder

Builder for Transform.

TypedFieldDef

Field Def without scale (and without bin: "binned" support).

TypedFieldDefBuilder

Builder for TypedFieldDef.

UrlClass

A text description of this mark for ARIA accessibility (SVG output only). For SVG output the "aria-label" attribute will be set to this description.

UrlClassBuilder

Builder for UrlClass.

UrlData
UrlDataBuilder

Builder for UrlData.

ValueLinearGradient
ValueLinearGradientBuilder

Builder for ValueLinearGradient.

Vegalite

A Vega-Lite top-level specification. This is the root class for all Vega-Lite specifications. (The json schema is generated from this type.)

VegaliteBuilder

Builder for Vegalite.

VegaliteSpec

A specification of the view that gets faceted.

VegaliteSpecBuilder

Builder for VegaliteSpec.

ViewBackground

An object defining the view background's fill and stroke.

ViewBackgroundBuilder

Builder for ViewBackground.

ViewConfig

Default properties for single view plots.

ViewConfigBuilder

Builder for ViewConfig.

WindowFieldDef
WindowFieldDefBuilder

Builder for WindowFieldDef.

X2Class

Latitude-2 position for geographically projected ranged "area", "bar", "rect", and "rule".

X2ClassBuilder

Builder for X2Class.

XClass

X coordinates of the marks, or width of horizontal "bar" and "area" without specified x2 or width.

XClassBuilder

Builder for XClass.

XError2Class

Error value of x coordinates for error specified "errorbar" and "errorband".

XError2ClassBuilder

Builder for XError2Class.

XErrorClass

Error value of x coordinates for error specified "errorbar" and "errorband".

XErrorClassBuilder

Builder for XErrorClass.

Y2Class

Latitude-2 position for geographically projected ranged "area", "bar", "rect", and "rule".

Y2ClassBuilder

Builder for Y2Class.

YClass

X coordinates of the marks, or width of horizontal "bar" and "area" without specified x2 or width.

YClassBuilder

Builder for YClass.

YError2Class

Error value of x coordinates for error specified "errorbar" and "errorband".

YError2ClassBuilder

Builder for YError2Class.

YErrorClass

Error value of x coordinates for error specified "errorbar" and "errorband".

YErrorClassBuilder

Builder for YErrorClass.

Enums

Aggregate

Aggregation function for the field (e.g., "mean", "sum", "median", "min", "max", "count").

AggregateOp

The aggregation operation to apply to the fields (e.g., "sum", "average", or "count"). See the full list of supported aggregation operations for more information.

Align

Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

Angle
AngleBin

An object indicating bin properties, or simply true for using default bin parameters.

AngleCondition
AnyMark

A string describing the mark type (one of "bar", "circle", "square", "tick", "line", "area", "point", "rule", "geoshape", and "text") or a mark definition object.

Aria
Autosize

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.

AutosizeType

The sizing format type. One of "pad", "fit", "fit-x", "fit-y", or "none". See the autosize type documentation for descriptions of each.

AxisBandGridDash
AxisBandTickDash
AxisGridDash
AxisOrient

The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. - For bar, rule and tick, this determines whether the size of the bar and tick should be applied to x or y dimension. - For area, this property determines the orient property of the Vega output. - For line and trail marks, this property determines the sort order of the points in the line if config.sortLineBy is not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored.

AxisTickDash
Baseline

Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom", "line-top", or "line-bottom". The "line-top" and "line-bottom" values operate similarly to "top" and "bottom", but are calculated relative to the lineHeight rather than fontSize alone.

BinEnum
BinExtent

A two-element ([min, max]) array indicating the range of desired bin values.

Bind

Establishes a two-way binding between the interval selection and the scales used within the same view. This allows a user to interactively pan and zoom the view.

BindUnion
BlendEnum
BlendUnion
Bounds

The bounds calculation method to use for determining the extent of a sub-plot. One of full (the default) or flush.

BoxplotExtent

The extent of the whiskers. Available options include: - "min-max": min and max are the lower and upper whiskers respectively. - A number representing multiple of the interquartile range. This number will be multiplied by the IQR to determine whisker boundary, which spans from the smallest data to the largest data within the range [Q1 - k * IQR, Q3 + k * IQR] where Q1 and Q3 are the first and third quartiles while IQR is the interquartile range (Q3-Q1).

Cap
Center
ClearUnion
Color

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

ColorCondition
ConditionUnion
ConditionalAxisPropertyAlignNull
ConditionalAxisPropertyFontStyleNull
ConditionalAxisPropertyStringNull
ConditionalPredicateValueDefTextExprRefText

A constant value in visual domain (e.g., "red" / "#0099ff" / gradient definition for color, values between 0 to 1 for opacity).

ConditionalValueDefGradientStringNullExprRefValue
ConditionalValueDefNumberExprRefPredicateComposition

Predicate for triggering the condition

ConditionalValueDefNumberExprRefSelectionComposition

Filter using a selection name or a logical composition of selection names.

ConditionalValueDefNumberExprRefValue
ConditionalValueDefNumberExprRefValueUnion

A constant value in visual domain (e.g., "red" / "#0099ff" / gradient definition for color, values between 0 to 1 for opacity).

ConditionalValueDefTextExprRefText

A constant value in visual domain (e.g., "red" / "#0099ff" / gradient definition for color, values between 0 to 1 for opacity).

Contains

Determines how size calculation should be performed, one of "content" or "padding". The default setting ("content") interprets the width and height settings as the data rectangle (plotting) dimensions, to which padding is then added. In contrast, the "padding" setting includes the padding within the view size calculations, such that the width and height settings indicate the total intended size of the view.

Content
CornerRadiusUnion
Cursor

The mouse cursor used over the mark. Any valid CSS cursor type can be used.

CursorUnion
DataFormatType

Type of input data: "json", "csv", "tsv", "dsv".

Day

Value representing the day of a week. This can be one of: (1) integer value -- 1 represents Monday; (2) case-insensitive day name (e.g., "Monday"); (3) case-insensitive, 3-character short day name (e.g., "Mon").

DefBox
DescriptionBin
DescriptionCondition
Detail
Dir
Direction
DiscreteHeightUnion

The default height when the plot has non arc marks and either a discrete y-field or no y-field. The height can be either a number indicating a fixed height or an object in the form of {step: number} defining the height per discrete step.

DiscreteWidthUnion

The default width when the plot has non-arc marks and either a discrete x-field or no x-field. The width can be either a number indicating a fixed width or an object in the form of {step: number} defining the width per discrete step.

DomainElement
DomainEnum
DomainM
DomainUnion

Customized domain values in the form of constant values or dynamic values driven by a selection.

Empty

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

EncodingTooltip
Equal

The value that the field should be equal to.

ErrorbandExtent

The extent of the band. Available options include: - "ci": Extend the band to the confidence interval of the mean. - "stderr": The size of band are set to the value of standard error, extending from the mean. - "stdev": The size of band are set to the value of standard deviation, extending from the mean. - "iqr": Extend the band to the q1 and q3.

ExprRefCondition
ExprRefConditionUnion
ExprRefType
ExtentEnum
ExtentExtent

The extent of the band. Available options include: - "ci": Extend the band to the confidence interval of the mean. - "stderr": The size of band are set to the value of standard error, extending from the mean. - "stdev": The size of band are set to the value of standard deviation, extending from the mean. - "iqr": Extend the band to the q1 and q3.

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.

FieldOrDatumDefWithConditionStringFieldDefStringCondition
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)").

FluffyConditionalPredicateValueDefFontStyleNullExprRef
FluffyConditionalPredicateValueDefFontWeightNullExprRef
FluffyConditionalPredicateValueDefStringNullExprRef
FluffyRange
FluffySortArray

Sort order for the encoded field.

FluffyStream
FontSize
FontWeight
FontWeightEnum
FontWeightUnion
Format
Gradient

The type of gradient. Use "linear" for a linear gradient.

Graticule

Generate graticule GeoJSON data for geographic reference lines.

GridAlign
GridColorUnion
GridDashOffsetUnion
GridOpacityUnion
GridWidthUnion
HeightEnum
HeightUnion
ImputeParamsMethod

The imputation method to use for the field value of imputed data objects. One of "value", "mean", "median", "max" or "min".

Init
InitValue
InlineDatasetValue

The full data set, included inline. This can be an array of objects or primitive values, an object, or a string. Arrays of primitive values are ingested as objects with a data property. Strings are parsed according to the specified format type.

Interpolate

The line interpolation method to use for line and area marks. One of the following: - "linear": piecewise linear segments, as in a polyline. - "linear-closed": close the linear segments to form a polygon. - "step": alternate between horizontal and vertical segments, as in a step function. - "step-before": alternate between vertical and horizontal segments, as in a step function. - "step-after": alternate between horizontal and vertical segments, as in a step function. - "basis": a B-spline, with control point duplication on the ends. - "basis-open": an open B-spline; may not intersect the start or end. - "basis-closed": a closed B-spline, as in a loop. - "cardinal": a Cardinal spline, with control point duplication on the ends. - "cardinal-open": an open Cardinal spline; may not intersect the start or end, but will intersect other control points. - "cardinal-closed": a closed Cardinal spline, as in a loop. - "bundle": equivalent to basis, except the tension parameter is used to straighten the spline. - "monotone": cubic interpolation that preserves monotonicity in y.

Invalid
Keyvals
Label
LabelAngle
LabelFlush

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.

LabelOverlapEnum
LabelOverlapUnion

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "parity", a strategy of removing every other label is used (this works well for standard linear axes). If set to "greedy", a linear scan of the labels is performed, removing any labels that overlaps with the last visible label (this often works better for log-scaled axes).

Latitude2Value
LayoutAlign

The alignment to apply to symbol legends rows and columns. The supported string values are "all", "each" (the default), and none. For more information, see the grid layout documentation.

LegendBinding

When set, a selection is populated by interacting with the corresponding legend. Direct manipulation interaction is disabled by default; to re-enable it, set the selection's on property.

LegendBindingEnum
LegendOrient

The orientation of the legend, which determines how the legend is positioned within the scene. One of "left", "right", "top", "bottom", "top-left", "top-right", "bottom-left", "bottom-right", "none".

LegendText

A string or array of strings indicating the name of custom styles to apply to the mark. A style is a named collection of mark property defaults defined within the style configuration. If style is an array, later styles will override earlier styles. Any mark properties explicitly defined within the encoding will override a style default.

LegendType

The type of the legend. Use "symbol" to create a discrete legend and "gradient" for a continuous color gradient.

LegendUnion
Line
LogicalNotPredicateRange

An array of inclusive minimum and maximum values for a field value of a data item to be included in the filtered data.

Lt
Mark

The mark type. This could a primitive mark type (one of "bar", "circle", "square", "tick", "line", "area", "point", "geoshape", "rule", and "text") or a composite mark type ("boxplot", "errorband", "errorbar").

MarkConfigExprOrSignalRefColor

Default color.

MarkConfigExprOrSignalRefFill
MarkConfigExprOrSignalRefInterpolate
MarkConfigExprOrSignalRefTooltip
MarkDefExtent
MarkType
Month

One of: (1) integer value representing the month from 1-12. 1 represents January; (2) case-insensitive month name (e.g., "January"); (3) case-insensitive, 3-character short month name (e.g., "Jan").

Nice

Extending the domain so that it starts and ends on nice round values. This method typically modifies the scale’s domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be irregular. For example, for a domain of [0.201479…, 0.996679…], a nice domain might be [0.2, 1.0].

NonArgAggregateOp

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.

OnUnion
Op

The window or aggregation operation to apply within a window (e.g., "rank", "lead", "sum", "average" or "count"). See the list of all supported operations here.

Opacity
Order
OrderFieldDefCondition

One or more value definition(s) with a selection or a test predicate.

Orient

The orientation of the header label. One of "top", "bottom", "left" or "right".

Orientation

The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. - For bar, rule and tick, this determines whether the size of the bar and tick should be applied to x or y dimension. - For area, this property determines the orient property of the Vega output. - For line and trail marks, this property determines the sort order of the points in the line if config.sortLineBy is not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored.

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.

PointEnum
PointUnion
PredicateCompositionElement

Predicate for triggering the condition

PrimitiveValue

A constant value in data domain.

ProjectionType

The cartographic projection to use. This value is case-insensitive, for example "albers" and "Albers" indicate the same projection type. You can find all valid projection types in the documentation.

PurpleLegendBinding

Establishes a two-way binding between the interval selection and the scales used within the same view. This allows a user to interactively pan and zoom the view.

PurpleRange
PurpleSortArray
PurpleStream
PurpleTextBaseline
RangeEnum
RangeM
RangeText

A string or array of strings indicating the name of custom styles to apply to the mark. A style is a named collection of mark property defaults defined within the style configuration. If style is an array, later styles will override earlier styles. Any mark properties explicitly defined within the encoding will override a style default.

RangeValue
RemovableValue

Wrapper for a field that can be either the default value, null or specified

RepeatEnum
RepeatUnion
ResolveMode
ScaleBins

Bin boundaries can be provided to scales as either an explicit array of bin boundaries or as a bin specification object. The legal values are: - An array literal of bin boundary values. For example, [0, 5, 10, 15, 20]. The array must include both starting and ending boundaries. The previous example uses five values to indicate a total of four bin intervals: [0-5), [5-10), [10-15), [15-20]. Array literals may include signal references as elements. - A bin specification object that indicates the bin step size, and optionally the start and stop boundaries. - An array of bin boundaries over the scale domain. If provided, axes and legends will use the bin boundaries to inform the choice of tick marks and text labels.

ScaleInterpolate

The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in HCL space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include rgb, hsl, hsl-long, lab, hcl, hcl-long, cubehelix and cubehelix-long ('-long' variants use longer paths in polar coordinate spaces). If object-valued, this property accepts an object with a string-valued type property and an optional numeric gamma property applicable to rgb and cubehelix interpolators. For more, see the d3-interpolate documentation.

ScaleInterpolateEnum
ScaleRange

The range of the scale. One of:

ScaleType

The type of scale. Vega-Lite supports the following categories of scale types:

Scheme

A string indicating a color scheme name (e.g., "category10" or "blues") or a scheme parameter object.

SelectionCompositionElement

Filter using a selection name or a logical composition of selection names.

SelectionDefType

Determines the default event processing and data query for the selection. Vega-Lite currently supports three selection types:

SelectionInit
SelectionInitInterval
SelectionResolution

With layered and multi-view displays, a strategy that determines how selections' data queries are resolved when applied in a filter transform, conditional encoding rule, or scale domain.

ShapeCondition
SingleBind

When set, a selection is populated by input elements (also known as dynamic query widgets) or by interacting with the corresponding legend. Direct manipulation interaction is disabled by default; to re-enable it, set the selection's on property.

SingleDefUnitChannel

The encoding channel to extract selected values for, when a selection is projected over multiple fields or encodings.

Sort

The sort order. One of "ascending" (default) or "descending".

SortByChannel

The encoding channel to sort by (e.g., "x", "y")

SortOrder

The sort order. One of "ascending" (default) or "descending".

SortUnion

Sort order for the encoded field.

Source
Spacing
SphereUnion

Generate sphere GeoJSON data for the full globe.

Stack
StackOffset

Mode for stacking marks. One of "zero" (default), "center", or "normalize". The "zero" offset will stack starting at 0. The "center" offset will center the stacks. The "normalize" offset will compute percentage values for each stack point, with output values in the range [0,1].

StandardType

The type of measurement ("quantitative", "temporal", "ordinal", or "nominal") for the encoded field or constant value (datum). It can also be a "geojson" type for encoding 'geoshape'.

StickyConditionalPredicateValueDefNumberNullExprRef
StrokeCap

The stroke cap for line ending style. One of "butt", "round", or "square".

StrokeDashCondition
StrokeDashUnion

A constant value in visual domain (e.g., "red" / "#0099ff" / gradient definition for color, values between 0 to 1 for opacity).

StrokeJoin

The stroke line join method. One of "miter", "round" or "bevel".

StrokeJoinUnion
StyleColor
StyleFill
StyleOrient
StyleTooltip
TentacledConditionalPredicateValueDefNumberNullExprRef
TextBaseline
TextCondition
TextDirection

The direction of the text. One of "ltr" (left-to-right) or "rtl" (right-to-left). This property determines on which side is truncated in response to the limit parameter.

TickBandEnum

For band scales, indicates if ticks and grid lines should be placed at the "center" of a band (default) or at the band "extent"s to indicate intervals

TickBandUnion
TickCount
TimeInterval
TimeUnit

Defines how date-time values should be binned.

TimeUnitUnion

Time unit for the field to be tested.

TitleAlignUnion
TitleAnchorEnum
TitleAnchorUnion
TitleOrient

Default title orientation ("top", "bottom", "left", or "right")

TitleOrientUnion
TitleParamsOrient
TitleUnion

Title for the plot.

TransformMethod

The imputation method to use for the field value of imputed data objects. One of "value", "mean", "median", "max" or "min".

Translate

When truthy, allows a user to interactively move an interval selection back-and-forth. Can be true, false (to disable panning), or a Vega event stream definition which must include a start and end event to trigger continuous panning.

Type

The type of measurement ("quantitative", "temporal", "ordinal", or "nominal") for the encoded field or constant value (datum). It can also be a "geojson" type for encoding 'geoshape'.

UrlDataInlineDataset

The full data set, included inline. This can be an array of objects or primitive values, an object, or a string. Arrays of primitive values are ingested as objects with a data property. Strings are parsed according to the specified format type.

ValueEnum
ValueUnion
Values

Explicitly set the visible axis tick values.

VegaliteAlign

The alignment to apply to grid rows and columns. The supported string values are "all", "each", and "none".

XEnum
XUnion
YEnum
YUnion

Traits

Showable

Functions

iter_to_data

Helper method turning an iterator over a Serialize-able type into a data that can't be used in a graph.