Bokeh Menu

bokeh.models.sources

class AjaxDataSource(*args, **kw)[source]

Bases: bokeh.models.sources.RemoteSource

content_type

property type: String

Set the “contentType” parameter for the Ajax request.

http_headers

property type: Dict ( String , String )

HTTP headers to set for the Ajax request.

if_modified

property type: Bool

Whether to include an If-Modified-Since header in AJAX requests to the server. If this header is supported by the server, then only new data since the last request will be returned.

max_size

property type: Int

Maximum size of the data array being kept after each pull requests. Larger than that size, the data will be right shifted.

method

property type: Enum ( Enumeration(POST, GET) )

http method - GET or POST

mode

property type: Enum ( Enumeration(replace, append) )

Whether to append new data to existing data (up to max_size), or to replace existing data entirely.

JSON Prototype 
{
  "callback": null,
  "column_names": [],
  "content_type": "application/json",
  "data": {},
  "data_url": null,
  "http_headers": {},
  "id": "9e17e36e-267e-4c3d-879a-5a34cf65dc5d",
  "if_modified": false,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "max_size": null,
  "method": "POST",
  "mode": "replace",
  "name": null,
  "polling_interval": null,
  "selected": {
    "0d": {
      "glyph": null,
      "indices": []
    },
    "1d": {
      "indices": []
    },
    "2d": {
      "indices": {}
    }
  },
  "subscribed_events": [],
  "tags": []
}
class ColumnDataSource(*args, **kw)[source]

Bases: bokeh.models.sources.ColumnarDataSource

Maps names of columns to sequences or arrays.

If the ColumnDataSource initializer is called with a single argument that is a dict or pandas.DataFrame, that argument is used as the value for the “data” attribute. For example:

ColumnDataSource(mydict) # same as ColumnDataSource(data=mydict)
ColumnDataSource(df) # same as ColumnDataSource(data=df)

Note

There is an implicit assumption that all the columns in a a given ColumnDataSource have the same length.

data

property type: ColumnData ( String , Seq ( Any ) )

Mapping of column names to sequences of data. The data can be, e.g, Python lists or tuples, NumPy arrays, etc.

add(data, name=None)[source]

Appends a new column of data to the data source.

Parameters:
  • data (seq) – new data to add
  • name (str, optional) – column name to use. If not supplied, generate a name of the form “Series ####”
Returns:

the column name used
Return type:

str
classmethod from_df(data)[source]

Create a dict of columns from a Pandas DataFrame, suitable for creating a ColumnDataSource.

Parameters:data (DataFrame) – data to convert
Returns:dict[str, np.array]
patch(patches, setter=None)[source]

Efficiently update data source columns at specific locations

If it is only necessary to update a small subset of data in a ColumnDataSource, this method can be used to efficiently update only the subset, instead of requiring the entire data set to be sent.

This method should be passed a dictionary that maps column names to lists of tuples, each of the form (index, new_value). The value at the given index for that column will be updated with the new value.

Parameters:patches (dict[str, list[tuple]]) – lists of patches for each column.
Returns:None
Raises:ValueError

Example:

source = ColumnDataSource(data=dict(foo=[10, 20], bar=[100, 200]))

patches = {
    'foo' : [ (0, 1) ],
    'bar' : [ (0, 101), (1, 201) ],
}

source.patch(patches)
remove(name)[source]

Remove a column of data.

Parameters:name (str) – name of the column to remove
Returns:None

Note

If the column name does not exist, a warning is issued.

stream(new_data, rollover=None, setter=None)[source]

Efficiently update data source columns with new append-only data.

In cases where it is necessary to update data columns in, this method can efficiently send only the new data, instead of requiring the entire data set to be re-sent.

Parameters:
  • new_data (dict[str, seq]) –

    a mapping of column names to sequences of new data to append to each column.

    All columns of the data source must be present in new_data, with identical-length append data.

  • rollover (int, optional) – A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded (default: None)
Returns:

