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

Vega-Altair

altair.ErrorBandConfig#

class altair.ErrorBandConfig(band=Undefined, borders=Undefined, extent=Undefined, interpolate=Undefined, tension=Undefined, **kwds)#

ErrorBandConfig schema wrapper

Parameters:
bandbool, dict, BarConfig, AreaConfig, LineConfig, MarkConfig, RectConfig, TickConfig, AnyMarkConfig
bordersbool, dict, BarConfig, AreaConfig, LineConfig, MarkConfig, RectConfig, TickConfig, AnyMarkConfig
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.

tensionfloat

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

__init__(band=Undefined, borders=Undefined, extent=Undefined, interpolate=Undefined, tension=Undefined, **kwds)#

Methods

__init__([band, borders, extent, ...])

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