bokeh.models.transforms

class Interpolator(**kwargs)

Bases: bokeh.models.transforms.Transform

Base class for interpolator transforms.

Interpolators return the value of a function which has been evaluated between specified (x, y) pairs of data. As an example, if two control point pairs were provided to the interpolator, a linear interpolaction at a specific value of ‘x’ would result in the value of ‘y’ which existed on the line conneting the two control points.

The control point pairs for the interpolators can be specified through either

  • A literal sequence of values:
  • or a pair of columns defined in a ColumnDataSource object:

This is the base class and is not intended to end use. Please see the documentation for the final derived classes (Jitter, LineraInterpolator, StepInterpolator) for mor information on their specific methods of interpolation.

clip

property type: clip:Bool

Determine if the interpolation should clip the result to include only values inside its predefined range. If this is set to False, it will return the most value of the closest point.

data

property type: data:Instance(ColumnDataSource)

Data which defines the source for the named columns if a string is passed to either the x or y parameters.

x

property type: x:Either(String, Seq(Float))

Independant coordiante denoting the location of a point.

y

property type: y:Either(String, Seq(Float))

Dependant coordinate denoting the value of a point at a location.

JSON Prototype
{
  "clip": true,
  "data": null,
  "id": "c24bcb93-0de5-45b5-bb09-b675ad0f79e8",
  "name": null,
  "tags": [],
  "x": null,
  "y": null
}
class Jitter(**kwargs)

Bases: bokeh.models.transforms.Transform

Apply either a uniform or normally sampled random jitter to data.

distribution

property type: distribution:Enum(‘uniform’, ‘normal’)

The random distribution upon which to pull the random scatter

mean

property type: mean:Float

The central value for the random sample

width

property type: width:Float

The width (absolute for uniform distribution and sigma for the normal distribution) of the random sample.

JSON Prototype
{
  "distribution": "uniform",
  "id": "a58478dd-d2c3-47ae-91b7-6fda154ff87b",
  "mean": 0,
  "name": null,
  "tags": [],
  "width": 1
}
class LinearInterpolator(**kwargs)

Bases: bokeh.models.transforms.Interpolator

Compute a linear interpolation between the control points provided throught the x, y, and data parameters.

JSON Prototype
{
  "clip": true,
  "data": null,
  "id": "4f8dc1a6-d4c6-414f-85da-ddc37909d2dd",
  "name": null,
  "tags": [],
  "x": null,
  "y": null
}
class StepInterpolator(**kwargs)

Bases: bokeh.models.transforms.Interpolator

Compute a step-wise interpolation between the points provided throught the x, y, and data parameters.

mode

property type: mode:Enum(‘before’, ‘after’, ‘center’)

Adjust the behavior of the returned value in relation to the control points. The parameter can assume one of three values:

  • after (default): Assume the y-value associated with the nearest x-value which is less than or equal to the point to transform.
  • before: Assume the y-value associated with the nearest x-value which is greater than the point to transform.
  • center: Assume the y-value associated with the nearest x-value to the point to transform.
JSON Prototype
{
  "clip": true,
  "data": null,
  "id": "2b3c49d5-d8e2-4b9b-9425-7964370942bb",
  "mode": "after",
  "name": null,
  "tags": [],
  "x": null,
  "y": null
}
class Transform(**kwargs)

Bases: bokeh.model.Model

Base class for Transform models that represent a computation to be carried out on the client-side.

JavaScript implementations should implement the following methods:

JSON Prototype
{
  "id": "b40f09eb-7505-4a5f-b20f-0b65f4dc48de",
  "name": null,
  "tags": []
}