API Reference

This is the class and function reference of Altair, and the following content is generated automatically from the code documentation strings. Please refer to the full user guide for further details, as this low-level documentation may not be enough to give full guidelines on their use.

Top-Level Objects

Chart Create a basic Altair/Vega-Lite chart.
LayerChart A Chart with layers within a single panel
HConcatChart A chart with horizontally-concatenated facets
VConcatChart A chart with vertically-concatenated facets
FacetChart A Chart with layers within a single panel
RepeatChart A chart repeated across rows and columns with small changes

Encoding Channels

Color Color schema wrapper
ColorValue ColorValue schema wrapper
Column Column schema wrapper
Detail Detail schema wrapper
Fill Fill schema wrapper
FillValue FillValue schema wrapper
Href Href schema wrapper
HrefValue HrefValue schema wrapper
Key Key schema wrapper
Latitude Latitude schema wrapper
Latitude2 Latitude2 schema wrapper
Longitude Longitude schema wrapper
Longitude2 Longitude2 schema wrapper
Opacity Opacity schema wrapper
OpacityValue OpacityValue schema wrapper
Order Order schema wrapper
Row Row schema wrapper
Shape Shape schema wrapper
ShapeValue ShapeValue schema wrapper
Size Size schema wrapper
SizeValue SizeValue schema wrapper
Stroke Stroke schema wrapper
StrokeValue StrokeValue schema wrapper
Text Text schema wrapper
TextValue TextValue schema wrapper
Tooltip Tooltip schema wrapper
TooltipValue TooltipValue schema wrapper
X X schema wrapper
XValue XValue schema wrapper
X2 X2 schema wrapper
X2Value X2Value schema wrapper
Y Y schema wrapper
YValue YValue schema wrapper
Y2 Y2 schema wrapper
Y2Value Y2Value schema wrapper

API Functions

layer layer multiple charts
vconcat Concatenate charts vertically
hconcat Concatenate charts horizontally
repeat Tie a channel to the row or column within a repeated chart
value Specify a value for use in an encoding
selection Create a named selection.
selection_interval Create a selection with type=’interval’
selection_multi Create a selection with type=’multi’
selection_single Create a selection with type=’single’
binding A generic binding
binding_checkbox A checkbox binding
binding_radio A radio button binding
binding_range A range binding
binding_select A select binding
condition A conditional attribute or encoding
topo_feature A convenience function for extracting features from a topojson url

Low-Level Schema Wrappers

