altair.FacetedEncoding
- class altair.FacetedEncoding(angle=Undefined, color=Undefined, column=Undefined, description=Undefined, detail=Undefined, facet=Undefined, fill=Undefined, fillOpacity=Undefined, href=Undefined, key=Undefined, latitude=Undefined, latitude2=Undefined, longitude=Undefined, longitude2=Undefined, opacity=Undefined, order=Undefined, radius=Undefined, radius2=Undefined, row=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeDash=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, text=Undefined, theta=Undefined, theta2=Undefined, tooltip=Undefined, url=Undefined, x=Undefined, x2=Undefined, xError=Undefined, xError2=Undefined, y=Undefined, y2=Undefined, yError=Undefined, yError2=Undefined, **kwds)
FacetedEncoding schema wrapper
Mapping(required=[])
- Attributes:
- angle
NumericMarkPropDef
Rotation angle of point and text marks.
- color
ColorDef
Color of the marks – either fill or stroke color based on the
filled
property of mark definition. By default,color
represents fill color for"area"
,"bar"
,"tick"
,"text"
,"trail"
,"circle"
, and"square"
/ stroke color for"line"
and"point"
.Default value: If undefined, the default color depends on mark config ‘s
color
property.Note: 1) For fine-grained control over both fill and stroke colors of the marks, please use the
fill
andstroke
channels. Thefill
orstroke
encodings have higher precedence thancolor
, thus may override thecolor
encoding if conflicting encodings are specified. 2) See the scale documentation for more information about customizing color scheme.- column
RowColumnEncodingFieldDef
A field definition for the horizontal facet of trellis plots.
- descriptionanyOf(
StringFieldDefWithCondition
, - :class:`StringValueDefWithCondition`)
A text description of this mark for ARIA accessibility (SVG output only). For SVG output the
"aria-label"
attribute will be set to this description.- detailanyOf(
FieldDefWithoutScale
, List(FieldDefWithoutScale
)) Additional levels of detail for grouping data in aggregate views and in line, trail, and area marks without mapping data to a specific visual channel.
- facet
FacetEncodingFieldDef
A field definition for the (flexible) facet of trellis plots.
If either
row
orcolumn
is specified, this channel will be ignored.- fill
ColorDef
Fill color of the marks. Default value: If undefined, the default color depends on mark config ‘s
color
property.Note: The
fill
encoding has higher precedence thancolor
, thus may override thecolor
encoding if conflicting encodings are specified.- fillOpacity
NumericMarkPropDef
Fill opacity of the marks.
Default value: If undefined, the default opacity depends on mark config ‘s
fillOpacity
property.- hrefanyOf(
StringFieldDefWithCondition
,StringValueDefWithCondition
) A URL to load upon mouse click.
- key
FieldDefWithoutScale
A data field to use as a unique key for data binding. When a visualization’s data is updated, the key value will be used to match data elements to existing mark instances. Use a key channel to enable object constancy for transitions over dynamic data.
- latitude
LatLongDef
Latitude position of geographically projected marks.
- latitude2
Position2Def
Latitude-2 position for geographically projected ranged
"area"
,"bar"
,"rect"
, and"rule"
.- longitude
LatLongDef
Longitude position of geographically projected marks.
- longitude2
Position2Def
Longitude-2 position for geographically projected ranged
"area"
,"bar"
,"rect"
, and"rule"
.- opacity
NumericMarkPropDef
Opacity of the marks.
Default value: If undefined, the default opacity depends on mark config ‘s
opacity
property.- orderanyOf(
OrderFieldDef
, List(OrderFieldDef
),OrderValueDef
) Order of the marks. - For stacked marks, this
order
channel encodes stack order. - For line and trail marks, thisorder
channel encodes order of data points in the lines. This can be useful for creating a connected scatterplot. Settingorder
to{"value": null}
makes the line marks use the original order in the data sources. - Otherwise, thisorder
channel encodes layer order of the marks.Note : In aggregate plots,
order
field should beaggregate
d to avoid creating additional aggregation grouping.- radius
PolarDef
The outer radius in pixels of arc marks.
- radius2
Position2Def
The inner radius in pixels of arc marks.
- row
RowColumnEncodingFieldDef
A field definition for the vertical facet of trellis plots.
- shape
ShapeDef
Shape of the mark.
#. For
point
marks the supported values include: - plotting shapes:"circle"
,"square"
,"cross"
,"diamond"
,"triangle-up"
,"triangle-down"
,"triangle-right"
, or"triangle-left"
. - the line symbol"stroke"
- centered directional shapes"arrow"
,"wedge"
, or"triangle"
- a custom SVG path string (For correct sizing, custom shape paths should be defined within a square bounding box with coordinates ranging from -1 to 1 along both the x and y dimensions.)#. For
geoshape
marks it should be a field definition of the geojson dataDefault value: If undefined, the default shape depends on mark config ‘s
shape
property. ("circle"
if unset.)- size
NumericMarkPropDef
Size of the mark. - For
"point"
,"square"
and"circle"
, – the symbol size, or pixel area of the mark. - For"bar"
and"tick"
– the bar and tick’s size. - For"text"
– the text’s font size. - Size is unsupported for"line"
,"area"
, and"rect"
. (Use"trail"
instead of line with varying size)- stroke
ColorDef
Stroke color of the marks. Default value: If undefined, the default color depends on mark config ‘s
color
property.Note: The
stroke
encoding has higher precedence thancolor
, thus may override thecolor
encoding if conflicting encodings are specified.- strokeDash
NumericArrayMarkPropDef
Stroke dash of the marks.
Default value:
[1,0]
(No dash).- strokeOpacity
NumericMarkPropDef
Stroke opacity of the marks.
Default value: If undefined, the default opacity depends on mark config ‘s
strokeOpacity
property.- strokeWidth
NumericMarkPropDef
Stroke width of the marks.
Default value: If undefined, the default stroke width depends on mark config ‘s
strokeWidth
property.- text
TextDef
Text of the
text
mark.- theta
PolarDef
For arc marks, the arc length in radians if theta2 is not specified, otherwise the start arc angle. (A value of 0 indicates up or “north”, increasing values proceed clockwise.)
For text marks, polar coordinate angle in radians.
- theta2
Position2Def
The end angle of arc marks in radians. A value of 0 indicates up or “north”, increasing values proceed clockwise.
- tooltipanyOf(
StringFieldDefWithCondition
,StringValueDefWithCondition
, - List(:class:`StringFieldDef`), None)
The tooltip text to show upon mouse hover. Specifying
tooltip
encoding overrides the tooltip property in the mark definition.See the tooltip documentation for a detailed discussion about tooltip in Vega-Lite.
- urlanyOf(
StringFieldDefWithCondition
,StringValueDefWithCondition
) The URL of an image mark.
- x
PositionDef
X coordinates of the marks, or width of horizontal
"bar"
and"area"
without specifiedx2
orwidth
.The
value
of this channel can be a number or a string"width"
for the width of the plot.- x2
Position2Def
X2 coordinates for ranged
"area"
,"bar"
,"rect"
, and"rule"
.The
value
of this channel can be a number or a string"width"
for the width of the plot.- xErroranyOf(
SecondaryFieldDef
,ValueDefnumber
) Error value of x coordinates for error specified
"errorbar"
and"errorband"
.- xError2anyOf(
SecondaryFieldDef
,ValueDefnumber
) Secondary error value of x coordinates for error specified
"errorbar"
and"errorband"
.- y
PositionDef
Y coordinates of the marks, or height of vertical
"bar"
and"area"
without specifiedy2
orheight
.The
value
of this channel can be a number or a string"height"
for the height of the plot.- y2
Position2Def
Y2 coordinates for ranged
"area"
,"bar"
,"rect"
, and"rule"
.The
value
of this channel can be a number or a string"height"
for the height of the plot.- yErroranyOf(
SecondaryFieldDef
,ValueDefnumber
) Error value of y coordinates for error specified
"errorbar"
and"errorband"
.- yError2anyOf(
SecondaryFieldDef
,ValueDefnumber
) Secondary error value of y coordinates for error specified
"errorbar"
and"errorband"
.
- angle
- __init__(angle=Undefined, color=Undefined, column=Undefined, description=Undefined, detail=Undefined, facet=Undefined, fill=Undefined, fillOpacity=Undefined, href=Undefined, key=Undefined, latitude=Undefined, latitude2=Undefined, longitude=Undefined, longitude2=Undefined, opacity=Undefined, order=Undefined, radius=Undefined, radius2=Undefined, row=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeDash=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, text=Undefined, theta=Undefined, theta2=Undefined, tooltip=Undefined, url=Undefined, x=Undefined, x2=Undefined, xError=Undefined, xError2=Undefined, y=Undefined, y2=Undefined, yError=Undefined, yError2=Undefined, **kwds)
Methods
__init__
([angle, color, column, ...])copy
([deep, ignore])Return a copy of the object
from_dict
(dct[, validate, _wrapper_classes])Construct class from a dictionary representation
from_json
(json_string[, validate])Instantiate the object from a valid JSON string
resolve_references
([schema])Resolve references in the context of this object's schema or root schema.
to_dict
([validate, ignore, context])Return a dictionary representation of the object
to_json
([validate, ignore, context, indent, ...])Emit the JSON representation for this object as a string.
validate
(instance[, schema])Validate the instance against the class schema in the context of the rootschema.
validate_property
(name, value[, schema])Validate a property against property schema in the context of the rootschema