.. _API: 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 ----------------- .. currentmodule:: altair .. autosummary:: :toctree: generated/toplevel/ :nosignatures: Chart ConcatChart FacetChart HConcatChart LayerChart RepeatChart TopLevelMixin VConcatChart Encoding Channels ----------------- .. currentmodule:: altair .. autosummary:: :toctree: generated/channels/ :nosignatures: Angle AngleDatum AngleValue Color ColorDatum ColorValue Column Description DescriptionValue Detail Facet Fill FillDatum FillOpacity FillOpacityDatum FillOpacityValue FillValue Href HrefValue Key Latitude Latitude2 Latitude2Datum Latitude2Value LatitudeDatum LatitudeValue Longitude Longitude2 Longitude2Datum Longitude2Value LongitudeDatum LongitudeValue Opacity OpacityDatum OpacityValue Order OrderValue Radius Radius2 Radius2Datum Radius2Value RadiusDatum RadiusValue Row Shape ShapeDatum ShapeValue Size SizeDatum SizeValue Stroke StrokeDash StrokeDashDatum StrokeDashValue StrokeDatum StrokeOpacity StrokeOpacityDatum StrokeOpacityValue StrokeValue StrokeWidth StrokeWidthDatum StrokeWidthValue Text TextDatum TextValue Theta Theta2 Theta2Datum Theta2Value ThetaDatum ThetaValue Tooltip TooltipValue Url UrlValue X X2 X2Datum X2Value XDatum XError XError2 XError2Value XErrorValue XValue Y Y2 Y2Datum Y2Value YDatum YError YError2 YError2Value YErrorValue YValue API Functions ------------- .. currentmodule:: altair .. autosummary:: :toctree: generated/api/ :nosignatures: binding binding_checkbox binding_radio binding_range binding_select concat condition graticule hconcat layer repeat selection selection_interval selection_multi selection_single sequence sphere topo_feature value vconcat Low-Level Schema Wrappers ------------------------- .. currentmodule:: altair .. autosummary:: :toctree: generated/core/ :nosignatures: Aggregate AggregateOp AggregateTransform AggregatedFieldDef Align AllSortString AnyMark AnyMarkConfig AreaConfig ArgmaxDef ArgminDef AutoSizeParams AutosizeType Axis AxisConfig AxisOrient AxisResolveMap BarConfig BaseTitleNoValueRefs Baseline BinExtent BinParams BinTransform BindCheckbox BindRadioSelect BindRange Binding Blend BoxPlot BoxPlotConfig BoxPlotDef BrushConfig CalculateTransform Categorical Color ColorDef ColorName ColorScheme CompositeMark CompositeMarkDef CompositionConfig ConcatSpecGenericSpec ConditionalAxisColor ConditionalAxisLabelAlign ConditionalAxisLabelBaseline ConditionalAxisLabelFontStyle ConditionalAxisLabelFontWeight ConditionalAxisNumber ConditionalAxisNumberArray ConditionalAxisPropertyAlignnull ConditionalAxisPropertyColornull ConditionalAxisPropertyFontStylenull ConditionalAxisPropertyFontWeightnull ConditionalAxisPropertyTextBaselinenull ConditionalAxisPropertynumberArraynull ConditionalAxisPropertynumbernull ConditionalAxisPropertystringnull ConditionalAxisString ConditionalMarkPropFieldOrDatumDef ConditionalMarkPropFieldOrDatumDefTypeForShape ConditionalPredicateMarkPropFieldOrDatumDef ConditionalPredicateMarkPropFieldOrDatumDefTypeForShape ConditionalPredicateStringFieldDef ConditionalPredicateValueDefAlignnullExprRef ConditionalPredicateValueDefColornullExprRef ConditionalPredicateValueDefFontStylenullExprRef ConditionalPredicateValueDefFontWeightnullExprRef ConditionalPredicateValueDefGradientstringnullExprRef ConditionalPredicateValueDefTextBaselinenullExprRef ConditionalPredicateValueDefTextExprRef ConditionalPredicateValueDefnumber ConditionalPredicateValueDefnumberArrayExprRef ConditionalPredicateValueDefnumberArraynullExprRef ConditionalPredicateValueDefnumberExprRef ConditionalPredicateValueDefnumbernullExprRef ConditionalPredicateValueDefstringExprRef ConditionalPredicateValueDefstringnullExprRef ConditionalSelectionMarkPropFieldOrDatumDef ConditionalSelectionMarkPropFieldOrDatumDefTypeForShape ConditionalSelectionStringFieldDef ConditionalSelectionValueDefGradientstringnullExprRef ConditionalSelectionValueDefTextExprRef ConditionalSelectionValueDefnumber ConditionalSelectionValueDefnumberArrayExprRef ConditionalSelectionValueDefnumberExprRef ConditionalSelectionValueDefstringExprRef ConditionalSelectionValueDefstringnullExprRef ConditionalStringFieldDef ConditionalValueDefGradientstringnullExprRef ConditionalValueDefTextExprRef ConditionalValueDefnumber ConditionalValueDefnumberArrayExprRef ConditionalValueDefnumberExprRef ConditionalValueDefstringExprRef ConditionalValueDefstringnullExprRef Config CsvDataFormat Cursor Cyclical Data DataFormat DataSource Datasets DateTime DatumDef Day DensityTransform DerivedStream DictInlineDataset DictSelectionInit DictSelectionInitInterval Dictunknown Diverging DomainUnionWith DsvDataFormat Element Encoding EncodingSortField EncodingSortFieldFieldName ErrorBand ErrorBandConfig ErrorBandDef ErrorBar ErrorBarConfig ErrorBarDef ErrorBarExtent EventStream EventType Expr ExprOrSignalRef ExprRef FacetEncodingFieldDef FacetFieldDef FacetFieldDefFieldName FacetMapping FacetMappingFieldName FacetSpec FacetedEncoding FacetedUnitSpec Field FieldDefWithoutScale FieldEqualPredicate FieldGTEPredicate FieldGTPredicate FieldLTEPredicate FieldLTPredicate FieldName FieldOneOfPredicate FieldOrDatumDefWithConditionDatumDefGradientstringnull FieldOrDatumDefWithConditionDatumDefnumber FieldOrDatumDefWithConditionDatumDefnumberArray FieldOrDatumDefWithConditionDatumDefstringnull FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapestringnull FieldOrDatumDefWithConditionMarkPropFieldDefnumber FieldOrDatumDefWithConditionMarkPropFieldDefnumberArray FieldOrDatumDefWithConditionStringDatumDefText FieldOrDatumDefWithConditionStringFieldDefText FieldOrDatumDefWithConditionStringFieldDefstring FieldRangePredicate FieldValidPredicate FilterTransform Fit FlattenTransform FoldTransform FontStyle FontWeight Generator GeoJsonFeature GeoJsonFeatureCollection Gradient GradientStop GraticuleGenerator GraticuleParams HConcatSpecGenericSpec Header HeaderConfig HexColor ImputeMethod ImputeParams ImputeSequence ImputeTransform InlineData InlineDataset InputBinding Interpolate IntervalSelection IntervalSelectionConfig JoinAggregateFieldDef JoinAggregateTransform JsonDataFormat LabelOverlap LatLongDef LatLongFieldDef LayerRepeatMapping LayerRepeatSpec LayerSpec LayoutAlign Legend LegendBinding LegendConfig LegendOrient LegendResolveMap LegendStreamBinding LineConfig LinearGradient LocalMultiTimeUnit LocalSingleTimeUnit LoessTransform LogicalAndPredicate LogicalNotPredicate LogicalOrPredicate LookupData LookupSelection LookupTransform Mark MarkConfig MarkConfigExprOrSignalRef MarkDef MarkPropDefGradientstringnull MarkPropDefnumber MarkPropDefnumberArray MarkPropDefstringnullTypeForShape MarkType MergedStream Month MultiSelection MultiSelectionConfig MultiTimeUnit NamedData NonArgAggregateOp NonLayerRepeatSpec NormalizedConcatSpecGenericSpec NormalizedFacetSpec NormalizedHConcatSpecGenericSpec NormalizedSpec NormalizedVConcatSpecGenericSpec NumericArrayMarkPropDef NumericMarkPropDef NumericValueDef OrderFieldDef OrderValueDef Orient Orientation OverlayMarkDef Padding Parameter Parse ParseValue PivotTransform PolarDef Position2Def PositionDatumDef PositionDatumDefBase PositionDef PositionFieldDef PositionFieldDefBase PositionValueDef Predicate PredicateComposition PrimitiveValue Projection ProjectionConfig ProjectionType QuantileTransform RadialGradient RangeConfig RangeEnum RangeRaw RangeRawArray RangeScheme RectConfig RegressionTransform RepeatMapping RepeatRef RepeatSpec Resolve ResolveMode Root RowColLayoutAlign RowColboolean RowColnumber RowColumnEncodingFieldDef SampleTransform Scale ScaleBinParams ScaleBins ScaleConfig ScaleInterpolateEnum ScaleInterpolateParams ScaleResolveMap ScaleType SchemaBase SchemeParams SecondaryFieldDef SelectionAnd SelectionComposition SelectionConfig SelectionDef SelectionExtent SelectionInit SelectionInitInterval SelectionInitIntervalMapping SelectionInitMapping SelectionNot SelectionOr SelectionPredicate SelectionResolution SequenceGenerator SequenceParams SequentialMultiHue SequentialSingleHue ShapeDef SharedEncoding SingleDefUnitChannel SingleSelection SingleSelectionConfig SingleTimeUnit Sort SortArray SortByChannel SortByChannelDesc SortByEncoding SortField SortOrder Spec SphereGenerator StackOffset StackTransform StandardType Step Stream StringFieldDef StringFieldDefWithCondition StringValueDefWithCondition StrokeCap StrokeJoin StyleConfigIndex SymbolShape Text TextBaseline TextDef TextDirection TickConfig TickCount TimeInterval TimeIntervalStep TimeUnit TimeUnitParams TimeUnitTransform TitleAnchor TitleConfig TitleFrame TitleOrient TitleParams TooltipContent TopLevelFacetSpec TopLevelLayerSpec TopLevelNormalizedConcatSpecGenericSpec TopLevelNormalizedHConcatSpecGenericSpec TopLevelNormalizedVConcatSpecGenericSpec TopLevelRepeatSpec TopLevelSpec TopLevelUnitSpec TopoDataFormat Transform Type TypeForShape TypedFieldDef URI UnitSpec UnitSpecWithFrame UrlData UtcMultiTimeUnit UtcSingleTimeUnit VConcatSpecGenericSpec ValueDefWithConditionMarkPropFieldOrDatumDefGradientstringnull ValueDefWithConditionMarkPropFieldOrDatumDefTypeForShapestringnull ValueDefWithConditionMarkPropFieldOrDatumDefnumber ValueDefWithConditionMarkPropFieldOrDatumDefnumberArray ValueDefWithConditionMarkPropFieldOrDatumDefstringnull ValueDefWithConditionStringFieldDefText ValueDefnumber ValueDefnumberExprRef ValueDefnumberwidthheightExprRef Vector2DateTime Vector2Vector2number Vector2boolean Vector2number Vector2string Vector3number VegaLiteSchema ViewBackground ViewConfig WindowEventType WindowFieldDef WindowOnlyOp WindowTransform