altair.ErrorBandDef

class altair.ErrorBandDef(type=Undefined, band=Undefined, borders=Undefined, clip=Undefined, color=Undefined, extent=Undefined, interpolate=Undefined, opacity=Undefined, orient=Undefined, tension=Undefined, **kwds)

ErrorBandDef schema wrapper

Mapping(required=[type])

Attributes

typeErrorBand

The mark type. This could a primitive mark type (one of "bar", "circle", "square", "tick", "line", "area", "point", "geoshape", "rule", and "text" ) or a composite mark type ( "boxplot", "errorband", "errorbar" ).

bandanyOf(boolean, MarkConfig)

bordersanyOf(boolean, MarkConfig)

clipboolean

Whether a composite mark be clipped to the enclosing group’s width and height.

coloranyOf(Color, Gradient)

Default color.

Default value: ■ "#4682b4"

Note:

• This property cannot be used in a style config.

• The fill and stroke properties have higher precedence than color and will override color.

extentErrorBarExtent

The extent of the band. Available options include:

• "ci" : Extend the band to the confidence interval of the mean.

• "stderr" : The size of band are set to the value of standard error, extending from the mean.

• "stdev" : The size of band are set to the value of standard deviation, extending from the mean.

• "iqr" : Extend the band to the q1 and q3.

Default value: "stderr".

interpolateInterpolate

The line interpolation method for the error band. One of the following:

• "linear" : piecewise linear segments, as in a polyline.

• "linear-closed" : close the linear segments to form a polygon.

• "step" : a piecewise constant function (a step function) consisting of alternating horizontal and vertical lines. The y-value changes at the midpoint of each pair of adjacent x-values.

• "step-before" : a piecewise constant function (a step function) consisting of alternating horizontal and vertical lines. The y-value changes before the x-value.

• "step-after" : a piecewise constant function (a step function) consisting of alternating horizontal and vertical lines. The y-value changes after the x-value.

• "basis" : a B-spline, with control point duplication on the ends.

• "basis-open" : an open B-spline; may not intersect the start or end.

• "basis-closed" : a closed B-spline, as in a loop.

• "cardinal" : a Cardinal spline, with control point duplication on the ends.

• "cardinal-open" : an open Cardinal spline; may not intersect the start or end, but will intersect other control points.

• "cardinal-closed" : a closed Cardinal spline, as in a loop.

• "bundle" : equivalent to basis, except the tension parameter is used to straighten the spline.

• "monotone" : cubic interpolation that preserves monotonicity in y.

opacityfloat

The opacity (value between [0,1]) of the mark.

orientOrientation

Orientation of the error band. This is normally automatically determined, but can be specified when the orientation is ambiguous and cannot be automatically determined.

tensionfloat

The tension parameter for the interpolation type of the error band.

__init__(self, type=Undefined, band=Undefined, borders=Undefined, clip=Undefined, color=Undefined, extent=Undefined, interpolate=Undefined, opacity=Undefined, orient=Undefined, tension=Undefined, **kwds)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self[, type, band, borders, clip, …])	Initialize self.
copy(self[, 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(self[, validate, ignore, context])	Return a dictionary representation of the object
to_json(self[, validate, ignore, context, …])	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

copy(self, deep=True, ignore=())

Return a copy of the object

Parameters

deepboolean or list, optional

If True (default) then return a deep copy of all dict, list, and SchemaBase objects within the object structure. If False, then only copy the top object. If a list or iterable, then only copy the listed attributes.

ignorelist, optional

A list of keys for which the contents should not be copied, but only stored by reference.

classmethod from_dict(dct, validate=True, _wrapper_classes=None)

Construct class from a dictionary representation

Parameters

dctdictionary

The dict from which to construct the class

validateboolean

If True (default), then validate the input against the schema.

_wrapper_classeslist (optional)

The set of SchemaBase classes to use when constructing wrappers of the dict inputs. If not specified, the result of cls._default_wrapper_classes will be used.

Returns

objSchema object

The wrapped schema

Raises

jsonschema.ValidationError :

if validate=True and dct does not conform to the schema

classmethod from_json(json_string, validate=True, **kwargs)

Instantiate the object from a valid JSON string

Parameters

json_stringstring

The string containing a valid JSON chart specification.

validateboolean

If True (default), then validate the input against the schema.

**kwargs :

Additional keyword arguments are passed to json.loads

Returns

chartChart object

The altair Chart object built from the specification.

classmethod resolve_references(schema=None)

Resolve references in the context of this object’s schema or root schema.

to_dict(self, validate=True, ignore=None, context=None)

Return a dictionary representation of the object

Parameters

validateboolean or string

If True (default), then validate the output dictionary against the schema. If “deep” then recursively validate all objects in the spec. This takes much more time, but it results in friendlier tracebacks for large objects.

ignorelist

A list of keys to ignore. This will not passed to child to_dict function calls.

contextdict (optional)

A context dictionary that will be passed to all child to_dict function calls

Returns

dctdictionary

The dictionary representation of this object

Raises

jsonschema.ValidationError :

if validate=True and the dict does not conform to the schema

to_json(self, validate=True, ignore=[], context={}, indent=2, sort_keys=True, **kwargs)

Emit the JSON representation for this object as a string.

Parameters

validateboolean or string

If True (default), then validate the output dictionary against the schema. If “deep” then recursively validate all objects in the spec. This takes much more time, but it results in friendlier tracebacks for large objects.

ignorelist

A list of keys to ignore. This will not passed to child to_dict function calls.

contextdict (optional)

A context dictionary that will be passed to all child to_dict function calls

indentinteger, default 2

the number of spaces of indentation to use

sort_keysboolean, default True

if True, sort keys in the output

**kwargs

Additional keyword arguments are passed to json.dumps()

Returns

specstring

The JSON specification of the chart object.

classmethod validate(instance, schema=None)

Validate the instance against the class schema in the context of the rootschema.

classmethod validate_property(name, value, schema=None)

Validate a property against property schema in the context of the rootschema