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#
Create a basic Altair/Vega-Lite chart. |
|
A chart with horizontally-concatenated facets Mapping(required=[concat]) |
|
A Chart with layers within a single panel Mapping(required=[data, facet, spec]) |
|
A chart with horizontally-concatenated facets Mapping(required=[hconcat]) |
|
A Chart with layers within a single panel Mapping(required=[layer]) |
|
A chart repeated across rows and columns with small changes anyOf(Mapping(required=[repeat, spec]), Mapping(required=[repeat, spec])) |
|
Mixin for top-level chart objects such as Chart, LayeredChart, etc. |
|
A chart with vertically-concatenated facets Mapping(required=[vconcat]) |
Encoding Channels#
Angle schema wrapper |
|
AngleDatum schema wrapper |
|
AngleValue schema wrapper |
|
Color schema wrapper |
|
ColorDatum schema wrapper |
|
ColorValue schema wrapper |
|
Column schema wrapper |
|
Description schema wrapper |
|
DescriptionValue schema wrapper |
|
Detail schema wrapper |
|
Facet schema wrapper |
|
Fill schema wrapper |
|
FillDatum schema wrapper |
|
FillOpacity schema wrapper |
|
FillOpacityDatum schema wrapper |
|
FillOpacityValue schema wrapper |
|
FillValue schema wrapper |
|
Href schema wrapper |
|
HrefValue schema wrapper |
|
Key schema wrapper |
|
Latitude schema wrapper |
|
Latitude2 schema wrapper |
|
Latitude2Datum schema wrapper |
|
Latitude2Value schema wrapper |
|
LatitudeDatum schema wrapper |
|
Longitude schema wrapper |
|
Longitude2 schema wrapper |
|
Longitude2Datum schema wrapper |
|
Longitude2Value schema wrapper |
|
LongitudeDatum schema wrapper |
|
Opacity schema wrapper |
|
OpacityDatum schema wrapper |
|
OpacityValue schema wrapper |
|
Order schema wrapper |
|
OrderValue schema wrapper |
|
Radius schema wrapper |
|
Radius2 schema wrapper |
|
Radius2Datum schema wrapper |
|
Radius2Value schema wrapper |
|
RadiusDatum schema wrapper |
|
RadiusValue schema wrapper |
|
Row schema wrapper |
|
Shape schema wrapper |
|
ShapeDatum schema wrapper |
|
ShapeValue schema wrapper |
|
Size schema wrapper |
|
SizeDatum schema wrapper |
|
SizeValue schema wrapper |
|
Stroke schema wrapper |
|
StrokeDash schema wrapper |
|
StrokeDashDatum schema wrapper |
|
StrokeDashValue schema wrapper |
|
StrokeDatum schema wrapper |
|
StrokeOpacity schema wrapper |
|
StrokeOpacityDatum schema wrapper |
|
StrokeOpacityValue schema wrapper |
|
StrokeValue schema wrapper |
|
StrokeWidth schema wrapper |
|
StrokeWidthDatum schema wrapper |
|
StrokeWidthValue schema wrapper |
|
Text schema wrapper |
|
TextDatum schema wrapper |
|
TextValue schema wrapper |
|
Theta schema wrapper |
|
Theta2 schema wrapper |
|
Theta2Datum schema wrapper |
|
Theta2Value schema wrapper |
|
ThetaDatum schema wrapper |
|
ThetaValue schema wrapper |
|
Tooltip schema wrapper |
|
TooltipValue schema wrapper |
|
Url schema wrapper |
|
UrlValue schema wrapper |
|
X schema wrapper |
|
X2 schema wrapper |
|
X2Datum schema wrapper |
|
X2Value schema wrapper |
|
XDatum schema wrapper |
|
XError schema wrapper |
|
XError2 schema wrapper |
|
XError2Value schema wrapper |
|
XErrorValue schema wrapper |
|
XOffset schema wrapper |
|
XOffsetDatum schema wrapper |
|
XOffsetValue schema wrapper |
|
XValue schema wrapper |
|
Y schema wrapper |
|
Y2 schema wrapper |
|
Y2Datum schema wrapper |
|
Y2Value schema wrapper |
|
YDatum schema wrapper |
|
YError schema wrapper |
|
YError2 schema wrapper |
|
YError2Value schema wrapper |
|
YErrorValue schema wrapper |
|
YOffset schema wrapper |
|
YOffsetDatum schema wrapper |
|
YOffsetValue schema wrapper |
|
YValue schema wrapper |
API Functions#
A generic binding anyOf( |
|
A checkbox binding Mapping(required=[input]) |
|
A radio button binding Mapping(required=[input, options]) |
|
A range binding Mapping(required=[input]) |
|
A select binding Mapping(required=[input, options]) |
|
Concatenate charts horizontally |
|
A conditional attribute or encoding |
|
Graticule generator. |
|
Concatenate charts horizontally |
|
layer multiple charts |
|
Create a named parameter. |
|
Tie a channel to the row or column within a repeated chart |
|
Create a selection. |
|
Create a selection parameter with type='interval' Mapping(required=[type]) |
|
PointSelectionConfig schema wrapper |
|
PointSelectionConfig schema wrapper |
|
Sequence generator. |
|
Sphere generator. |
|
A convenience function for extracting features from a topojson url |
|
Specify a value for use in an encoding |
|
Concatenate charts vertically |
Low-Level Schema Wrappers#
Aggregate schema wrapper |
|
AggregateOp schema wrapper |
|
AggregateTransform schema wrapper |
|
AggregatedFieldDef schema wrapper |
|
Align schema wrapper |
|
AllSortString schema wrapper |
|
AnyMark schema wrapper |
|
AnyMarkConfig schema wrapper |
|
AreaConfig schema wrapper |
|
ArgmaxDef schema wrapper |
|
ArgminDef schema wrapper |
|
AutoSizeParams schema wrapper |
|
AutosizeType schema wrapper |
|
Axis schema wrapper |
|
AxisConfig schema wrapper |
|
AxisOrient schema wrapper |
|
AxisResolveMap schema wrapper |
|
BarConfig schema wrapper |
|
BaseTitleNoValueRefs schema wrapper |
|
Baseline schema wrapper |
|
BinExtent schema wrapper |
|
BinParams schema wrapper |
|
BinTransform schema wrapper |
|
BindCheckbox schema wrapper |
|
BindDirect schema wrapper |
|
BindInput schema wrapper |
|
BindRadioSelect schema wrapper |
|
BindRange schema wrapper |
|
Binding schema wrapper |
|
Blend schema wrapper |
|
BoxPlot schema wrapper |
|
BoxPlotConfig schema wrapper |
|
BoxPlotDef schema wrapper |
|
BrushConfig schema wrapper |
|
CalculateTransform schema wrapper |
|
Categorical schema wrapper |
|
Color schema wrapper |
|
ColorDef schema wrapper |
|
ColorName schema wrapper |
|
ColorScheme schema wrapper |
|
CompositeMark schema wrapper |
|
CompositeMarkDef schema wrapper |
|
CompositionConfig schema wrapper |
|
ConcatSpecGenericSpec schema wrapper |
|
ConditionalAxisColor schema wrapper |
|
ConditionalAxisLabelAlign schema wrapper |
|
ConditionalAxisLabelBaseline schema wrapper |
|
ConditionalAxisLabelFontStyle schema wrapper |
|
ConditionalAxisLabelFontWeight schema wrapper |
|
ConditionalAxisNumber schema wrapper |
|
ConditionalAxisNumberArray schema wrapper |
|
ConditionalAxisPropertyAlignnull schema wrapper |
|
ConditionalAxisPropertyColornull schema wrapper |
|
ConditionalAxisPropertyFontStylenull schema wrapper |
|
ConditionalAxisPropertyFontWeightnull schema wrapper |
|
ConditionalAxisPropertyTextBaselinenull schema wrapper |
|
ConditionalAxisPropertynumberArraynull schema wrapper |
|
ConditionalAxisPropertynumbernull schema wrapper |
|
ConditionalAxisPropertystringnull schema wrapper |
|
ConditionalAxisString schema wrapper |
|
ConditionalMarkPropFieldOrDatumDef schema wrapper |
|
ConditionalMarkPropFieldOrDatumDefTypeForShape schema wrapper |
|
ConditionalParameterMarkPropFieldOrDatumDef schema wrapper |
|
ConditionalParameterMarkPropFieldOrDatumDefTypeForShape schema wrapper |
|
ConditionalParameterStringFieldDef schema wrapper |
|
ConditionalParameterValueDefGradientstringnullExprRef schema wrapper |
|
ConditionalParameterValueDefTextExprRef schema wrapper |
|
ConditionalParameterValueDefnumber schema wrapper |
|
ConditionalParameterValueDefnumberArrayExprRef schema wrapper |
|
ConditionalParameterValueDefnumberExprRef schema wrapper |
|
ConditionalParameterValueDefstringExprRef schema wrapper |
|
ConditionalParameterValueDefstringnullExprRef schema wrapper |
|
ConditionalPredicateMarkPropFieldOrDatumDef schema wrapper |
|
ConditionalPredicateMarkPropFieldOrDatumDefTypeForShape schema wrapper |
|
ConditionalPredicateStringFieldDef schema wrapper |
|
ConditionalPredicateValueDefAlignnullExprRef schema wrapper |
|
ConditionalPredicateValueDefColornullExprRef schema wrapper |
|
ConditionalPredicateValueDefFontStylenullExprRef schema wrapper |
|
ConditionalPredicateValueDefFontWeightnullExprRef schema wrapper |
|
ConditionalPredicateValueDefGradientstringnullExprRef schema wrapper |
|
ConditionalPredicateValueDefTextBaselinenullExprRef schema wrapper |
|
ConditionalPredicateValueDefTextExprRef schema wrapper |
|
ConditionalPredicateValueDefnumber schema wrapper |
|
ConditionalPredicateValueDefnumberArrayExprRef schema wrapper |
|
ConditionalPredicateValueDefnumberArraynullExprRef schema wrapper |
|
ConditionalPredicateValueDefnumberExprRef schema wrapper |
|
ConditionalPredicateValueDefnumbernullExprRef schema wrapper |
|
ConditionalPredicateValueDefstringExprRef schema wrapper |
|
ConditionalPredicateValueDefstringnullExprRef schema wrapper |
|
ConditionalStringFieldDef schema wrapper |
|
ConditionalValueDefGradientstringnullExprRef schema wrapper |
|
ConditionalValueDefTextExprRef schema wrapper |
|
ConditionalValueDefnumber schema wrapper |
|
ConditionalValueDefnumberArrayExprRef schema wrapper |
|
ConditionalValueDefnumberExprRef schema wrapper |
|
ConditionalValueDefstringExprRef schema wrapper |
|
ConditionalValueDefstringnullExprRef schema wrapper |
|
Config schema wrapper |
|
CsvDataFormat schema wrapper |
|
Cursor schema wrapper |
|
Cyclical schema wrapper |
|
Data schema wrapper |
|
DataFormat schema wrapper |
|
DataSource schema wrapper |
|
Datasets schema wrapper |
|
DateTime schema wrapper |
|
DatumDef schema wrapper |
|
Day schema wrapper |
|
DensityTransform schema wrapper |
|
DerivedStream schema wrapper |
|
DictInlineDataset schema wrapper |
|
DictSelectionInit schema wrapper |
|
DictSelectionInitInterval schema wrapper |
|
Diverging schema wrapper |
|
DomainUnionWith schema wrapper |
|
DsvDataFormat schema wrapper |
|
Element schema wrapper |
|
Encoding schema wrapper |
|
EncodingSortField schema wrapper |
|
ErrorBand schema wrapper |
|
ErrorBandConfig schema wrapper |
|
ErrorBandDef schema wrapper |
|
ErrorBar schema wrapper |
|
ErrorBarConfig schema wrapper |
|
ErrorBarDef schema wrapper |
|
ErrorBarExtent schema wrapper |
|
EventStream schema wrapper |
|
EventType schema wrapper |
|
Expr schema wrapper |
|
ExprRef schema wrapper |
|
FacetEncodingFieldDef schema wrapper |
|
FacetFieldDef schema wrapper |
|
FacetMapping schema wrapper |
|
FacetSpec schema wrapper |
|
FacetedEncoding schema wrapper |
|
FacetedUnitSpec schema wrapper |
|
Field schema wrapper |
|
FieldDefWithoutScale schema wrapper |
|
FieldEqualPredicate schema wrapper |
|
FieldGTEPredicate schema wrapper |
|
FieldGTPredicate schema wrapper |
|
FieldLTEPredicate schema wrapper |
|
FieldLTPredicate schema wrapper |
|
FieldName schema wrapper |
|
FieldOneOfPredicate schema wrapper |
|
FieldOrDatumDefWithConditionDatumDefGradientstringnull schema wrapper |
|
FieldOrDatumDefWithConditionDatumDefnumber schema wrapper |
|
FieldOrDatumDefWithConditionDatumDefnumberArray schema wrapper |
|
FieldOrDatumDefWithConditionDatumDefstringnull schema wrapper |
|
|
FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull schema wrapper |
|
FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapestringnull schema wrapper |
FieldOrDatumDefWithConditionMarkPropFieldDefnumber schema wrapper |
|
FieldOrDatumDefWithConditionMarkPropFieldDefnumberArray schema wrapper |
|
FieldOrDatumDefWithConditionStringDatumDefText schema wrapper |
|
FieldOrDatumDefWithConditionStringFieldDefText schema wrapper |
|
FieldOrDatumDefWithConditionStringFieldDefstring schema wrapper |
|
FieldRangePredicate schema wrapper |
|
FieldValidPredicate schema wrapper |
|
FilterTransform schema wrapper |
|
Fit schema wrapper |
|
FlattenTransform schema wrapper |
|
FoldTransform schema wrapper |
|
FontStyle schema wrapper |
|
FontWeight schema wrapper |
|
Generator schema wrapper |
|
GenericUnitSpecEncodingAnyMark schema wrapper |
|
GeoJsonFeature schema wrapper |
|
GeoJsonFeatureCollection schema wrapper |
|
Gradient schema wrapper |
|
GradientStop schema wrapper |
|
GraticuleGenerator schema wrapper |
|
GraticuleParams schema wrapper |
|
HConcatSpecGenericSpec schema wrapper |
|
Header schema wrapper |
|
HeaderConfig schema wrapper |
|
HexColor schema wrapper |
|
ImputeMethod schema wrapper |
|
ImputeParams schema wrapper |
|
ImputeSequence schema wrapper |
|
ImputeTransform schema wrapper |
|
InlineData schema wrapper |
|
InlineDataset schema wrapper |
|
Interpolate schema wrapper |
|
IntervalSelectionConfig schema wrapper |
|
IntervalSelectionConfigWithoutType schema wrapper |
|
JoinAggregateFieldDef schema wrapper |
|
JoinAggregateTransform schema wrapper |
|
JsonDataFormat schema wrapper |
|
LabelOverlap schema wrapper |
|
LatLongDef schema wrapper |
|
LatLongFieldDef schema wrapper |
|
LayerRepeatMapping schema wrapper |
|
LayerRepeatSpec schema wrapper |
|
LayerSpec schema wrapper |
|
LayoutAlign schema wrapper |
|
Legend schema wrapper |
|
LegendBinding schema wrapper |
|
LegendConfig schema wrapper |
|
LegendOrient schema wrapper |
|
LegendResolveMap schema wrapper |
|
LegendStreamBinding schema wrapper |
|
LineConfig schema wrapper |
|
LinearGradient schema wrapper |
|
LocalMultiTimeUnit schema wrapper |
|
LocalSingleTimeUnit schema wrapper |
|
Locale schema wrapper |
|
LoessTransform schema wrapper |
|
LogicalAndPredicate schema wrapper |
|
LogicalNotPredicate schema wrapper |
|
LogicalOrPredicate schema wrapper |
|
LookupData schema wrapper |
|
LookupSelection schema wrapper |
|
LookupTransform schema wrapper |
|
Mark schema wrapper |
|
MarkConfig schema wrapper |
|
MarkDef schema wrapper |
|
MarkPropDefGradientstringnull schema wrapper |
|
MarkPropDefnumber schema wrapper |
|
MarkPropDefnumberArray schema wrapper |
|
MarkPropDefstringnullTypeForShape schema wrapper |
|
MarkType schema wrapper |
|
MergedStream schema wrapper |
|
Month schema wrapper |
|
MultiTimeUnit schema wrapper |
|
NamedData schema wrapper |
|
NonArgAggregateOp schema wrapper |
|
NonLayerRepeatSpec schema wrapper |
|
NonNormalizedSpec schema wrapper |
|
NumberLocale schema wrapper |
|
NumericArrayMarkPropDef schema wrapper |
|
NumericMarkPropDef schema wrapper |
|
OffsetDef schema wrapper |
|
OrderFieldDef schema wrapper |
|
OrderValueDef schema wrapper |
|
Orient schema wrapper |
|
Orientation schema wrapper |
|
OverlayMarkDef schema wrapper |
|
Padding schema wrapper |
|
A Parameter object |
|
ParameterExtent schema wrapper |
|
ParameterName schema wrapper |
|
ParameterPredicate schema wrapper |
|
Parse schema wrapper |
|
ParseValue schema wrapper |
|
PivotTransform schema wrapper |
|
PointSelectionConfig schema wrapper |
|
PointSelectionConfigWithoutType schema wrapper |
|
PolarDef schema wrapper |
|
Position2Def schema wrapper |
|
PositionDatumDef schema wrapper |
|
PositionDatumDefBase schema wrapper |
|
PositionDef schema wrapper |
|
PositionFieldDef schema wrapper |
|
PositionFieldDefBase schema wrapper |
|
PositionValueDef schema wrapper |
|
Predicate schema wrapper |
|
PredicateComposition schema wrapper |
|
PrimitiveValue schema wrapper |
|
Projection schema wrapper |
|
ProjectionConfig schema wrapper |
|
ProjectionType schema wrapper |
|
QuantileTransform schema wrapper |
|
RadialGradient schema wrapper |
|
RangeConfig schema wrapper |
|
RangeEnum schema wrapper |
|
RangeRaw schema wrapper |
|
RangeRawArray schema wrapper |
|
RangeScheme schema wrapper |
|
RectConfig schema wrapper |
|
RegressionTransform schema wrapper |
|
RelativeBandSize schema wrapper |
|
RepeatMapping schema wrapper |
|
RepeatRef schema wrapper |
|
RepeatSpec schema wrapper |
|
Resolve schema wrapper |
|
ResolveMode schema wrapper |
|
Root schema wrapper |
|
RowColLayoutAlign schema wrapper |
|
RowColboolean schema wrapper |
|
RowColnumber schema wrapper |
|
RowColumnEncodingFieldDef schema wrapper |
|
SampleTransform schema wrapper |
|
Scale schema wrapper |
|
ScaleBinParams schema wrapper |
|
ScaleBins schema wrapper |
|
ScaleConfig schema wrapper |
|
ScaleDatumDef schema wrapper |
|
ScaleFieldDef schema wrapper |
|
ScaleInterpolateEnum schema wrapper |
|
ScaleInterpolateParams schema wrapper |
|
ScaleResolveMap schema wrapper |
|
ScaleType schema wrapper |
|
Base class for schema wrappers. |
|
SchemeParams schema wrapper |
|
SecondaryFieldDef schema wrapper |
|
SelectionConfig schema wrapper |
|
SelectionInit schema wrapper |
|
SelectionInitInterval schema wrapper |
|
SelectionInitIntervalMapping schema wrapper |
|
SelectionInitMapping schema wrapper |
|
SelectionParameter schema wrapper |
|
SelectionResolution schema wrapper |
|
SelectionType schema wrapper |
|
SequenceGenerator schema wrapper |
|
SequenceParams schema wrapper |
|
SequentialMultiHue schema wrapper |
|
SequentialSingleHue schema wrapper |
|
ShapeDef schema wrapper |
|
SharedEncoding schema wrapper |
|
SingleDefUnitChannel schema wrapper |
|
SingleTimeUnit schema wrapper |
|
Sort schema wrapper |
|
SortArray schema wrapper |
|
SortByChannel schema wrapper |
|
SortByChannelDesc schema wrapper |
|
SortByEncoding schema wrapper |
|
SortField schema wrapper |
|
SortOrder schema wrapper |
|
Spec schema wrapper |
|
SphereGenerator schema wrapper |
|
StackOffset schema wrapper |
|
StackTransform schema wrapper |
|
StandardType schema wrapper |
|
Step schema wrapper |
|
StepFor schema wrapper |
|
Stream schema wrapper |
|
StringFieldDef schema wrapper |
|
StringFieldDefWithCondition schema wrapper |
|
StringValueDefWithCondition schema wrapper |
|
StrokeCap schema wrapper |
|
StrokeJoin schema wrapper |
|
StyleConfigIndex schema wrapper |
|
SymbolShape schema wrapper |
|
Text schema wrapper |
|
TextBaseline schema wrapper |
|
TextDef schema wrapper |
|
TextDirection schema wrapper |
|
TickConfig schema wrapper |
|
TickCount schema wrapper |
|
TimeInterval schema wrapper |
|
TimeIntervalStep schema wrapper |
|
TimeLocale schema wrapper |
|
TimeUnit schema wrapper |
|
TimeUnitParams schema wrapper |
|
TimeUnitTransform schema wrapper |
|
TitleAnchor schema wrapper |
|
TitleConfig schema wrapper |
|
TitleFrame schema wrapper |
|
TitleOrient schema wrapper |
|
TitleParams schema wrapper |
|
TooltipContent schema wrapper |
|
TopLevelConcatSpec schema wrapper |
|
TopLevelFacetSpec schema wrapper |
|
TopLevelHConcatSpec schema wrapper |
|
TopLevelLayerSpec schema wrapper |
|
TopLevelRepeatSpec schema wrapper |
|
TopLevelSelectionParameter schema wrapper |
|
TopLevelSpec schema wrapper |
|
TopLevelUnitSpec schema wrapper |
|
TopLevelVConcatSpec schema wrapper |
|
TopoDataFormat schema wrapper |
|
Transform schema wrapper |
|
Type schema wrapper |
|
TypeForShape schema wrapper |
|
TypedFieldDef schema wrapper |
|
URI schema wrapper |
|
UnitSpec schema wrapper |
|
UnitSpecWithFrame schema wrapper |
|
UrlData schema wrapper |
|
UtcMultiTimeUnit schema wrapper |
|
UtcSingleTimeUnit schema wrapper |
|
VConcatSpecGenericSpec schema wrapper |
|
|
ValueDefWithConditionMarkPropFieldOrDatumDefGradientstringnull schema wrapper |
|
ValueDefWithConditionMarkPropFieldOrDatumDefTypeForShapestringnull schema wrapper |
ValueDefWithConditionMarkPropFieldOrDatumDefnumber schema wrapper |
|
ValueDefWithConditionMarkPropFieldOrDatumDefnumberArray schema wrapper |
|
ValueDefWithConditionMarkPropFieldOrDatumDefstringnull schema wrapper |
|
ValueDefWithConditionStringFieldDefText schema wrapper |
|
ValueDefnumber schema wrapper |
|
ValueDefnumberwidthheightExprRef schema wrapper |
|
VariableParameter schema wrapper |
|
Vector10string schema wrapper |
|
Vector12string schema wrapper |
|
Vector2DateTime schema wrapper |
|
Vector2Vector2number schema wrapper |
|
Vector2boolean schema wrapper |
|
Vector2number schema wrapper |
|
Vector2string schema wrapper |
|
Vector3number schema wrapper |
|
Vector7string schema wrapper |
|
ViewBackground schema wrapper |
|
ViewConfig schema wrapper |
|
WindowEventType schema wrapper |
|
WindowFieldDef schema wrapper |
|
WindowOnlyOp schema wrapper |
|
WindowTransform schema wrapper |