grids#

A guide renderer for displaying grid lines on Bokeh plots.

class Grid(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: GuideRenderer

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

JSON Prototype
{
  "axis": null,
  "band_fill_alpha": 0,
  "band_fill_color": null,
  "band_hatch_alpha": 1.0,
  "band_hatch_color": "black",
  "band_hatch_extra": {
    "type": "map"
  },
  "band_hatch_pattern": null,
  "band_hatch_scale": 12.0,
  "band_hatch_weight": 1.0,
  "bounds": "auto",
  "coordinates": null,
  "cross_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,
  "group": null,
  "id": "p122473",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "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": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "ticker": null,
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

dimension

Which dimension the Axis Grid lines will intersect.

bounds

Bounds for the rendered grid lines.

cross_bounds

Bounds for the rendered grid lines in the orthogonal direction.

axis

An Axis to delegate ticking to.

ticker

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

grid_line_color

The line color of the Grid lines.

grid_line_alpha

The line alpha of the Grid lines.

grid_line_width

The line width of the Grid lines.

grid_line_join

The line join of the Grid lines.

grid_line_cap

The line cap of the Grid lines.

grid_line_dash

The line dash of the Grid lines.

grid_line_dash_offset

The line dash offset of the Grid lines.

minor_grid_line_color

The line color of the minor Grid lines.

minor_grid_line_alpha

The line alpha of the minor Grid lines.

minor_grid_line_width

The line width of the minor Grid lines.

minor_grid_line_join

The line join of the minor Grid lines.

minor_grid_line_cap

The line cap of the minor Grid lines.

minor_grid_line_dash

The line dash of the minor Grid lines.

minor_grid_line_dash_offset

The line dash offset of the minor Grid lines.

band_fill_color

The fill color of alternating bands between Grid lines.

band_fill_alpha

The fill alpha of alternating bands between Grid lines.

band_hatch_color

The hatch color of alternating bands between Grid lines.

band_hatch_alpha

The hatch alpha of alternating bands between Grid lines.

band_hatch_scale

The hatch scale of alternating bands between Grid lines.

band_hatch_pattern

The hatch pattern of alternating bands between Grid lines.

band_hatch_weight

The hatch weight of alternating bands between Grid lines.

band_hatch_extra

The hatch extra of alternating bands between Grid lines.

name

An arbitrary, user-supplied name for this model.

tags

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

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

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

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.
Inherited from GuideRenderer

name

An arbitrary, user-supplied name for this model.

tags

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

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

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

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.
Inherited from Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

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

y_range_name

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

group

name

An arbitrary, user-supplied name for this model.

tags

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

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

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

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.
Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

js_property_callbacks

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

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

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

document

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

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, band_fill_alpha, ...])

Inherited from GuideRenderer

__init__(*[, group, level, name, syncable, ...])

Inherited from Renderer

__init__(*[, group, level, name, syncable, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

lookup()

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

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.
Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.
Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.
Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model
axis = None#
Type:

Nullable(Instance(Axis))

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 = 0#
Type:

Alpha

The fill alpha of alternating bands between Grid lines.

band_fill_color = None#
Type:

Nullable(Color)

The fill color of alternating bands between Grid lines.

band_hatch_alpha = 1.0#
Type:

Alpha

The hatch alpha of alternating bands between Grid lines.

band_hatch_color = 'black'#
Type:

Nullable(Color)

The hatch color of alternating bands between Grid lines.

band_hatch_extra = {}#
Type:

Dict(String, Instance(Texture))

The hatch extra of alternating bands between Grid lines.

band_hatch_pattern = None#
Type:

Nullable(String)

The hatch pattern of alternating bands between Grid lines.

band_hatch_scale = 12.0#
Type:

Size

The hatch scale of alternating bands between Grid lines.

band_hatch_weight = 1.0#
Type:

Size

The hatch weight of alternating bands between Grid lines.

bounds = 'auto'#
Type:

Either(Auto, Tuple(Float, Float))

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.

cross_bounds = 'auto'#
Type:

Either(Auto, Tuple(Float, Float))

Bounds for the rendered grid lines in the orthogonal direction. By default, a grid will span the entire visible range.

dimension = 0#
Type:

Int

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 = 1.0#
Type:

Alpha

The line alpha of the Grid lines.

grid_line_cap = 'butt'#
Type:

Enum(LineCap)

The line cap of the Grid lines.

grid_line_color = '#e5e5e5'#
Type:

Nullable(Color)

The line color of the Grid lines.

grid_line_dash = []#
Type:

DashPattern

The line dash of the Grid lines.

grid_line_dash_offset = 0#
Type:

Int

The line dash offset of the Grid lines.

grid_line_join = 'bevel'#
Type:

Enum(LineJoin)

The line join of the Grid lines.

grid_line_width = 1#
Type:

Float

The line width of the Grid lines.

level = 'underlay'#
Type:

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

minor_grid_line_alpha = 1.0#
Type:

Alpha

The line alpha of the minor Grid lines.

minor_grid_line_cap = 'butt'#
Type:

Enum(LineCap)

The line cap of the minor Grid lines.

minor_grid_line_color = None#
Type:

Nullable(Color)

The line color of the minor Grid lines.

minor_grid_line_dash = []#
Type:

DashPattern

The line dash of the minor Grid lines.

minor_grid_line_dash_offset = 0#
Type:

Int

The line dash offset of the minor Grid lines.

minor_grid_line_join = 'bevel'#
Type:

Enum(LineJoin)

The line join of the minor Grid lines.

minor_grid_line_width = 1#
Type:

Float

The line width of the minor Grid lines.

name = None#
Type:

Nullable(String)

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.

syncable = True#
Type:

Bool

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 = []#
Type:

List

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 = None#
Type:

Nullable(Instance(Ticker))

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

visible = True#
Type:

Bool

Is the renderer visible.

x_range_name = 'default'#
Type:

String

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 = 'default'#
Type:

String

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: dict[str, Any]) → None#

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() → dict[str, DataSpec]#

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 descriptors() → list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() → None#

Clean up references to the document and property

equals(other: HasProps) → bool#

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: str, *callbacks: JSEventCallback) → None#

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)
classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None#

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

Parameters:

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

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None#

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: str | type[Event], *callbacks: EventCallback) → None#

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 parameters() → list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]#

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, include_undefined: bool = False) → 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: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

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() → set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None#

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]#

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: SelectorType) → Model | None#

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: str, value: Any, *, setter: Setter | None = None) → 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: type[Model] | SelectorType, updates: dict[str, Any]) → None#

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

Parameters:

  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() → dict[str, Any] | None#

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_serializable(serializer: Serializer) → ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None#
unapply_theme() → None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None#

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)
property document: Document | None#

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