altair.Encoding#

class altair.Encoding(angle=Undefined, color=Undefined, description=Undefined, detail=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, 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, xOffset=Undefined, y=Undefined, y2=Undefined, yError=Undefined, yError2=Undefined, yOffset=Undefined, **kwds)#

Encoding schema wrapper.

Parameters:
angledict, NumericMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumber, FieldOrDatumDefWithConditionMarkPropFieldDefnumber, ValueDefWithConditionMarkPropFieldOrDatumDefnumber

Rotation angle of point and text marks.

colordict, ColorDef, FieldOrDatumDefWithConditionDatumDefGradientstringnull, FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull, ValueDefWithConditionMarkPropFieldOrDatumDefGradientstringnull

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 and stroke channels. The fill or stroke encodings have higher precedence than color, thus may override the color encoding if conflicting encodings are specified. 2) See the scale documentation for more information about customizing color scheme.

descriptiondict, StringFieldDefWithCondition, 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.

detaildict, FieldDefWithoutScale, Sequence[dict, 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.

filldict, ColorDef, FieldOrDatumDefWithConditionDatumDefGradientstringnull, FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull, ValueDefWithConditionMarkPropFieldOrDatumDefGradientstringnull

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 than color, thus may override the color encoding if conflicting encodings are specified.

fillOpacitydict, NumericMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumber, FieldOrDatumDefWithConditionMarkPropFieldDefnumber, ValueDefWithConditionMarkPropFieldOrDatumDefnumber

Fill opacity of the marks.

Default value: If undefined, the default opacity depends on mark config’s fillOpacity property.

hrefdict, StringFieldDefWithCondition, StringValueDefWithCondition

A URL to load upon mouse click.

keydict, 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.

latitudedict, DatumDef, LatLongDef, LatLongFieldDef

Latitude position of geographically projected marks.

latitude2dict, DatumDef, Position2Def, PositionValueDef, SecondaryFieldDef

Latitude-2 position for geographically projected ranged "area", "bar", "rect", and "rule".

longitudedict, DatumDef, LatLongDef, LatLongFieldDef

Longitude position of geographically projected marks.

longitude2dict, DatumDef, Position2Def, PositionValueDef, SecondaryFieldDef

Longitude-2 position for geographically projected ranged "area", "bar", "rect", and "rule".

opacitydict, NumericMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumber, FieldOrDatumDefWithConditionMarkPropFieldDefnumber, ValueDefWithConditionMarkPropFieldOrDatumDefnumber

Opacity of the marks.

Default value: If undefined, the default opacity depends on mark config’s opacity property.

orderdict, OrderOnlyDef, OrderFieldDef, OrderValueDef, Sequence[dict, OrderFieldDef]

Order of the marks.

  • For stacked marks, this order channel encodes stack order.

  • For line and trail marks, this order channel encodes order of data points in the lines. This can be useful for creating a connected scatterplot. Setting order to {"value": null} makes the line marks use the original order in the data sources.

  • Otherwise, this order channel encodes layer order of the marks.

Note: In aggregate plots, order field should be ``aggregate``d to avoid creating additional aggregation grouping.

radiusdict, PolarDef, PositionValueDef, PositionDatumDefBase, PositionFieldDefBase

The outer radius in pixels of arc marks.

radius2dict, DatumDef, Position2Def, PositionValueDef, SecondaryFieldDef

The inner radius in pixels of arc marks.

shapedict, ShapeDef, FieldOrDatumDefWithConditionDatumDefstringnull, FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapestringnull, ValueDefWithConditionMarkPropFieldOrDatumDefTypeForShapestringnull

Shape of the mark.

1. 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.)

  1. For geoshape marks it should be a field definition of the geojson data

Default value: If undefined, the default shape depends on mark config’s shape property. ("circle" if unset.)

