axes¶
Guide renderers for various kinds of axes that can be added to Bokeh plots
Axis¶
- class Axis(*args, **kwargs)[source]¶
Bases:
bokeh.models.renderers.GuideRenderer
A base class that defines common properties for all axis 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.
JSON Prototype
{ "axis_label": null, "axis_label_standoff": 5, "axis_label_text_align": "left", "axis_label_text_alpha": 1.0, "axis_label_text_baseline": "bottom", "axis_label_text_color": "#444444", "axis_label_text_font": "helvetica", "axis_label_text_font_size": "13px", "axis_label_text_font_style": "italic", "axis_label_text_line_height": 1.2, "axis_line_alpha": 1.0, "axis_line_cap": "butt", "axis_line_color": "black", "axis_line_dash": [], "axis_line_dash_offset": 0, "axis_line_join": "bevel", "axis_line_width": 1, "bounds": "auto", "coordinates": null, "fixed_location": null, "group": null, "id": "14370", "js_event_callbacks": {}, "js_property_callbacks": {}, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": {}, "major_label_policy": { "id": "14371" }, "major_label_standoff": 5, "major_label_text_align": "center", "major_label_text_alpha": 1.0, "major_label_text_baseline": "alphabetic", "major_label_text_color": "#444444", "major_label_text_font": "helvetica", "major_label_text_font_size": "11px", "major_label_text_font_style": "normal", "major_label_text_line_height": 1.2, "major_tick_in": 2, "major_tick_line_alpha": 1.0, "major_tick_line_cap": "butt", "major_tick_line_color": "black", "major_tick_line_dash": [], "major_tick_line_dash_offset": 0, "major_tick_line_join": "bevel", "major_tick_line_width": 1, "major_tick_out": 6, "minor_tick_in": 0, "minor_tick_line_alpha": 1.0, "minor_tick_line_cap": "butt", "minor_tick_line_color": "black", "minor_tick_line_dash": [], "minor_tick_line_dash_offset": 0, "minor_tick_line_join": "bevel", "minor_tick_line_width": 1, "minor_tick_out": 4, "name": null, "subscribed_events": [], "syncable": true, "tags": [], "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
Bounds for the rendered axis.
A Ticker to use for computing locations of axis components.
A
TickFormatter
to use for formatting the visual appearance of ticks.A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
The distance in pixels that the axis labels should be offset from the tick labels.
The text color of the axis label.
The text font size of the axis label.
The text align of the axis label.
The text line height of the axis label.
The text baseline of the axis label.
The text font of the axis label.
The text font style of the axis label.
The text alpha of the axis label.
The distance in pixels that the major tick labels should be offset from the associated ticks.
What direction the major label text should be oriented.
Provide explicit tick label values for specific tick locations that override normal formatting.
Allows to filter out labels, e.g.
The text color of the major tick labels.
The text font size of the major tick labels.
The text align of the major tick labels.
The text line height of the major tick labels.
The text baseline of the major tick labels.
The text font of the major tick labels.
The text font style of the major tick labels.
The text alpha of the major tick labels.
The line color of the axis line.
The line dash offset of the axis line.
The line width of the axis line.
The line dash of the axis line.
The line join of the axis line.
The line alpha of the axis line.
The line cap of the axis line.
The line color of the major ticks.
The line dash offset of the major ticks.
The line width of the major ticks.
The line dash of the major ticks.
The line join of the major ticks.
The line alpha of the major ticks.
The line cap of the major ticks.
The distance in pixels that major ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
The line color of the minor ticks.
The line dash offset of the minor ticks.
The line width of the minor ticks.
The line dash of the minor ticks.
The line join of the minor ticks.
The line alpha of the minor ticks.
The line cap of the minor ticks.
The distance in pixels that minor ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
Set to specify a fixed coordinate location to draw the axis.
Inherited from
Renderer
Specifies the level in which to paint this renderer.
Is the renderer visible.
coordinates
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
Inherited from
Model
model_class_reverse_map
id
ref
A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
An arbitrary, user-supplied name for this model.
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.subscribed_events
List of events that are subscribed to by Python 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.Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
Public Methods:
Inherited from
Model
__init_subclass__
()__new__
(cls, *args, **kwargs)__init__
(**kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
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.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_json
(include_defaults)Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
to_json_string
(include_defaults)Returns a JSON string encoding the attributes of this object.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init__
(**kwargs)__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.
static_to_serializable
(serializer)to_serializable
(serializer)set_from_json
(name, json, *[, models, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
update_from_json
(json_attributes, *[, ...])Updates the object's properties from a JSON attributes dictionary.
lookup
(name, *[, raises])Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.properties
(*[, _with_props])Collect the names of properties on this class.
Collect the names of all properties on this class that also have references.
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.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.
Remove any themed values and restore defaults.
Inherited from
HasDocumentRef
__init__
(**kwargs)Inherited from
PropertyCallbackManager
__init__
(**kwargs)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])Inherited from
EventCallbackManager
__init__
(**kwargs)on_event
(event, *callbacks)Run callbacks when the specified event occurs on this Model
- axis_label = None¶
-
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_standoff = 5¶
- Type
The distance in pixels that the axis labels should be offset from the tick labels.
- axis_label_text_baseline = 'bottom'¶
- Type
The text baseline of the axis label.
- axis_line_dash = []¶
- Type
The line dash of the axis line.
- bounds = 'auto'¶
-
Bounds for the rendered axis. If unset, the axis will span the entire plot in the given dimension.
- fixed_location = None¶
-
Set to specify a fixed coordinate location to draw the axis. The direction of ticks and major labels is determined by the side panel that the axis belongs to.
Note
Axes labels are suppressed when axes are positioned at fixed locations inside the central plot area.
- formatter = Undefined¶
- Type
A
TickFormatter
to use for formatting the visual appearance of ticks.
- level = 'guide'¶
- Type
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'¶
-
What direction the major label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- major_label_overrides = {}¶
-
Provide explicit tick label values for specific tick locations that override normal formatting.
- major_label_policy = AllLabels(id='14396', ...)¶
- Type
Instance
(LabelingPolicy
)
Allows to filter out labels, e.g. declutter labels to avoid overlap.
- major_label_standoff = 5¶
- Type
The distance in pixels that the major tick labels should be offset from the associated ticks.
- major_label_text_baseline = 'alphabetic'¶
- Type
The text baseline of the major tick labels.
- major_label_text_font_style = 'normal'¶
-
The text font style of the major tick labels.
- major_tick_in = 2¶
- Type
The distance in pixels that major ticks should extend into the main plot area.
- major_tick_line_dash = []¶
- Type
The line dash of the major ticks.
- major_tick_out = 6¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- minor_tick_in = 0¶
- Type
The distance in pixels that minor ticks should extend into the main plot area.
- minor_tick_line_dash = []¶
- Type
The line dash of the minor ticks.
- minor_tick_out = 4¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- name = 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.
- 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 anyon_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.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 = Undefined¶
-
A Ticker to use for computing locations of axis components.
The property may also be passed a sequence of floating point numbers as a shorthand for creating and configuring a
FixedTicker
, e.g. the following codefrom bokeh.plotting import figure p = figure() p.xaxis.ticker = [10, 20, 37.4]
is equivalent to:
from bokeh.plotting import figure from bokeh.models import FixedTicker p = figure() p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
- 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 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.
- equals(other: bokeh.core.has_props.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 a CustomJS callback to update one Bokeh model property whenever another changes value.
- Parameters
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: 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
- 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
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 properties(*, _with_props: bool = False) Union[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.
- 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.
- query_properties_with_values(query: Callable[[bokeh.core.property.descriptors.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
- references() Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) 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, Unknown] | 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_json(include_defaults: bool) JSON ¶
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: bool) str ¶
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: str, old: Unknown, new: Unknown, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) 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)
- update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) 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 struct: bokeh.core.types.ReferenceJson¶
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.
CategoricalAxis¶
- class CategoricalAxis(*args, **kwargs)[source]¶
Bases:
bokeh.models.axes.Axis
An axis that displays ticks and labels for categorical ranges.
The
CategoricalAxis
can handle factor ranges with up to two levels of nesting, including drawing a separator line between top-level groups of factors.JSON Prototype
{ "axis_label": null, "axis_label_standoff": 5, "axis_label_text_align": "left", "axis_label_text_alpha": 1.0, "axis_label_text_baseline": "bottom", "axis_label_text_color": "#444444", "axis_label_text_font": "helvetica", "axis_label_text_font_size": "13px", "axis_label_text_font_style": "italic", "axis_label_text_line_height": 1.2, "axis_line_alpha": 1.0, "axis_line_cap": "butt", "axis_line_color": "black", "axis_line_dash": [], "axis_line_dash_offset": 0, "axis_line_join": "bevel", "axis_line_width": 1, "bounds": "auto", "coordinates": null, "fixed_location": null, "formatter": { "id": "14433" }, "group": null, "group_label_orientation": "parallel", "group_text_align": "left", "group_text_alpha": 1.0, "group_text_baseline": "bottom", "group_text_color": "grey", "group_text_font": "helvetica", "group_text_font_size": "11px", "group_text_font_style": "bold", "group_text_line_height": 1.2, "id": "14431", "js_event_callbacks": {}, "js_property_callbacks": {}, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": {}, "major_label_policy": { "id": "14434" }, "major_label_standoff": 5, "major_label_text_align": "center", "major_label_text_alpha": 1.0, "major_label_text_baseline": "alphabetic", "major_label_text_color": "#444444", "major_label_text_font": "helvetica", "major_label_text_font_size": "11px", "major_label_text_font_style": "normal", "major_label_text_line_height": 1.2, "major_tick_in": 2, "major_tick_line_alpha": 1.0, "major_tick_line_cap": "butt", "major_tick_line_color": "black", "major_tick_line_dash": [], "major_tick_line_dash_offset": 0, "major_tick_line_join": "bevel", "major_tick_line_width": 1, "major_tick_out": 6, "minor_tick_in": 0, "minor_tick_line_alpha": 1.0, "minor_tick_line_cap": "butt", "minor_tick_line_color": "black", "minor_tick_line_dash": [], "minor_tick_line_dash_offset": 0, "minor_tick_line_join": "bevel", "minor_tick_line_width": 1, "minor_tick_out": 4, "name": null, "separator_line_alpha": 1.0, "separator_line_cap": "butt", "separator_line_color": "lightgrey", "separator_line_dash": [], "separator_line_dash_offset": 0, "separator_line_join": "bevel", "separator_line_width": 2, "subgroup_label_orientation": "parallel", "subgroup_text_align": "left", "subgroup_text_alpha": 1.0, "subgroup_text_baseline": "bottom", "subgroup_text_color": "#444444", "subgroup_text_font": "helvetica", "subgroup_text_font_size": "11px", "subgroup_text_font_style": "bold", "subgroup_text_line_height": 1.2, "subscribed_events": [], "syncable": true, "tags": [], "ticker": { "id": "14432" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
The line color of the separator line between top-level categorical groups.
The line dash offset of the separator line between top-level categorical groups.
The line width of the separator line between top-level categorical groups.
The line dash of the separator line between top-level categorical groups.
The line join of the separator line between top-level categorical groups.
The line alpha of the separator line between top-level categorical groups.
The line cap of the separator line between top-level categorical groups.
The text color of the group categorical labels.
The text font size of the group categorical labels.
The text align of the group categorical labels.
The text line height of the group categorical labels.
The text baseline of the group categorical labels.
The text font of the group categorical labels.
The text font style of the group categorical labels.
The text alpha of the group categorical labels.
What direction the group label text should be oriented.
The text color of the subgroup categorical labels.
The text font size of the subgroup categorical labels.
The text align of the subgroup categorical labels.
The text line height of the subgroup categorical labels.
The text baseline of the subgroup categorical labels.
The text font of the subgroup categorical labels.
The text font style of the subgroup categorical labels.
The text alpha of the subgroup categorical labels.
What direction the subgroup label text should be oriented.
Inherited from
Axis
Bounds for the rendered axis.
A Ticker to use for computing locations of axis components.
A
TickFormatter
to use for formatting the visual appearance of ticks.A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
The distance in pixels that the axis labels should be offset from the tick labels.
The text color of the axis label.
The text font size of the axis label.
The text align of the axis label.
The text line height of the axis label.
The text baseline of the axis label.
The text font of the axis label.
The text font style of the axis label.
The text alpha of the axis label.
The distance in pixels that the major tick labels should be offset from the associated ticks.
What direction the major label text should be oriented.
Provide explicit tick label values for specific tick locations that override normal formatting.
Allows to filter out labels, e.g.
The text color of the major tick labels.
The text font size of the major tick labels.
The text align of the major tick labels.
The text line height of the major tick labels.
The text baseline of the major tick labels.
The text font of the major tick labels.
The text font style of the major tick labels.
The text alpha of the major tick labels.
The line color of the axis line.
The line dash offset of the axis line.
The line width of the axis line.
The line dash of the axis line.
The line join of the axis line.
The line alpha of the axis line.
The line cap of the axis line.
The line color of the major ticks.
The line dash offset of the major ticks.
The line width of the major ticks.
The line dash of the major ticks.
The line join of the major ticks.
The line alpha of the major ticks.
The line cap of the major ticks.
The distance in pixels that major ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
The line color of the minor ticks.
The line dash offset of the minor ticks.
The line width of the minor ticks.
The line dash of the minor ticks.
The line join of the minor ticks.
The line alpha of the minor ticks.
The line cap of the minor ticks.
The distance in pixels that minor ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
Set to specify a fixed coordinate location to draw the axis.
Inherited from
Renderer
Specifies the level in which to paint this renderer.
Is the renderer visible.
coordinates
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
Inherited from
Model
model_class_reverse_map
id
ref
A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
An arbitrary, user-supplied name for this model.
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.subscribed_events
List of events that are subscribed to by Python 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.Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
Public Methods:
Inherited from
Model
__init_subclass__
()__new__
(cls, *args, **kwargs)__init__
(**kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
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.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_json
(include_defaults)Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
to_json_string
(include_defaults)Returns a JSON string encoding the attributes of this object.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init__
(**kwargs)__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.
static_to_serializable
(serializer)to_serializable
(serializer)set_from_json
(name, json, *[, models, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
update_from_json
(json_attributes, *[, ...])Updates the object's properties from a JSON attributes dictionary.
lookup
(name, *[, raises])Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.properties
(*[, _with_props])Collect the names of properties on this class.
Collect the names of all properties on this class that also have references.
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.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.
Remove any themed values and restore defaults.
Inherited from
HasDocumentRef
__init__
(**kwargs)Inherited from
PropertyCallbackManager
__init__
(**kwargs)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])Inherited from
EventCallbackManager
__init__
(**kwargs)on_event
(event, *callbacks)Run callbacks when the specified event occurs on this Model
- axis_label = None¶
-
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_standoff = 5¶
- Type
The distance in pixels that the axis labels should be offset from the tick labels.
- axis_label_text_baseline = 'bottom'¶
- Type
The text baseline of the axis label.
- axis_line_dash = []¶
- Type
The line dash of the axis line.
- bounds = 'auto'¶
-
Bounds for the rendered axis. If unset, the axis will span the entire plot in the given dimension.
- fixed_location = None¶
-
Set to specify a fixed coordinate location to draw the axis. The direction of ticks and major labels is determined by the side panel that the axis belongs to.
Note
Axes labels are suppressed when axes are positioned at fixed locations inside the central plot area.
- formatter = CategoricalTickFormatter(id='14455', ...)¶
- Type
A
TickFormatter
to use for formatting the visual appearance of ticks.
- group_label_orientation = 'parallel'¶
- Type
What direction the group label text should be oriented.
If a number is supplied, the angle of the text is measured from horizontal.
This property always applies to factors in the outermost level of nesting. If the list of categorical factors is flat (i.e. no nesting) then this property has no effect.
- group_text_align = 'left'¶
-
The text align of the group categorical labels.
This property always applies to factors in the outermost level of nesting. If the list of categorical factors is flat (i.e. no nesting) then this property has no effect.
- group_text_alpha = 1.0¶
- Type
The text alpha of the group categorical labels.
This property always applies to factors in the outermost level of nesting. If the list of categorical factors is flat (i.e. no nesting) then this property has no effect.
- group_text_baseline = 'bottom'¶
- Type
The text baseline of the group categorical labels.
This property always applies to factors in the outermost level of nesting. If the list of categorical factors is flat (i.e. no nesting) then this property has no effect.
- group_text_color = 'grey'¶
-
The text color of the group categorical labels.
This property always applies to factors in the outermost level of nesting. If the list of categorical factors is flat (i.e. no nesting) then this property has no effect.
- group_text_font = 'helvetica'¶
- Type
The text font of the group categorical labels.
This property always applies to factors in the outermost level of nesting. If the list of categorical factors is flat (i.e. no nesting) then this property has no effect.
- group_text_font_size = '11px'¶
- Type
The text font size of the group categorical labels.
This property always applies to factors in the outermost level of nesting. If the list of categorical factors is flat (i.e. no nesting) then this property has no effect.
- group_text_font_style = 'bold'¶
-
The text font style of the group categorical labels.
This property always applies to factors in the outermost level of nesting. If the list of categorical factors is flat (i.e. no nesting) then this property has no effect.
- group_text_line_height = 1.2¶
- Type
The text line height of the group categorical labels.
This property always applies to factors in the outermost level of nesting. If the list of categorical factors is flat (i.e. no nesting) then this property has no effect.
- level = 'guide'¶
- Type
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'¶
-
What direction the major label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- major_label_overrides = {}¶
-
Provide explicit tick label values for specific tick locations that override normal formatting.
- major_label_policy = AllLabels(id='14469', ...)¶
- Type
Instance
(LabelingPolicy
)
Allows to filter out labels, e.g. declutter labels to avoid overlap.
- major_label_standoff = 5¶
- Type
The distance in pixels that the major tick labels should be offset from the associated ticks.
- major_label_text_baseline = 'alphabetic'¶
- Type
The text baseline of the major tick labels.
- major_label_text_font_style = 'normal'¶
-
The text font style of the major tick labels.
- major_tick_in = 2¶
- Type
The distance in pixels that major ticks should extend into the main plot area.
- major_tick_line_dash = []¶
- Type
The line dash of the major ticks.
- major_tick_out = 6¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- minor_tick_in = 0¶
- Type
The distance in pixels that minor ticks should extend into the main plot area.
- minor_tick_line_dash = []¶
- Type
The line dash of the minor ticks.
- minor_tick_out = 4¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- name = 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.
- separator_line_alpha = 1.0¶
- Type
The line alpha of the separator line between top-level categorical groups.
This property always applies to factors in the outermost level of nesting.
- separator_line_cap = 'butt'¶
-
The line cap of the separator line between top-level categorical groups.
This property always applies to factors in the outermost level of nesting.
- separator_line_color = 'lightgrey'¶
-
The line color of the separator line between top-level categorical groups.
This property always applies to factors in the outermost level of nesting.
- separator_line_dash = []¶
- Type
The line dash of the separator line between top-level categorical groups.
This property always applies to factors in the outermost level of nesting.
- separator_line_dash_offset = 0¶
- Type
The line dash offset of the separator line between top-level categorical groups.
This property always applies to factors in the outermost level of nesting.
- separator_line_join = 'bevel'¶
-
The line join of the separator line between top-level categorical groups.
This property always applies to factors in the outermost level of nesting.
- separator_line_width = 2¶
- Type
The line width of the separator line between top-level categorical groups.
This property always applies to factors in the outermost level of nesting.
- subgroup_label_orientation = 'parallel'¶
- Type
What direction the subgroup label text should be oriented.
If a number is supplied, the angle of the text is measured from horizontal.
This property always applies to factors in the middle level of nesting. If the list of categorical factors is has only zero or one levels of nesting, then this property has no effect.
- subgroup_text_align = 'left'¶
-
The text align of the subgroup categorical labels.
This property always applies to factors in the middle level of nesting. If the list of categorical factors is has only zero or one levels of nesting, then this property has no effect.
- subgroup_text_alpha = 1.0¶
- Type
The text alpha of the subgroup categorical labels.
This property always applies to factors in the middle level of nesting. If the list of categorical factors is has only zero or one levels of nesting, then this property has no effect.
- subgroup_text_baseline = 'bottom'¶
- Type
The text baseline of the subgroup categorical labels.
This property always applies to factors in the middle level of nesting. If the list of categorical factors is has only zero or one levels of nesting, then this property has no effect.
- subgroup_text_color = '#444444'¶
-
The text color of the subgroup categorical labels.
This property always applies to factors in the middle level of nesting. If the list of categorical factors is has only zero or one levels of nesting, then this property has no effect.
- subgroup_text_font = 'helvetica'¶
- Type
The text font of the subgroup categorical labels.
This property always applies to factors in the middle level of nesting. If the list of categorical factors is has only zero or one levels of nesting, then this property has no effect.
- subgroup_text_font_size = '11px'¶
- Type
The text font size of the subgroup categorical labels.
This property always applies to factors in the middle level of nesting. If the list of categorical factors is has only zero or one levels of nesting, then this property has no effect.
- subgroup_text_font_style = 'bold'¶
-
The text font style of the subgroup categorical labels.
This property always applies to factors in the middle level of nesting. If the list of categorical factors is has only zero or one levels of nesting, then this property has no effect.
- subgroup_text_line_height = 1.2¶
- Type
The text line height of the subgroup categorical labels.
This property always applies to factors in the middle level of nesting. If the list of categorical factors is has only zero or one levels of nesting, then this property has no effect.
- 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 anyon_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.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 = CategoricalTicker(id='14517', ...)¶
-
A Ticker to use for computing locations of axis components.
The property may also be passed a sequence of floating point numbers as a shorthand for creating and configuring a
FixedTicker
, e.g. the following codefrom bokeh.plotting import figure p = figure() p.xaxis.ticker = [10, 20, 37.4]
is equivalent to:
from bokeh.plotting import figure from bokeh.models import FixedTicker p = figure() p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
- 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 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.
- equals(other: bokeh.core.has_props.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 a CustomJS callback to update one Bokeh model property whenever another changes value.
- Parameters
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: 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
- 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
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 properties(*, _with_props: bool = False) Union[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.
- 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.
- query_properties_with_values(query: Callable[[bokeh.core.property.descriptors.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
- references() Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) 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, Unknown] | 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_json(include_defaults: bool) JSON ¶
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: bool) str ¶
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: str, old: Unknown, new: Unknown, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) 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)
- update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) 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 struct: bokeh.core.types.ReferenceJson¶
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.
ContinuousAxis¶
- class ContinuousAxis(*args, **kwargs)[source]¶
Bases:
bokeh.models.axes.Axis
A base class for all numeric, non-categorical axes 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.
JSON Prototype
{ "axis_label": null, "axis_label_standoff": 5, "axis_label_text_align": "left", "axis_label_text_alpha": 1.0, "axis_label_text_baseline": "bottom", "axis_label_text_color": "#444444", "axis_label_text_font": "helvetica", "axis_label_text_font_size": "13px", "axis_label_text_font_style": "italic", "axis_label_text_line_height": 1.2, "axis_line_alpha": 1.0, "axis_line_cap": "butt", "axis_line_color": "black", "axis_line_dash": [], "axis_line_dash_offset": 0, "axis_line_join": "bevel", "axis_line_width": 1, "bounds": "auto", "coordinates": null, "fixed_location": null, "group": null, "id": "14521", "js_event_callbacks": {}, "js_property_callbacks": {}, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": {}, "major_label_policy": { "id": "14522" }, "major_label_standoff": 5, "major_label_text_align": "center", "major_label_text_alpha": 1.0, "major_label_text_baseline": "alphabetic", "major_label_text_color": "#444444", "major_label_text_font": "helvetica", "major_label_text_font_size": "11px", "major_label_text_font_style": "normal", "major_label_text_line_height": 1.2, "major_tick_in": 2, "major_tick_line_alpha": 1.0, "major_tick_line_cap": "butt", "major_tick_line_color": "black", "major_tick_line_dash": [], "major_tick_line_dash_offset": 0, "major_tick_line_join": "bevel", "major_tick_line_width": 1, "major_tick_out": 6, "minor_tick_in": 0, "minor_tick_line_alpha": 1.0, "minor_tick_line_cap": "butt", "minor_tick_line_color": "black", "minor_tick_line_dash": [], "minor_tick_line_dash_offset": 0, "minor_tick_line_join": "bevel", "minor_tick_line_width": 1, "minor_tick_out": 4, "name": null, "subscribed_events": [], "syncable": true, "tags": [], "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
Inherited from
Axis
Bounds for the rendered axis.
A Ticker to use for computing locations of axis components.
A
TickFormatter
to use for formatting the visual appearance of ticks.A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
The distance in pixels that the axis labels should be offset from the tick labels.
The text color of the axis label.
The text font size of the axis label.
The text align of the axis label.
The text line height of the axis label.
The text baseline of the axis label.
The text font of the axis label.
The text font style of the axis label.
The text alpha of the axis label.
The distance in pixels that the major tick labels should be offset from the associated ticks.
What direction the major label text should be oriented.
Provide explicit tick label values for specific tick locations that override normal formatting.
Allows to filter out labels, e.g.
The text color of the major tick labels.
The text font size of the major tick labels.
The text align of the major tick labels.
The text line height of the major tick labels.
The text baseline of the major tick labels.
The text font of the major tick labels.
The text font style of the major tick labels.
The text alpha of the major tick labels.
The line color of the axis line.
The line dash offset of the axis line.
The line width of the axis line.
The line dash of the axis line.
The line join of the axis line.
The line alpha of the axis line.
The line cap of the axis line.
The line color of the major ticks.
The line dash offset of the major ticks.
The line width of the major ticks.
The line dash of the major ticks.
The line join of the major ticks.
The line alpha of the major ticks.
The line cap of the major ticks.
The distance in pixels that major ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
The line color of the minor ticks.
The line dash offset of the minor ticks.
The line width of the minor ticks.
The line dash of the minor ticks.
The line join of the minor ticks.
The line alpha of the minor ticks.
The line cap of the minor ticks.
The distance in pixels that minor ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
Set to specify a fixed coordinate location to draw the axis.
Inherited from
Renderer
Specifies the level in which to paint this renderer.
Is the renderer visible.
coordinates
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
Inherited from
Model
model_class_reverse_map
id
ref
A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
An arbitrary, user-supplied name for this model.
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.subscribed_events
List of events that are subscribed to by Python 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.Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
Public Methods:
Inherited from
Model
__init_subclass__
()__new__
(cls, *args, **kwargs)__init__
(**kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
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.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_json
(include_defaults)Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
to_json_string
(include_defaults)Returns a JSON string encoding the attributes of this object.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init__
(**kwargs)__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.
static_to_serializable
(serializer)to_serializable
(serializer)set_from_json
(name, json, *[, models, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
update_from_json
(json_attributes, *[, ...])Updates the object's properties from a JSON attributes dictionary.
lookup
(name, *[, raises])Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.properties
(*[, _with_props])Collect the names of properties on this class.
Collect the names of all properties on this class that also have references.
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.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.
Remove any themed values and restore defaults.
Inherited from
HasDocumentRef
__init__
(**kwargs)Inherited from
PropertyCallbackManager
__init__
(**kwargs)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])Inherited from
EventCallbackManager
__init__
(**kwargs)on_event
(event, *callbacks)Run callbacks when the specified event occurs on this Model
- axis_label = None¶
-
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_standoff = 5¶
- Type
The distance in pixels that the axis labels should be offset from the tick labels.
- axis_label_text_baseline = 'bottom'¶
- Type
The text baseline of the axis label.
- axis_line_dash = []¶
- Type
The line dash of the axis line.
- bounds = 'auto'¶
-
Bounds for the rendered axis. If unset, the axis will span the entire plot in the given dimension.
- fixed_location = None¶
-
Set to specify a fixed coordinate location to draw the axis. The direction of ticks and major labels is determined by the side panel that the axis belongs to.
Note
Axes labels are suppressed when axes are positioned at fixed locations inside the central plot area.
- formatter = Undefined¶
- Type
A
TickFormatter
to use for formatting the visual appearance of ticks.
- level = 'guide'¶
- Type
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'¶
-
What direction the major label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- major_label_overrides = {}¶
-
Provide explicit tick label values for specific tick locations that override normal formatting.
- major_label_policy = AllLabels(id='14547', ...)¶
- Type
Instance
(LabelingPolicy
)
Allows to filter out labels, e.g. declutter labels to avoid overlap.
- major_label_standoff = 5¶
- Type
The distance in pixels that the major tick labels should be offset from the associated ticks.
- major_label_text_baseline = 'alphabetic'¶
- Type
The text baseline of the major tick labels.
- major_label_text_font_style = 'normal'¶
-
The text font style of the major tick labels.
- major_tick_in = 2¶
- Type
The distance in pixels that major ticks should extend into the main plot area.
- major_tick_line_dash = []¶
- Type
The line dash of the major ticks.
- major_tick_out = 6¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- minor_tick_in = 0¶
- Type
The distance in pixels that minor ticks should extend into the main plot area.
- minor_tick_line_dash = []¶
- Type
The line dash of the minor ticks.
- minor_tick_out = 4¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- name = 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.
- 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 anyon_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.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 = Undefined¶
-
A Ticker to use for computing locations of axis components.
The property may also be passed a sequence of floating point numbers as a shorthand for creating and configuring a
FixedTicker
, e.g. the following codefrom bokeh.plotting import figure p = figure() p.xaxis.ticker = [10, 20, 37.4]
is equivalent to:
from bokeh.plotting import figure from bokeh.models import FixedTicker p = figure() p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
- 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 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.
- equals(other: bokeh.core.has_props.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 a CustomJS callback to update one Bokeh model property whenever another changes value.
- Parameters
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: 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
- 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
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 properties(*, _with_props: bool = False) Union[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.
- 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.
- query_properties_with_values(query: Callable[[bokeh.core.property.descriptors.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
- references() Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) 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, Unknown] | 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_json(include_defaults: bool) JSON ¶
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: bool) str ¶
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: str, old: Unknown, new: Unknown, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) 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)
- update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) 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 struct: bokeh.core.types.ReferenceJson¶
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.
DatetimeAxis¶
- class DatetimeAxis(*args, **kwargs)[source]¶
Bases:
bokeh.models.axes.LinearAxis
A
LinearAxis
that picks nice numbers for tick locations on a datetime scale. Configured with aDatetimeTickFormatter
by default.JSON Prototype
{ "axis_label": null, "axis_label_standoff": 5, "axis_label_text_align": "left", "axis_label_text_alpha": 1.0, "axis_label_text_baseline": "bottom", "axis_label_text_color": "#444444", "axis_label_text_font": "helvetica", "axis_label_text_font_size": "13px", "axis_label_text_font_style": "italic", "axis_label_text_line_height": 1.2, "axis_line_alpha": 1.0, "axis_line_cap": "butt", "axis_line_color": "black", "axis_line_dash": [], "axis_line_dash_offset": 0, "axis_line_join": "bevel", "axis_line_width": 1, "bounds": "auto", "coordinates": null, "fixed_location": null, "formatter": { "id": "14584" }, "group": null, "id": "14582", "js_event_callbacks": {}, "js_property_callbacks": {}, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": {}, "major_label_policy": { "id": "14585" }, "major_label_standoff": 5, "major_label_text_align": "center", "major_label_text_alpha": 1.0, "major_label_text_baseline": "alphabetic", "major_label_text_color": "#444444", "major_label_text_font": "helvetica", "major_label_text_font_size": "11px", "major_label_text_font_style": "normal", "major_label_text_line_height": 1.2, "major_tick_in": 2, "major_tick_line_alpha": 1.0, "major_tick_line_cap": "butt", "major_tick_line_color": "black", "major_tick_line_dash": [], "major_tick_line_dash_offset": 0, "major_tick_line_join": "bevel", "major_tick_line_width": 1, "major_tick_out": 6, "minor_tick_in": 0, "minor_tick_line_alpha": 1.0, "minor_tick_line_cap": "butt", "minor_tick_line_color": "black", "minor_tick_line_dash": [], "minor_tick_line_dash_offset": 0, "minor_tick_line_join": "bevel", "minor_tick_line_width": 1, "minor_tick_out": 4, "name": null, "subscribed_events": [], "syncable": true, "tags": [], "ticker": { "id": "14583" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
Inherited from
Axis
Bounds for the rendered axis.
A Ticker to use for computing locations of axis components.
A
TickFormatter
to use for formatting the visual appearance of ticks.A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
The distance in pixels that the axis labels should be offset from the tick labels.
The text color of the axis label.
The text font size of the axis label.
The text align of the axis label.
The text line height of the axis label.
The text baseline of the axis label.
The text font of the axis label.
The text font style of the axis label.
The text alpha of the axis label.
The distance in pixels that the major tick labels should be offset from the associated ticks.
What direction the major label text should be oriented.
Provide explicit tick label values for specific tick locations that override normal formatting.
Allows to filter out labels, e.g.
The text color of the major tick labels.
The text font size of the major tick labels.
The text align of the major tick labels.
The text line height of the major tick labels.
The text baseline of the major tick labels.
The text font of the major tick labels.
The text font style of the major tick labels.
The text alpha of the major tick labels.
The line color of the axis line.
The line dash offset of the axis line.
The line width of the axis line.
The line dash of the axis line.
The line join of the axis line.
The line alpha of the axis line.
The line cap of the axis line.
The line color of the major ticks.
The line dash offset of the major ticks.
The line width of the major ticks.
The line dash of the major ticks.
The line join of the major ticks.
The line alpha of the major ticks.
The line cap of the major ticks.
The distance in pixels that major ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
The line color of the minor ticks.
The line dash offset of the minor ticks.
The line width of the minor ticks.
The line dash of the minor ticks.
The line join of the minor ticks.
The line alpha of the minor ticks.
The line cap of the minor ticks.
The distance in pixels that minor ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
Set to specify a fixed coordinate location to draw the axis.
Inherited from
Renderer
Specifies the level in which to paint this renderer.
Is the renderer visible.
coordinates
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
Inherited from
Model
model_class_reverse_map
id
ref
A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
An arbitrary, user-supplied name for this model.
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.subscribed_events
List of events that are subscribed to by Python 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.Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
Public Methods:
Inherited from
Model
__init_subclass__
()__new__
(cls, *args, **kwargs)__init__
(**kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
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.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_json
(include_defaults)Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
to_json_string
(include_defaults)Returns a JSON string encoding the attributes of this object.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init__
(**kwargs)__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.
static_to_serializable
(serializer)to_serializable
(serializer)set_from_json
(name, json, *[, models, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
update_from_json
(json_attributes, *[, ...])Updates the object's properties from a JSON attributes dictionary.
lookup
(name, *[, raises])Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.properties
(*[, _with_props])Collect the names of properties on this class.
Collect the names of all properties on this class that also have references.
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.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.
Remove any themed values and restore defaults.
Inherited from
HasDocumentRef
__init__
(**kwargs)Inherited from
PropertyCallbackManager
__init__
(**kwargs)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])Inherited from
EventCallbackManager
__init__
(**kwargs)on_event
(event, *callbacks)Run callbacks when the specified event occurs on this Model
- axis_label = None¶
-
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_standoff = 5¶
- Type
The distance in pixels that the axis labels should be offset from the tick labels.
- axis_label_text_baseline = 'bottom'¶
- Type
The text baseline of the axis label.
- axis_line_dash = []¶
- Type
The line dash of the axis line.
- bounds = 'auto'¶
-
Bounds for the rendered axis. If unset, the axis will span the entire plot in the given dimension.
- fixed_location = None¶
-
Set to specify a fixed coordinate location to draw the axis. The direction of ticks and major labels is determined by the side panel that the axis belongs to.
Note
Axes labels are suppressed when axes are positioned at fixed locations inside the central plot area.
- formatter = DatetimeTickFormatter(id='14606', ...)¶
- Type
A
TickFormatter
to use for formatting the visual appearance of ticks.
- level = 'guide'¶
- Type
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'¶
-
What direction the major label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- major_label_overrides = {}¶
-
Provide explicit tick label values for specific tick locations that override normal formatting.
- major_label_policy = AllLabels(id='14611', ...)¶
- Type
Instance
(LabelingPolicy
)
Allows to filter out labels, e.g. declutter labels to avoid overlap.
- major_label_standoff = 5¶
- Type
The distance in pixels that the major tick labels should be offset from the associated ticks.
- major_label_text_baseline = 'alphabetic'¶
- Type
The text baseline of the major tick labels.
- major_label_text_font_style = 'normal'¶
-
The text font style of the major tick labels.
- major_tick_in = 2¶
- Type
The distance in pixels that major ticks should extend into the main plot area.
- major_tick_line_dash = []¶
- Type
The line dash of the major ticks.
- major_tick_out = 6¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- minor_tick_in = 0¶
- Type
The distance in pixels that minor ticks should extend into the main plot area.
- minor_tick_line_dash = []¶
- Type
The line dash of the minor ticks.
- minor_tick_out = 4¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- name = 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.
- 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 anyon_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.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 = DatetimeTicker(id='14643', ...)¶
-
A Ticker to use for computing locations of axis components.
The property may also be passed a sequence of floating point numbers as a shorthand for creating and configuring a
FixedTicker
, e.g. the following codefrom bokeh.plotting import figure p = figure() p.xaxis.ticker = [10, 20, 37.4]
is equivalent to:
from bokeh.plotting import figure from bokeh.models import FixedTicker p = figure() p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
- 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 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.
- equals(other: bokeh.core.has_props.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 a CustomJS callback to update one Bokeh model property whenever another changes value.
- Parameters
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: 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
- 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
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 properties(*, _with_props: bool = False) Union[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.
- 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.
- query_properties_with_values(query: Callable[[bokeh.core.property.descriptors.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
- references() Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) 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, Unknown] | 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_json(include_defaults: bool) JSON ¶
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: bool) str ¶
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: str, old: Unknown, new: Unknown, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) 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)
- update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) 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 struct: bokeh.core.types.ReferenceJson¶
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.
LinearAxis¶
- class LinearAxis(*args, **kwargs)[source]¶
Bases:
bokeh.models.axes.ContinuousAxis
An axis that picks nice numbers for tick locations on a linear scale. Configured with a
BasicTickFormatter
by default.JSON Prototype
{ "axis_label": null, "axis_label_standoff": 5, "axis_label_text_align": "left", "axis_label_text_alpha": 1.0, "axis_label_text_baseline": "bottom", "axis_label_text_color": "#444444", "axis_label_text_font": "helvetica", "axis_label_text_font_size": "13px", "axis_label_text_font_style": "italic", "axis_label_text_line_height": 1.2, "axis_line_alpha": 1.0, "axis_line_cap": "butt", "axis_line_color": "black", "axis_line_dash": [], "axis_line_dash_offset": 0, "axis_line_join": "bevel", "axis_line_width": 1, "bounds": "auto", "coordinates": null, "fixed_location": null, "formatter": { "id": "14649" }, "group": null, "id": "14647", "js_event_callbacks": {}, "js_property_callbacks": {}, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": {}, "major_label_policy": { "id": "14650" }, "major_label_standoff": 5, "major_label_text_align": "center", "major_label_text_alpha": 1.0, "major_label_text_baseline": "alphabetic", "major_label_text_color": "#444444", "major_label_text_font": "helvetica", "major_label_text_font_size": "11px", "major_label_text_font_style": "normal", "major_label_text_line_height": 1.2, "major_tick_in": 2, "major_tick_line_alpha": 1.0, "major_tick_line_cap": "butt", "major_tick_line_color": "black", "major_tick_line_dash": [], "major_tick_line_dash_offset": 0, "major_tick_line_join": "bevel", "major_tick_line_width": 1, "major_tick_out": 6, "minor_tick_in": 0, "minor_tick_line_alpha": 1.0, "minor_tick_line_cap": "butt", "minor_tick_line_color": "black", "minor_tick_line_dash": [], "minor_tick_line_dash_offset": 0, "minor_tick_line_join": "bevel", "minor_tick_line_width": 1, "minor_tick_out": 4, "name": null, "subscribed_events": [], "syncable": true, "tags": [], "ticker": { "id": "14648" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
Inherited from
Axis
Bounds for the rendered axis.
A Ticker to use for computing locations of axis components.
A
TickFormatter
to use for formatting the visual appearance of ticks.A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
The distance in pixels that the axis labels should be offset from the tick labels.
The text color of the axis label.
The text font size of the axis label.
The text align of the axis label.
The text line height of the axis label.
The text baseline of the axis label.
The text font of the axis label.
The text font style of the axis label.
The text alpha of the axis label.
The distance in pixels that the major tick labels should be offset from the associated ticks.
What direction the major label text should be oriented.
Provide explicit tick label values for specific tick locations that override normal formatting.
Allows to filter out labels, e.g.
The text color of the major tick labels.
The text font size of the major tick labels.
The text align of the major tick labels.
The text line height of the major tick labels.
The text baseline of the major tick labels.
The text font of the major tick labels.
The text font style of the major tick labels.
The text alpha of the major tick labels.
The line color of the axis line.
The line dash offset of the axis line.
The line width of the axis line.
The line dash of the axis line.
The line join of the axis line.
The line alpha of the axis line.
The line cap of the axis line.
The line color of the major ticks.
The line dash offset of the major ticks.
The line width of the major ticks.
The line dash of the major ticks.
The line join of the major ticks.
The line alpha of the major ticks.
The line cap of the major ticks.
The distance in pixels that major ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
The line color of the minor ticks.
The line dash offset of the minor ticks.
The line width of the minor ticks.
The line dash of the minor ticks.
The line join of the minor ticks.
The line alpha of the minor ticks.
The line cap of the minor ticks.
The distance in pixels that minor ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
Set to specify a fixed coordinate location to draw the axis.
Inherited from
Renderer
Specifies the level in which to paint this renderer.
Is the renderer visible.
coordinates
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
Inherited from
Model
model_class_reverse_map
id
ref
A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
An arbitrary, user-supplied name for this model.
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.subscribed_events
List of events that are subscribed to by Python 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.Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
Public Methods:
Inherited from
Model
__init_subclass__
()__new__
(cls, *args, **kwargs)__init__
(**kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
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.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_json
(include_defaults)Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
to_json_string
(include_defaults)Returns a JSON string encoding the attributes of this object.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init__
(**kwargs)__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.
static_to_serializable
(serializer)to_serializable
(serializer)set_from_json
(name, json, *[, models, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
update_from_json
(json_attributes, *[, ...])Updates the object's properties from a JSON attributes dictionary.
lookup
(name, *[, raises])Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.properties
(*[, _with_props])Collect the names of properties on this class.
Collect the names of all properties on this class that also have references.
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.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.
Remove any themed values and restore defaults.
Inherited from
HasDocumentRef
__init__
(**kwargs)Inherited from
PropertyCallbackManager
__init__
(**kwargs)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])Inherited from
EventCallbackManager
__init__
(**kwargs)on_event
(event, *callbacks)Run callbacks when the specified event occurs on this Model
- axis_label = None¶
-
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_standoff = 5¶
- Type
The distance in pixels that the axis labels should be offset from the tick labels.
- axis_label_text_baseline = 'bottom'¶
- Type
The text baseline of the axis label.
- axis_line_dash = []¶
- Type
The line dash of the axis line.
- bounds = 'auto'¶
-
Bounds for the rendered axis. If unset, the axis will span the entire plot in the given dimension.
- fixed_location = None¶
-
Set to specify a fixed coordinate location to draw the axis. The direction of ticks and major labels is determined by the side panel that the axis belongs to.
Note
Axes labels are suppressed when axes are positioned at fixed locations inside the central plot area.
- formatter = BasicTickFormatter(id='14671', ...)¶
- Type
A
TickFormatter
to use for formatting the visual appearance of ticks.
- level = 'guide'¶
- Type
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'¶
-
What direction the major label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- major_label_overrides = {}¶
-
Provide explicit tick label values for specific tick locations that override normal formatting.
- major_label_policy = AllLabels(id='14676', ...)¶
- Type
Instance
(LabelingPolicy
)
Allows to filter out labels, e.g. declutter labels to avoid overlap.
- major_label_standoff = 5¶
- Type
The distance in pixels that the major tick labels should be offset from the associated ticks.
- major_label_text_baseline = 'alphabetic'¶
- Type
The text baseline of the major tick labels.
- major_label_text_font_style = 'normal'¶
-
The text font style of the major tick labels.
- major_tick_in = 2¶
- Type
The distance in pixels that major ticks should extend into the main plot area.
- major_tick_line_dash = []¶
- Type
The line dash of the major ticks.
- major_tick_out = 6¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- minor_tick_in = 0¶
- Type
The distance in pixels that minor ticks should extend into the main plot area.
- minor_tick_line_dash = []¶
- Type
The line dash of the minor ticks.
- minor_tick_out = 4¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- name = 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.
- 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 anyon_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.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 = BasicTicker(id='14708', ...)¶
-
A Ticker to use for computing locations of axis components.
The property may also be passed a sequence of floating point numbers as a shorthand for creating and configuring a
FixedTicker
, e.g. the following codefrom bokeh.plotting import figure p = figure() p.xaxis.ticker = [10, 20, 37.4]
is equivalent to:
from bokeh.plotting import figure from bokeh.models import FixedTicker p = figure() p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
- 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 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.
- equals(other: bokeh.core.has_props.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 a CustomJS callback to update one Bokeh model property whenever another changes value.
- Parameters
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: 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
- 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
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 properties(*, _with_props: bool = False) Union[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.
- 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.
- query_properties_with_values(query: Callable[[bokeh.core.property.descriptors.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
- references() Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) 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, Unknown] | 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_json(include_defaults: bool) JSON ¶
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: bool) str ¶
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: str, old: Unknown, new: Unknown, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) 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)
- update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) 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 struct: bokeh.core.types.ReferenceJson¶
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.
LogAxis¶
- class LogAxis(*args, **kwargs)[source]¶
Bases:
bokeh.models.axes.ContinuousAxis
An axis that picks nice numbers for tick locations on a log scale. Configured with a
LogTickFormatter
by default.JSON Prototype
{ "axis_label": null, "axis_label_standoff": 5, "axis_label_text_align": "left", "axis_label_text_alpha": 1.0, "axis_label_text_baseline": "bottom", "axis_label_text_color": "#444444", "axis_label_text_font": "helvetica", "axis_label_text_font_size": "13px", "axis_label_text_font_style": "italic", "axis_label_text_line_height": 1.2, "axis_line_alpha": 1.0, "axis_line_cap": "butt", "axis_line_color": "black", "axis_line_dash": [], "axis_line_dash_offset": 0, "axis_line_join": "bevel", "axis_line_width": 1, "bounds": "auto", "coordinates": null, "fixed_location": null, "formatter": { "id": "14714" }, "group": null, "id": "14712", "js_event_callbacks": {}, "js_property_callbacks": {}, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": {}, "major_label_policy": { "id": "14715" }, "major_label_standoff": 5, "major_label_text_align": "center", "major_label_text_alpha": 1.0, "major_label_text_baseline": "alphabetic", "major_label_text_color": "#444444", "major_label_text_font": "helvetica", "major_label_text_font_size": "11px", "major_label_text_font_style": "normal", "major_label_text_line_height": 1.2, "major_tick_in": 2, "major_tick_line_alpha": 1.0, "major_tick_line_cap": "butt", "major_tick_line_color": "black", "major_tick_line_dash": [], "major_tick_line_dash_offset": 0, "major_tick_line_join": "bevel", "major_tick_line_width": 1, "major_tick_out": 6, "minor_tick_in": 0, "minor_tick_line_alpha": 1.0, "minor_tick_line_cap": "butt", "minor_tick_line_color": "black", "minor_tick_line_dash": [], "minor_tick_line_dash_offset": 0, "minor_tick_line_join": "bevel", "minor_tick_line_width": 1, "minor_tick_out": 4, "name": null, "subscribed_events": [], "syncable": true, "tags": [], "ticker": { "id": "14713" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
Inherited from
Axis
Bounds for the rendered axis.
A Ticker to use for computing locations of axis components.
A
TickFormatter
to use for formatting the visual appearance of ticks.A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
The distance in pixels that the axis labels should be offset from the tick labels.
The text color of the axis label.
The text font size of the axis label.
The text align of the axis label.
The text line height of the axis label.
The text baseline of the axis label.
The text font of the axis label.
The text font style of the axis label.
The text alpha of the axis label.
The distance in pixels that the major tick labels should be offset from the associated ticks.
What direction the major label text should be oriented.
Provide explicit tick label values for specific tick locations that override normal formatting.
Allows to filter out labels, e.g.
The text color of the major tick labels.
The text font size of the major tick labels.
The text align of the major tick labels.
The text line height of the major tick labels.
The text baseline of the major tick labels.
The text font of the major tick labels.
The text font style of the major tick labels.
The text alpha of the major tick labels.
The line color of the axis line.
The line dash offset of the axis line.
The line width of the axis line.
The line dash of the axis line.
The line join of the axis line.
The line alpha of the axis line.
The line cap of the axis line.
The line color of the major ticks.
The line dash offset of the major ticks.
The line width of the major ticks.
The line dash of the major ticks.
The line join of the major ticks.
The line alpha of the major ticks.
The line cap of the major ticks.
The distance in pixels that major ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
The line color of the minor ticks.
The line dash offset of the minor ticks.
The line width of the minor ticks.
The line dash of the minor ticks.
The line join of the minor ticks.
The line alpha of the minor ticks.
The line cap of the minor ticks.
The distance in pixels that minor ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
Set to specify a fixed coordinate location to draw the axis.
Inherited from
Renderer
Specifies the level in which to paint this renderer.
Is the renderer visible.
coordinates
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
Inherited from
Model
model_class_reverse_map
id
ref
A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
An arbitrary, user-supplied name for this model.
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.subscribed_events
List of events that are subscribed to by Python 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.Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
Public Methods:
Inherited from
Model
__init_subclass__
()__new__
(cls, *args, **kwargs)__init__
(**kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
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.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_json
(include_defaults)Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
to_json_string
(include_defaults)Returns a JSON string encoding the attributes of this object.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init__
(**kwargs)__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.
static_to_serializable
(serializer)to_serializable
(serializer)set_from_json
(name, json, *[, models, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
update_from_json
(json_attributes, *[, ...])Updates the object's properties from a JSON attributes dictionary.
lookup
(name, *[, raises])Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.properties
(*[, _with_props])Collect the names of properties on this class.
Collect the names of all properties on this class that also have references.
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.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.
Remove any themed values and restore defaults.
Inherited from
HasDocumentRef
__init__
(**kwargs)Inherited from
PropertyCallbackManager
__init__
(**kwargs)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])Inherited from
EventCallbackManager
__init__
(**kwargs)on_event
(event, *callbacks)Run callbacks when the specified event occurs on this Model
- axis_label = None¶
-
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_standoff = 5¶
- Type
The distance in pixels that the axis labels should be offset from the tick labels.
- axis_label_text_baseline = 'bottom'¶
- Type
The text baseline of the axis label.
- axis_line_dash = []¶
- Type
The line dash of the axis line.
- bounds = 'auto'¶
-
Bounds for the rendered axis. If unset, the axis will span the entire plot in the given dimension.
- fixed_location = None¶
-
Set to specify a fixed coordinate location to draw the axis. The direction of ticks and major labels is determined by the side panel that the axis belongs to.
Note
Axes labels are suppressed when axes are positioned at fixed locations inside the central plot area.
- formatter = LogTickFormatter(id='14736', ...)¶
- Type
A
TickFormatter
to use for formatting the visual appearance of ticks.
- level = 'guide'¶
- Type
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'¶
-
What direction the major label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- major_label_overrides = {}¶
-
Provide explicit tick label values for specific tick locations that override normal formatting.
- major_label_policy = AllLabels(id='14741', ...)¶
- Type
Instance
(LabelingPolicy
)
Allows to filter out labels, e.g. declutter labels to avoid overlap.
- major_label_standoff = 5¶
- Type
The distance in pixels that the major tick labels should be offset from the associated ticks.
- major_label_text_baseline = 'alphabetic'¶
- Type
The text baseline of the major tick labels.
- major_label_text_font_style = 'normal'¶
-
The text font style of the major tick labels.
- major_tick_in = 2¶
- Type
The distance in pixels that major ticks should extend into the main plot area.
- major_tick_line_dash = []¶
- Type
The line dash of the major ticks.
- major_tick_out = 6¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- minor_tick_in = 0¶
- Type
The distance in pixels that minor ticks should extend into the main plot area.
- minor_tick_line_dash = []¶
- Type
The line dash of the minor ticks.
- minor_tick_out = 4¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- name = 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.
- 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 anyon_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.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 = LogTicker(id='14773', ...)¶
-
A Ticker to use for computing locations of axis components.
The property may also be passed a sequence of floating point numbers as a shorthand for creating and configuring a
FixedTicker
, e.g. the following codefrom bokeh.plotting import figure p = figure() p.xaxis.ticker = [10, 20, 37.4]
is equivalent to:
from bokeh.plotting import figure from bokeh.models import FixedTicker p = figure() p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
- 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 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.
- equals(other: bokeh.core.has_props.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 a CustomJS callback to update one Bokeh model property whenever another changes value.
- Parameters
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: 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
- 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
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 properties(*, _with_props: bool = False) Union[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.
- 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.
- query_properties_with_values(query: Callable[[bokeh.core.property.descriptors.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
- references() Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) 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, Unknown] | 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_json(include_defaults: bool) JSON ¶
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: bool) str ¶
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: str, old: Unknown, new: Unknown, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) 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)
- update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) 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 struct: bokeh.core.types.ReferenceJson¶
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.
MercatorAxis¶
- class MercatorAxis(*args, **kwargs)[source]¶
Bases:
bokeh.models.axes.LinearAxis
An axis that picks nice numbers for tick locations on a Mercator scale. Configured with a
MercatorTickFormatter
by default.- Parameters
dimension ('lat' or 'lon', optional) – Whether this axis will display latitude or longitude values. (default: ‘lat’)
JSON Prototype
{ "axis_label": null, "axis_label_standoff": 5, "axis_label_text_align": "left", "axis_label_text_alpha": 1.0, "axis_label_text_baseline": "bottom", "axis_label_text_color": "#444444", "axis_label_text_font": "helvetica", "axis_label_text_font_size": "13px", "axis_label_text_font_style": "italic", "axis_label_text_line_height": 1.2, "axis_line_alpha": 1.0, "axis_line_cap": "butt", "axis_line_color": "black", "axis_line_dash": [], "axis_line_dash_offset": 0, "axis_line_join": "bevel", "axis_line_width": 1, "bounds": "auto", "coordinates": null, "fixed_location": null, "formatter": { "id": "14780" }, "group": null, "id": "14777", "js_event_callbacks": {}, "js_property_callbacks": {}, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": {}, "major_label_policy": { "id": "14784" }, "major_label_standoff": 5, "major_label_text_align": "center", "major_label_text_alpha": 1.0, "major_label_text_baseline": "alphabetic", "major_label_text_color": "#444444", "major_label_text_font": "helvetica", "major_label_text_font_size": "11px", "major_label_text_font_style": "normal", "major_label_text_line_height": 1.2, "major_tick_in": 2, "major_tick_line_alpha": 1.0, "major_tick_line_cap": "butt", "major_tick_line_color": "black", "major_tick_line_dash": [], "major_tick_line_dash_offset": 0, "major_tick_line_join": "bevel", "major_tick_line_width": 1, "major_tick_out": 6, "minor_tick_in": 0, "minor_tick_line_alpha": 1.0, "minor_tick_line_cap": "butt", "minor_tick_line_color": "black", "minor_tick_line_dash": [], "minor_tick_line_dash_offset": 0, "minor_tick_line_join": "bevel", "minor_tick_line_width": 1, "minor_tick_out": 4, "name": null, "subscribed_events": [], "syncable": true, "tags": [], "ticker": { "id": "14778" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
Inherited from
Axis
Bounds for the rendered axis.
A Ticker to use for computing locations of axis components.
A
TickFormatter
to use for formatting the visual appearance of ticks.A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
The distance in pixels that the axis labels should be offset from the tick labels.
The text color of the axis label.
The text font size of the axis label.
The text align of the axis label.
The text line height of the axis label.
The text baseline of the axis label.
The text font of the axis label.
The text font style of the axis label.
The text alpha of the axis label.
The distance in pixels that the major tick labels should be offset from the associated ticks.
What direction the major label text should be oriented.
Provide explicit tick label values for specific tick locations that override normal formatting.
Allows to filter out labels, e.g.
The text color of the major tick labels.
The text font size of the major tick labels.
The text align of the major tick labels.
The text line height of the major tick labels.
The text baseline of the major tick labels.
The text font of the major tick labels.
The text font style of the major tick labels.
The text alpha of the major tick labels.
The line color of the axis line.
The line dash offset of the axis line.
The line width of the axis line.
The line dash of the axis line.
The line join of the axis line.
The line alpha of the axis line.
The line cap of the axis line.
The line color of the major ticks.
The line dash offset of the major ticks.
The line width of the major ticks.
The line dash of the major ticks.
The line join of the major ticks.
The line alpha of the major ticks.
The line cap of the major ticks.
The distance in pixels that major ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
The line color of the minor ticks.
The line dash offset of the minor ticks.
The line width of the minor ticks.
The line dash of the minor ticks.
The line join of the minor ticks.
The line alpha of the minor ticks.
The line cap of the minor ticks.
The distance in pixels that minor ticks should extend into the main plot area.
The distance in pixels that major ticks should extend out of the main plot area.
Set to specify a fixed coordinate location to draw the axis.
Inherited from
Renderer
Specifies the level in which to paint this renderer.
Is the renderer visible.
coordinates
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
Inherited from
Model
model_class_reverse_map
id
ref
A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
An arbitrary, user-supplied name for this model.
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.subscribed_events
List of events that are subscribed to by Python 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.Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
Public Methods:
__init__
([dimension])Inherited from
Model
__init_subclass__
()__new__
(cls, *args, **kwargs)__init__
([dimension])__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
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.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_json
(include_defaults)Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
to_json_string
(include_defaults)Returns a JSON string encoding the attributes of this object.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init__
([dimension])__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.
static_to_serializable
(serializer)to_serializable
(serializer)set_from_json
(name, json, *[, models, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
update_from_json
(json_attributes, *[, ...])Updates the object's properties from a JSON attributes dictionary.
lookup
(name, *[, raises])Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.properties
(*[, _with_props])Collect the names of properties on this class.
Collect the names of all properties on this class that also have references.
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.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.
Remove any themed values and restore defaults.
Inherited from
HasDocumentRef
__init__
([dimension])Inherited from
PropertyCallbackManager
__init__
([dimension])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])Inherited from
EventCallbackManager
__init__
([dimension])on_event
(event, *callbacks)Run callbacks when the specified event occurs on this Model
- axis_label = None¶
-
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_standoff = 5¶
- Type
The distance in pixels that the axis labels should be offset from the tick labels.
- axis_label_text_baseline = 'bottom'¶
- Type
The text baseline of the axis label.
- axis_line_dash = []¶
- Type
The line dash of the axis line.
- bounds = 'auto'¶
-
Bounds for the rendered axis. If unset, the axis will span the entire plot in the given dimension.
- fixed_location = None¶
-
Set to specify a fixed coordinate location to draw the axis. The direction of ticks and major labels is determined by the side panel that the axis belongs to.
Note
Axes labels are suppressed when axes are positioned at fixed locations inside the central plot area.
- formatter = MercatorTickFormatter(id='14885', ...)¶
- Type
A
TickFormatter
to use for formatting the visual appearance of ticks.
- level = 'guide'¶
- Type
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'¶
-
What direction the major label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- major_label_overrides = {}¶
-
Provide explicit tick label values for specific tick locations that override normal formatting.
- major_label_policy = AllLabels(id='14906', ...)¶
- Type
Instance
(LabelingPolicy
)
Allows to filter out labels, e.g. declutter labels to avoid overlap.
- major_label_standoff = 5¶
- Type
The distance in pixels that the major tick labels should be offset from the associated ticks.
- major_label_text_baseline = 'alphabetic'¶
- Type
The text baseline of the major tick labels.
- major_label_text_font_style = 'normal'¶
-
The text font style of the major tick labels.
- major_tick_in = 2¶
- Type
The distance in pixels that major ticks should extend into the main plot area.
- major_tick_line_dash = []¶
- Type
The line dash of the major ticks.
- major_tick_out = 6¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- minor_tick_in = 0¶
- Type
The distance in pixels that minor ticks should extend into the main plot area.
- minor_tick_line_dash = []¶
- Type
The line dash of the minor ticks.
- minor_tick_out = 4¶
- Type
The distance in pixels that major ticks should extend out of the main plot area.
- name = 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.
- 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 anyon_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.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 = MercatorTicker(id='15062', ...)¶
-
A Ticker to use for computing locations of axis components.
The property may also be passed a sequence of floating point numbers as a shorthand for creating and configuring a
FixedTicker
, e.g. the following codefrom bokeh.plotting import figure p = figure() p.xaxis.ticker = [10, 20, 37.4]
is equivalent to:
from bokeh.plotting import figure from bokeh.models import FixedTicker p = figure() p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
- 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 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.
- equals(other: bokeh.core.has_props.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 a CustomJS callback to update one Bokeh model property whenever another changes value.
- Parameters
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: 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
- 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
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 properties(*, _with_props: bool = False) Union[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.
- 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.
- query_properties_with_values(query: Callable[[bokeh.core.property.descriptors.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
- references() Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) 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, Unknown] | 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_json(include_defaults: bool) JSON ¶
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: bool) str ¶
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: str, old: Unknown, new: Unknown, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) 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)
- update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) 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 struct: bokeh.core.types.ReferenceJson¶
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.