Anaconda Enterprise: Documentation

# bokeh.models.ranges

Models for describing different kinds of ranges of values in different kinds of spaces (e.g., continuous or categorical) and with options for “auto sizing”.

class `bokeh.models.ranges.``DataRange`(**kwargs)

  Bases: `bokeh.models.ranges.Range`

  A base class for all data range types.

  Note

  This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

  `names`

    property type: `List` ( `String` )

    A list of names to query for. If set, only renderers that have a matching value for their `name` attribute will be used for autoranging.

  `renderers`

    property type: `List` ( `Instance` ( `Renderer` ) )

    An explicit list of renderers to autorange against. If unset, defaults to all renderers on a plot.

JSON Prototype

    {
      "callback": null,
      "id": "69814064-021d-40b6-91cc-5f6c00b157eb",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "names": [],
      "renderers": [],
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.ranges.``DataRange1d`(*args, **kwargs)

  Bases: `bokeh.models.ranges.DataRange`

  An auto-fitting range in a continuous scalar dimension. The upper and lower bounds are set to the min and max of the data.

  `bounds`

    property type: `MinMaxBounds`

    The bounds that the range is allowed to go to. Typically used to prevent the user from panning/zooming/etc away from the data.

    By default, the bounds will be None, allowing your plot to pan/zoom as far as you want. If bounds are ‘auto’ they will be computed to be the same as the start and end of the DataRange1d.

    Bounds are provided as a tuple of `(min, max)` so regardless of whether your range is increasing or decreasing, the first item should be the minimum value of the range and the second item should be the maximum. Setting `min > max` will result in a `ValueError`.

    If you only want to constrain one end of the plot, you can set `min` or `max` to `None` e.g. `DataRange1d(bounds=(None, 12))`

  `default_span`

    property type: `Float`

    A default width for the interval, in case `start` is equal to `end` (if used with a log axis, default_span is in powers of 10).

  `end`

    property type: `Float`

    An explicitly supplied range end. If provided, will override automatically computed end value.

  `flipped`

    property type: `Bool`

    Whether the range should be “flipped” from its normal direction when auto-ranging.

  `follow`

    property type: `Enum` ( `StartEnd` )

    Configure the data to follow one or the other data extreme, with a maximum range size of `follow_interval`.

    If set to `"start"` then the range will adjust so that `start` always corresponds to the minimum data value (or maximum, if `flipped` is `True`).

    If set to `"end"` then the range will adjust so that `end` always corresponds to the maximum data value (or minimum, if `flipped` is `True`).

    If set to `None` (default), then auto-ranging does not follow, and the range will encompass both the minimum and maximum data values.

    `follow` cannot be used with bounds, and if set, bounds will be set to `None`.

  `follow_interval`

    property type: `Float`

    If `follow` is set to `"start"` or `"end"` then the range will always be constrained to that:

        abs(r.start - r.end) <= follow_interval

    is maintained.

  `max_interval`

    property type: `Float`

    The level that the range is allowed to zoom out, expressed as the maximum visible interval. Note that `bounds` can impose an implicit constraint on the maximum interval as well.

  `min_interval`

    property type: `Float`

    The level that the range is allowed to zoom in, expressed as the minimum visible interval. If set to `None` (default), the minimum interval is not bound.

  `range_padding`

    property type: `Float`

    How much padding to add around the computed data bounds.

    When `range_padding_units` is set to `"percent"`, the span of the range span is expanded to make the range `range_padding` percent larger.

    When `range_padding_units` is set to `"absolute"`, the start and end of the range span are extended by the amount `range_padding`.

  `range_padding_units`

    property type: `Enum` ( `PaddingUnits` )

    Whether the `range_padding` should be interpreted as a percentage, or as an absolute quantity. (default: `"percent"`)

  `start`

    property type: `Float`

    An explicitly supplied range start. If provided, will override automatically computed start value.

JSON Prototype

    {
      "bounds": null,
      "callback": null,
      "default_span": 2.0,
      "end": null,
      "flipped": false,
      "follow": null,
      "follow_interval": null,
      "id": "909ebfc2-ecbd-4cf4-a32b-eaed6db21292",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "max_interval": null,
      "min_interval": null,
      "name": null,
      "names": [],
      "range_padding": 0.1,
      "range_padding_units": "percent",
      "renderers": [],
      "start": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.ranges.``FactorRange`(*args, **kwargs)

  Bases: `bokeh.models.ranges.Range`

  A Range of values for a categorical dimension.

  In addition to supplying `factors` as a keyword argument to the `FactorRange` initializer, you may also instantiate with a sequence of positional arguments:

      FactorRange("foo", "bar") # equivalent to FactorRange(factors=["foo", "bar"])

  Users will normally supply categorical values directly:

      p.circle(x=["foo", "bar"], ...)

  BokehJS will create a mapping from `"foo"` and `"bar"` to a numerical coordinate system called synthetic coordinates. In the simplest cases, factors are separated by a distance of 1.0 in synthetic coordinates, however the exact mapping from factors to synthetic coordinates is affected by he padding properties as well as whether the number of levels the factors have.

  Users typically do not need to worry about the details of this mapping, however it can be useful to fine tune positions by adding offsets. When supplying factors as coordinates or values, it is possible to add an offset in the synthetic coordinate space by adding a final number value to a factor tuple. For example:

      p.circle(x=[("foo", 0.3), ...], ...)

  will position the first circle at an `x` position that is offset by adding 0.3 to the synthetic coordinate for `"foo"`.

  `bounds`

    property type: `MinMaxBounds`

    The bounds (in synthetic coordinates) that the range is allowed to go to. Typically used to prevent the user from panning/zooming/etc away from the data.

    Note

    Synthetic coordinates are only computed in the browser, based on the factors and various padding properties. Some experimentation may be required to arrive at bounds suitable for specific situations.

    By default, the bounds will be None, allowing your plot to pan/zoom as far as you want. If bounds are ‘auto’ they will be computed to be the same as the start and end of the FactorRange.

  `end`

    property type: `Float`

    The end of the range, in synthetic coordinates.

    Note

    Synthetic coordinates are only computed in the browser, based on the factors and various padding properties. The value of `end` will only be available in situations where bidirectional communication is available (e.g. server, notebook).

  `factor_padding`

    property type: `Float`

    How much padding to add in between all lowest-level factors. When `factor_padding` is non-zero, every factor in every group will have the padding value applied.

  `factors`

    property type: `Either` ( `Seq` ( `String` ), `Seq` ( `Tuple` ( `String` , `String` ) ), `Seq` ( `Tuple` ( `String` , `String` , `String` ) ) )

    A sequence of factors to define this categorical range.

    Factors may have 1, 2, or 3 levels. For 1-level factors, each factor is simply a string. For example:

    defines a range with three simple factors that might represent different units of a business.

    For 2- and 3- level factors, each factor is a tuple of strings:

        FactorRange(factors=[
            ["2016", "sales'], ["2016", "marketing'], ["2016", "engineering"],
            ["2017", "sales'], ["2017", "marketing'], ["2017", "engineering"],
        ])

    defines a range with six 2-level factors that might represent the three business units, grouped by year.

    Note that factors and sub-factors may only be strings.

  `group_padding`

    property type: `Float`

    How much padding to add in between top-level groups of factors. This property only applies when the overall range factors have either two or three levels. For example, with:

        FactorRange(factors=[["foo", "1'], ["foo", "2'], ["bar", "1"]])

    The top level groups correspond to `"foo"` and ``"bar"`, and the group padding will be applied between the factors``[“foo”, “2’]`` and `["bar", "1"]`

  `max_interval`

    property type: `Float`

    The level that the range is allowed to zoom out, expressed as the maximum visible interval in synthetic coordinates.. Note that `bounds` can impose an implicit constraint on the maximum interval as well.

    The default “width” of a category is 1.0 in synthetic coordinates. However, the distance between factors is affected by the various padding properties and whether or not factors are grouped.

  `min_interval`

    property type: `Float`

    The level that the range is allowed to zoom in, expressed as the minimum visible interval in synthetic coordinates. If set to `None` (default), the minimum interval is not bounded.

    The default “width” of a category is 1.0 in synthetic coordinates. However, the distance between factors is affected by the various padding properties and whether or not factors are grouped.

  `range_padding`

    property type: `Float`

    How much padding to add around the outside of computed range bounds.

    When `range_padding_units` is set to `"percent"`, the span of the range span is expanded to make the range `range_padding` percent larger.

    When `range_padding_units` is set to `"absolute"`, the start and end of the range span are extended by the amount `range_padding`.

  `range_padding_units`

    property type: `Enum` ( `PaddingUnits` )

    Whether the `range_padding` should be interpreted as a percentage, or as an absolute quantity. (default: `"percent"`)

  `start`

    property type: `Float`

    The start of the range, in synthetic coordinates.

    > Synthetic coordinates are only computed in the browser, based on the factors and various padding properties. The value of `end` will only be available in situations where bidirectional communication is available (e.g. server, notebook).

  `subgroup_padding`

    property type: `Float`

    How much padding to add in between mid-level groups of factors. This property only applies when the overall factors have three levels. For example with:

        FactorRange(factors=[
            ['foo', 'A', '1'],  ['foo', 'A', '2'], ['foo', 'A', '3'],
            ['foo', 'B', '2'],
            ['bar', 'A', '1'],  ['bar', 'A', '2']
        ])

    This property dictates how much padding to add between the three factors in the [‘foo’, ‘A’] group, and between the two factors in the the [bar]

JSON Prototype

    {
      "bounds": null,
      "callback": null,
      "factor_padding": 0.0,
      "factors": [],
      "group_padding": 1.4,
      "id": "bf54a1ff-9ada-4512-9f13-e74787389019",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "max_interval": null,
      "min_interval": null,
      "name": null,
      "range_padding": 0,
      "range_padding_units": "percent",
      "subgroup_padding": 0.8,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.ranges.``Range`(**kwargs)

  Bases: `bokeh.model.Model`

  A base class for all range types.

  Note

  This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

  `callback`

    property type: `Instance` ( `Callback` )

    A callback to run in the browser whenever the range is updated.

JSON Prototype

    {
      "callback": null,
      "id": "e284697c-ba92-47a2-9690-7d9386ff0a90",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.ranges.``Range1d`(*args, **kwargs)

  Bases: `bokeh.models.ranges.Range`

  A fixed, closed range [start, end] in a continuous scalar dimension.

  In addition to supplying `start` and `end` keyword arguments to the `Range1d` initializer, you can also instantiate with the convenience syntax:

      Range(0, 10) # equivalent to Range(start=0, end=10)

  `bounds`

    property type: `MinMaxBounds`

    The bounds that the range is allowed to go to. Typically used to prevent the user from panning/zooming/etc away from the data.

    If set to `'auto'`, the bounds will be computed to the start and end of the Range.

    Bounds are provided as a tuple of `(min, max)` so regardless of whether your range is increasing or decreasing, the first item should be the minimum value of the range and the second item should be the maximum. Setting min > max will result in a `ValueError`.

    By default, bounds are `None` and your plot to pan/zoom as far as you want. If you only want to constrain one end of the plot, you can set min or max to None.

    Examples:

    > Range1d(0, 1, bounds=’auto’) # Auto-bounded to 0 and 1 (Default behavior) Range1d(start=0, end=1, bounds=(0, None)) # Maximum is unbounded, minimum bounded to 0

  `end`

    property type: `Either` ( `Float` , `Datetime` , `Int` )

    The end of the range.

  `max_interval`

    property type: `Either` ( `Float` , `TimeDelta` , `Int` )

    The level that the range is allowed to zoom out, expressed as the maximum visible interval. Can be a timedelta. Note that `bounds` can impose an implicit constraint on the maximum interval as well.

  `min_interval`

    property type: `Either` ( `Float` , `TimeDelta` , `Int` )

    The level that the range is allowed to zoom in, expressed as the minimum visible interval. If set to `None` (default), the minimum interval is not bound. Can be a timedelta.

  `start`

    property type: `Either` ( `Float` , `Datetime` , `Int` )

    The start of the range.

JSON Prototype

    {
      "bounds": null,
      "callback": null,
      "end": 1,
      "id": "0dcc96ae-36ce-40c6-87df-57218a21ad9a",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "max_interval": null,
      "min_interval": null,
      "name": null,
      "start": 0,
      "subscribed_events": [],
      "tags": []
    }