bokeh.models.grids

A guide renderer for displaying grid lines on Bokeh plots.

class Grid(*args, **kwargs)[source]

Bases: bokeh.models.renderers.GuideRenderer

Display horizontal or vertical grid lines at locations given by a supplied Ticker.

axis
Property type

Instance(Axis)

Default value

None

An Axis to delegate ticking to. If the ticker property is None, then the Grid will use the ticker on the specified axis for computing where to draw grid lines. Otherwise, it ticker is not None, it will take precedence over any Axis.

band_fill_alpha
Property type

Alpha

Default value

0

The fill alpha of alternating bands between Grid lines.

band_fill_color
Property type

Color

Default value

None

The fill color of alternating bands between Grid lines.

band_hatch_alpha
Property type

Alpha

Default value

1.0

The hatch alpha of alternating bands between Grid lines.

band_hatch_color
Property type

Color

Default value

'black'

The hatch color of alternating bands between Grid lines.

band_hatch_extra
Property type

Dict(String, Instance(Texture))

Default value

{}

The hatch extra of alternating bands between Grid lines.

band_hatch_pattern
Property type

String

Default value

None

The hatch pattern of alternating bands between Grid lines.

band_hatch_scale
Property type

Size

Default value

12.0

The hatch scale of alternating bands between Grid lines.

band_hatch_weight
Property type

Size

Default value

1.0

The hatch weight of alternating bands between Grid lines.

bounds
Property type

Either(Auto, Tuple(Float, Float))

Default value

'auto'

Bounds for the rendered grid lines. By default, a grid will look for a corresponding axis to ask for bounds. If one cannot be found, the grid will span the entire visible range.

dimension
Property type

Int

Default value

0

Which dimension the Axis Grid lines will intersect. The x-axis is dimension 0 (vertical Grid lines) and the y-axis is dimension 1 (horizontal Grid lines).

grid_line_alpha
Property type

Alpha

Default value

1.0

The line alpha of the Grid lines.

grid_line_cap
Property type

Enum(LineCap)

Default value

'butt'

The line cap of the Grid lines.

grid_line_color
Property type

Color

Default value

'#e5e5e5'

The line color of the Grid lines.

grid_line_dash
Property type

DashPattern

Default value

[]

The line dash of the Grid lines.

grid_line_dash_offset
Property type

Int

Default value

0

The line dash offset of the Grid lines.

grid_line_join
Property type

Enum(LineJoin)

Default value

'bevel'

The line join of the Grid lines.

grid_line_width
Property type

Float

Default value

1

The line width of the Grid lines.

js_event_callbacks
Property type

Dict(String, List(Instance(CustomJS)))

Default value

{}

A mapping of event names to lists of CustomJS callbacks.

Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_event method:

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks
Property type

Dict(String, List(Instance(CustomJS)))

Default value

{}

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_change method:

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
level
Property type

Enum(RenderLevel)

Default value

'underlay'

Specifies the level in which to paint this renderer.

minor_grid_line_alpha
Property type

Alpha

Default value

1.0

The line alpha of the minor Grid lines.

minor_grid_line_cap
Property type

Enum(LineCap)

Default value

'butt'

The line cap of the minor Grid lines.

minor_grid_line_color
Property type

Color

Default value

None

The line color of the minor Grid lines.

minor_grid_line_dash
Property type

DashPattern

Default value

[]

The line dash of the minor Grid lines.

minor_grid_line_dash_offset
Property type

Int

Default value

0

The line dash offset of the minor Grid lines.

minor_grid_line_join
Property type

Enum(LineJoin)

Default value

'bevel'

The line join of the minor Grid lines.

minor_grid_line_width
Property type

Float

Default value

1

The line width of the minor Grid lines.

name
Property type

String

Default value

None

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

subscribed_events
Property type

List(String)

Default value

[]

List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.

syncable
Property type

Bool

Default value

True

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags
Property type