Aggregate Aggregate schema wrapper
AggregateOp AggregateOp schema wrapper
AggregateTransform AggregateTransform schema wrapper
AggregatedFieldDef AggregatedFieldDef schema wrapper
Anchor Anchor schema wrapper
AnyMark AnyMark schema wrapper
AreaConfig AreaConfig schema wrapper
AutoSizeParams AutoSizeParams schema wrapper
AutosizeType AutosizeType schema wrapper
Axis Axis schema wrapper
AxisConfig AxisConfig schema wrapper
AxisOrient AxisOrient schema wrapper
AxisResolveMap AxisResolveMap schema wrapper
BarConfig BarConfig schema wrapper
Baseline Baseline schema wrapper
BasicType BasicType schema wrapper
BinParams BinParams schema wrapper
BinTransform BinTransform schema wrapper
BrushConfig BrushConfig schema wrapper
CalculateTransform CalculateTransform schema wrapper
CompositeUnitSpec CompositeUnitSpec schema wrapper
CompositeUnitSpecAlias CompositeUnitSpecAlias schema wrapper
ConditionalFieldDef ConditionalFieldDef schema wrapper
ConditionalMarkPropFieldDef ConditionalMarkPropFieldDef schema wrapper
ConditionalPredicateFieldDef ConditionalPredicateFieldDef schema wrapper
ConditionalPredicateMarkPropFieldDef ConditionalPredicateMarkPropFieldDef schema wrapper
ConditionalPredicateTextFieldDef ConditionalPredicateTextFieldDef schema wrapper
ConditionalPredicateValueDef ConditionalPredicateValueDef schema wrapper
ConditionalSelectionFieldDef ConditionalSelectionFieldDef schema wrapper
ConditionalSelectionMarkPropFieldDef ConditionalSelectionMarkPropFieldDef schema wrapper
ConditionalSelectionTextFieldDef ConditionalSelectionTextFieldDef schema wrapper
ConditionalSelectionValueDef ConditionalSelectionValueDef schema wrapper
ConditionalTextFieldDef ConditionalTextFieldDef schema wrapper
ConditionalValueDef ConditionalValueDef schema wrapper
Config Config schema wrapper
CsvDataFormat CsvDataFormat schema wrapper
Cursor Cursor schema wrapper
Data Data schema wrapper
DataFormat DataFormat schema wrapper
Datasets Datasets schema wrapper
DateTime DateTime schema wrapper
Day Day schema wrapper
DictInlineDataset DictInlineDataset schema wrapper
Dir Dir schema wrapper
DsvDataFormat DsvDataFormat schema wrapper
Encoding Encoding schema wrapper
EncodingSortField EncodingSortField schema wrapper
EncodingWithFacet EncodingWithFacet schema wrapper
FacetFieldDef FacetFieldDef schema wrapper
FacetMapping FacetMapping schema wrapper
FacetSpec FacetSpec schema wrapper
FacetedCompositeUnitSpecAlias FacetedCompositeUnitSpecAlias schema wrapper
FieldDef FieldDef schema wrapper
FieldDefWithCondition FieldDefWithCondition schema wrapper
FieldEqualPredicate FieldEqualPredicate schema wrapper
FieldGTEPredicate FieldGTEPredicate schema wrapper
FieldGTPredicate FieldGTPredicate schema wrapper
FieldLTEPredicate FieldLTEPredicate schema wrapper
FieldLTPredicate FieldLTPredicate schema wrapper
FieldOneOfPredicate FieldOneOfPredicate schema wrapper
FieldRangePredicate FieldRangePredicate schema wrapper
FilterTransform FilterTransform schema wrapper
FontStyle FontStyle schema wrapper
FontWeight FontWeight schema wrapper
FontWeightNumber FontWeightNumber schema wrapper
FontWeightString FontWeightString schema wrapper
GeoType GeoType schema wrapper
HConcatSpec HConcatSpec schema wrapper
Header Header schema wrapper
HeaderConfig HeaderConfig schema wrapper
HorizontalAlign HorizontalAlign schema wrapper
InlineData InlineData schema wrapper
InlineDataset InlineDataset schema wrapper
Interpolate Interpolate schema wrapper
IntervalSelection IntervalSelection schema wrapper
IntervalSelectionConfig IntervalSelectionConfig schema wrapper
JsonDataFormat JsonDataFormat schema wrapper
LayerSpec LayerSpec schema wrapper
Legend Legend schema wrapper
LegendConfig LegendConfig schema wrapper
LegendOrient LegendOrient schema wrapper
LegendResolveMap LegendResolveMap schema wrapper
LineConfig LineConfig schema wrapper
LocalMultiTimeUnit LocalMultiTimeUnit schema wrapper
LocalSingleTimeUnit LocalSingleTimeUnit schema wrapper
LogicalAndPredicate LogicalAndPredicate schema wrapper
LogicalNotPredicate LogicalNotPredicate schema wrapper
LogicalOperandPredicate LogicalOperandPredicate schema wrapper
LogicalOrPredicate LogicalOrPredicate schema wrapper
LookupData LookupData schema wrapper
LookupTransform LookupTransform schema wrapper
Mark Mark schema wrapper
MarkConfig MarkConfig schema wrapper
MarkDef MarkDef schema wrapper
MarkPropFieldDefWithCondition MarkPropFieldDefWithCondition schema wrapper
MarkPropValueDefWithCondition MarkPropValueDefWithCondition schema wrapper
Month Month schema wrapper
MultiSelection MultiSelection schema wrapper
MultiSelectionConfig MultiSelectionConfig schema wrapper
MultiTimeUnit MultiTimeUnit schema wrapper
NamedData NamedData schema wrapper
NiceTime NiceTime schema wrapper
OrderFieldDef OrderFieldDef schema wrapper
Orient Orient schema wrapper
OverlayMarkDef OverlayMarkDef schema wrapper
Padding Padding schema wrapper
Parse Parse schema wrapper
PositionFieldDef PositionFieldDef schema wrapper
Predicate Predicate schema wrapper
Projection Projection schema wrapper
ProjectionConfig ProjectionConfig schema wrapper
ProjectionType ProjectionType schema wrapper
RangeConfig RangeConfig schema wrapper
RangeConfigValue RangeConfigValue schema wrapper
Repeat Repeat schema wrapper
RepeatRef RepeatRef schema wrapper
RepeatSpec RepeatSpec schema wrapper
Resolve Resolve schema wrapper
ResolveMode ResolveMode schema wrapper
Root Root schema wrapper
RowColVgLayoutAlign RowColVgLayoutAlign schema wrapper
RowColboolean RowColboolean schema wrapper
RowColnumber RowColnumber schema wrapper
Scale Scale schema wrapper
ScaleConfig ScaleConfig schema wrapper
ScaleInterpolate ScaleInterpolate schema wrapper
ScaleInterpolateParams ScaleInterpolateParams schema wrapper
ScaleResolveMap ScaleResolveMap schema wrapper
ScaleType ScaleType schema wrapper
SchemaBase Base class for schema wrappers.
SchemeParams SchemeParams schema wrapper
SelectionAnd SelectionAnd schema wrapper
SelectionConfig SelectionConfig schema wrapper
SelectionDef SelectionDef schema wrapper
SelectionDomain SelectionDomain schema wrapper
SelectionNot SelectionNot schema wrapper
SelectionOperand SelectionOperand schema wrapper
SelectionOr SelectionOr schema wrapper
SelectionPredicate SelectionPredicate schema wrapper
SelectionResolution SelectionResolution schema wrapper
SingleDefChannel SingleDefChannel schema wrapper
SingleSelection SingleSelection schema wrapper
SingleSelectionConfig SingleSelectionConfig schema wrapper
SingleTimeUnit SingleTimeUnit schema wrapper
Sort Sort schema wrapper
SortField SortField schema wrapper
SortOrder SortOrder schema wrapper
Spec Spec schema wrapper
StackOffset StackOffset schema wrapper
StrokeCap StrokeCap schema wrapper
StrokeJoin StrokeJoin schema wrapper
StyleConfigIndex StyleConfigIndex schema wrapper
TextBaseline TextBaseline schema wrapper
TextConfig TextConfig schema wrapper
TextFieldDef TextFieldDef schema wrapper
TextFieldDefWithCondition TextFieldDefWithCondition schema wrapper
TextValueDefWithCondition TextValueDefWithCondition schema wrapper
TickConfig TickConfig schema wrapper
TimeUnit TimeUnit schema wrapper
TimeUnitTransform TimeUnitTransform schema wrapper
TitleOrient TitleOrient schema wrapper
TitleParams TitleParams schema wrapper
TopLevelFacetSpec TopLevelFacetSpec schema wrapper
TopLevelFacetedUnitSpec TopLevelFacetedUnitSpec schema wrapper
TopLevelHConcatSpec TopLevelHConcatSpec schema wrapper
TopLevelLayerSpec TopLevelLayerSpec schema wrapper
TopLevelRepeatSpec TopLevelRepeatSpec schema wrapper
TopLevelSpec TopLevelSpec schema wrapper
TopLevelVConcatSpec TopLevelVConcatSpec schema wrapper
TopoDataFormat TopoDataFormat schema wrapper
Transform Transform schema wrapper
Type Type schema wrapper
Undefined A singleton object for marking undefined attributes
UrlData UrlData schema wrapper
UtcMultiTimeUnit UtcMultiTimeUnit schema wrapper
UtcSingleTimeUnit UtcSingleTimeUnit schema wrapper
VConcatSpec VConcatSpec schema wrapper
ValueDef ValueDef schema wrapper
ValueDefWithCondition ValueDefWithCondition schema wrapper
VegaLiteSchema
VerticalAlign VerticalAlign schema wrapper
VgAxisConfig VgAxisConfig schema wrapper
VgBinding VgBinding schema wrapper
VgCheckboxBinding VgCheckboxBinding schema wrapper
VgComparatorOrder VgComparatorOrder schema wrapper
VgEventStream VgEventStream schema wrapper
VgGenericBinding VgGenericBinding schema wrapper
VgLayoutAlign VgLayoutAlign schema wrapper
VgMarkConfig VgMarkConfig schema wrapper
VgProjectionType VgProjectionType schema wrapper
VgRadioBinding VgRadioBinding schema wrapper
VgRangeBinding VgRangeBinding schema wrapper
VgScheme VgScheme schema wrapper
VgSelectBinding VgSelectBinding schema wrapper
VgTitleConfig VgTitleConfig schema wrapper
ViewConfig ViewConfig schema wrapper
WindowFieldDef WindowFieldDef schema wrapper
WindowOnlyOp WindowOnlyOp schema wrapper
WindowTransform WindowTransform schema wrapper