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 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¶
Color schema wrapper |
|
ColorValue schema wrapper |
|
Column schema wrapper |
|
Detail schema wrapper |
|
Facet schema wrapper |
|
Fill schema wrapper |
|
FillOpacity schema wrapper |
|
FillOpacityValue schema wrapper |
|
FillValue schema wrapper |
|
Href schema wrapper |
|
HrefValue schema wrapper |
|
Key schema wrapper |
|
Latitude schema wrapper |
|
Latitude2 schema wrapper |
|
Latitude2Value schema wrapper |
|
LatitudeValue schema wrapper |
|
Longitude schema wrapper |
|
Longitude2 schema wrapper |
|
Longitude2Value schema wrapper |
|
LongitudeValue schema wrapper |
|
Opacity schema wrapper |
|
OpacityValue schema wrapper |
|
Order schema wrapper |
|
OrderValue schema wrapper |
|
Row schema wrapper |
|
Shape schema wrapper |
|
ShapeValue schema wrapper |
|
Size schema wrapper |
|
SizeValue schema wrapper |
|
Stroke schema wrapper |
|
StrokeDash schema wrapper |
|
StrokeDashValue schema wrapper |
|
StrokeOpacity schema wrapper |
|
StrokeOpacityValue schema wrapper |
|
StrokeValue schema wrapper |
|
StrokeWidth schema wrapper |
|
StrokeWidthValue schema wrapper |
|
Text schema wrapper |
|
TextValue schema wrapper |
|
Tooltip schema wrapper |
|
TooltipValue schema wrapper |
|
Url schema wrapper |
|
UrlValue schema wrapper |
|
X schema wrapper |
|
X2 schema wrapper |
|
X2Value schema wrapper |
|
XError schema wrapper |
|
XError2 schema wrapper |
|
XError2Value schema wrapper |
|
XErrorValue schema wrapper |
|
XValue schema wrapper |
|
Y schema wrapper |
|
Y2 schema wrapper |
|
Y2Value schema wrapper |
|
YError schema wrapper |
|
YError2 schema wrapper |
|
YError2Value schema wrapper |
|
YErrorValue 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 |
|
Tie a channel to the row or column within a repeated chart |
|
Create a named selection. |
|
Create a selection with type=’interval’ Mapping(required=[type]) |
|
Create a selection with type=’multi’ Mapping(required=[type]) |
|
Create a selection with type=’single’ Mapping(required=[type]) |
|
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 |
|
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 |
|
ColorGradientFieldDefWithCondition schema wrapper |
|
ColorGradientValueWithCondition 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 |
|
ConditionalAxisPropertynumbernull schema wrapper |
|
ConditionalAxisPropertystringnull schema wrapper |
|
ConditionalAxisString schema wrapper |
|
ConditionalMarkPropFieldDef schema wrapper |
|
ConditionalMarkPropFieldDefTypeForShape schema wrapper |
|
ConditionalNumberValueDef schema wrapper |
|
ConditionalPredicateMarkPropFieldDef schema wrapper |
|
ConditionalPredicateMarkPropFieldDefTypeForShape schema wrapper |
|
ConditionalPredicateNumberValueDef schema wrapper |
|
ConditionalPredicateStringFieldDef schema wrapper |
|
ConditionalPredicateStringValueDef schema wrapper |
|
ConditionalPredicateValueDefAlignnull schema wrapper |
|
ConditionalPredicateValueDefColornull schema wrapper |
|
ConditionalPredicateValueDefFontStylenull schema wrapper |
|
ConditionalPredicateValueDefFontWeightnull schema wrapper |
|
ConditionalPredicateValueDefGradientstringnull schema wrapper |
|
ConditionalPredicateValueDefText schema wrapper |
|
ConditionalPredicateValueDefTextBaselinenull schema wrapper |
|
ConditionalPredicateValueDefnumber schema wrapper |
|
ConditionalPredicateValueDefnumbernull schema wrapper |
|
ConditionalPredicateValueDefstring schema wrapper |
|
ConditionalSelectionMarkPropFieldDef schema wrapper |
|
ConditionalSelectionMarkPropFieldDefTypeForShape schema wrapper |
|
ConditionalSelectionNumberValueDef schema wrapper |
|
ConditionalSelectionStringFieldDef schema wrapper |
|
ConditionalSelectionStringValueDef schema wrapper |
|
ConditionalSelectionValueDefGradientstringnull schema wrapper |
|
ConditionalSelectionValueDefText schema wrapper |
|
ConditionalSelectionValueDefnumber schema wrapper |
|
ConditionalSelectionValueDefstring schema wrapper |
|
ConditionalStringFieldDef schema wrapper |
|
ConditionalStringValueDef schema wrapper |
|
ConditionalValueDefGradientstringnull schema wrapper |
|
ConditionalValueDefText schema wrapper |
|
ConditionalValueDefnumber schema wrapper |
|
ConditionalValueDefstring 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 |
|
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 |
|
EncodingSortFieldFieldName 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 |
|
FacetEncodingFieldDef schema wrapper |
|
FacetFieldDef schema wrapper |
|
FacetFieldDefFieldName schema wrapper |
|
FacetMapping schema wrapper |
|
FacetMappingFieldName schema wrapper |
|
FacetSpec schema wrapper |
|
FacetedEncoding schema wrapper |
|
FacetedUnitSpec schema wrapper |
|
Field schema wrapper |
|
FieldDefWithConditionMarkPropFieldDefGradientstringnull schema wrapper |
|
FieldDefWithConditionMarkPropFieldDefTypeForShapestringnull schema wrapper |
|
FieldDefWithConditionMarkPropFieldDefnumber schema wrapper |
|
FieldDefWithConditionStringFieldDefText schema wrapper |
|
FieldDefWithConditionStringFieldDefstring 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 |
|
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 |
|
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 |
|
InputBinding schema wrapper |
|
Interpolate schema wrapper |
|
IntervalSelection schema wrapper |
|
IntervalSelectionConfig schema wrapper |
|
JoinAggregateFieldDef schema wrapper |
|
JoinAggregateTransform schema wrapper |
|
JsonDataFormat schema wrapper |
|
LabelOverlap schema wrapper |
|
LatLongFieldDef 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 |
|
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 |
|
MarkType schema wrapper |
|
MergedStream schema wrapper |
|
Month schema wrapper |
|
MultiSelection schema wrapper |
|
MultiSelectionConfig schema wrapper |
|
MultiTimeUnit schema wrapper |
|
NamedData schema wrapper |
|
NonArgAggregateOp schema wrapper |
|
NormalizedConcatSpecGenericSpec schema wrapper |
|
NormalizedFacetSpec schema wrapper |
|
NormalizedHConcatSpecGenericSpec schema wrapper |
|
NormalizedSpec schema wrapper |
|
NormalizedVConcatSpecGenericSpec schema wrapper |
|
NumberValueDef schema wrapper |
|
NumericArrayFieldDefWithCondition schema wrapper |
|
NumericArrayValueDefWithCondition schema wrapper |
|
NumericFieldDefWithCondition schema wrapper |
|
NumericValueWithCondition schema wrapper |
|
OrderFieldDef schema wrapper |
|
Orient schema wrapper |
|
Orientation schema wrapper |
|
OverlayMarkDef schema wrapper |
|
Padding schema wrapper |
|
Parse schema wrapper |
|
ParseValue schema wrapper |
|
PivotTransform schema wrapper |
|
PositionFieldDef schema wrapper |
|
Predicate schema wrapper |
|
PredicateComposition 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 |
|
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 |
|
ScaleInterpolateEnum schema wrapper |
|
ScaleInterpolateParams schema wrapper |
|
ScaleResolveMap schema wrapper |
|
ScaleType schema wrapper |
|
Base class for schema wrappers. |
|
SchemeParams schema wrapper |
|
SecondaryFieldDef schema wrapper |
|
SelectionAnd schema wrapper |
|
SelectionComposition schema wrapper |
|
SelectionConfig schema wrapper |
|
SelectionDef schema wrapper |
|
SelectionExtent schema wrapper |
|
SelectionInit schema wrapper |
|
SelectionInitInterval schema wrapper |
|
SelectionInitIntervalMapping schema wrapper |
|
SelectionInitMapping schema wrapper |
|
SelectionNot schema wrapper |
|
SelectionOr schema wrapper |
|
SelectionPredicate schema wrapper |
|
SelectionResolution schema wrapper |
|
SequenceGenerator schema wrapper |
|
SequenceParams schema wrapper |
|
SequentialMultiHue schema wrapper |
|
SequentialSingleHue schema wrapper |
|
ShapeFieldDefWithCondition schema wrapper |
|
ShapeValueWithCondition schema wrapper |
|
SingleDefUnitChannel schema wrapper |
|
SingleSelection schema wrapper |
|
SingleSelectionConfig 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 |
|
Stream schema wrapper |
|
StringFieldDef schema wrapper |
|
StringFieldDefWithCondition schema wrapper |
|
StringValueWithCondition schema wrapper |
|
StringValueWithConditionTypeForShape schema wrapper |
|
StyleConfigIndex schema wrapper |
|
SymbolShape schema wrapper |
|
Text schema wrapper |
|
TextBaseline schema wrapper |
|
TextDirection schema wrapper |
|
TextFieldDefWithCondition schema wrapper |
|
TextValueWithCondition schema wrapper |
|
TickConfig schema wrapper |
|
TickCount schema wrapper |
|
TimeInterval schema wrapper |
|
TimeIntervalStep 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 |
|
TopLevelFacetSpec schema wrapper |
|
TopLevelLayerSpec schema wrapper |
|
TopLevelNormalizedConcatSpecGenericSpec schema wrapper |
|
TopLevelNormalizedHConcatSpecGenericSpec schema wrapper |
|
TopLevelNormalizedVConcatSpecGenericSpec schema wrapper |
|
TopLevelRepeatSpec schema wrapper |
|
TopLevelSpec schema wrapper |
|
TopLevelUnitSpec schema wrapper |
|
TopoDataFormat schema wrapper |
|
Transform schema wrapper |
|
TypeForShape schema wrapper |
|
TypedFieldDef schema wrapper |
|
UnitSpec schema wrapper |
|
UnitSpecWithFrame schema wrapper |
|
UrlData schema wrapper |
|
UtcMultiTimeUnit schema wrapper |
|
UtcSingleTimeUnit schema wrapper |
|
VConcatSpecGenericSpec schema wrapper |
|
Value schema wrapper |
|
ValueConditionGradientstringnull schema wrapper |
|
ValueConditionText schema wrapper |
|
ValueConditionnumber schema wrapper |
|
ValueConditionstring schema wrapper |
|
ValueConditionstringnull schema wrapper |
|
ValueDefWithConditionMarkPropFieldDefGradientstringnull schema wrapper |
|
ValueDefWithConditionMarkPropFieldDefTypeForShapestringnull schema wrapper |
|
ValueDefWithConditionMarkPropFieldDefnumber schema wrapper |
|
ValueDefWithConditionMarkPropFieldDefstringnull schema wrapper |
|
ValueDefWithConditionStringFieldDefText schema wrapper |
|
ValueWithConditionMarkPropFieldDefGradientstringnull schema wrapper |
|
ValueWithConditionMarkPropFieldDefTypeForShapestringnull schema wrapper |
|
ValueWithConditionMarkPropFieldDefnumber schema wrapper |
|
ValueWithConditionMarkPropFieldDefstringnull schema wrapper |
|
ValueWithConditionStringFieldDefText schema wrapper |
|
Vector2DateTime schema wrapper |
|
Vector2Vector2number schema wrapper |
|
Vector2boolean schema wrapper |
|
Vector2number schema wrapper |
|
Vector2string schema wrapper |
|
Vector3number schema wrapper |
|
ViewBackground schema wrapper |
|
ViewConfig schema wrapper |
|
WindowEventType schema wrapper |
|
WindowFieldDef schema wrapper |
|
WindowOnlyOp schema wrapper |
|
WindowTransform schema wrapper |
|
XValueDef schema wrapper |
|
YValueDef schema wrapper |