grids (original) (raw)
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.
{ "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", "context_menu": null, "coordinates": null, "cross_bounds": "auto", "css_classes": [], "css_variables": { "type": "map" }, "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, "html_attributes": { "type": "map" }, "html_id": null, "id": "p61286", "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, "propagate_hover": false, "styles": { "type": "map" }, "stylesheets": [], "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "ticker": null, "visible": true, "x_range_name": "default", "y_range_name": "default" }
axis = None#
Type:
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:
The fill alpha of alternating bands between Grid lines.
band_fill_color = None#
Type:
The fill color of alternating bands between Grid lines.
band_hatch_alpha = 1.0#
Type:
The hatch alpha of alternating bands between Grid lines.
band_hatch_color = 'black'#
Type:
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:
The hatch pattern of alternating bands between Grid lines.
band_hatch_scale = 12.0#
Type:
The hatch scale of alternating bands between Grid lines.
band_hatch_weight = 1.0#
Type:
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.
Type:
Nullable(Instance(‘.models.ui.Menu’))
A menu to display when user right clicks on the component.
Note
Use shift key when right clicking to display the native context menu.
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.
css_classes = []#
Type:
A list of additional CSS classes to add to the underlying DOM element.
css_variables = {}#
Type:
Dict(String, Either(String, Instance(Node)))
Allows to define dynamically computed CSS variables.
This can be used, for example, to coordinate positioning and styling between canvas’ renderers and/or visuals and HTML-based UI elements.
Variables defined here are equivalent to setting the same variables under :host { ... } in a CSS stylesheet.
Note
This property is experimental and may change at any point.
dimension = 0#
Type:
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:
The line alpha of the Grid lines.
grid_line_cap = 'butt'#
Type:
The line cap of the Grid lines.
grid_line_color = '#e5e5e5'#
Type:
The line color of the Grid lines.
grid_line_dash = []#
Type:
The line dash of the Grid lines.
grid_line_dash_offset = 0#
Type:
The line dash offset of the Grid lines.
grid_line_join = 'bevel'#
Type:
The line join of the Grid lines.
grid_line_width = 1#
Type:
The line width of the Grid lines.
group = None#
Type:
Nullable(Instance(RendererGroup))
Note
This property is experimental and may change at any point.
html_attributes = {}#
Type:
Allows to configure HTML attributes on the underlying HTML element.
html_id = None#
Type:
Sets the id attribute of the underlying HTML element.
This is a shorthand for the common HTML id attribute. Alternatively the id can be set in the html_attributes dictionary. html_idtakes precedence.
level = 'underlay'#
Type:
Specifies the level in which to paint this renderer.
minor_grid_line_alpha = 1.0#
Type:
The line alpha of the minor Grid lines.
minor_grid_line_cap = 'butt'#
Type:
The line cap of the minor Grid lines.
minor_grid_line_color = None#
Type:
The line color of the minor Grid lines.
minor_grid_line_dash = []#
Type:
The line dash of the minor Grid lines.
minor_grid_line_dash_offset = 0#
Type:
The line dash offset of the minor Grid lines.
minor_grid_line_join = 'bevel'#
Type:
The line join of the minor Grid lines.
minor_grid_line_width = 1#
Type:
The line width of the minor Grid lines.
name = None#
Type:
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
plot.scatter([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.
propagate_hover = False#
Type:
Allows to propagate hover events to the parent renderer, frame or canvas.
Note
This property is experimental and may change at any point.
styles = {}#
Type:
Either(Dict(String, Nullable(String)), Instance(Styles))
Inline CSS styles applied to the underlying DOM element.
stylesheets = []#
Type:
Additional style-sheets to use for the underlying DOM element.
Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.
syncable = True#
Type:
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:
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.scatter([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:
A Ticker to use for computing locations for the Grid lines.
visible = True#
Type:
Is the renderer visible.
x_range_name = 'default'#
Type:
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:
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 theHasProps instance should modify it).
Parameters:
property_values (dict) – theme values to use in place of defaults
Returns:
None
classmethod clear_extensions() → None#
Clear any currently defined custom extensions.
Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.
clone(**overrides: Any) → Self#
Duplicate a HasProps object.
This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
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:
classmethod descriptors() → list[PropertyDescriptor[Any]]#
List of property descriptors in the order of definition.
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
js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None#
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding aCustomJS 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
otherto link together - attr_selector (int | str) – The index to link an item in a subscriptable
attr
Added in version 1.1
Raises:
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: JSChangeCallback) → 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:
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
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → 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:
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:
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:
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
- value (JSON-value) – value to set to the attribute to
- 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, orNone 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#
Remove any themed values and restore defaults.
Returns:
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)