Ctrl+K
This website is for version 5. You can find the documentation for version 4 here.

Vega-Altair

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

Parameters:
typestr, ErrorBand

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

bandbool, dict, BarConfig, AreaConfig, LineConfig, MarkConfig, RectConfig, TickConfig, AnyMarkConfig
bordersbool, dict, BarConfig, AreaConfig, LineConfig, MarkConfig, RectConfig, TickConfig, AnyMarkConfig
clipbool

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

colorstr, dict, Color, ExprRef, Gradient, HexColor, ColorName, LinearGradient, RadialGradient, Literal[‘black’, ‘silver’, ‘gray’, ‘white’, ‘maroon’, ‘red’, ‘purple’, ‘fuchsia’, ‘green’, ‘lime’, ‘olive’, ‘yellow’, ‘navy’, ‘blue’, ‘teal’, ‘aqua’, ‘orange’, ‘aliceblue’, ‘antiquewhite’, ‘aquamarine’, ‘azure’, ‘beige’, ‘bisque’, ‘blanchedalmond’, ‘blueviolet’, ‘brown’, ‘burlywood’, ‘cadetblue’, ‘chartreuse’, ‘chocolate’, ‘coral’, ‘cornflowerblue’, ‘cornsilk’, ‘crimson’, ‘cyan’, ‘darkblue’, ‘darkcyan’, ‘darkgoldenrod’, ‘darkgray’, ‘darkgreen’, ‘darkgrey’, ‘darkkhaki’, ‘darkmagenta’, ‘darkolivegreen’, ‘darkorange’, ‘darkorchid’, ‘darkred’, ‘darksalmon’, ‘darkseagreen’, ‘darkslateblue’, ‘darkslategray’, ‘darkslategrey’, ‘darkturquoise’, ‘darkviolet’, ‘deeppink’, ‘deepskyblue’, ‘dimgray’, ‘dimgrey’, ‘dodgerblue’, ‘firebrick’, ‘floralwhite’, ‘forestgreen’, ‘gainsboro’, ‘ghostwhite’, ‘gold’, ‘goldenrod’, ‘greenyellow’, ‘grey’, ‘honeydew’, ‘hotpink’, ‘indianred’, ‘indigo’, ‘ivory’, ‘khaki’, ‘lavender’, ‘lavenderblush’, ‘lawngreen’, ‘lemonchiffon’, ‘lightblue’, ‘lightcoral’, ‘lightcyan’, ‘lightgoldenrodyellow’, ‘lightgray’, ‘lightgreen’, ‘lightgrey’, ‘lightpink’, ‘lightsalmon’, ‘lightseagreen’, ‘lightskyblue’, ‘lightslategray’, ‘lightslategrey’, ‘lightsteelblue’, ‘lightyellow’, ‘limegreen’, ‘linen’, ‘magenta’, ‘mediumaquamarine’, ‘mediumblue’, ‘mediumorchid’, ‘mediumpurple’, ‘mediumseagreen’, ‘mediumslateblue’, ‘mediumspringgreen’, ‘mediumturquoise’, ‘mediumvioletred’, ‘midnightblue’, ‘mintcream’, ‘mistyrose’, ‘moccasin’, ‘navajowhite’, ‘oldlace’, ‘olivedrab’, ‘orangered’, ‘orchid’, ‘palegoldenrod’, ‘palegreen’, ‘paleturquoise’, ‘palevioletred’, ‘papayawhip’, ‘peachpuff’, ‘peru’, ‘pink’, ‘plum’, ‘powderblue’, ‘rosybrown’, ‘royalblue’, ‘saddlebrown’, ‘salmon’, ‘sandybrown’, ‘seagreen’, ‘seashell’, ‘sienna’, ‘skyblue’, ‘slateblue’, ‘slategray’, ‘slategrey’, ‘snow’, ‘springgreen’, ‘steelblue’, ‘tan’, ‘thistle’, ‘tomato’, ‘turquoise’, ‘violet’, ‘wheat’, ‘whitesmoke’, ‘yellowgreen’, ‘rebeccapurple’]

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, Literal[‘ci’, ‘iqr’, ‘stderr’, ‘stdev’]

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, Literal[‘basis’, ‘basis-open’, ‘basis-closed’, ‘bundle’, ‘cardinal’, ‘cardinal-open’, ‘cardinal-closed’, ‘catmull-rom’, ‘linear’, ‘linear-closed’, ‘monotone’, ‘natural’, ‘step’, ‘step-before’, ‘step-after’]

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, Literal[‘horizontal’, ‘vertical’]

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__(type=Undefined, band=Undefined, borders=Undefined, clip=Undefined, color=Undefined, extent=Undefined, interpolate=Undefined, opacity=Undefined, orient=Undefined, tension=Undefined, **kwds)#

Methods

__init__([type, band, borders, clip, color, ...])

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, 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
On this page