1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
|
.. currentmodule:: altair
.. _user-guide-encoding-channel-options:
Channel Options
---------------
Some encoding channels allow for additional options to be expressed.
These can control things like axis properties, scale properties, headers and
titles, binning parameters, aggregation, sorting, and many more.
The section titles below refer to the channels introduced in :ref:`user-guide-encoding-channels`
and show the accepted options for these channels.
X and Y
~~~~~~~
The :class:`X` and :class:`Y` encodings accept the following options:
.. altair-object-table:: altair.PositionFieldDef
Color, Fill, and Stroke
~~~~~~~~~~~~~~~~~~~~~~~
The :class:`Color`, :class:`Fill`, and :class:`Stroke` encodings accept the following options:
.. altair-object-table:: altair.FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull
Shape
~~~~~
The :class:`Shape` encoding accepts the following options:
.. altair-object-table:: altair.FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapestringnull
Order
~~~~~
The :class:`Order` encoding accepts the following options:
.. altair-object-table:: altair.OrderFieldDef
Angle, FillOpacity, Opacity, Size, StrokeOpacity, and StrokeWidth
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The :class:`Angle`, :class:`FillOpacity`, :class:`Opacity`, :class:`Size`, :class:`StrokeOpacity`,
and :class:`StrokeWidth` encodings accept the following options:
.. altair-object-table:: altair.FieldOrDatumDefWithConditionMarkPropFieldDefnumber
StrokeDash
~~~~~~~~~~
The :class:`StrokeDash` encoding accepts the following options:
.. altair-object-table:: altair.FieldOrDatumDefWithConditionMarkPropFieldDefnumberArray
Row and Column
~~~~~~~~~~~~~~
The :class:`Row` and :class:`Column`, and :class:`Facet` encodings accept the following options:
.. altair-object-table:: altair.RowColumnEncodingFieldDef
Facet
~~~~~
The :class:`Facet` encoding accepts the following options:
.. altair-object-table:: altair.FacetEncodingFieldDef
Text
~~~~
The :class:`Text` encoding accepts the following options:
.. altair-object-table:: altair.FieldOrDatumDefWithConditionStringFieldDefText
Href, Tooltip, Url
~~~~~~~~~~~~~~~~~~
The :class:`Href`, :class:`Tooltip`, and :class:`Url` encodings accept the following options:
.. altair-object-table:: altair.StringFieldDefWithCondition
Detail
~~~~~~
The :class:`Detail` encoding accepts the following options:
.. altair-object-table:: altair.FieldDefWithoutScale
Latitude and Longitude
~~~~~~~~~~~~~~~~~~~~~~
The :class:`Latitude` and :class:`Longitude` encodings accept the following options:
.. altair-object-table:: altair.LatLongFieldDef
Radius and Theta
~~~~~~~~~~~~~~~~
The :class:`Radius` and :class:`Theta` encodings accept the following options:
.. altair-object-table:: altair.PositionFieldDefBase
Latitude2, Longitude2, Radius2, Theta2, X2, Y2, XError, YError, XError2, and YError2
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The :class:`Latitude2`, :class:`Longitude2`, :class:`Radius2`, :class:`Theta2`, :class:`X2`, :class:`Y2`, :class:`XError`, :class:`YError`, :class:`XError2`, and :class:`YError2` encodings accept the following options:
.. altair-object-table:: altair.SecondaryFieldDef
|