None
Raises:

ValueError

Example:

source = ColumnDataSource(data=dict(foo=[], bar=[]))

# has new, identical-length updates for all columns in source
new_data = {
    'foo' : [10, 20],
    'bar' : [100, 200],
}

source.stream(new_data)
to_df()[source]

Convert this data source to pandas dataframe.

If column_names is set, use those. Otherwise let Pandas infer the column names. The column_names property can be used both to order and filter the columns.

Returns:DataFrame
JSON Prototype 
{
  "callback": null,
  "column_names": [],
  "data": {},
  "id": "15edd109-0489-40f7-86e6-dc60f604216e",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "selected": {
    "0d": {
      "glyph": null,
      "indices": []
    },
    "1d": {
      "indices": []
    },
    "2d": {
      "indices": {}
    }
  },
  "subscribed_events": [],
  "tags": []
}
class ColumnarDataSource(**kwargs)[source]

Bases: bokeh.models.sources.DataSource

A base class for data source types, which can be mapped onto a columnar format.

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.

column_names

property type: List ( String )

An list of names for all the columns in this DataSource.

JSON Prototype 
{
  "callback": null,
  "column_names": [],
  "id": "b75894eb-6ab1-424d-a044-ddbd83c1684f",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "selected": {
    "0d": {
      "glyph": null,
      "indices": []
    },
    "1d": {
      "indices": []
    },
    "2d": {
      "indices": {}
    }
  },
  "subscribed_events": [],
  "tags": []
}
class DataSource(**kwargs)[source]

Bases: bokeh.model.Model

A base class for data source 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 selection is changed.

selected

property type: Dict ( String , Dict ( String , Any ) )

A dict to indicate selected indices on different dimensions on this DataSource. Keys are:

# selection information for line and patch glyphs
'0d' : {
  # the glyph that was selected
  'glyph': None

  # array with the [smallest] index of the segment of the line that was hit
  'indices': []
}

# selection for most (point-like) glyphs, except lines and patches
'1d': {
  # indices of the points included in the selection
  indices: []
}

# selection information for multiline and patches glyphs
'2d': {
  # mapping of indices of the multiglyph to array of glyph indices that were hit
  # e.g. {3: [5, 6], 4, [5]}
  indices: {}
}
JSON Prototype 
{
  "callback": null,
  "id": "20c79079-82a9-4622-ab63-66deb051c146",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "selected": {
    "0d": {
      "glyph": null,
      "indices": []
    },
    "1d": {
      "indices": []
    },
    "2d": {
      "indices": {}
    }
  },
  "subscribed_events": [],
  "tags": []
}
class GeoJSONDataSource(**kwargs)[source]

Bases: bokeh.models.sources.ColumnarDataSource

geojson

property type: JSON

GeoJSON that contains features for plotting. Currently GeoJSONDataSource can only process a FeatureCollection or GeometryCollection.

JSON Prototype 
{
  "callback": null,
  "column_names": [],
  "geojson": null,
  "id": "c7a70938-d99d-4151-bc87-019a80c4034c",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "selected": {
    "0d": {
      "glyph": null,
      "indices": []
    },
    "1d": {
      "indices": []
    },
    "2d": {
      "indices": {}
    }
  },
  "subscribed_events": [],
  "tags": []
}
class RemoteSource(*args, **kw)[source]

Bases: bokeh.models.sources.ColumnDataSource

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.

data_url

property type: String

The URL to the endpoint for the data.

polling_interval

property type: Int

polling interval for updating data source in milliseconds

JSON Prototype 
{
  "callback": null,
  "column_names": [],
  "data": {},
  "data_url": null,
  "id": "7a8f16ba-1ca5-4202-886c-af77fae8d2e6",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "polling_interval": null,
  "selected": {
    "0d": {
      "glyph": null,
      "indices": []
    },
    "1d": {
      "indices": []
    },
    "2d": {
      "indices": {}
    }
  },
  "subscribed_events": [],
  "tags": []
}