.. _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 <http://altair-viz.github.io>`_ 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
   Longitude
   Longitude2
   Longitude2Datum
   Longitude2Value
   LongitudeDatum
   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
   XOffset
   XOffsetDatum
   XOffsetValue
   XValue
   Y
   Y2
   Y2Datum
   Y2Value
   YDatum
   YError
   YError2
   YError2Value
   YErrorValue
   YOffset
   YOffsetDatum
   YOffsetValue
   YValue

API Functions
-------------
.. currentmodule:: altair

.. autosummary::
   :toctree: generated/api/
   :nosignatures:

   binding
   binding_checkbox
   binding_radio
   binding_range
   binding_select
   check_fields_and_encodings
   concat
   condition
   graticule
   hconcat
   layer
   param
   repeat
   selection
   selection_interval
   selection_multi
   selection_point
   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
   BBox
   BarConfig
   BaseTitleNoValueRefs
   Baseline
   BinExtent
   BinParams
   BinTransform
   BindCheckbox
   BindDirect
   BindInput
   BindRadioSelect
   BindRange
   Binding
   Blend
   BoxPlot
   BoxPlotConfig
   BoxPlotDef
   BrushConfig
   CalculateTransform
   Categorical
   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
   ConditionalParameterMarkPropFieldOrDatumDef
   ConditionalParameterMarkPropFieldOrDatumDefTypeForShape
   ConditionalParameterStringFieldDef
   ConditionalParameterValueDefGradientstringnullExprRef
   ConditionalParameterValueDefTextExprRef
   ConditionalParameterValueDefnumber
   ConditionalParameterValueDefnumberArrayExprRef
   ConditionalParameterValueDefnumberExprRef
   ConditionalParameterValueDefstringExprRef
   ConditionalParameterValueDefstringnullExprRef
   ConditionalPredicateMarkPropFieldOrDatumDef
   ConditionalPredicateMarkPropFieldOrDatumDefTypeForShape
   ConditionalPredicateStringFieldDef
   ConditionalPredicateValueDefAlignnullExprRef
   ConditionalPredicateValueDefColornullExprRef
   ConditionalPredicateValueDefFontStylenullExprRef
   ConditionalPredicateValueDefFontWeightnullExprRef
   ConditionalPredicateValueDefGradientstringnullExprRef
   ConditionalPredicateValueDefTextBaselinenullExprRef
   ConditionalPredicateValueDefTextExprRef
   ConditionalPredicateValueDefnumber
   ConditionalPredicateValueDefnumberArrayExprRef
   ConditionalPredicateValueDefnumberArraynullExprRef
   ConditionalPredicateValueDefnumberExprRef
   ConditionalPredicateValueDefnumbernullExprRef
   ConditionalPredicateValueDefstringExprRef
   ConditionalPredicateValueDefstringnullExprRef
   ConditionalStringFieldDef
   ConditionalValueDefGradientstringnullExprRef
   ConditionalValueDefTextExprRef
   ConditionalValueDefnumber
   ConditionalValueDefnumberArrayExprRef
   ConditionalValueDefnumberExprRef
   ConditionalValueDefstringExprRef
   ConditionalValueDefstringnullExprRef
   Config
   CsvDataFormat
   Cursor
   Cyclical
   Data
   DataFormat
   DataSource
   Datasets
   DateTime
   DatumDef
   Day
   DensityTransform
   DerivedStream
   Dict
   DictInlineDataset
   DictSelectionInit
   DictSelectionInitInterval
   Diverging
   DomainUnionWith
   DsvDataFormat
   Element
   Encoding
   EncodingSortField
   ErrorBand
   ErrorBandConfig
   ErrorBandDef
   ErrorBar
   ErrorBarConfig
   ErrorBarDef
   ErrorBarExtent
   EventStream
   EventType
   Expr
   ExprRef
   FacetEncodingFieldDef
   FacetFieldDef
   FacetMapping
   FacetSpec
   FacetedEncoding
   FacetedUnitSpec
   Feature
   FeatureCollection
   FeatureGeometryGeoJsonProperties
   Field
   FieldDefWithoutScale
   FieldEqualPredicate
   FieldGTEPredicate
   FieldGTPredicate
   FieldLTEPredicate
   FieldLTPredicate
   FieldName
   FieldOneOfPredicate
   FieldOrDatumDefWithConditionDatumDefGradientstringnull
   FieldOrDatumDefWithConditionDatumDefnumber
   FieldOrDatumDefWithConditionDatumDefnumberArray
   FieldOrDatumDefWithConditionDatumDefstringnull
   FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull
   FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapestringnull
   FieldOrDatumDefWithConditionMarkPropFieldDefnumber
   FieldOrDatumDefWithConditionMarkPropFieldDefnumberArray
   FieldOrDatumDefWithConditionStringDatumDefText
   FieldOrDatumDefWithConditionStringFieldDefText
   FieldOrDatumDefWithConditionStringFieldDefstring
   FieldRange
   FieldRangePredicate
   FieldValidPredicate
   FilterTransform
   Fit
   FlattenTransform
   FoldTransform
   FontStyle
   FontWeight
   Generator
   GenericUnitSpecEncodingAnyMark
   GeoJsonFeature
   GeoJsonFeatureCollection
   GeoJsonProperties
   Geometry
   GeometryCollection
   Gradient
   GradientStop
   GraticuleGenerator
   GraticuleParams
   HConcatSpecGenericSpec
   Header
   HeaderConfig
   HexColor
   ImputeMethod
   ImputeParams
   ImputeSequence
   ImputeTransform
   InlineData
   InlineDataset
   Interpolate
   IntervalSelectionConfig
   IntervalSelectionConfigWithoutType
   JoinAggregateFieldDef
   JoinAggregateTransform
   JsonDataFormat
   LabelOverlap
   LatLongDef
   LatLongFieldDef
   LayerRepeatMapping
   LayerRepeatSpec
   LayerSpec
   LayoutAlign
   Legend
   LegendBinding
   LegendConfig
   LegendOrient
   LegendResolveMap
   LegendStreamBinding
   LineConfig
   LineString
   LinearGradient
   LocalMultiTimeUnit
   LocalSingleTimeUnit
   Locale
   LoessTransform
   LogicalAndPredicate
   LogicalNotPredicate
   LogicalOrPredicate
   LookupData
   LookupSelection
   LookupTransform
   Mark
   MarkConfig
   MarkDef
   MarkPropDefGradientstringnull
   MarkPropDefnumber
   MarkPropDefnumberArray
   MarkPropDefstringnullTypeForShape
   MarkType
   MergedStream
   Month
   MultiLineString
   MultiPoint
   MultiPolygon
   MultiTimeUnit
   NamedData
   NonArgAggregateOp
   NonLayerRepeatSpec
   NonNormalizedSpec
   NumberLocale
   NumericArrayMarkPropDef
   NumericMarkPropDef
   OffsetDef
   OrderFieldDef
   OrderValueDef
   Orient
   Orientation
   OverlayMarkDef
   Padding
   ParameterExtent
   ParameterName
   ParameterPredicate
   Parse
   ParseValue
   PivotTransform
   Point
   PointSelectionConfig
   PointSelectionConfigWithoutType
   PolarDef
   Polygon
   Position
   Position2Def
   PositionDatumDef
   PositionDatumDefBase
   PositionDef
   PositionFieldDef
   PositionFieldDefBase
   PositionValueDef
   Predicate
   PredicateComposition
   PrimitiveValue
   Projection
   ProjectionConfig
   ProjectionType
   QuantileTransform
   RadialGradient
   RangeConfig
   RangeEnum
   RangeRaw
   RangeRawArray
   RangeScheme
   RectConfig
   RegressionTransform
   RelativeBandSize
   RepeatMapping
   RepeatRef
   RepeatSpec
   Resolve
   ResolveMode
   Root
   RowColLayoutAlign
   RowColboolean
   RowColnumber
   RowColumnEncodingFieldDef
   SampleTransform
   Scale
   ScaleBinParams
   ScaleBins
   ScaleConfig
   ScaleDatumDef
   ScaleFieldDef
   ScaleInterpolateEnum
   ScaleInterpolateParams
   ScaleResolveMap
   ScaleType
   SchemaBase
   SchemeParams
   SecondaryFieldDef
   SelectionConfig
   SelectionInit
   SelectionInitInterval
   SelectionInitIntervalMapping
   SelectionInitMapping
   SelectionParameter
   SelectionResolution
   SelectionType
   SequenceGenerator
   SequenceParams
   SequentialMultiHue
   SequentialSingleHue
   ShapeDef
   SharedEncoding
   SingleDefUnitChannel
   SingleTimeUnit
   Sort
   SortArray
   SortByChannel
   SortByChannelDesc
   SortByEncoding
   SortField
   SortOrder
   Spec
   SphereGenerator
   StackOffset
   StackTransform
   StandardType
   Step
   StepFor
   Stream
   StringFieldDef
   StringFieldDefWithCondition
   StringValueDefWithCondition
   StrokeCap
   StrokeJoin
   StyleConfigIndex
   SymbolShape
   TextBaseline
   TextDef
   TextDirection
   TickConfig
   TickCount
   TimeInterval
   TimeIntervalStep
   TimeLocale
   TimeUnit
   TimeUnitParams
   TimeUnitTransform
   TitleAnchor
   TitleConfig
   TitleFrame
   TitleOrient
   TitleParams
   TooltipContent
   TopLevelConcatSpec
   TopLevelFacetSpec
   TopLevelHConcatSpec
   TopLevelLayerSpec
   TopLevelParameter
   TopLevelRepeatSpec
   TopLevelSelectionParameter
   TopLevelSpec
   TopLevelUnitSpec
   TopLevelVConcatSpec
   TopoDataFormat
   Transform
   Type
   TypeForShape
   TypedFieldDef
   URI
   UnitSpec
   UnitSpecWithFrame
   UrlData
   UtcMultiTimeUnit
   UtcSingleTimeUnit
   VConcatSpecGenericSpec
   ValueDefWithConditionMarkPropFieldOrDatumDefGradientstringnull
   ValueDefWithConditionMarkPropFieldOrDatumDefTypeForShapestringnull
   ValueDefWithConditionMarkPropFieldOrDatumDefnumber
   ValueDefWithConditionMarkPropFieldOrDatumDefnumberArray
   ValueDefWithConditionMarkPropFieldOrDatumDefstringnull
   ValueDefWithConditionStringFieldDefText
   ValueDefnumber
   ValueDefnumberwidthheightExprRef
   VariableParameter
   Vector10string
   Vector12string
   Vector2DateTime
   Vector2Vector2number
   Vector2boolean
   Vector2number
   Vector2string
   Vector3number
   Vector7string
   VegaLiteSchema
   ViewBackground
   ViewConfig
   WindowEventType
   WindowFieldDef
   WindowOnlyOp
   WindowTransform