sizedict, NumericMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumber, FieldOrDatumDefWithConditionMarkPropFieldDefnumber, ValueDefWithConditionMarkPropFieldOrDatumDefnumber

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)

strokedict, ColorDef, FieldOrDatumDefWithConditionDatumDefGradientstringnull, FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull, ValueDefWithConditionMarkPropFieldOrDatumDefGradientstringnull

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 than color, thus may override the color encoding if conflicting encodings are specified.

strokeDashdict, NumericArrayMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumberArray, FieldOrDatumDefWithConditionMarkPropFieldDefnumberArray, ValueDefWithConditionMarkPropFieldOrDatumDefnumberArray

Stroke dash of the marks.

Default value: [1,0] (No dash).

strokeOpacitydict, NumericMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumber, FieldOrDatumDefWithConditionMarkPropFieldDefnumber, ValueDefWithConditionMarkPropFieldOrDatumDefnumber

Stroke opacity of the marks.

Default value: If undefined, the default opacity depends on mark config’s strokeOpacity property.

strokeWidthdict, NumericMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumber, FieldOrDatumDefWithConditionMarkPropFieldDefnumber, ValueDefWithConditionMarkPropFieldOrDatumDefnumber

Stroke width of the marks.

Default value: If undefined, the default stroke width depends on mark config’s strokeWidth property.

textdict, TextDef, ValueDefWithConditionStringFieldDefText, FieldOrDatumDefWithConditionStringDatumDefText, FieldOrDatumDefWithConditionStringFieldDefText

Text of the text mark.

thetadict, PolarDef, PositionValueDef, PositionDatumDefBase, PositionFieldDefBase

  • 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.

theta2dict, DatumDef, Position2Def, PositionValueDef, SecondaryFieldDef

The end angle of arc marks in radians. A value of 0 indicates up or “north”, increasing values proceed clockwise.

tooltipdict, StringFieldDefWithCondition, StringValueDefWithCondition, Sequence[dict, 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.

urldict, StringFieldDefWithCondition, StringValueDefWithCondition

The URL of an image mark.

xdict, PositionDef, PositionDatumDef, PositionFieldDef, PositionValueDef

X coordinates of the marks, or width of horizontal "bar" and "area" without specified x2 or width.

The value of this channel can be a number or a string "width" for the width of the plot.

x2dict, DatumDef, Position2Def, PositionValueDef, SecondaryFieldDef

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.

xErrordict, ValueDefnumber, SecondaryFieldDef

Error value of x coordinates for error specified "errorbar" and "errorband".

xError2dict, ValueDefnumber, SecondaryFieldDef

Secondary error value of x coordinates for error specified "errorbar" and "errorband".

xOffsetdict, OffsetDef, ScaleDatumDef, ScaleFieldDef, ValueDefnumber

Offset of x-position of the marks

ydict, PositionDef, PositionDatumDef, PositionFieldDef, PositionValueDef

Y coordinates of the marks, or height of vertical "bar" and "area" without specified y2 or height.

The value of this channel can be a number or a string "height" for the height of the plot.

y2dict, DatumDef, Position2Def, PositionValueDef, SecondaryFieldDef

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.

yErrordict, ValueDefnumber, SecondaryFieldDef

Error value of y coordinates for error specified "errorbar" and "errorband".

yError2dict, ValueDefnumber, SecondaryFieldDef

Secondary error value of y coordinates for error specified "errorbar" and "errorband".

yOffsetdict, OffsetDef, ScaleDatumDef, ScaleFieldDef, ValueDefnumber

Offset of y-position of the marks

__init__(angle=Undefined, color=Undefined, description=Undefined, detail=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, 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, xOffset=Undefined, y=Undefined, y2=Undefined, yError=Undefined, yError2=Undefined, yOffset=Undefined, **kwds)#

Methods

__init__([angle, color, description, ...])

copy([deep, ignore])

Return a copy of the object.

from_dict(dct[, validate])

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, indent, sort_keys, ...])

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.