axes#
Guide renderers for various kinds of axes that can be added to Bokeh plots
- class Axis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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_align": "center", "axis_label_orientation": "parallel", "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_label_text_outline_color": null, "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, "background_fill_alpha": 1.0, "background_fill_color": null, "bounds": "auto", "context_menu": null, "coordinates": null, "css_classes": [], "css_variables": { "type": "map" }, "dimension": "auto", "face": "auto", "fixed_location": null, "formatter": { "name": "unset", "type": "symbol" }, "group": null, "id": "p54291", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": { "type": "map" }, "major_label_policy": { "id": "p54292", "name": "AllLabels", "type": "object" }, "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_label_text_outline_color": null, "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, "propagate_hover": false, "styles": { "type": "map" }, "stylesheets": [], "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "ticker": { "name": "unset", "type": "symbol" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
- axis_label = None#
- Type:
Nullable
(TextLike
)
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_orientation = 'parallel'#
- Type:
What direction the axis label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- 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_label_text_outline_color = None#
-
The text outline color 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.
-
A menu to display when user right clicks on the component.
Note
Use shift key when right clicking to display the native context menu.
- css_variables = {}#
-
Allows to define dynamically computed CSS variables.
This can be used, for example, to coordinate positioning and styling between canvas’ renderers and/or visuals and HTML-based UI elements.
Variables defined here are equivalent to setting the same variables under
:host { ... }
in a CSS stylesheet.Note
This property is experimental and may change at any point.
- dimension = 'auto'#
-
This allows to override the inferred dimensions in contexts that support this. This property has no effect when an axes is used as a frame axis.
Note
This property is experimental and may change at any point.
- face = 'auto'#
-
The direction toward which the axis will face.
Note
This property is experimental and may change at any point.
- 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.
- group = None#
- Type:
Note
This property is experimental and may change at any point.
- level = 'guide'#
- Type:
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'#
- Type:
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='p54363', ...)#
- 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_label_text_outline_color = None#
-
The text outline color 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.
- propagate_hover = False#
- Type:
Allows to propagate hover events to the parent renderer, frame or canvas.
Note
This property is experimental and may change at any point.
- styles = {}#
-
Inline CSS styles applied to the underlying DOM element.
- stylesheets = []#
- Type:
Additional style-sheets to use for the underlying DOM element.
Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use
:host
CSS pseudo selector to access the root DOM element.
- syncable = True#
- Type:
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to
False
may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.Note
Setting this property to
False
will prevent 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
- clone(**overrides: Any) Self #
Duplicate a
HasProps
object.This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
- classmethod dataspecs() dict[str, DataSpec] #
Collect the names of all
DataSpec
properties on this class.This method always traverses the class hierarchy and includes properties defined on any parent classes.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- equals(other: HasProps) bool #
Structural equality of models.
- Parameters:
other (HasProps) – the other instance to compare to
- Returns:
True, if properties are structurally equal, otherwise False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding 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: JSChangeCallback) None #
Attach a
CustomJS
callback to an arbitrary BokehJS model event.On the BokehJS side, change events for model properties have the form
"change:property_name"
. As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with"change:"
automatically:# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a
ColumnDataSource
, use the"stream"
event on the source:source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod parameters() list[Parameter] #
Generate Python
Parameter
values suitable for functions that are derived from the glyph.- Returns:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in
list
.- Returns:
property names
- classmethod properties_with_refs() dict[str, Property[Any]] #
Collect the names of all properties on this class that also have references.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
- 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[[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:
- remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None #
Remove a callback from this object
- select(selector: SelectorType) Iterable[Model] #
Query this object and all of its references for objects that match the given selector.
- Parameters:
selector (JSON-like)
- Returns:
seq[Model]
- select_one(selector: SelectorType) Model | None #
Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like
- Returns:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
Set a property value on this object from JSON.
- Parameters:
name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
Update objects that match a given selector with the specified attribute/value updates.
- Parameters:
selector (JSON-like)
updates (dict)
- Returns:
None
- themed_values() dict[str, Any] | None #
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or
None
if no theme overrides any values for this instance.- Returns:
dict or None
- to_serializable(serializer: Serializer) ObjectRefRep #
Converts this object to a serializable representation.
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- 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)
- class CategoricalAxis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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_align": "center", "axis_label_orientation": "parallel", "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_label_text_outline_color": null, "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, "background_fill_alpha": 1.0, "background_fill_color": null, "bounds": "auto", "context_menu": null, "coordinates": null, "css_classes": [], "css_variables": { "type": "map" }, "dimension": "auto", "face": "auto", "fixed_location": null, "formatter": { "id": "p54442", "name": "CategoricalTickFormatter", "type": "object" }, "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, "group_text_outline_color": null, "id": "p54440", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": { "type": "map" }, "major_label_policy": { "id": "p54443", "name": "AllLabels", "type": "object" }, "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_label_text_outline_color": null, "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, "propagate_hover": false, "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, "styles": { "type": "map" }, "stylesheets": [], "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, "subgroup_text_outline_color": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "ticker": { "id": "p54441", "name": "CategoricalTicker", "type": "object" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
- axis_label = None#
- Type:
Nullable
(TextLike
)
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_orientation = 'parallel'#
- Type:
What direction the axis label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- 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_label_text_outline_color = None#
-
The text outline color 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.
-
A menu to display when user right clicks on the component.
Note
Use shift key when right clicking to display the native context menu.
- css_variables = {}#
-
Allows to define dynamically computed CSS variables.
This can be used, for example, to coordinate positioning and styling between canvas’ renderers and/or visuals and HTML-based UI elements.
Variables defined here are equivalent to setting the same variables under
:host { ... }
in a CSS stylesheet.Note
This property is experimental and may change at any point.
- dimension = 'auto'#
-
This allows to override the inferred dimensions in contexts that support this. This property has no effect when an axes is used as a frame axis.
Note
This property is experimental and may change at any point.
- face = 'auto'#
-
The direction toward which the axis will face.
Note
This property is experimental and may change at any point.
- 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='p54564', ...)#
- Type:
A
TickFormatter
to use for formatting the visual appearance of ticks.
- group = None#
- Type:
Note
This property is experimental and may change at any point.
- 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.
- group_text_outline_color = None#
-
The text outline 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.
- level = 'guide'#
- Type:
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'#
- Type:
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='p54625', ...)#
- 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_label_text_outline_color = None#
-
The text outline color 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.
- propagate_hover = False#
- Type:
Allows to propagate hover events to the parent renderer, frame or canvas.
Note
This property is experimental and may change at any point.
- 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.
- styles = {}#
-
Inline CSS styles applied to the underlying DOM element.
- stylesheets = []#
- Type:
Additional style-sheets to use for the underlying DOM element.
Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use
:host
CSS pseudo selector to access the root DOM element.
- 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.
- subgroup_text_outline_color = None#
-
The text outline 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.
- 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='p54834', ...)#
-
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
- clone(**overrides: Any) Self #
Duplicate a
HasProps
object.This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
- classmethod dataspecs() dict[str, DataSpec] #
Collect the names of all
DataSpec
properties on this class.This method always traverses the class hierarchy and includes properties defined on any parent classes.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- equals(other: HasProps) bool #
Structural equality of models.
- Parameters:
other (HasProps) – the other instance to compare to
- Returns:
True, if properties are structurally equal, otherwise False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding 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: JSChangeCallback) None #
Attach a
CustomJS
callback to an arbitrary BokehJS model event.On the BokehJS side, change events for model properties have the form
"change:property_name"
. As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with"change:"
automatically:# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a
ColumnDataSource
, use the"stream"
event on the source:source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod parameters() list[Parameter] #
Generate Python
Parameter
values suitable for functions that are derived from the glyph.- Returns:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in
list
.- Returns:
property names
- classmethod properties_with_refs() dict[str, Property[Any]] #
Collect the names of all properties on this class that also have references.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
- 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[[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:
- remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None #
Remove a callback from this object
- select(selector: SelectorType) Iterable[Model] #
Query this object and all of its references for objects that match the given selector.
- Parameters:
selector (JSON-like)
- Returns:
seq[Model]
- select_one(selector: SelectorType) Model | None #
Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like
- Returns:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
Set a property value on this object from JSON.
- Parameters:
name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
Update objects that match a given selector with the specified attribute/value updates.
- Parameters:
selector (JSON-like)
updates (dict)
- Returns:
None
- themed_values() dict[str, Any] | None #
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or
None
if no theme overrides any values for this instance.- Returns:
dict or None
- to_serializable(serializer: Serializer) ObjectRefRep #
Converts this object to a serializable representation.
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- 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)
- class ContinuousAxis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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_align": "center", "axis_label_orientation": "parallel", "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_label_text_outline_color": null, "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, "background_fill_alpha": 1.0, "background_fill_color": null, "bounds": "auto", "context_menu": null, "coordinates": null, "css_classes": [], "css_variables": { "type": "map" }, "dimension": "auto", "face": "auto", "fixed_location": null, "formatter": { "name": "unset", "type": "symbol" }, "group": null, "id": "p54847", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": { "type": "map" }, "major_label_policy": { "id": "p54848", "name": "AllLabels", "type": "object" }, "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_label_text_outline_color": null, "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, "propagate_hover": false, "styles": { "type": "map" }, "stylesheets": [], "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "ticker": { "name": "unset", "type": "symbol" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
- axis_label = None#
- Type:
Nullable
(TextLike
)
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_orientation = 'parallel'#
- Type:
What direction the axis label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- 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_label_text_outline_color = None#
-
The text outline color 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.
-
A menu to display when user right clicks on the component.
Note
Use shift key when right clicking to display the native context menu.
- css_variables = {}#
-
Allows to define dynamically computed CSS variables.
This can be used, for example, to coordinate positioning and styling between canvas’ renderers and/or visuals and HTML-based UI elements.
Variables defined here are equivalent to setting the same variables under
:host { ... }
in a CSS stylesheet.Note
This property is experimental and may change at any point.
- dimension = 'auto'#
-
This allows to override the inferred dimensions in contexts that support this. This property has no effect when an axes is used as a frame axis.
Note
This property is experimental and may change at any point.
- face = 'auto'#
-
The direction toward which the axis will face.
Note
This property is experimental and may change at any point.
- 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.
- group = None#
- Type:
Note
This property is experimental and may change at any point.
- level = 'guide'#
- Type:
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'#
- Type:
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='p54919', ...)#
- 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_label_text_outline_color = None#
-
The text outline color 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.
- propagate_hover = False#
- Type:
Allows to propagate hover events to the parent renderer, frame or canvas.
Note
This property is experimental and may change at any point.
- styles = {}#
-
Inline CSS styles applied to the underlying DOM element.
- stylesheets = []#
- Type:
Additional style-sheets to use for the underlying DOM element.
Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use
:host
CSS pseudo selector to access the root DOM element.
- syncable = True#
- Type:
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to
False
may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.Note
Setting this property to
False
will prevent 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
- clone(**overrides: Any) Self #
Duplicate a
HasProps
object.This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
- classmethod dataspecs() dict[str, DataSpec] #
Collect the names of all
DataSpec
properties on this class.This method always traverses the class hierarchy and includes properties defined on any parent classes.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- equals(other: HasProps) bool #
Structural equality of models.
- Parameters:
other (HasProps) – the other instance to compare to
- Returns:
True, if properties are structurally equal, otherwise False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding 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: JSChangeCallback) None #
Attach a
CustomJS
callback to an arbitrary BokehJS model event.On the BokehJS side, change events for model properties have the form
"change:property_name"
. As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with"change:"
automatically:# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a
ColumnDataSource
, use the"stream"
event on the source:source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod parameters() list[Parameter] #
Generate Python
Parameter
values suitable for functions that are derived from the glyph.- Returns:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in
list
.- Returns:
property names
- classmethod properties_with_refs() dict[str, Property[Any]] #
Collect the names of all properties on this class that also have references.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
- 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[[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:
- remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None #
Remove a callback from this object
- select(selector: SelectorType) Iterable[Model] #
Query this object and all of its references for objects that match the given selector.
- Parameters:
selector (JSON-like)
- Returns:
seq[Model]
- select_one(selector: SelectorType) Model | None #
Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like
- Returns:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
Set a property value on this object from JSON.
- Parameters:
name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
Update objects that match a given selector with the specified attribute/value updates.
- Parameters:
selector (JSON-like)
updates (dict)
- Returns:
None
- themed_values() dict[str, Any] | None #
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or
None
if no theme overrides any values for this instance.- Returns:
dict or None
- to_serializable(serializer: Serializer) ObjectRefRep #
Converts this object to a serializable representation.
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- 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)
- class DatetimeAxis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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_align": "center", "axis_label_orientation": "parallel", "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_label_text_outline_color": null, "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, "background_fill_alpha": 1.0, "background_fill_color": null, "bounds": "auto", "context_menu": null, "coordinates": null, "css_classes": [], "css_variables": { "type": "map" }, "dimension": "auto", "face": "auto", "fixed_location": null, "formatter": { "id": "p55010", "name": "DatetimeTickFormatter", "type": "object" }, "group": null, "id": "p54996", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": { "type": "map" }, "major_label_policy": { "id": "p55011", "name": "AllLabels", "type": "object" }, "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_label_text_outline_color": null, "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, "propagate_hover": false, "styles": { "type": "map" }, "stylesheets": [], "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "ticker": { "attributes": { "tickers": [ { "attributes": { "mantissas": [ 1, 2, 5 ], "max_interval": 500.0, "num_minor_ticks": 0 }, "id": "p54998", "name": "AdaptiveTicker", "type": "object" }, { "attributes": { "base": 60, "mantissas": [ 1, 2, 5, 10, 15, 20, 30 ], "max_interval": 1800000.0, "min_interval": 1000.0, "num_minor_ticks": 0 }, "id": "p54999", "name": "AdaptiveTicker", "type": "object" }, { "attributes": { "base": 24, "mantissas": [ 1, 2, 4, 6, 8, 12 ], "max_interval": 43200000.0, "min_interval": 3600000.0, "num_minor_ticks": 0 }, "id": "p55000", "name": "AdaptiveTicker", "type": "object" }, { "attributes": { "days": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31 ] }, "id": "p55001", "name": "DaysTicker", "type": "object" }, { "attributes": { "days": [ 1, 4, 7, 10, 13, 16, 19, 22, 25, 28 ] }, "id": "p55002", "name": "DaysTicker", "type": "object" }, { "attributes": { "days": [ 1, 8, 15, 22 ] }, "id": "p55003", "name": "DaysTicker", "type": "object" }, { "attributes": { "days": [ 1, 15 ] }, "id": "p55004", "name": "DaysTicker", "type": "object" }, { "attributes": { "months": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ] }, "id": "p55005", "name": "MonthsTicker", "type": "object" }, { "attributes": { "months": [ 0, 2, 4, 6, 8, 10 ] }, "id": "p55006", "name": "MonthsTicker", "type": "object" }, { "attributes": { "months": [ 0, 4, 8 ] }, "id": "p55007", "name": "MonthsTicker", "type": "object" }, { "attributes": { "months": [ 0, 6 ] }, "id": "p55008", "name": "MonthsTicker", "type": "object" }, { "id": "p55009", "name": "YearsTicker", "type": "object" } ] }, "id": "p54997", "name": "DatetimeTicker", "type": "object" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
- axis_label = None#
- Type:
Nullable
(TextLike
)
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_orientation = 'parallel'#
- Type:
What direction the axis label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- 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_label_text_outline_color = None#
-
The text outline color 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.
-
A menu to display when user right clicks on the component.
Note
Use shift key when right clicking to display the native context menu.
- css_variables = {}#
-
Allows to define dynamically computed CSS variables.
This can be used, for example, to coordinate positioning and styling between canvas’ renderers and/or visuals and HTML-based UI elements.
Variables defined here are equivalent to setting the same variables under
:host { ... }
in a CSS stylesheet.Note
This property is experimental and may change at any point.
- dimension = 'auto'#
-
This allows to override the inferred dimensions in contexts that support this. This property has no effect when an axes is used as a frame axis.
Note
This property is experimental and may change at any point.
- face = 'auto'#
-
The direction toward which the axis will face.
Note
This property is experimental and may change at any point.
- 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='p55492', ...)#
- Type:
A
TickFormatter
to use for formatting the visual appearance of ticks.
- group = None#
- Type:
Note
This property is experimental and may change at any point.
- level = 'guide'#
- Type:
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'#
- Type:
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='p55573', ...)#
- 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_label_text_outline_color = None#
-
The text outline color 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.
- propagate_hover = False#
- Type:
Allows to propagate hover events to the parent renderer, frame or canvas.
Note
This property is experimental and may change at any point.
- styles = {}#
-
Inline CSS styles applied to the underlying DOM element.
- stylesheets = []#
- Type:
Additional style-sheets to use for the underlying DOM element.
Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use
:host
CSS pseudo selector to access the root DOM element.
- syncable = True#
- Type:
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to
False
may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.Note
Setting this property to
False
will prevent 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='p56134', ...)#
-
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
- clone(**overrides: Any) Self #
Duplicate a
HasProps
object.This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
- classmethod dataspecs() dict[str, DataSpec] #
Collect the names of all
DataSpec
properties on this class.This method always traverses the class hierarchy and includes properties defined on any parent classes.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- equals(other: HasProps) bool #
Structural equality of models.
- Parameters:
other (HasProps) – the other instance to compare to
- Returns:
True, if properties are structurally equal, otherwise False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding 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: JSChangeCallback) None #
Attach a
CustomJS
callback to an arbitrary BokehJS model event.On the BokehJS side, change events for model properties have the form
"change:property_name"
. As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with"change:"
automatically:# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a
ColumnDataSource
, use the"stream"
event on the source:source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod parameters() list[Parameter] #
Generate Python
Parameter
values suitable for functions that are derived from the glyph.- Returns:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in
list
.- Returns:
property names
- classmethod properties_with_refs() dict[str, Property[Any]] #
Collect the names of all properties on this class that also have references.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
- 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[[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:
- remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None #
Remove a callback from this object
- select(selector: SelectorType) Iterable[Model] #
Query this object and all of its references for objects that match the given selector.
- Parameters:
selector (JSON-like)
- Returns:
seq[Model]
- select_one(selector: SelectorType) Model | None #
Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like
- Returns:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
Set a property value on this object from JSON.
- Parameters:
name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
Update objects that match a given selector with the specified attribute/value updates.
- Parameters:
selector (JSON-like)
updates (dict)
- Returns:
None
- themed_values() dict[str, Any] | None #
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or
None
if no theme overrides any values for this instance.- Returns:
dict or None
- to_serializable(serializer: Serializer) ObjectRefRep #
Converts this object to a serializable representation.
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- 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)
- class LinearAxis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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_align": "center", "axis_label_orientation": "parallel", "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_label_text_outline_color": null, "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, "background_fill_alpha": 1.0, "background_fill_color": null, "bounds": "auto", "context_menu": null, "coordinates": null, "css_classes": [], "css_variables": { "type": "map" }, "dimension": "auto", "face": "auto", "fixed_location": null, "formatter": { "id": "p56197", "name": "BasicTickFormatter", "type": "object" }, "group": null, "id": "p56195", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": { "type": "map" }, "major_label_policy": { "id": "p56198", "name": "AllLabels", "type": "object" }, "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_label_text_outline_color": null, "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, "propagate_hover": false, "styles": { "type": "map" }, "stylesheets": [], "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "ticker": { "attributes": { "mantissas": [ 1, 2, 5 ] }, "id": "p56196", "name": "BasicTicker", "type": "object" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
- axis_label = None#
- Type:
Nullable
(TextLike
)
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_orientation = 'parallel'#
- Type:
What direction the axis label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- 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_label_text_outline_color = None#
-
The text outline color 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.
-
A menu to display when user right clicks on the component.
Note
Use shift key when right clicking to display the native context menu.
- css_variables = {}#
-
Allows to define dynamically computed CSS variables.
This can be used, for example, to coordinate positioning and styling between canvas’ renderers and/or visuals and HTML-based UI elements.
Variables defined here are equivalent to setting the same variables under
:host { ... }
in a CSS stylesheet.Note
This property is experimental and may change at any point.
- dimension = 'auto'#
-
This allows to override the inferred dimensions in contexts that support this. This property has no effect when an axes is used as a frame axis.
Note
This property is experimental and may change at any point.
- face = 'auto'#
-
The direction toward which the axis will face.
Note
This property is experimental and may change at any point.
- 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='p56319', ...)#
- Type:
A
TickFormatter
to use for formatting the visual appearance of ticks.
- group = None#
- Type:
Note
This property is experimental and may change at any point.
- level = 'guide'#
- Type:
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'#
- Type:
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='p56340', ...)#
- 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_label_text_outline_color = None#
-
The text outline color 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.
- propagate_hover = False#
- Type:
Allows to propagate hover events to the parent renderer, frame or canvas.
Note
This property is experimental and may change at any point.
- styles = {}#
-
Inline CSS styles applied to the underlying DOM element.
- stylesheets = []#
- Type:
Additional style-sheets to use for the underlying DOM element.
Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use
:host
CSS pseudo selector to access the root DOM element.
- syncable = True#
- Type:
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to
False
may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.Note
Setting this property to
False
will prevent 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='p56481', ...)#
-
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
- clone(**overrides: Any) Self #
Duplicate a
HasProps
object.This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
- classmethod dataspecs() dict[str, DataSpec] #
Collect the names of all
DataSpec
properties on this class.This method always traverses the class hierarchy and includes properties defined on any parent classes.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- equals(other: HasProps) bool #
Structural equality of models.
- Parameters:
other (HasProps) – the other instance to compare to
- Returns:
True, if properties are structurally equal, otherwise False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding 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: JSChangeCallback) None #
Attach a
CustomJS
callback to an arbitrary BokehJS model event.On the BokehJS side, change events for model properties have the form
"change:property_name"
. As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with"change:"
automatically:# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a
ColumnDataSource
, use the"stream"
event on the source:source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod parameters() list[Parameter] #
Generate Python
Parameter
values suitable for functions that are derived from the glyph.- Returns:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in
list
.- Returns:
property names
- classmethod properties_with_refs() dict[str, Property[Any]] #
Collect the names of all properties on this class that also have references.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
- 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[[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:
- remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None #
Remove a callback from this object
- select(selector: SelectorType) Iterable[Model] #
Query this object and all of its references for objects that match the given selector.
- Parameters:
selector (JSON-like)
- Returns:
seq[Model]
- select_one(selector: SelectorType) Model | None #
Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like
- Returns:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
Set a property value on this object from JSON.
- Parameters:
name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
Update objects that match a given selector with the specified attribute/value updates.
- Parameters:
selector (JSON-like)
updates (dict)
- Returns:
None
- themed_values() dict[str, Any] | None #
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or
None
if no theme overrides any values for this instance.- Returns:
dict or None
- to_serializable(serializer: Serializer) ObjectRefRep #
Converts this object to a serializable representation.
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- 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)
- class LogAxis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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_align": "center", "axis_label_orientation": "parallel", "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_label_text_outline_color": null, "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, "background_fill_alpha": 1.0, "background_fill_color": null, "bounds": "auto", "context_menu": null, "coordinates": null, "css_classes": [], "css_variables": { "type": "map" }, "dimension": "auto", "face": "auto", "fixed_location": null, "formatter": { "id": "p56496", "name": "LogTickFormatter", "type": "object" }, "group": null, "id": "p56494", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": { "type": "map" }, "major_label_policy": { "id": "p56497", "name": "AllLabels", "type": "object" }, "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_label_text_outline_color": null, "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, "propagate_hover": false, "styles": { "type": "map" }, "stylesheets": [], "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "ticker": { "attributes": { "mantissas": [ 1, 5 ] }, "id": "p56495", "name": "LogTicker", "type": "object" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
- axis_label = None#
- Type:
Nullable
(TextLike
)
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_orientation = 'parallel'#
- Type:
What direction the axis label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- 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_label_text_outline_color = None#
-
The text outline color 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.
-
A menu to display when user right clicks on the component.
Note
Use shift key when right clicking to display the native context menu.
- css_variables = {}#
-
Allows to define dynamically computed CSS variables.
This can be used, for example, to coordinate positioning and styling between canvas’ renderers and/or visuals and HTML-based UI elements.
Variables defined here are equivalent to setting the same variables under
:host { ... }
in a CSS stylesheet.Note
This property is experimental and may change at any point.
- dimension = 'auto'#
-
This allows to override the inferred dimensions in contexts that support this. This property has no effect when an axes is used as a frame axis.
Note
This property is experimental and may change at any point.
- face = 'auto'#
-
The direction toward which the axis will face.
Note
This property is experimental and may change at any point.
- 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='p56618', ...)#
- Type:
A
TickFormatter
to use for formatting the visual appearance of ticks.
- group = None#
- Type:
Note
This property is experimental and may change at any point.
- level = 'guide'#
- Type:
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'#
- Type:
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='p56639', ...)#
- 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_label_text_outline_color = None#
-
The text outline color 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.
- propagate_hover = False#
- Type:
Allows to propagate hover events to the parent renderer, frame or canvas.
Note
This property is experimental and may change at any point.
- styles = {}#
-
Inline CSS styles applied to the underlying DOM element.
- stylesheets = []#
- Type:
Additional style-sheets to use for the underlying DOM element.
Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use
:host
CSS pseudo selector to access the root DOM element.
- syncable = True#
- Type:
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to
False
may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.Note
Setting this property to
False
will prevent 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='p56780', ...)#
-
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
- clone(**overrides: Any) Self #
Duplicate a
HasProps
object.This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
- classmethod dataspecs() dict[str, DataSpec] #
Collect the names of all
DataSpec
properties on this class.This method always traverses the class hierarchy and includes properties defined on any parent classes.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- equals(other: HasProps) bool #
Structural equality of models.
- Parameters:
other (HasProps) – the other instance to compare to
- Returns:
True, if properties are structurally equal, otherwise False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding 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: JSChangeCallback) None #
Attach a
CustomJS
callback to an arbitrary BokehJS model event.On the BokehJS side, change events for model properties have the form
"change:property_name"
. As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with"change:"
automatically:# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a
ColumnDataSource
, use the"stream"
event on the source:source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod parameters() list[Parameter] #
Generate Python
Parameter
values suitable for functions that are derived from the glyph.- Returns:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in
list
.- Returns:
property names
- classmethod properties_with_refs() dict[str, Property[Any]] #
Collect the names of all properties on this class that also have references.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
- 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[[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:
- remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None #
Remove a callback from this object
- select(selector: SelectorType) Iterable[Model] #
Query this object and all of its references for objects that match the given selector.
- Parameters:
selector (JSON-like)
- Returns:
seq[Model]
- select_one(selector: SelectorType) Model | None #
Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like
- Returns:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
Set a property value on this object from JSON.
- Parameters:
name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
Update objects that match a given selector with the specified attribute/value updates.
- Parameters:
selector (JSON-like)
updates (dict)
- Returns:
None
- themed_values() dict[str, Any] | None #
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or
None
if no theme overrides any values for this instance.- Returns:
dict or None
- to_serializable(serializer: Serializer) ObjectRefRep #
Converts this object to a serializable representation.
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- 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)
- class MercatorAxis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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_align": "center", "axis_label_orientation": "parallel", "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_label_text_outline_color": null, "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, "background_fill_alpha": 1.0, "background_fill_color": null, "bounds": "auto", "context_menu": null, "coordinates": null, "css_classes": [], "css_variables": { "type": "map" }, "dimension": "auto", "face": "auto", "fixed_location": null, "formatter": { "attributes": { "dimension": "lat" }, "id": "p56795", "name": "MercatorTickFormatter", "type": "object" }, "group": null, "id": "p56793", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "guide", "major_label_orientation": "horizontal", "major_label_overrides": { "type": "map" }, "major_label_policy": { "id": "p56796", "name": "AllLabels", "type": "object" }, "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_label_text_outline_color": null, "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, "propagate_hover": false, "styles": { "type": "map" }, "stylesheets": [], "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "ticker": { "attributes": { "dimension": "lat", "mantissas": [ 1, 2, 5 ] }, "id": "p56794", "name": "MercatorTicker", "type": "object" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
- axis_label = None#
- Type:
Nullable
(TextLike
)
A text or LaTeX notation label for the axis, displayed parallel to the axis rule.
- axis_label_orientation = 'parallel'#
- Type:
What direction the axis label text should be oriented. If a number is supplied, the angle of the text is measured from horizontal.
- 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_label_text_outline_color = None#
-
The text outline color 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.
-
A menu to display when user right clicks on the component.
Note
Use shift key when right clicking to display the native context menu.
- css_variables = {}#
-
Allows to define dynamically computed CSS variables.
This can be used, for example, to coordinate positioning and styling between canvas’ renderers and/or visuals and HTML-based UI elements.
Variables defined here are equivalent to setting the same variables under
:host { ... }
in a CSS stylesheet.Note
This property is experimental and may change at any point.
- dimension = 'auto'#
-
This allows to override the inferred dimensions in contexts that support this. This property has no effect when an axes is used as a frame axis.
Note
This property is experimental and may change at any point.
- face = 'auto'#
-
The direction toward which the axis will face.
Note
This property is experimental and may change at any point.
- 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='p56917', ...)#
- Type:
A
TickFormatter
to use for formatting the visual appearance of ticks.
- group = None#
- Type:
Note
This property is experimental and may change at any point.
- level = 'guide'#
- Type:
Specifies the level in which to paint this renderer.
- major_label_orientation = 'horizontal'#
- Type:
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='p56938', ...)#
- 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_label_text_outline_color = None#
-
The text outline color 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.
- propagate_hover = False#
- Type:
Allows to propagate hover events to the parent renderer, frame or canvas.
Note
This property is experimental and may change at any point.
- styles = {}#
-
Inline CSS styles applied to the underlying DOM element.
- stylesheets = []#
- Type:
Additional style-sheets to use for the underlying DOM element.
Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use
:host
CSS pseudo selector to access the root DOM element.
- syncable = True#
- Type:
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to
False
may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.Note
Setting this property to
False
will prevent 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='p57079', ...)#
-
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
- clone(**overrides: Any) Self #
Duplicate a
HasProps
object.This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
- classmethod dataspecs() dict[str, DataSpec] #
Collect the names of all
DataSpec
properties on this class.This method always traverses the class hierarchy and includes properties defined on any parent classes.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- equals(other: HasProps) bool #
Structural equality of models.
- Parameters:
other (HasProps) – the other instance to compare to
- Returns:
True, if properties are structurally equal, otherwise False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding 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: JSChangeCallback) None #
Attach a
CustomJS
callback to an arbitrary BokehJS model event.On the BokehJS side, change events for model properties have the form
"change:property_name"
. As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with"change:"
automatically:# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a
ColumnDataSource
, use the"stream"
event on the source:source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod parameters() list[Parameter] #
Generate Python
Parameter
values suitable for functions that are derived from the glyph.- Returns:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in
list
.- Returns:
property names
- classmethod properties_with_refs() dict[str, Property[Any]] #
Collect the names of all properties on this class that also have references.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
- 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[[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:
- remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None #
Remove a callback from this object
- select(selector: SelectorType) Iterable[Model] #
Query this object and all of its references for objects that match the given selector.
- Parameters:
selector (JSON-like)
- Returns:
seq[Model]
- select_one(selector: SelectorType) Model | None #
Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like
- Returns:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
Set a property value on this object from JSON.
- Parameters:
name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
Update objects that match a given selector with the specified attribute/value updates.
- Parameters:
selector (JSON-like)
updates (dict)
- Returns:
None
- themed_values() dict[str, Any] | None #
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or
None
if no theme overrides any values for this instance.- Returns:
dict or None
- to_serializable(serializer: Serializer) ObjectRefRep #
Converts this object to a serializable representation.
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- 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)