Expand description
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§
- Aggregated
Field Def - Aggregated
Field DefBuilder - Builder for
AggregatedFieldDef. - Ambitious
Expr Ref - Ambitious
Expr RefBuilder - Builder for
AmbitiousExprRef. - Angle
Class - Rotation angle of point and text marks.
- Angle
Class Builder - Builder for
AngleClass. - Area
Config - Area-Specific Config
- Area
Config Builder - Builder for
AreaConfig. - ArgmDef
- Argm
DefBuilder - Builder for
ArgmDef. - Auto
Size Params - Auto
Size Params Builder - Builder for
AutoSizeParams. - Axis
- Axis
Builder - Builder for
Axis. - Axis
Config - Axis configuration, which determines default properties for all
xandyaxes. For a full list of axis configuration options, please see the corresponding section of the axis documentation. - Axis
Config Builder - Builder for
AxisConfig. - Axis
Resolve Map - Axis
Resolve MapBuilder - Builder for
AxisResolveMap. - Background
Expr Ref - Background
Expr RefBuilder - Builder for
BackgroundExprRef. - BarConfig
- Bar-Specific Config
- BarConfig
Builder - Builder for
BarConfig. - Base
Title NoValue Refs - 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.
- Base
Title NoValue Refs Builder - Builder for
BaseTitleNoValueRefs. - BinExtent
Class - BinExtent
Class Builder - Builder for
BinExtentClass. - BinParams
- Binning properties or boolean flag for determining whether to bin data or not.
- BinParams
Builder - Builder for
BinParams. - Binding
- Binds the parameter to an external input element such as a slider, selection list or radio button group.
- Binding
Builder - Builder for
Binding. - BoxPlot
Config - Box Config
- BoxPlot
Config Builder - Builder for
BoxPlotConfig. - Brush
Config - An interval selection also adds a rectangle mark to depict the extents of the interval.
The
markproperty can be used to customize the appearance of the mark. - Brush
Config Builder - Builder for
BrushConfig. - Clear
Derived Stream - Clear
Derived Stream Builder - Builder for
ClearDerivedStream. - Color
Class - Color of the marks – either fill or stroke color based on the
filledproperty of mark definition. By default,colorrepresents fill color for"area","bar","tick","text","trail","circle", and"square"/ stroke color for"line"and"point". - Color
Class Builder - Builder for
ColorClass. - Composition
Config - Default configuration for all concatenation and repeat view composition operators
(
concat,hconcat,vconcat, andrepeat) - Composition
Config Builder - Builder for
CompositionConfig. - Condition
Class - Condition
Class Builder - Builder for
ConditionClass. - Condition
Condition - Condition
Condition Builder - Builder for
ConditionCondition. - Condition
Condition Class - Condition
Condition Class Builder - Builder for
ConditionConditionClass. - Conditional
- Conditional
Builder - Builder for
Conditional. - Conditional
Predicate Value DefAlign Null Expr Ref - Conditional
Predicate Value DefAlign Null Expr RefBuilder - Builder for
ConditionalPredicateValueDefAlignNullExprRef. - Conditional
Predicate Value DefColor Null Expr Ref - Conditional
Predicate Value DefColor Null Expr RefBuilder - Builder for
ConditionalPredicateValueDefColorNullExprRef. - Conditional
Predicate Value DefFont Style Null Expr Ref - Conditional
Predicate Value DefFont Style Null Expr RefBuilder - Builder for
ConditionalPredicateValueDefFontStyleNullExprRef. - Conditional
Predicate Value DefFont Weight Null Expr Ref - Conditional
Predicate Value DefFont Weight Null Expr RefBuilder - Builder for
ConditionalPredicateValueDefFontWeightNullExprRef. - Conditional
Predicate Value DefGradient String Null Expr RefClass - Conditional
Predicate Value DefGradient String Null Expr RefClass Builder - Builder for
ConditionalPredicateValueDefGradientStringNullExprRefClass. - Conditional
Predicate Value DefNumber Class - Conditional
Predicate Value DefNumber Class Builder - Builder for
ConditionalPredicateValueDefNumberClass. - Conditional
Predicate Value DefNumber Expr RefClass - Conditional
Predicate Value DefNumber Expr RefClass Builder - Builder for
ConditionalPredicateValueDefNumberExprRefClass. - Conditional
Predicate Value DefNumber Null Expr Ref - Conditional
Predicate Value DefNumber Null Expr RefBuilder - Builder for
ConditionalPredicateValueDefNumberNullExprRef. - Conditional
Predicate Value DefNumber Null Expr RefElement - Conditional
Predicate Value DefNumber Null Expr RefElement Builder - Builder for
ConditionalPredicateValueDefNumberNullExprRefElement. - Conditional
Predicate Value DefString Null Expr Ref - Conditional
Predicate Value DefString Null Expr RefBuilder - Builder for
ConditionalPredicateValueDefStringNullExprRef. - Conditional
Predicate Value DefString Null Expr RefClass - Conditional
Predicate Value DefString Null Expr RefClass Builder - Builder for
ConditionalPredicateValueDefStringNullExprRefClass. - Conditional
Predicate Value DefText Baseline Null Expr Ref - Conditional
Predicate Value DefText Baseline Null Expr RefBuilder - Builder for
ConditionalPredicateValueDefTextBaselineNullExprRef. - Conditional
Selection Value DefNumber Expr RefClass - Conditional
Selection Value DefNumber Expr RefClass Builder - Builder for
ConditionalSelectionValueDefNumberExprRefClass. - Conditional
Value DefGradient String Null Expr Ref - Conditional
Value DefGradient String Null Expr RefBuilder - Builder for
ConditionalValueDefGradientStringNullExprRef. - Conditional
Value DefNumber - Conditional
Value DefNumber Builder - Builder for
ConditionalValueDefNumber. - Conditional
Value DefNumber Expr Ref - Conditional
Value DefNumber Expr RefBuilder - Builder for
ConditionalValueDefNumberExprRef. - Conditional
Value DefNumber Expr RefElement - Conditional
Value DefNumber Expr RefElement Builder - Builder for
ConditionalValueDefNumberExprRefElement. - Conditional
Value DefString Null Expr Ref - Conditional
Value DefString Null Expr RefBuilder - Builder for
ConditionalValueDefStringNullExprRef. - Conditional
Value DefText Expr Ref - Conditional
Value DefText Expr RefBuilder - Builder for
ConditionalValueDefTextExprRef. - Config
- Vega-Lite configuration object. This property can only be defined at the top-level of a specification.
- Config
Builder - Builder for
Config. - Cunning
Expr Ref - Cunning
Expr RefBuilder - Builder for
CunningExprRef. - Data
- Secondary data source to lookup in.
- Data
Builder - Builder for
Data. - Data
Format - An object that specifies the format for parsing the data.
- Data
Format Builder - Builder for
DataFormat. - Date
Time - Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided,
month has higher precedence.
daycannot be combined with other date. We accept string for month and day names. - Date
Time Builder - Builder for
DateTime. - Def
- DefBuilder
- Builder for
Def. - Description
Class - 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. - Description
Class Builder - Builder for
DescriptionClass. - Discrete
Height Class - Discrete
Height Class Builder - Builder for
DiscreteHeightClass. - Discrete
Width Class - Discrete
Width Class Builder - Builder for
DiscreteWidthClass. - Domain
Date Time - Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided,
month has higher precedence.
daycannot be combined with other date. We accept string for month and day names. - Domain
Date Time Builder - Builder for
DomainDateTime. - Domain
MaxDate Time - Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided,
month has higher precedence.
daycannot be combined with other date. We accept string for month and day names. - Domain
MaxDate Time Builder - Builder for
DomainMaxDateTime. - Domain
Union With - Domain
Union With Builder - Builder for
DomainUnionWith. - EdEncoding
- A key-value mapping between encoding channels and definition of fields.
- EdEncoding
Builder - Builder for
EdEncoding. - Encoding
Sort Field - A sort definition for sorting a discrete scale in an encoding field definition.
- Encoding
Sort Field Builder - Builder for
EncodingSortField. - Encoding
Sort Field Field Name - A sort definition for sorting a discrete scale in an encoding field definition.
- Encoding
Sort Field Field Name Builder - Builder for
EncodingSortFieldFieldName. - Equal
Date Time - Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided,
month has higher precedence.
daycannot be combined with other date. We accept string for month and day names. - Equal
Date Time Builder - Builder for
EqualDateTime. - Error
Band Config - ErrorBand Config
- Error
Band Config Builder - Builder for
ErrorBandConfig. - Error
BarConfig - ErrorBar Config
- Error
BarConfig Builder - Builder for
ErrorBarConfig. - ExprRef
- Expr
RefBuilder - 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
rowandcolumnchannels to their field definitions - Facet
Builder - Builder for
Facet. - Facet
Encoding Field Def - A field definition for the (flexible) facet of trellis plots.
- Facet
Encoding Field DefBuilder - Builder for
FacetEncodingFieldDef. - Facet
Field Def - A field definition for the horizontal facet of trellis plots.
- Facet
Field DefBuilder - Builder for
FacetFieldDef. - Facet
Field DefField Name - A field definition for the horizontal facet of trellis plots.
- Facet
Field DefField Name Builder - Builder for
FacetFieldDefFieldName. - Facet
Field Name - 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
rowandcolumnchannels to their field definitions - Facet
Field Name Builder - Builder for
FacetFieldName. - Field
OrDatum DefWith Condition String Field DefString - A FieldDef with Condition
{ condition: {value: …}, field: …, … } - Field
OrDatum DefWith Condition String Field DefString Builder - Builder for
FieldOrDatumDefWithConditionStringFieldDefString. - Fill
Class - Color of the marks – either fill or stroke color based on the
filledproperty of mark definition. By default,colorrepresents fill color for"area","bar","tick","text","trail","circle", and"square"/ stroke color for"line"and"point". - Fill
Class Builder - Builder for
FillClass. - Fill
Opacity Class - Rotation angle of point and text marks.
- Fill
Opacity Class Builder - Builder for
FillOpacityClass. - Fluffy
Binding - Binds the parameter to an external input element such as a slider, selection list or radio button group.
- Fluffy
Binding Builder - Builder for
FluffyBinding. - Fluffy
Conditional Expr Ref - Fluffy
Conditional Expr RefBuilder - Builder for
FluffyConditionalExprRef. - Fluffy
Conditional Predicate Value DefNumber Null Expr Ref - Fluffy
Conditional Predicate Value DefNumber Null Expr RefBuilder - Builder for
FluffyConditionalPredicateValueDefNumberNullExprRef. - Fluffy
Conditional Value DefString Expr Ref - Fluffy
Conditional Value DefString Expr RefBuilder - Builder for
FluffyConditionalValueDefStringExprRef. - Fluffy
Expr Ref - Fluffy
Expr RefBuilder - Builder for
FluffyExprRef. - Fluffy
Linear Gradient - Fluffy
Linear Gradient Builder - Builder for
FluffyLinearGradient. - Fluffy
Tooltip Content - Fluffy
Tooltip Content Builder - Builder for
FluffyTooltipContent. - Gradient
Stop - Gradient
Stop Builder - Builder for
GradientStop. - Graticule
Params - Graticule
Params Builder - Builder for
GraticuleParams. - Grid
Color Expr Ref - Grid
Color Expr RefBuilder - Builder for
GridColorExprRef. - Grid
Dash Offset Expr Ref - Grid
Dash Offset Expr RefBuilder - Builder for
GridDashOffsetExprRef. - Grid
Opacity Expr Ref - Grid
Opacity Expr RefBuilder - Builder for
GridOpacityExprRef. - Grid
Width Expr Ref - Grid
Width Expr RefBuilder - Builder for
GridWidthExprRef. - GtDate
Time - Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided,
month has higher precedence.
daycannot be combined with other date. We accept string for month and day names. - GtDate
Time Builder - Builder for
GtDateTime. - Header
- An object defining properties of a facet’s header.
- Header
Builder - Builder for
Header. - Header
Config - Header configuration, which determines default properties for all headers.
- Header
Config Builder - Builder for
HeaderConfig. - Hilarious
Expr Ref - Hilarious
Expr RefBuilder - Builder for
HilariousExprRef. - Href
Class - 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. - Href
Class Builder - Builder for
HrefClass. - Impute
Params - Impute
Params Builder - Builder for
ImputeParams. - Impute
Sequence - Impute
Sequence Builder - Builder for
ImputeSequence. - Indecent
Expr Ref - Indecent
Expr RefBuilder - Builder for
IndecentExprRef. - Indigo
Expr Ref - Indigo
Expr RefBuilder - Builder for
IndigoExprRef. - Interval
Selection Config - The default definition for an
intervalselection. All properties and transformations for an interval selection definition (excepttype) may be specified here. - Interval
Selection Config Builder - Builder for
IntervalSelectionConfig. - Join
Aggregate Field Def - Join
Aggregate Field DefBuilder - Builder for
JoinAggregateFieldDef. - KeyClass
- Field Def without scale (and without bin: “binned” support).
- KeyClass
Builder - Builder for
KeyClass. - Latitude2
Class - Latitude-2 position for geographically projected ranged
"area","bar","rect", and"rule". - Latitude2
Class Builder - Builder for
Latitude2Class. - Latitude
Class - Latitude position of geographically projected marks.
- Latitude
Class Builder - Builder for
LatitudeClass. - Layer
Element - A specification of the view that gets repeated.
- Layer
Element Builder - Builder for
LayerElement. - Layer
Encoding - A shared key-value mapping between encoding channels and definition of fields in the underlying layers.
- Layer
Encoding Builder - Builder for
LayerEncoding. - Legend
- Properties of a legend or boolean flag for determining whether to show it.
- Legend
Builder - Builder for
Legend. - Legend
Config - 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.
- Legend
Config Builder - Builder for
LegendConfig. - Legend
Resolve Map - Legend
Resolve MapBuilder - Builder for
LegendResolveMap. - Legend
Stream Binding - Legend
Stream Binding Builder - Builder for
LegendStreamBinding. - Line
Config - Line-Specific Config
- Line
Config Builder - Builder for
LineConfig. - Longitude2
Class - Latitude-2 position for geographically projected ranged
"area","bar","rect", and"rule". - Longitude2
Class Builder - Builder for
Longitude2Class. - Longitude
Class - Latitude position of geographically projected marks.
- Longitude
Class Builder - Builder for
LongitudeClass. - Lookup
- Data source or selection for secondary data reference.
- Lookup
Builder - Builder for
Lookup. - Magenta
Expr Ref - Magenta
Expr RefBuilder - Builder for
MagentaExprRef. - Mark
Config - Circle-Specific Config
- Mark
Config Builder - Builder for
MarkConfig. - Mark
Config Expr OrSignal Ref - Mark
Config Expr OrSignal RefBuilder - Builder for
MarkConfigExprOrSignalRef. - Mark
Prop DefNumber - Stroke dash of the marks.
- Mark
Prop DefNumber Builder - Builder for
MarkPropDefNumber. - Mark
Prop DefString Null Type ForShape - Shape of the mark.
- Mark
Prop DefString Null Type ForShape Builder - Builder for
MarkPropDefStringNullTypeForShape. - Multi
Selection Config - The default definition for a
multiselection. All properties and transformations for a multi selection definition (excepttype) may be specified here. - Multi
Selection Config Builder - Builder for
MultiSelectionConfig. - Nice
Time Interval Step - Nice
Time Interval Step Builder - Builder for
NiceTimeIntervalStep. - Normalized
Spec - Any specification in Vega-Lite.
- Normalized
Spec Builder - Builder for
NormalizedSpec. - Normalized
Spec Spec - A specification of the view that gets repeated.
- Normalized
Spec Spec Builder - Builder for
NormalizedSpecSpec. - OnDerived
Stream - OnDerived
Stream Builder - Builder for
OnDerivedStream. - Opacity
Class - Rotation angle of point and text marks.
- Opacity
Class Builder - Builder for
OpacityClass. - Order
Def - Order
DefBuilder - Builder for
OrderDef. - Order
Field Def - Order
Field DefBuilder - Builder for
OrderFieldDef. - Overlay
Mark Def - Overlay
Mark DefBuilder - Builder for
OverlayMarkDef. - Parameter
- Parameter
Builder - Builder for
Parameter. - Predicate
- Predicate
Builder - 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.
- Projection
Builder - Builder for
Projection. - Purple
Binding - Binds the parameter to an external input element such as a slider, selection list or radio button group.
- Purple
Binding Builder - Builder for
PurpleBinding. - Purple
Conditional Expr Ref - Purple
Conditional Expr RefBuilder - Builder for
PurpleConditionalExprRef. - Purple
Conditional Predicate Value DefFont Style Null Expr Ref - Purple
Conditional Predicate Value DefFont Style Null Expr RefBuilder - Builder for
PurpleConditionalPredicateValueDefFontStyleNullExprRef. - Purple
Conditional Predicate Value DefFont Weight Null Expr Ref - Purple
Conditional Predicate Value DefFont Weight Null Expr RefBuilder - Builder for
PurpleConditionalPredicateValueDefFontWeightNullExprRef. - Purple
Conditional Predicate Value DefNumber Null Expr Ref - Purple
Conditional Predicate Value DefNumber Null Expr RefBuilder - Builder for
PurpleConditionalPredicateValueDefNumberNullExprRef. - Purple
Conditional Predicate Value DefString Null Expr Ref - Purple
Conditional Predicate Value DefString Null Expr RefBuilder - Builder for
PurpleConditionalPredicateValueDefStringNullExprRef. - Purple
Conditional Value DefString Expr Ref - Purple
Conditional Value DefString Expr RefBuilder - Builder for
PurpleConditionalValueDefStringExprRef. - Purple
Expr Ref - Purple
Expr RefBuilder - Builder for
PurpleExprRef. - Purple
Linear Gradient - Purple
Linear Gradient Builder - Builder for
PurpleLinearGradient. - Purple
Tooltip Content - Purple
Tooltip Content Builder - Builder for
PurpleTooltipContent. - Radius2
Class - Latitude-2 position for geographically projected ranged
"area","bar","rect", and"rule". - Radius2
Class Builder - Builder for
Radius2Class. - Radius
Class - The outer radius in pixels of arc marks.
- Radius
Class Builder - Builder for
RadiusClass. - Range
Class - Range
Class Builder - Builder for
RangeClass. - Range
Date Time - Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided,
month has higher precedence.
daycannot be combined with other date. We accept string for month and day names. - Range
Date Time Builder - Builder for
RangeDateTime. - Range
Range - Range
Range Builder - Builder for
RangeRange. - Rect
Config - Arc-specific Config
- Rect
Config Builder - Builder for
RectConfig. - Repeat
Mapping - 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. - Repeat
Mapping Builder - Builder for
RepeatMapping. - Repeat
Ref - Reference to a repeated value.
- Repeat
RefBuilder - Builder for
RepeatRef. - Repeat
RefClass - Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided,
month has higher precedence.
daycannot be combined with other date. We accept string for month and day names. - Repeat
RefClass Builder - Builder for
RepeatRefClass. - Resolve
- Scale, axis, and legend resolutions for view composition specifications.
- Resolve
Builder - Builder for
Resolve. - RowCol
Boolean - RowCol
Boolean Builder - Builder for
RowColBoolean. - RowCol
Layout Align - RowCol
Layout Align Builder - Builder for
RowColLayoutAlign. - RowCol
Number - RowCol
Number Builder - Builder for
RowColNumber. - RowColumn
Encoding Field Def - A field definition for the horizontal facet of trellis plots.
- RowColumn
Encoding Field DefBuilder - Builder for
RowColumnEncodingFieldDef. - Scale
- Scale
BinParams - Scale
BinParams Builder - Builder for
ScaleBinParams. - Scale
Builder - Builder for
Scale. - Scale
Config - 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.
- Scale
Config Builder - Builder for
ScaleConfig. - Scale
Resolve Map - Scale
Resolve MapBuilder - Builder for
ScaleResolveMap. - Scheme
Params - Scheme
Params Builder - Builder for
SchemeParams. - Selection
- Selection
Builder - Builder for
Selection. - Selection
Config - An object hash for defining default properties for each type of selections.
- Selection
Config Builder - Builder for
SelectionConfig. - Selection
Def - Selection
DefBuilder - Builder for
SelectionDef. - Sequence
Params - Generate a sequence of numbers.
- Sequence
Params Builder - Builder for
SequenceParams. - Single
Selection Config - The default definition for a
singleselection. All properties and transformations for a single selection definition (excepttype) may be specified here. - Single
Selection Config Builder - Builder for
SingleSelectionConfig. - Size
Class - Rotation angle of point and text marks.
- Size
Class Builder - Builder for
SizeClass. - Sort
Encoding Sort Field - A sort definition for sorting a discrete scale in an encoding field definition.
- Sort
Encoding Sort Field Builder - Builder for
SortEncodingSortField. - Sort
Field - A sort definition for transform
- Sort
Field Builder - Builder for
SortField. - Spec
- A specification of the view that gets repeated.
- Spec
Builder - Builder for
Spec. - Spec
Encoding - A key-value mapping between encoding channels and definition of fields.
- Spec
Encoding Builder - Builder for
SpecEncoding. - Sphere
Class - Sphere
Class Builder - Builder for
SphereClass. - Step
- Step
Builder - Builder for
Step. - Sticky
Expr Ref - Sticky
Expr RefBuilder - Builder for
StickyExprRef. - Sticky
Linear Gradient - Sticky
Linear Gradient Builder - Builder for
StickyLinearGradient. - Stream
- Stream
Builder - Builder for
Stream. - String
Field Def - String
Field DefBuilder - Builder for
StringFieldDef. - Stroke
Class - Color of the marks – either fill or stroke color based on the
filledproperty of mark definition. By default,colorrepresents fill color for"area","bar","tick","text","trail","circle", and"square"/ stroke color for"line"and"point". - Stroke
Class Builder - Builder for
StrokeClass. - Stroke
Opacity Class - Rotation angle of point and text marks.
- Stroke
Opacity Class Builder - Builder for
StrokeOpacityClass. - Stroke
Width Class - Rotation angle of point and text marks.
- Stroke
Width Class Builder - Builder for
StrokeWidthClass. - Style
Value - Arc-specific Config
- Style
Value Builder - Builder for
StyleValue. - Tentacled
Expr Ref - Tentacled
Expr RefBuilder - Builder for
TentacledExprRef. - Tentacled
Linear Gradient - Tentacled
Linear Gradient Builder - Builder for
TentacledLinearGradient. - TextDef
- Text of the
textmark. - Text
DefBuilder - Builder for
TextDef. - Theta2
Class - Latitude-2 position for geographically projected ranged
"area","bar","rect", and"rule". - Theta2
Class Builder - Builder for
Theta2Class. - Theta
Class - The outer radius in pixels of arc marks.
- Theta
Class Builder - Builder for
ThetaClass. - Tick
Config - Tick-Specific Config
- Tick
Config Builder - Builder for
TickConfig. - Tick
Count Time Interval Step - Tick
Count Time Interval Step Builder - Builder for
TickCountTimeIntervalStep. - Time
Unit Params - Time
Unit Params Builder - Builder for
TimeUnitParams. - Title
Params - Title
Params Builder - Builder for
TitleParams. - Transform
- Transform
Builder - Builder for
Transform. - Typed
Field Def - Field Def without scale (and without bin: “binned” support).
- Typed
Field DefBuilder - 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. - UrlClass
Builder - Builder for
UrlClass. - UrlData
- UrlData
Builder - Builder for
UrlData. - Value
Linear Gradient - Value
Linear Gradient Builder - 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.)
- Vegalite
Builder - Builder for
Vegalite. - Vegalite
Spec - A specification of the view that gets faceted.
- Vegalite
Spec Builder - Builder for
VegaliteSpec. - View
Background - An object defining the view background’s fill and stroke.
- View
Background Builder - Builder for
ViewBackground. - View
Config - Default properties for single view plots.
- View
Config Builder - Builder for
ViewConfig. - Window
Field Def - Window
Field DefBuilder - Builder for
WindowFieldDef. - X2Class
- Latitude-2 position for geographically projected ranged
"area","bar","rect", and"rule". - X2Class
Builder - Builder for
X2Class. - XClass
- X coordinates of the marks, or width of horizontal
"bar"and"area"without specifiedx2orwidth. - XClass
Builder - Builder for
XClass. - XError2
Class - Error value of x coordinates for error specified
"errorbar"and"errorband". - XError2
Class Builder - Builder for
XError2Class. - XError
Class - Error value of x coordinates for error specified
"errorbar"and"errorband". - XError
Class Builder - Builder for
XErrorClass. - Y2Class
- Latitude-2 position for geographically projected ranged
"area","bar","rect", and"rule". - Y2Class
Builder - Builder for
Y2Class. - YClass
- X coordinates of the marks, or width of horizontal
"bar"and"area"without specifiedx2orwidth. - YClass
Builder - Builder for
YClass. - YError2
Class - Error value of x coordinates for error specified
"errorbar"and"errorband". - YError2
Class Builder - Builder for
YError2Class. - YError
Class - Error value of x coordinates for error specified
"errorbar"and"errorband". - YError
Class Builder - Builder for
YErrorClass.
Enums§
- Aggregate
- Aggregation function for the field (e.g.,
"mean","sum","median","min","max","count"). - Aggregate
Op - 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. - Aggregated
Field DefBuilder Error - Error type for AggregatedFieldDefBuilder
- Align
- Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.
- Ambitious
Expr RefBuilder Error - Error type for AmbitiousExprRefBuilder
- Angle
- Angle
Bin - An object indicating bin properties, or simply
truefor using default bin parameters. - Angle
Class Builder Error - Error type for AngleClassBuilder
- Angle
Condition - 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. - Area
Config Builder Error - Error type for AreaConfigBuilder
- Argm
DefBuilder Error - Error type for ArgmDefBuilder
- Aria
- Auto
Size Params Builder Error - Error type for AutoSizeParamsBuilder
- 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. - Autosize
Type - The sizing format type. One of
"pad","fit","fit-x","fit-y", or"none". See the autosize type documentation for descriptions of each. - Axis
Band Grid Dash - Axis
Band Tick Dash - Axis
Builder Error - Error type for AxisBuilder
- Axis
Config Builder Error - Error type for AxisConfigBuilder
- Axis
Grid Dash - Axis
Orient - 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.sortLineByis not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored. - Axis
Resolve MapBuilder Error - Error type for AxisResolveMapBuilder
- Axis
Tick Dash - Background
Expr RefBuilder Error - Error type for BackgroundExprRefBuilder
- BarConfig
Builder Error - Error type for BarConfigBuilder
- Base
Title NoValue Refs Builder Error - Error type for BaseTitleNoValueRefsBuilder
- 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. - BinExtent
Class Builder Error - Error type for BinExtentClassBuilder
- BinParams
Builder Error - Error type for BinParamsBuilder
- 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.
- Bind
Union - Binding
Builder Error - Error type for BindingBuilder
- Blend
Enum - Blend
Union - Bounds
- The bounds calculation method to use for determining the extent of a sub-plot. One of
full(the default) orflush. - BoxPlot
Config Builder Error - Error type for BoxPlotConfigBuilder
- Boxplot
Extent - 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). - Brush
Config Builder Error - Error type for BrushConfigBuilder
- Cap
- Center
- Clear
Derived Stream Builder Error - Error type for ClearDerivedStreamBuilder
- Clear
Union - Color
- CSS color property to use as the background of the entire view.
- Color
Class Builder Error - Error type for ColorClassBuilder
- Color
Condition - Composition
Config Builder Error - Error type for CompositionConfigBuilder
- Condition
Class Builder Error - Error type for ConditionClassBuilder
- Condition
Condition Builder Error - Error type for ConditionConditionBuilder
- Condition
Condition Class Builder Error - Error type for ConditionConditionClassBuilder
- Condition
Union - Conditional
Axis Property Align Null - Conditional
Axis Property Font Style Null - Conditional
Axis Property String Null - Conditional
Builder Error - Error type for ConditionalBuilder
- Conditional
Predicate Value DefAlign Null Expr RefBuilder Error - Error type for ConditionalPredicateValueDefAlignNullExprRefBuilder
- Conditional
Predicate Value DefColor Null Expr RefBuilder Error - Error type for ConditionalPredicateValueDefColorNullExprRefBuilder
- Conditional
Predicate Value DefFont Style Null Expr RefBuilder Error - Error type for ConditionalPredicateValueDefFontStyleNullExprRefBuilder
- Conditional
Predicate Value DefFont Weight Null Expr RefBuilder Error - Error type for ConditionalPredicateValueDefFontWeightNullExprRefBuilder
- Conditional
Predicate Value DefGradient String Null Expr RefClass Builder Error - Error type for ConditionalPredicateValueDefGradientStringNullExprRefClassBuilder
- Conditional
Predicate Value DefNumber Class Builder Error - Error type for ConditionalPredicateValueDefNumberClassBuilder
- Conditional
Predicate Value DefNumber Expr RefClass Builder Error - Error type for ConditionalPredicateValueDefNumberExprRefClassBuilder
- Conditional
Predicate Value DefNumber Null Expr RefBuilder Error - Error type for ConditionalPredicateValueDefNumberNullExprRefBuilder
- Conditional
Predicate Value DefNumber Null Expr RefElement Builder Error - Error type for ConditionalPredicateValueDefNumberNullExprRefElementBuilder
- Conditional
Predicate Value DefString Null Expr RefBuilder Error - Error type for ConditionalPredicateValueDefStringNullExprRefBuilder
- Conditional
Predicate Value DefString Null Expr RefClass Builder Error - Error type for ConditionalPredicateValueDefStringNullExprRefClassBuilder
- Conditional
Predicate Value DefText Baseline Null Expr RefBuilder Error - Error type for ConditionalPredicateValueDefTextBaselineNullExprRefBuilder
- Conditional
Predicate Value DefText Expr RefText - A constant value in visual domain (e.g.,
"red"/"#0099ff"/ gradient definition for color, values between0to1for opacity). - Conditional
Selection Value DefNumber Expr RefClass Builder Error - Error type for ConditionalSelectionValueDefNumberExprRefClassBuilder
- Conditional
Value DefGradient String Null Expr RefBuilder Error - Error type for ConditionalValueDefGradientStringNullExprRefBuilder
- Conditional
Value DefGradient String Null Expr RefValue - Conditional
Value DefNumber Builder Error - Error type for ConditionalValueDefNumberBuilder
- Conditional
Value DefNumber Expr RefBuilder Error - Error type for ConditionalValueDefNumberExprRefBuilder
- Conditional
Value DefNumber Expr RefElement Builder Error - Error type for ConditionalValueDefNumberExprRefElementBuilder
- Conditional
Value DefNumber Expr RefPredicate Composition - Predicate for triggering the condition
- Conditional
Value DefNumber Expr RefSelection Composition - Filter using a selection name or a logical composition of selection names.
- Conditional
Value DefNumber Expr RefValue - Conditional
Value DefNumber Expr RefValue Union - A constant value in visual domain (e.g.,
"red"/"#0099ff"/ gradient definition for color, values between0to1for opacity). - Conditional
Value DefString Null Expr RefBuilder Error - Error type for ConditionalValueDefStringNullExprRefBuilder
- Conditional
Value DefText Expr RefBuilder Error - Error type for ConditionalValueDefTextExprRefBuilder
- Conditional
Value DefText Expr RefText - A constant value in visual domain (e.g.,
"red"/"#0099ff"/ gradient definition for color, values between0to1for opacity). - Config
Builder Error - Error type for ConfigBuilder
- 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
- Corner
Radius Union - Cunning
Expr RefBuilder Error - Error type for CunningExprRefBuilder
- Cursor
- The mouse cursor used over the mark. Any valid CSS cursor type can be used.
- Cursor
Union - Data
Builder Error - Error type for DataBuilder
- Data
Format Builder Error - Error type for DataFormatBuilder
- Data
Format Type - Type of input data:
"json","csv","tsv","dsv". - Date
Time Builder Error - Error type for DateTimeBuilder
- Day
- Value representing the day of a week. This can be one of: (1) integer value –
1represents Monday; (2) case-insensitive day name (e.g.,"Monday"); (3) case-insensitive, 3-character short day name (e.g.,"Mon"). - DefBox
- DefBuilder
Error - Error type for DefBuilder
- Description
Bin - Description
Class Builder Error - Error type for DescriptionClassBuilder
- Description
Condition - Detail
- Dir
- Direction
- Discrete
Height Class Builder Error - Error type for DiscreteHeightClassBuilder
- Discrete
Height Union - 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. - Discrete
Width Class Builder Error - Error type for DiscreteWidthClassBuilder
- Discrete
Width Union - 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. - Domain
Date Time Builder Error - Error type for DomainDateTimeBuilder
- Domain
Element - Domain
Enum - DomainM
- Domain
MaxDate Time Builder Error - Error type for DomainMaxDateTimeBuilder
- Domain
Union - Customized domain values in the form of constant values or dynamic values driven by a selection.
- Domain
Union With Builder Error - Error type for DomainUnionWithBuilder
- EdEncoding
Builder Error - Error type for EdEncodingBuilder
- Empty
- By default,
alldata values are considered to lie within an empty selection. When set tonone, empty selections contain no data values. - Encoding
Sort Field Builder Error - Error type for EncodingSortFieldBuilder
- Encoding
Sort Field Field Name Builder Error - Error type for EncodingSortFieldFieldNameBuilder
- Encoding
Tooltip - Equal
- The value that the field should be equal to.
- Equal
Date Time Builder Error - Error type for EqualDateTimeBuilder
- Error
Band Config Builder Error - Error type for ErrorBandConfigBuilder
- Error
BarConfig Builder Error - Error type for ErrorBarConfigBuilder
- Errorband
Extent - 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. - Expr
RefBuilder Error - Error type for ExprRefBuilder
- Expr
RefCondition - Expr
RefCondition Union - Expr
RefType - Extent
Enum - Extent
Extent - 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. - Facet
Builder Error - Error type for FacetBuilder
- Facet
Encoding Field DefBuilder Error - Error type for FacetEncodingFieldDefBuilder
- Facet
Field DefBuilder Error - Error type for FacetFieldDefBuilder
- Facet
Field DefField Name Builder Error - Error type for FacetFieldDefFieldNameBuilder
- Facet
Field Name Builder Error - Error type for FacetFieldNameBuilder
- 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
repeatoperator. - Field
OrDatum DefWith Condition String Field DefString Builder Error - Error type for FieldOrDatumDefWithConditionStringFieldDefStringBuilder
- Field
OrDatum DefWith Condition String Field DefString Condition - Field
Title - 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)”). - Fill
Class Builder Error - Error type for FillClassBuilder
- Fill
Opacity Class Builder Error - Error type for FillOpacityClassBuilder
- Fluffy
Binding Builder Error - Error type for FluffyBindingBuilder
- Fluffy
Conditional Expr RefBuilder Error - Error type for FluffyConditionalExprRefBuilder
- Fluffy
Conditional Predicate Value DefFont Style Null Expr Ref - Fluffy
Conditional Predicate Value DefFont Weight Null Expr Ref - Fluffy
Conditional Predicate Value DefNumber Null Expr RefBuilder Error - Error type for FluffyConditionalPredicateValueDefNumberNullExprRefBuilder
- Fluffy
Conditional Predicate Value DefString Null Expr Ref - Fluffy
Conditional Value DefString Expr RefBuilder Error - Error type for FluffyConditionalValueDefStringExprRefBuilder
- Fluffy
Expr RefBuilder Error - Error type for FluffyExprRefBuilder
- Fluffy
Linear Gradient Builder Error - Error type for FluffyLinearGradientBuilder
- Fluffy
Range - Fluffy
Sort Array - Sort order for the encoded field.
- Fluffy
Stream - Fluffy
Tooltip Content Builder Error - Error type for FluffyTooltipContentBuilder
- Font
Size - Font
Weight - Font
Weight Enum - Font
Weight Union - Format
- Gradient
- The type of gradient. Use
"linear"for a linear gradient. - Gradient
Stop Builder Error - Error type for GradientStopBuilder
- Graticule
- Generate graticule GeoJSON data for geographic reference lines.
- Graticule
Params Builder Error - Error type for GraticuleParamsBuilder
- Grid
Align - Grid
Color Expr RefBuilder Error - Error type for GridColorExprRefBuilder
- Grid
Color Union - Grid
Dash Offset Expr RefBuilder Error - Error type for GridDashOffsetExprRefBuilder
- Grid
Dash Offset Union - Grid
Opacity Expr RefBuilder Error - Error type for GridOpacityExprRefBuilder
- Grid
Opacity Union - Grid
Width Expr RefBuilder Error - Error type for GridWidthExprRefBuilder
- Grid
Width Union - GtDate
Time Builder Error - Error type for GtDateTimeBuilder
- Header
Builder Error - Error type for HeaderBuilder
- Header
Config Builder Error - Error type for HeaderConfigBuilder
- Height
Enum - Height
Union - Hilarious
Expr RefBuilder Error - Error type for HilariousExprRefBuilder
- Href
Class Builder Error - Error type for HrefClassBuilder
- Impute
Params Builder Error - Error type for ImputeParamsBuilder
- Impute
Params Method - The imputation method to use for the field value of imputed data objects. One of
"value","mean","median","max"or"min". - Impute
Sequence Builder Error - Error type for ImputeSequenceBuilder
- Indecent
Expr RefBuilder Error - Error type for IndecentExprRefBuilder
- Indigo
Expr RefBuilder Error - Error type for IndigoExprRefBuilder
- Init
- Init
Value - Inline
Dataset Value - 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
dataproperty. 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. - Interval
Selection Config Builder Error - Error type for IntervalSelectionConfigBuilder
- Invalid
- Join
Aggregate Field DefBuilder Error - Error type for JoinAggregateFieldDefBuilder
- KeyClass
Builder Error - Error type for KeyClassBuilder
- Keyvals
- Label
- Label
Angle - Label
Flush - Indicates if labels should be hidden if they exceed the axis range. If
false(the default) no bounds overlap analysis is performed. Iftrue, 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. - Label
Overlap Enum - Label
Overlap Union - The strategy to use for resolving overlap of axis labels. If
false(the default), no overlap reduction is attempted. If set totrueor"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). - Latitude2
Class Builder Error - Error type for Latitude2ClassBuilder
- Latitude2
Value - Latitude
Class Builder Error - Error type for LatitudeClassBuilder
- Layer
Element Builder Error - Error type for LayerElementBuilder
- Layer
Encoding Builder Error - Error type for LayerEncodingBuilder
- Layout
Align - The alignment to apply to symbol legends rows and columns. The supported string values
are
"all","each"(the default), andnone. For more information, see the grid layout documentation. - Legend
Binding - 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
onproperty. - Legend
Binding Enum - Legend
Builder Error - Error type for LegendBuilder
- Legend
Config Builder Error - Error type for LegendConfigBuilder
- Legend
Orient - 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". - Legend
Resolve MapBuilder Error - Error type for LegendResolveMapBuilder
- Legend
Stream Binding Builder Error - Error type for LegendStreamBindingBuilder
- Legend
Text - 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
encodingwill override a style default. - Legend
Type - The type of the legend. Use
"symbol"to create a discrete legend and"gradient"for a continuous color gradient. - Legend
Union - Line
- Line
Config Builder Error - Error type for LineConfigBuilder
- Logical
NotPredicate Range - An array of inclusive minimum and maximum values for a field value of a data item to be included in the filtered data.
- Longitude2
Class Builder Error - Error type for Longitude2ClassBuilder
- Longitude
Class Builder Error - Error type for LongitudeClassBuilder
- Lookup
Builder Error - Error type for LookupBuilder
- Lt
- Magenta
Expr RefBuilder Error - Error type for MagentaExprRefBuilder
- 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"). - Mark
Config Builder Error - Error type for MarkConfigBuilder
- Mark
Config Expr OrSignal RefBuilder Error - Error type for MarkConfigExprOrSignalRefBuilder
- Mark
Config Expr OrSignal RefColor - Default color.
- Mark
Config Expr OrSignal RefFill - Mark
Config Expr OrSignal RefInterpolate - Mark
Config Expr OrSignal RefTooltip - Mark
DefExtent - Mark
Prop DefNumber Builder Error - Error type for MarkPropDefNumberBuilder
- Mark
Prop DefString Null Type ForShape Builder Error - Error type for MarkPropDefStringNullTypeForShapeBuilder
- Mark
Type - Month
- One of: (1) integer value representing the month from
1-12.1represents January; (2) case-insensitive month name (e.g.,"January"); (3) case-insensitive, 3-character short month name (e.g.,"Jan"). - Multi
Selection Config Builder Error - Error type for MultiSelectionConfigBuilder
- 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].
- Nice
Time Interval Step Builder Error - Error type for NiceTimeIntervalStepBuilder
- NonArg
Aggregate Op - 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. - Normalized
Spec Builder Error - Error type for NormalizedSpecBuilder
- Normalized
Spec Spec Builder Error - Error type for NormalizedSpecSpecBuilder
- OnDerived
Stream Builder Error - Error type for OnDerivedStreamBuilder
- 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
- Opacity
Class Builder Error - Error type for OpacityClassBuilder
- Order
- Order
DefBuilder Error - Error type for OrderDefBuilder
- Order
Field DefBuilder Error - Error type for OrderFieldDefBuilder
- Order
Field DefCondition - 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.sortLineByis not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored. - Overlay
Mark DefBuilder Error - Error type for OverlayMarkDefBuilder
- 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. - Parameter
Builder Error - Error type for ParameterBuilder
- Point
Enum - Point
Union - Predicate
Builder Error - Error type for PredicateBuilder
- Predicate
Composition Element - Predicate for triggering the condition
- Primitive
Value - A constant value in data domain.
- Projection
Builder Error - Error type for ProjectionBuilder
- Projection
Type - 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. - Purple
Binding Builder Error - Error type for PurpleBindingBuilder
- Purple
Conditional Expr RefBuilder Error - Error type for PurpleConditionalExprRefBuilder
- Purple
Conditional Predicate Value DefFont Style Null Expr RefBuilder Error - Error type for PurpleConditionalPredicateValueDefFontStyleNullExprRefBuilder
- Purple
Conditional Predicate Value DefFont Weight Null Expr RefBuilder Error - Error type for PurpleConditionalPredicateValueDefFontWeightNullExprRefBuilder
- Purple
Conditional Predicate Value DefNumber Null Expr RefBuilder Error - Error type for PurpleConditionalPredicateValueDefNumberNullExprRefBuilder
- Purple
Conditional Predicate Value DefString Null Expr RefBuilder Error - Error type for PurpleConditionalPredicateValueDefStringNullExprRefBuilder
- Purple
Conditional Value DefString Expr RefBuilder Error - Error type for PurpleConditionalValueDefStringExprRefBuilder
- Purple
Expr RefBuilder Error - Error type for PurpleExprRefBuilder
- Purple
Legend Binding - 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.
- Purple
Linear Gradient Builder Error - Error type for PurpleLinearGradientBuilder
- Purple
Range - Purple
Sort Array - Purple
Stream - Purple
Text Baseline - Purple
Tooltip Content Builder Error - Error type for PurpleTooltipContentBuilder
- Radius2
Class Builder Error - Error type for Radius2ClassBuilder
- Radius
Class Builder Error - Error type for RadiusClassBuilder
- Range
Class Builder Error - Error type for RangeClassBuilder
- Range
Date Time Builder Error - Error type for RangeDateTimeBuilder
- Range
Enum - RangeM
- Range
Range Builder Error - Error type for RangeRangeBuilder
- Range
Text - 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
encodingwill override a style default. - Range
Value - Rect
Config Builder Error - Error type for RectConfigBuilder
- Removable
Value - Wrapper for a field that can be either the default value, null or specified
- Repeat
Enum - Repeat
Mapping Builder Error - Error type for RepeatMappingBuilder
- Repeat
RefBuilder Error - Error type for RepeatRefBuilder
- Repeat
RefClass Builder Error - Error type for RepeatRefClassBuilder
- Repeat
Union - Resolve
Builder Error - Error type for ResolveBuilder
- Resolve
Mode - RowCol
Boolean Builder Error - Error type for RowColBooleanBuilder
- RowCol
Layout Align Builder Error - Error type for RowColLayoutAlignBuilder
- RowCol
Number Builder Error - Error type for RowColNumberBuilder
- RowColumn
Encoding Field DefBuilder Error - Error type for RowColumnEncodingFieldDefBuilder
- Scale
BinParams Builder Error - Error type for ScaleBinParamsBuilder
- Scale
Bins - 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. - Scale
Builder Error - Error type for ScaleBuilder
- Scale
Config Builder Error - Error type for ScaleConfigBuilder
- Scale
Interpolate - 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,cubehelixandcubehelix-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. - Scale
Interpolate Enum - Scale
Range - The range of the scale. One of:
- Scale
Resolve MapBuilder Error - Error type for ScaleResolveMapBuilder
- Scale
Type - 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. - Scheme
Params Builder Error - Error type for SchemeParamsBuilder
- Selection
Builder Error - Error type for SelectionBuilder
- Selection
Composition Element - Filter using a selection name or a logical composition of selection names.
- Selection
Config Builder Error - Error type for SelectionConfigBuilder
- Selection
DefBuilder Error - Error type for SelectionDefBuilder
- Selection
DefType - Determines the default event processing and data query for the selection. Vega-Lite currently supports three selection types:
- Selection
Init - Selection
Init Interval - Selection
Resolution - 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.
- Sequence
Params Builder Error - Error type for SequenceParamsBuilder
- Shape
Condition - Single
Bind - 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
onproperty. - Single
DefUnit Channel - The encoding channel to extract selected values for, when a selection is projected over multiple fields or encodings.
- Single
Selection Config Builder Error - Error type for SingleSelectionConfigBuilder
- Size
Class Builder Error - Error type for SizeClassBuilder
- Sort
- The sort order. One of
"ascending"(default) or"descending". - Sort
ByChannel - The encoding channel to
sort by (e.g.,
"x","y") - Sort
Encoding Sort Field Builder Error - Error type for SortEncodingSortFieldBuilder
- Sort
Field Builder Error - Error type for SortFieldBuilder
- Sort
Order - The sort order. One of
"ascending"(default) or"descending". - Sort
Union - Sort order for the encoded field.
- Source
- Spacing
- Spec
Builder Error - Error type for SpecBuilder
- Spec
Encoding Builder Error - Error type for SpecEncodingBuilder
- Sphere
Class Builder Error - Error type for SphereClassBuilder
- Sphere
Union - Generate sphere GeoJSON data for the full globe.
- Stack
- Stack
Offset - Mode for stacking marks. One of
"zero"(default),"center", or"normalize". The"zero"offset will stack starting at0. 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]. - Standard
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’. - Step
Builder Error - Error type for StepBuilder
- Sticky
Conditional Predicate Value DefNumber Null Expr Ref - Sticky
Expr RefBuilder Error - Error type for StickyExprRefBuilder
- Sticky
Linear Gradient Builder Error - Error type for StickyLinearGradientBuilder
- Stream
Builder Error - Error type for StreamBuilder
- String
Field DefBuilder Error - Error type for StringFieldDefBuilder
- Stroke
Cap - The stroke cap for line ending style. One of
"butt","round", or"square". - Stroke
Class Builder Error - Error type for StrokeClassBuilder
- Stroke
Dash Condition - Stroke
Dash Union - A constant value in visual domain (e.g.,
"red"/"#0099ff"/ gradient definition for color, values between0to1for opacity). - Stroke
Join - The stroke line join method. One of
"miter","round"or"bevel". - Stroke
Join Union - Stroke
Opacity Class Builder Error - Error type for StrokeOpacityClassBuilder
- Stroke
Width Class Builder Error - Error type for StrokeWidthClassBuilder
- Style
Color - Style
Fill - Style
Orient - Style
Tooltip - Style
Value Builder Error - Error type for StyleValueBuilder
- Tentacled
Conditional Predicate Value DefNumber Null Expr Ref - Tentacled
Expr RefBuilder Error - Error type for TentacledExprRefBuilder
- Tentacled
Linear Gradient Builder Error - Error type for TentacledLinearGradientBuilder
- Text
Baseline - Text
Condition - Text
DefBuilder Error - Error type for TextDefBuilder
- Text
Direction - 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. - Theta2
Class Builder Error - Error type for Theta2ClassBuilder
- Theta
Class Builder Error - Error type for ThetaClassBuilder
- Tick
Band Enum - 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 - Tick
Band Union - Tick
Config Builder Error - Error type for TickConfigBuilder
- Tick
Count - Tick
Count Time Interval Step Builder Error - Error type for TickCountTimeIntervalStepBuilder
- Time
Interval - Time
Unit - Defines how date-time values should be binned.
- Time
Unit Params Builder Error - Error type for TimeUnitParamsBuilder
- Time
Unit Union - Time unit for the field to be tested.
- Title
Align Union - Title
Anchor Enum - Title
Anchor Union - Title
Orient - Default title orientation (
"top","bottom","left", or"right") - Title
Orient Union - Title
Params Builder Error - Error type for TitleParamsBuilder
- Title
Params Orient - Title
Union - Title for the plot.
- Transform
Builder Error - Error type for TransformBuilder
- Transform
Method - 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’. - Typed
Field DefBuilder Error - Error type for TypedFieldDefBuilder
- UrlClass
Builder Error - Error type for UrlClassBuilder
- UrlData
Builder Error - Error type for UrlDataBuilder
- UrlData
Inline Dataset - 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
dataproperty. Strings are parsed according to the specified format type. - Value
Enum - Value
Linear Gradient Builder Error - Error type for ValueLinearGradientBuilder
- Value
Union - Values
- Explicitly set the visible axis tick values.
- Vegalite
Align - The alignment to apply to grid rows and columns. The supported string values are
"all","each", and"none". - Vegalite
Builder Error - Error type for VegaliteBuilder
- Vegalite
Spec Builder Error - Error type for VegaliteSpecBuilder
- View
Background Builder Error - Error type for ViewBackgroundBuilder
- View
Config Builder Error - Error type for ViewConfigBuilder
- Window
Field DefBuilder Error - Error type for WindowFieldDefBuilder
- X2Class
Builder Error - Error type for X2ClassBuilder
- XClass
Builder Error - Error type for XClassBuilder
- XEnum
- XError2
Class Builder Error - Error type for XError2ClassBuilder
- XError
Class Builder Error - Error type for XErrorClassBuilder
- XUnion
- Y2Class
Builder Error - Error type for Y2ClassBuilder
- YClass
Builder Error - Error type for YClassBuilder
- YEnum
- YError2
Class Builder Error - Error type for YError2ClassBuilder
- YError
Class Builder Error - Error type for YErrorClassBuilder
- YUnion
Traits§
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.