Skip to main content

ChartErrorRange

The uncertainty of a data point's value on one axis, drawn as an error bar.

Both bounds are measured from the value, so the range spans from value - lower_by to value + upper_by.

Properties

  • lower_by - How far the range extends below the value.
  • upper_by - How far the range extends above the value.

Methods

  • copy - Returns a copy of this object with the specified properties overridden.
  • symmetric - Creates a range that extends equally below and above the value.

Properties​

lower_byinstance-attribute​

lower_by: Number

How far the range extends below the value.

Raises:

  • ValueError - If it is not greater than or equal to 0.

upper_byinstance-attribute​

upper_by: Number

How far the range extends above the value.

Raises:

  • ValueError - If it is not greater than or equal to 0.

Methods​

copy​

copy(
    lower_by: Number | None = None,
    upper_by: Number | None = None,
) -> ChartErrorRange

Returns a copy of this object with the specified properties overridden.

symmetricclassmethod​

symmetric(value: Number) -> ChartErrorRange

Creates a range that extends equally below and above the value.

Parameters:

  • value (Number) - The distance of both bounds from the value.