List(AnyRef)

Default value

[]

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

ticker
Property type

Instance(Ticker)

Default value

None

A Ticker to use for computing locations for the Grid lines.

visible
Property type

Bool

Default value

True

Is the renderer visible.

x_range_name
Property type

String

Default value

'default'

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name
Property type

String

Default value

'default'

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters

property_values (dict) – theme values to use in place of defaults

Returns

None

classmethod dataspecs()

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns

names of DataSpec properties

Return type

set[str]

classmethod dataspecs_with_props()

Collect a dict mapping the names of all DataSpec properties on this class to the associated properties.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns

mapping of names and DataSpec properties

Return type

dict[str, DataSpec]

equals(other)

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters
  • attr (str) – The name of a Bokeh property on this model

  • other (Model) – A Bokeh model to link to self.attr

  • other_attr (str) – The property on other to link together

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises

ValueError

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)
js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)
layout(side, plot)
classmethod lookup(name)

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters

name (str) – name of the property to search for

Returns

descriptor for property named name

Return type

PropertyDescriptor

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

Parameters
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod properties(with_bases=True)

Collect the names of properties on this class.

This method optionally traverses the class hierarchy and includes properties defined on any parent classes.

Parameters

with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)

Returns

property names

Return type

set[str]

classmethod properties_containers()

Collect the names of all container properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns

names of container properties

Return type

set[str]

classmethod properties_with_refs()

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns

names of properties that have references

Return type

set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns

mapping from property names to their values

Return type

dict

query_properties_with_values(query, include_defaults=True)

Query the properties values of HasProps instances with a predicate.

Parameters
  • query (callable) – A callable that accepts property descriptors and returns True or False

  • include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns

mapping of property names and values for matching properties

Return type

dict

references()

Returns all Models that this object has references to.

remove_on_change(attr, *callbacks)

Remove a callback from this object

select(selector)

Query this object and all of its references for objects that match the given selector.

Parameters

selector (JSON-like) –

Returns

seq[Model]

select_one(selector)

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns

Model

set_from_json(name, json, models=None, setter=None)

Set a property value on this object from JSON.

Parameters
  • name – (str) : name of the attribute to set

  • json – (JSON-value) : value to set to the attribute to

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • setter (ClientSession or ServerSession or None, optional) –

    This is used to prevent “boomerang” updates to Bokeh apps.

    In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns

None

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values()

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns

dict or None

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

Remove any themed values and restore defaults.

Returns

None

update(**kwargs)

Updates the object’s properties from the given keyword arguments.

Returns

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)
update_from_json(json_attributes, models=None, setter=None)

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • setter (ClientSession or ServerSession or None, optional) –

    This is used to prevent “boomerang” updates to Bokeh apps.

    In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns

None

property document

The Document this model is attached to (can be None)

property struct

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

JSON Prototype
{
  "axis": null,
  "band_fill_alpha": 0,
  "band_fill_color": null,
  "band_hatch_alpha": 1.0,
  "band_hatch_color": "black",
  "band_hatch_extra": {},
  "band_hatch_pattern": null,
  "band_hatch_scale": 12.0,
  "band_hatch_weight": 1.0,
  "bounds": "auto",
  "dimension": 0,
  "grid_line_alpha": 1.0,
  "grid_line_cap": "butt",
  "grid_line_color": "#e5e5e5",
  "grid_line_dash": [],
  "grid_line_dash_offset": 0,
  "grid_line_join": "bevel",
  "grid_line_width": 1,
  "id": "15934",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "underlay",
  "minor_grid_line_alpha": 1.0,
  "minor_grid_line_cap": "butt",
  "minor_grid_line_color": null,
  "minor_grid_line_dash": [],
  "minor_grid_line_dash_offset": 0,
  "minor_grid_line_join": "bevel",
  "minor_grid_line_width": 1,
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "ticker": null,
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}