map_plots#

Models for displaying maps in Bokeh plots.

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

Bases: MapOptions

Options for GMapPlot objects.

lat = Undefined#

Type:: Required(Float)

The latitude where the map should be centered.

lng = Undefined#

Type:: Required(Float)

The longitude where the map should be centered.

map_type = 'roadmap'#

Type:: Enum(MapType)

The map type to use for the GMapPlot.

name = None#

Type:: Nullable(String)

An arbitrary, user-supplied name for this model.

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

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

Note

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

scale_control = False#

Type:: Bool

Whether the Google map should display its distance scale control.

styles = None#

Type:: Nullable(JSON)

A JSON array of map styles to use for the GMapPlot. Many example styles can be found here.

syncable = True#

Type:: Bool

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

Note

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

tags = []#

Type:: List

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

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

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

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

Note

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

tilt = 45#

Type:: Int

Tilt angle of the map. The only allowed values are 0 and 45. Only has an effect on ‘satellite’ and ‘hybrid’ map types. A value of 0 causes the map to always use a 0 degree overhead view. A value of 45 causes the tilt angle to switch to 45 imagery if available.

zoom = 12#

Type:: Int

The initial zoom level to use when displaying the map.

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.

Returns:: names of DataSpec properties
Return type:: set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]#: List of property descriptors in the order of definition.

destroy() → None#: Clean up references to the document and property

equals(other: HasProps) → bool#

Structural equality of models.

Parameters:: other (HasProps) – the other instance to compare to
Returns:: True, if properties are structurally equal, otherwise False

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:

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:: ValueError –

Examples

This code with js_link:

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

is equivalent to the following:

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

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

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

which is equivalent to:

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

js_on_change(event: str, *callbacks: JSChangeCallback) → None#

Attach a CustomJS callback to an arbitrary BokehJS model event.

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

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

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

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None#

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

Parameters:

name (str) – name of the property to search for
raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

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

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

Parameters:

attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None#

Run callbacks when the specified event occurs on this Model

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

classmethod parameters() → list[Parameter]#

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

Returns:: list(Parameter)

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

Collect the names of properties on this class.

Warning

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

Returns:: property names

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

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

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

Returns:: names of properties that have references
Return type:: set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

Collect a dict mapping property names to their values.

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

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

Parameters:: include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)
Returns:: mapping from property names to their values
Return type:: dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:

query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]#: Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None#: Remove a callback from this object

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

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

Parameters:: selector (JSON-like)
Returns:: seq[Model]

select_one(selector: SelectorType) → Model | None#

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

Returns:: Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None#

Set a property value on this object from JSON.

Parameters:

name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)

This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.

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

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None#

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

Parameters:

selector (JSON-like)
updates (dict)

Returns:

None

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

Get any theme-provided overrides.

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

Returns:: dict or None

to_serializable(serializer: Serializer) → ObjectRefRep#: Converts this object to a serializable representation.

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

unapply_theme() → None#

Remove any themed values and restore defaults.

Returns:: None

update(**kwargs: Any) → None#

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

Returns:: None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

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

# update properties together:
r.update(start=10, end=20)

property document: Document | None#: The Document this model is attached to (can be None)

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

Bases: MapPlot

A Bokeh Plot with a Google Map displayed underneath.

Data placed on this plot should be specified in decimal lat/lon coordinates e.g. (37.123, -122.404). It will be automatically converted into the web mercator projection to display properly over google maps tiles.

The api_key property must be configured with a Google API Key in order for GMapPlot to function. The key will be stored in the Bokeh Document JSON.

Note that Google Maps exert explicit control over aspect ratios at all times, which imposes some limitations on GMapPlot:

Only Range1d ranges are supported. Attempting to use other range types will result in an error.
Usage of BoxZoomTool is incompatible with GMapPlot. Adding a BoxZoomTool will have no effect.

JSON Prototype

{
  "above": [], 
  "align": "auto", 
  "api_key": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "api_version": "weekly", 
  "aspect_ratio": null, 
  "aspect_scale": 1, 
  "attribution": [], 
  "background_fill_alpha": 0.0, 
  "background_fill_color": "#ffffff", 
  "below": [], 
  "border_fill_alpha": 1.0, 
  "border_fill_color": "#ffffff", 
  "center": [], 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "extra_x_ranges": {
    "type": "map"
  }, 
  "extra_x_scales": {
    "type": "map"
  }, 
  "extra_y_ranges": {
    "type": "map"
  }, 
  "extra_y_scales": {
    "type": "map"
  }, 
  "flow_mode": "block", 
  "frame_align": true, 
  "frame_height": null, 
  "frame_width": null, 
  "height": 600, 
  "height_policy": "auto", 
  "hidpi": true, 
  "hold_render": false, 
  "id": "p59858", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "left": [], 
  "lod_factor": 10, 
  "lod_interval": 300, 
  "lod_threshold": 2000, 
  "lod_timeout": 500, 
  "map_options": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "margin": null, 
  "match_aspect": false, 
  "max_height": null, 
  "max_width": null, 
  "min_border": 5, 
  "min_border_bottom": null, 
  "min_border_left": null, 
  "min_border_right": null, 
  "min_border_top": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "outline_line_alpha": 1.0, 
  "outline_line_cap": "butt", 
  "outline_line_color": "#e5e5e5", 
  "outline_line_dash": [], 
  "outline_line_dash_offset": 0, 
  "outline_line_join": "bevel", 
  "outline_line_width": 1, 
  "output_backend": "canvas", 
  "renderers": [], 
  "reset_policy": "standard", 
  "resizable": false, 
  "right": [], 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": {
    "id": "p59863", 
    "name": "Title", 
    "type": "object"
  }, 
  "title_location": "above", 
  "toolbar": {
    "id": "p59864", 
    "name": "Toolbar", 
    "type": "object"
  }, 
  "toolbar_inner": false, 
  "toolbar_location": "right", 
  "toolbar_sticky": true, 
  "visible": true, 
  "width": 600, 
  "width_policy": "auto", 
  "x_range": {
    "id": "p59859", 
    "name": "Range1d", 
    "type": "object"
  }, 
  "x_scale": {
    "id": "p59861", 
    "name": "LinearScale", 
    "type": "object"
  }, 
  "y_range": {
    "id": "p59860", 
    "name": "Range1d", 
    "type": "object"
  }, 
  "y_scale": {
    "id": "p59862", 
    "name": "LinearScale", 
    "type": "object"
  }
}

above = []#

Type:: List

A list of renderers to occupy the area above of the plot.

align = 'auto'#

Type:: Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

The alignment point within the parent container.

This property is useful only if this component is a child element of a layout (e.g. a grid). Self alignment can be overridden by the parent container (e.g. grid track align).

api_key = Undefined#

Type:: Required(Bytes)

Google Maps API requires an API key. See https://developers.google.com/maps/documentation/javascript/get-api-key for more information on how to obtain your own.

api_version = 'weekly'#

Type:: String

The version of Google Maps API to use. See https://developers.google.com/maps/documentation/javascript/versions for more information.

Note

Changing this value may result in broken map rendering.

aspect_ratio = None#

Type:: Either(Null, Auto, Float)

Describes the proportional relationship between component’s width and height.

This works if any of component’s dimensions are flexible in size. If set to a number, width / height = aspect_ratio relationship will be maintained. Otherwise, if set to "auto", component’s preferred width and height will be used to determine the aspect (if not set, no aspect will be preserved).

aspect_scale = 1#

Type:: Float

A value to be given for increased aspect ratio control. This value is added multiplicatively to the calculated value required for match_aspect. aspect_scale is defined as the ratio of width over height of the figure.

For example, a plot with aspect_scale value of 2 will result in a square in data units to be drawn on the screen as a rectangle with a pixel width twice as long as its pixel height.

Note

This setting only takes effect if match_aspect is set to True.

attribution = []#

Type:: List

Allows to acknowledge or give credit to data, tile, etc. providers.

This can be in either HTML or plain text forms. Renderers, like tile renderers, can provide additional attributions which will be added after attributions provided here.

Note

This feature is experimental and may change in the short term.

background_fill_alpha = 0.0#

Type:: Alpha

The fill alpha for the plot background style.

background_fill_color = '#ffffff'#

Type:: Nullable(Color)

The fill color for the plot background style.

below = []#

Type:: List

A list of renderers to occupy the area below of the plot.

border_fill_alpha = 1.0#

Type:: Alpha

The fill alpha for the plot border style.

border_fill_color = '#ffffff'#

Type:: Nullable(Color)

The fill color for the plot border style.

center = []#

Type:: List

A list of renderers to occupy the center area (frame) of the plot.

context_menu = None#

Type:: Nullable(Instance(‘.models.ui.Menu’))

A menu to display when user right clicks on the component.

Note

Use shift key when right clicking to display the native context menu.

css_classes = []#

Type:: List

A list of additional CSS classes to add to the underlying DOM element.

css_variables = {}#

Type:: Dict(String, Instance(Node))

Allows to define dynamically computed CSS variables.

This can be used, for example, to coordinate positioning and styling between canvas’ renderers and/or visuals and HTML-based UI elements.

Variables defined here are equivalent to setting the same variables under :host { ... } in a CSS stylesheet.

Note

This property is experimental and may change at any point.

disabled = False#

Type:: Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

elements = []#

Type:: List

A collection of DOM-based UI elements attached to this pane.

This can include floating elements like tooltips, allowing to establish a parent-child relationship between this and other UI elements.

extra_x_ranges = {}#

Type:: Dict(String, Instance(Range))

Additional named ranges to make available for mapping x-coordinates.

This is useful for adding additional axes.

extra_x_scales = {}#

Type:: Dict(String, Instance(Scale))

Additional named scales to make available for mapping x-coordinates.

This is useful for adding additional axes.

Note

This feature is experimental and may change in the short term.

extra_y_ranges = {}#

Type:: Dict(String, Instance(Range))

Additional named ranges to make available for mapping y-coordinates.

This is useful for adding additional axes.

extra_y_scales = {}#

Type:: Dict(String, Instance(Scale))

Additional named scales to make available for mapping y-coordinates.

This is useful for adding additional axes.

Note

This feature is experimental and may change in the short term.

flow_mode = 'block'#

Type:: Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

frame_align = True#

Type:: Either(Bool, Struct)

Allows to specify which frame edges to align in multiple-plot layouts.

The default is to align all edges, but users can opt-out from alignment of each individual edge or all edges. Note also that other properties may disable alignment of certain edges, especially when using fixed frame size (frame_width and frame_height properties).

frame_height = None#

Type:: Nullable(Int)

The height of a plot frame or the inner height of a plot, excluding any axes, titles, border padding, etc.

frame_width = None#

Type:: Nullable(Int)

The width of a plot frame or the inner width of a plot, excluding any axes, titles, border padding, etc.

height = 600#

Type:: Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#

Type:: Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto": Use component’s preferred sizing policy.
"fixed": Use exactly height pixels. Component will overflow if it can’t fit in the available vertical space.
"fit": Use component’s preferred height (if set) and allow to fit into the available vertical space within the minimum and maximum height bounds (if set). Component’s height neither will be aggressively minimized nor maximized.
"min": Use as little vertical space as possible, not less than the minimum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max": Use as much vertical space as possible, not more than the maximum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.

Note

This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.

hidpi = True#

Type:: Bool

Whether to use HiDPI mode when available.

hold_render = False#

Type:: Bool

When set to True all requests to repaint the plot will be hold off.

This is useful when periodically updating many glyphs. For example, let’s assume we have 10 lines on a plot, each with its own datasource. We stream to all of them every second in a for loop like so:

for line in lines:
    line.stream(new_points())

The problem with this code is that every stream triggers a re-rendering of the plot. Even tough repainting only on the last stream would produce almost identical visual effect. Especially for lines with many points this becomes computationally expensive and can freeze your browser. Using a convenience method hold, we can control when rendering is initiated like so:

with plot.hold(render=True):
    for line in lines:
        line.stream(new_points())

In this case we render newly appended points only after the last stream.

inner_height = Undefined#

Type:: Readonly

This is the exact height of the plotting canvas, i.e. the height of the actual plot, without toolbars etc. Note this is computed in a web browser, so this property will work only in backends capable of bidirectional communication (server, notebook).

Note

This is an experimental feature and the API may change in near future.

inner_width = Undefined#

Type:: Readonly

This is the exact width of the plotting canvas, i.e. the width of the actual plot, without toolbars etc. Note this is computed in a web browser, so this property will work only in backends capable of bidirectional communication (server, notebook).

Note

This is an experimental feature and the API may change in near future.

left = []#

Type:: List

A list of renderers to occupy the area to the left of the plot.

lod_factor = 10#

Type:: Int

Decimation factor to use when applying level-of-detail decimation.

lod_interval = 300#

Type:: Int

Interval (in ms) during which an interactive tool event will enable level-of-detail downsampling.

lod_threshold = 2000#

Type:: Nullable(Int)

A number of data points, above which level-of-detail downsampling may be performed by glyph renderers. Set to None to disable any level-of-detail downsampling.

lod_timeout = 500#

Type:: Int

Timeout (in ms) for checking whether interactive tool events are still occurring. Once level-of-detail mode is enabled, a check is made every lod_timeout ms. If no interactive tool events have happened, level-of-detail mode is disabled.

map_options = Undefined#

Type:: Instance(GMapOptions)

Options for displaying the plot.

margin = None#

Type:: Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

match_aspect = False#

Type:: Bool

Specify the aspect ratio behavior of the plot. Aspect ratio is defined as the ratio of width over height. This property controls whether Bokeh should attempt to match the (width/height) of data space to the (width/height) in pixels of screen space.

Default is False which indicates that the data aspect ratio and the screen aspect ratio vary independently. True indicates that the plot aspect ratio of the axes will match the aspect ratio of the pixel extent the axes. The end result is that a 1x1 area in data space is a square in pixels, and conversely that a 1x1 pixel is a square in data units.

Note

This setting only takes effect when there are two dataranges. This setting only sets the initial plot draw and subsequent resets. It is possible for tools (single axis zoom, unconstrained box zoom) to change the aspect ratio.

Warning

This setting is incompatible with linking dataranges across multiple plots. Doing so may result in undefined behavior.

max_height = None#

Type:: Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None#

Type:: Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_border = 5#

Type:: Nullable(Int)

A convenience property to set all all the min_border_X properties to the same value. If an individual border property is explicitly set, it will override min_border.

min_border_bottom = None#

Type:: Nullable(Int)

Minimum size in pixels of the padding region below the bottom of the central plot region.

Note

This is a minimum. The padding region may expand as needed to accommodate titles or axes, etc.

min_border_left = None#

Type:: Nullable(Int)

Minimum size in pixels of the padding region to the left of the central plot region.

Note

This is a minimum. The padding region may expand as needed to accommodate titles or axes, etc.

min_border_right = None#

Type:: Nullable(Int)

Minimum size in pixels of the padding region to the right of the central plot region.

Note

This is a minimum. The padding region may expand as needed to accommodate titles or axes, etc.

min_border_top = None#

Type:: Nullable(Int)

Minimum size in pixels of the padding region above the top of the central plot region.

Note

This is a minimum. The padding region may expand as needed to accommodate titles or axes, etc.

min_height = None#

Type:: Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#

Type:: Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#

Type:: Nullable(String)

An arbitrary, user-supplied name for this model.

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

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

Note

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

outer_height = Undefined#

Type:: Readonly

This is the exact height of the layout, i.e. the height of the actual plot, with toolbars etc. Note this is computed in a web browser, so this property will work only in backends capable of bidirectional communication (server, notebook).

Note

This is an experimental feature and the API may change in near future.

outer_width = Undefined#

Type:: Readonly

This is the exact width of the layout, i.e. the height of the actual plot, with toolbars etc. Note this is computed in a web browser, so this property will work only in backends capable of bidirectional communication (server, notebook).

Note

This is an experimental feature and the API may change in near future.

outline_line_alpha = 1.0#

Type:: Alpha

The line alpha for the plot border outline.

outline_line_cap = 'butt'#

Type:: Enum(LineCap)

The line cap for the plot border outline.

outline_line_color = '#e5e5e5'#

Type:: Nullable(Color)

The line color for the plot border outline.

outline_line_dash = []#

Type:: DashPattern

The line dash for the plot border outline.

outline_line_dash_offset = 0#

Type:: Int

The line dash offset for the plot border outline.

outline_line_join = 'bevel'#

Type:: Enum(LineJoin)

The line join for the plot border outline.

outline_line_width = 1#

Type:: Float

The line width for the plot border outline.

output_backend = 'canvas'#

Type:: Enum(OutputBackend)

Specify the output backend for the plot area. Default is HTML5 Canvas.

Note

When set to webgl, glyphs without a WebGL rendering implementation will fall back to rendering onto 2D canvas.

renderers = []#

Type:: List

A list of all glyph renderers for this plot.

This property can be manipulated by hand, but the add_glyph is recommended to help make sure all necessary setup is performed.

reset_policy = 'standard'#

Type:: Enum(ResetPolicy)

How a plot should respond to being reset. By default, the standard actions are to clear any tool state history, return plot ranges to their original values, undo all selections, and emit a Reset event. If customization is desired, this property may be set to "event_only", which will suppress all of the actions except the Reset event.

resizable = False#

Type:: Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

right = []#

Type:: List

A list of renderers to occupy the area to the right of the plot.

sizing_mode = None#

Type:: Nullable(Enum(SizingMode))

How the component should size itself.

This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode).

Possible scenarios:

"inherit": The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.
"fixed": Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events.
"stretch_width": Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_height": Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_both": Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component.
"scale_width": Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio.
"scale_height": Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio.
"scale_both": Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.

styles = {}#

Type:: Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#

Type:: List

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:: Bool

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

Note

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

tags = []#

Type:: List

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

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

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

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

Note

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

title = Title(id='p60355', ...)#

Type:: Either(Null, Instance(Title))

A title for the plot. Can be a text string or a Title annotation.

title_location = 'above'#

Type:: Nullable(Enum(Location))

Where the title will be located. Titles on the left or right side will be rotated.

toolbar = Toolbar(id='p60370', ...)#

Type:: Instance(Toolbar)

The toolbar associated with this plot which holds all the tools. It is automatically created with the plot if necessary.

toolbar_inner = False#

Type:: Bool

Locate the toolbar inside the frame. Setting this property to True makes most sense with auto-hidden toolbars.

toolbar_location = 'right'#

Type:: Nullable(Enum(Location))

Where the toolbar will be located. If set to None, no toolbar will be attached to the plot.

toolbar_sticky = True#

Type:: Bool

Stick the toolbar to the edge of the plot. Default: True. If False, the toolbar will be outside of the axes, titles etc.

visible = True#

Type:: Bool

Whether the component should be displayed on screen.

width = 600#

Type:: Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#

Type:: Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto": Use component’s preferred sizing policy.
"fixed": Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.
"fit": Use component’s preferred width (if set) and allow it to fit into the available horizontal space within the minimum and maximum width bounds (if set). Component’s width neither will be aggressively minimized nor maximized.
"min": Use as little horizontal space as possible, not less than the minimum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max": Use as much horizontal space as possible, not more than the maximum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.

Note

This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.

x_range = Range1d(id='p60420', ...)#

Type:: Instance(Range)

The (default) data range of the horizontal dimension of the plot.

x_scale = LinearScale(id='p60428', ...)#

Type:: Instance(Scale)

What kind of scale to use to convert x-coordinates in data space into x-coordinates in screen space.

y_range = Range1d(id='p60436', ...)#

Type:: Instance(Range)

The (default) data range of the vertical dimension of the plot.

y_scale = LinearScale(id='p60444', ...)#

Type:: Instance(Scale)

What kind of scale to use to convert y-coordinates in data space into y-coordinates in screen space.

add_glyph(source_or_glyph: Glyph | ColumnarDataSource, glyph: Glyph | None = None, **kwargs: Any) → GlyphRenderer#

Adds a glyph to the plot with associated data sources and ranges.

This function will take care of creating and configuring a Glyph object, and then add it to the plot’s list of renderers.

Parameters:

source (DataSource) – a data source for the glyphs to all use
glyph (Glyph) – the glyph to add to the Plot

Keyword Arguments:

the (Any additional keyword arguments are passed on as-is to)
initializer. (Glyph)

Returns:

GlyphRenderer

add_layout(obj: Renderer, place: Literal['above', 'below', 'left', 'right', 'center'] = 'center') → None#

Adds an object to the plot in a specified place.

Parameters:

obj (Renderer) – the object to add to the Plot
place (str, optional) – where to add the object (default: ‘center’) Valid places are: ‘left’, ‘right’, ‘above’, ‘below’, ‘center’.

Returns:

None

add_tile(tile_source: TileSource | TileProvider | str, retina: bool = False, **kwargs: Any) → TileRenderer#

Adds new TileRenderer into Plot.renderers

Parameters:

tile_source (TileSource, xyzservices.TileProvider, str) – A tile source instance which contain tileset configuration
retina (bool) – Whether to use retina version of tiles (if available)

Keyword Arguments:

renderer (Additional keyword arguments are passed on as-is to the tile)

Returns:

TileRenderer

Return type:

TileRenderer

add_tools(*tools: Tool | str) → None#

Adds tools to the plot.

Parameters:: *tools (Tool) – the tools to add to the Plot
Returns:: None

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.

column(col, gridplot)#

Return whether this plot is in a given column of a GridPlot.

Parameters:

col (int) – index of the column to test
gridplot (GridPlot) – the GridPlot to check

Returns:

bool

classmethod dataspecs() → dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

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

Returns:: names of DataSpec properties
Return type:: set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]#: List of property descriptors in the order of definition.

destroy() → None#: Clean up references to the document and property

equals(other: HasProps) → bool#

Structural equality of models.

Parameters:: other (HasProps) – the other instance to compare to
Returns:: True, if properties are structurally equal, otherwise False

hold(*, render: bool) → Generator[None, None, None]#

Takes care of turning a property on and off within a scope.

Parameters:: render (bool) – Turns the property hold_render on and off.

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:

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:: ValueError –

Examples

This code with js_link:

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

is equivalent to the following:

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

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

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

which is equivalent to:

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

js_on_change(event: str, *callbacks: JSChangeCallback) → None#

Attach a CustomJS callback to an arbitrary BokehJS model event.

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

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

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

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None#

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

Parameters:

name (str) – name of the property to search for
raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

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

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

Parameters:

attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None#

Run callbacks when the specified event occurs on this Model

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

classmethod parameters() → list[Parameter]#

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

Returns:: list(Parameter)

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

Collect the names of properties on this class.

Warning

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

Returns:: property names

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

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

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

Returns:: names of properties that have references
Return type:: set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

Collect a dict mapping property names to their values.

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

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

Parameters:: include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)
Returns:: mapping from property names to their values
Return type:: dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:

query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]#: Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None#: Remove a callback from this object

remove_tools(*tools: Tool) → None#

Removes tools from the plot.

Parameters:: *tools (Tool) – the tools to remove from the Plot
Returns:: None

row(row, gridplot)#

Return whether this plot is in a given row of a GridPlot.

Parameters:

row (int) – index of the row to test
gridplot (GridPlot) – the GridPlot to check

Returns:

bool

select(*args, **kwargs)#

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

There are a few different ways to call the select method. The most general is to supply a JSON-like query dictionary as the single argument or as keyword arguments:

Parameters:: selector (JSON-like) – some sample text
Keyword Arguments:: kwargs – query dict key/values as keyword arguments

Additionally, for compatibility with Model.select, a selector dict may be passed as selector keyword argument, in which case the value of kwargs['selector'] is used for the query.

For convenience, queries on just names can be made by supplying the name string as the single parameter:

Parameters:: name (str) – the name to query on

Also queries on just type can be made simply by supplying the Model subclass as the single parameter:

Parameters:: type (Model) – the type to query on
Returns:: seq[Model]

Examples

# These three are equivalent
p.select(selector={"type": HoverTool})
p.select({"type": HoverTool})
p.select(HoverTool)

# These two are also equivalent
p.select({"name": "mycircle"})
p.select("mycircle")

# Keyword arguments can be supplied in place of selector dict
p.select({"name": "foo", "type": HoverTool})
p.select(name="foo", type=HoverTool)

select_one(selector: SelectorType) → Model | None#

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

Returns:: Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None#

Set a property value on this object from JSON.

Parameters:

name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)

This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.

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

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None#

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

Parameters:

selector (JSON-like)
updates (dict)

Returns:

None

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

Get any theme-provided overrides.

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

Returns:: dict or None

to_serializable(serializer: Serializer) → ObjectRefRep#: Converts this object to a serializable representation.

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

unapply_theme() → None#

Remove any themed values and restore defaults.

Returns:: None

update(**kwargs: Any) → None#

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

Returns:: None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

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

# update properties together:
r.update(start=10, end=20)

property axis#: Splattable list of Axis objects.

property document: Document | None#: The Document this model is attached to (can be None)

property grid#: Splattable list of Grid objects.

property hover#: Splattable list of HoverTool objects.

property legend#: Splattable list of Legend objects.

property xaxis#: Splattable list of Axis objects for the x dimension.

property xgrid#: Splattable list of Grid objects for the x dimension.

property yaxis#: Splattable list of Axis objects for the y dimension.

property ygrid#: Splattable list of Grid objects for the y dimension.

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

Bases: Model

Abstract base class for map options’ models.

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.

lat = Undefined#

Type:: Required(Float)

The latitude where the map should be centered.

lng = Undefined#

Type:: Required(Float)

The longitude where the map should be centered.

name = None#

Type:: Nullable(String)

An arbitrary, user-supplied name for this model.

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

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

Note

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

syncable = True#

Type:: Bool

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

Note

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

tags = []#

Type:: List

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

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

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

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

Note

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

zoom = 12#

Type:: Int

The initial zoom level to use when displaying the map.

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.

Returns:: names of DataSpec properties
Return type:: set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]#: List of property descriptors in the order of definition.

destroy() → None#: Clean up references to the document and property

equals(other: HasProps) → bool#

Structural equality of models.

Parameters:: other (HasProps) – the other instance to compare to
Returns:: True, if properties are structurally equal, otherwise False

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:

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:: ValueError –

Examples

This code with js_link:

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

is equivalent to the following:

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

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

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

which is equivalent to:

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

js_on_change(event: str, *callbacks: JSChangeCallback) → None#

Attach a CustomJS callback to an arbitrary BokehJS model event.

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

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

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

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None#

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

Parameters:

name (str) – name of the property to search for
raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

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

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

Parameters:

attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None#

Run callbacks when the specified event occurs on this Model

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

classmethod parameters() → list[Parameter]#

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

Returns:: list(Parameter)

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

Collect the names of properties on this class.

Warning

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

Returns:: property names

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

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

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

Returns:: names of properties that have references
Return type:: set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

Collect a dict mapping property names to their values.

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

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

Parameters:: include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)
Returns:: mapping from property names to their values
Return type:: dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:

query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]#: Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None#: Remove a callback from this object

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

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

Parameters:: selector (JSON-like)
Returns:: seq[Model]

select_one(selector: SelectorType) → Model | None#

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

Returns:: Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None#

Set a property value on this object from JSON.

Parameters:

name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)

This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.

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

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None#

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

Parameters:

selector (JSON-like)
updates (dict)

Returns:

None

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

Get any theme-provided overrides.

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

Returns:: dict or None

to_serializable(serializer: Serializer) → ObjectRefRep#: Converts this object to a serializable representation.

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

unapply_theme() → None#

Remove any themed values and restore defaults.

Returns:: None

update(**kwargs: Any) → None#

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

Returns:: None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

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

# update properties together:
r.update(start=10, end=20)

property document: Document | None#: The Document this model is attached to (can be None)

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

Bases: Plot

Abstract base class for map plot models.

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

{
  "above": [], 
  "align": "auto", 
  "aspect_ratio": null, 
  "aspect_scale": 1, 
  "attribution": [], 
  "background_fill_alpha": 1.0, 
  "background_fill_color": "#ffffff", 
  "below": [], 
  "border_fill_alpha": 1.0, 
  "border_fill_color": "#ffffff", 
  "center": [], 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "extra_x_ranges": {
    "type": "map"
  }, 
  "extra_x_scales": {
    "type": "map"
  }, 
  "extra_y_ranges": {
    "type": "map"
  }, 
  "extra_y_scales": {
    "type": "map"
  }, 
  "flow_mode": "block", 
  "frame_align": true, 
  "frame_height": null, 
  "frame_width": null, 
  "height": 600, 
  "height_policy": "auto", 
  "hidpi": true, 
  "hold_render": false, 
  "id": "p60452", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "left": [], 
  "lod_factor": 10, 
  "lod_interval": 300, 
  "lod_threshold": 2000, 
  "lod_timeout": 500, 
  "margin": null, 
  "match_aspect": false, 
  "max_height": null, 
  "max_width": null, 
  "min_border": 5, 
  "min_border_bottom": null, 
  "min_border_left": null, 
  "min_border_right": null, 
  "min_border_top": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "outline_line_alpha": 1.0, 
  "outline_line_cap": "butt", 
  "outline_line_color": "#e5e5e5", 
  "outline_line_dash": [], 
  "outline_line_dash_offset": 0, 
  "outline_line_join": "bevel", 
  "outline_line_width": 1, 
  "output_backend": "canvas", 
  "renderers": [], 
  "reset_policy": "standard", 
  "resizable": false, 
  "right": [], 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": {
    "id": "p60457", 
    "name": "Title", 
    "type": "object"
  }, 
  "title_location": "above", 
  "toolbar": {
    "id": "p60458", 
    "name": "Toolbar", 
    "type": "object"
  }, 
  "toolbar_inner": false, 
  "toolbar_location": "right", 
  "toolbar_sticky": true, 
  "visible": true, 
  "width": 600, 
  "width_policy": "auto", 
  "x_range": {
    "id": "p60453", 
    "name": "DataRange1d", 
    "type": "object"
  }, 
  "x_scale": {
    "id": "p60455", 
    "name": "LinearScale", 
    "type": "object"
  }, 
  "y_range": {
    "id": "p60454", 
    "name": "DataRange1d", 
    "type": "object"
  }, 
  "y_scale": {
    "id": "p60456", 
    "name": "LinearScale", 
    "type": "object"
  }
}

above = []#

Type:: List

A list of renderers to occupy the area above of the plot.

align = 'auto'#

Type:: Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

The alignment point within the parent container.

This property is useful only if this component is a child element of a layout (e.g. a grid). Self alignment can be overridden by the parent container (e.g. grid track align).

aspect_ratio = None#

Type:: Either(Null, Auto, Float)

Describes the proportional relationship between component’s width and height.

This works if any of component’s dimensions are flexible in size. If set to a number, width / height = aspect_ratio relationship will be maintained. Otherwise, if set to "auto", component’s preferred width and height will be used to determine the aspect (if not set, no aspect will be preserved).

aspect_scale = 1#

Type:: Float

A value to be given for increased aspect ratio control. This value is added multiplicatively to the calculated value required for match_aspect. aspect_scale is defined as the ratio of width over height of the figure.

For example, a plot with aspect_scale value of 2 will result in a square in data units to be drawn on the screen as a rectangle with a pixel width twice as long as its pixel height.

Note

This setting only takes effect if match_aspect is set to True.

attribution = []#

Type:: List

Allows to acknowledge or give credit to data, tile, etc. providers.

This can be in either HTML or plain text forms. Renderers, like tile renderers, can provide additional attributions which will be added after attributions provided here.

Note

This feature is experimental and may change in the short term.

background_fill_alpha = 1.0#

Type:: Alpha

The fill alpha for the plot background style.

background_fill_color = '#ffffff'#

Type:: Nullable(Color)

The fill color for the plot background style.

below = []#

Type:: List

A list of renderers to occupy the area below of the plot.

border_fill_alpha = 1.0#

Type:: Alpha

The fill alpha for the plot border style.

border_fill_color = '#ffffff'#

Type:: Nullable(Color)

The fill color for the plot border style.

center = []#

Type:: List

A list of renderers to occupy the center area (frame) of the plot.

context_menu = None#

Type:: Nullable(Instance(‘.models.ui.Menu’))

A menu to display when user right clicks on the component.

Note

Use shift key when right clicking to display the native context menu.

css_classes = []#

Type:: List

A list of additional CSS classes to add to the underlying DOM element.

css_variables = {}#

Type:: Dict(String, Instance(Node))

Allows to define dynamically computed CSS variables.

This can be used, for example, to coordinate positioning and styling between canvas’ renderers and/or visuals and HTML-based UI elements.

Variables defined here are equivalent to setting the same variables under :host { ... } in a CSS stylesheet.

Note

This property is experimental and may change at any point.

disabled = False#

Type:: Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

elements = []#

Type:: List

A collection of DOM-based UI elements attached to this pane.

This can include floating elements like tooltips, allowing to establish a parent-child relationship between this and other UI elements.

extra_x_ranges = {}#

Type:: Dict(String, Instance(Range))

Additional named ranges to make available for mapping x-coordinates.

This is useful for adding additional axes.

extra_x_scales = {}#

Type:: Dict(String, Instance(Scale))

Additional named scales to make available for mapping x-coordinates.

This is useful for adding additional axes.

Note

This feature is experimental and may change in the short term.

extra_y_ranges = {}#

Type:: Dict(String, Instance(Range))

Additional named ranges to make available for mapping y-coordinates.

This is useful for adding additional axes.

extra_y_scales = {}#

Type:: Dict(String, Instance(Scale))

Additional named scales to make available for mapping y-coordinates.

This is useful for adding additional axes.

Note

This feature is experimental and may change in the short term.

flow_mode = 'block'#

Type:: Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

frame_align = True#

Type:: Either(Bool, Struct)

Allows to specify which frame edges to align in multiple-plot layouts.

The default is to align all edges, but users can opt-out from alignment of each individual edge or all edges. Note also that other properties may disable alignment of certain edges, especially when using fixed frame size (frame_width and frame_height properties).

frame_height = None#

Type:: Nullable(Int)

The height of a plot frame or the inner height of a plot, excluding any axes, titles, border padding, etc.

frame_width = None#

Type:: Nullable(Int)

The width of a plot frame or the inner width of a plot, excluding any axes, titles, border padding, etc.

height = 600#

Type:: Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#

Type:: Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto": Use component’s preferred sizing policy.
"fixed": Use exactly height pixels. Component will overflow if it can’t fit in the available vertical space.
"fit": Use component’s preferred height (if set) and allow to fit into the available vertical space within the minimum and maximum height bounds (if set). Component’s height neither will be aggressively minimized nor maximized.
"min": Use as little vertical space as possible, not less than the minimum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max": Use as much vertical space as possible, not more than the maximum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.

Note

This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.

hidpi = True#

Type:: Bool

Whether to use HiDPI mode when available.

hold_render = False#

Type:: Bool

When set to True all requests to repaint the plot will be hold off.

This is useful when periodically updating many glyphs. For example, let’s assume we have 10 lines on a plot, each with its own datasource. We stream to all of them every second in a for loop like so:

for line in lines:
    line.stream(new_points())

The problem with this code is that every stream triggers a re-rendering of the plot. Even tough repainting only on the last stream would produce almost identical visual effect. Especially for lines with many points this becomes computationally expensive and can freeze your browser. Using a convenience method hold, we can control when rendering is initiated like so:

with plot.hold(render=True):
    for line in lines:
        line.stream(new_points())

In this case we render newly appended points only after the last stream.

inner_height = Undefined#

Type:: Readonly

This is the exact height of the plotting canvas, i.e. the height of the actual plot, without toolbars etc. Note this is computed in a web browser, so this property will work only in backends capable of bidirectional communication (server, notebook).

Note

This is an experimental feature and the API may change in near future.

inner_width = Undefined#

Type:: Readonly

This is the exact width of the plotting canvas, i.e. the width of the actual plot, without toolbars etc. Note this is computed in a web browser, so this property will work only in backends capable of bidirectional communication (server, notebook).

Note

This is an experimental feature and the API may change in near future.

left = []#

Type:: List

A list of renderers to occupy the area to the left of the plot.

lod_factor = 10#

Type:: Int

Decimation factor to use when applying level-of-detail decimation.

lod_interval = 300#

Type:: Int

Interval (in ms) during which an interactive tool event will enable level-of-detail downsampling.

lod_threshold = 2000#

Type:: Nullable(Int)

A number of data points, above which level-of-detail downsampling may be performed by glyph renderers. Set to None to disable any level-of-detail downsampling.

lod_timeout = 500#

Type:: Int

Timeout (in ms) for checking whether interactive tool events are still occurring. Once level-of-detail mode is enabled, a check is made every lod_timeout ms. If no interactive tool events have happened, level-of-detail mode is disabled.

margin = None#

Type:: Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

match_aspect = False#

Type:: Bool

Specify the aspect ratio behavior of the plot. Aspect ratio is defined as the ratio of width over height. This property controls whether Bokeh should attempt to match the (width/height) of data space to the (width/height) in pixels of screen space.

Default is False which indicates that the data aspect ratio and the screen aspect ratio vary independently. True indicates that the plot aspect ratio of the axes will match the aspect ratio of the pixel extent the axes. The end result is that a 1x1 area in data space is a square in pixels, and conversely that a 1x1 pixel is a square in data units.

Note

This setting only takes effect when there are two dataranges. This setting only sets the initial plot draw and subsequent resets. It is possible for tools (single axis zoom, unconstrained box zoom) to change the aspect ratio.

Warning

This setting is incompatible with linking dataranges across multiple plots. Doing so may result in undefined behavior.

max_height = None#

Type:: Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None#

Type:: Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_border = 5#

Type:: Nullable(Int)

A convenience property to set all all the min_border_X properties to the same value. If an individual border property is explicitly set, it will override min_border.

min_border_bottom = None#

Type:: Nullable(Int)

Minimum size in pixels of the padding region below the bottom of the central plot region.

Note

This is a minimum. The padding region may expand as needed to accommodate titles or axes, etc.

min_border_left = None#

Type:: Nullable(Int)

Minimum size in pixels of the padding region to the left of the central plot region.

Note

This is a minimum. The padding region may expand as needed to accommodate titles or axes, etc.

min_border_right = None#

Type:: Nullable(Int)

Minimum size in pixels of the padding region to the right of the central plot region.

Note

This is a minimum. The padding region may expand as needed to accommodate titles or axes, etc.

min_border_top = None#

Type:: Nullable(Int)

Minimum size in pixels of the padding region above the top of the central plot region.

Note

This is a minimum. The padding region may expand as needed to accommodate titles or axes, etc.

min_height = None#

Type:: Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#

Type:: Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#

Type:: Nullable(String)

An arbitrary, user-supplied name for this model.

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

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

Note

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

outer_height = Undefined#

Type:: Readonly

This is the exact height of the layout, i.e. the height of the actual plot, with toolbars etc. Note this is computed in a web browser, so this property will work only in backends capable of bidirectional communication (server, notebook).

Note

This is an experimental feature and the API may change in near future.

outer_width = Undefined#

Type:: Readonly

This is the exact width of the layout, i.e. the height of the actual plot, with toolbars etc. Note this is computed in a web browser, so this property will work only in backends capable of bidirectional communication (server, notebook).

Note

This is an experimental feature and the API may change in near future.

outline_line_alpha = 1.0#

Type:: Alpha

The line alpha for the plot border outline.

outline_line_cap = 'butt'#

Type:: Enum(LineCap)

The line cap for the plot border outline.

outline_line_color = '#e5e5e5'#

Type:: Nullable(Color)

The line color for the plot border outline.

outline_line_dash = []#

Type:: DashPattern

The line dash for the plot border outline.

outline_line_dash_offset = 0#

Type:: Int

The line dash offset for the plot border outline.

outline_line_join = 'bevel'#

Type:: Enum(LineJoin)

The line join for the plot border outline.

outline_line_width = 1#

Type:: Float

The line width for the plot border outline.

output_backend = 'canvas'#

Type:: Enum(OutputBackend)

Specify the output backend for the plot area. Default is HTML5 Canvas.

Note

When set to webgl, glyphs without a WebGL rendering implementation will fall back to rendering onto 2D canvas.

renderers = []#

Type:: List

A list of all glyph renderers for this plot.

This property can be manipulated by hand, but the add_glyph is recommended to help make sure all necessary setup is performed.

reset_policy = 'standard'#

Type:: Enum(ResetPolicy)

How a plot should respond to being reset. By default, the standard actions are to clear any tool state history, return plot ranges to their original values, undo all selections, and emit a Reset event. If customization is desired, this property may be set to "event_only", which will suppress all of the actions except the Reset event.

resizable = False#

Type:: Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

right = []#

Type:: List

A list of renderers to occupy the area to the right of the plot.

sizing_mode = None#

Type:: Nullable(Enum(SizingMode))

How the component should size itself.

This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode).

Possible scenarios:

"inherit": The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.
"fixed": Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events.
"stretch_width": Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_height": Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_both": Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component.
"scale_width": Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio.
"scale_height": Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio.
"scale_both": Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.

styles = {}#

Type:: Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#

Type:: List

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:: Bool

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

Note

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

tags = []#

Type:: List

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

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

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

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

Note

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

title = Title(id='p60928', ...)#

Type:: Either(Null, Instance(Title))

A title for the plot. Can be a text string or a Title annotation.

title_location = 'above'#

Type:: Nullable(Enum(Location))

Where the title will be located. Titles on the left or right side will be rotated.

toolbar = Toolbar(id='p60943', ...)#

Type:: Instance(Toolbar)

The toolbar associated with this plot which holds all the tools. It is automatically created with the plot if necessary.

toolbar_inner = False#

Type:: Bool

Locate the toolbar inside the frame. Setting this property to True makes most sense with auto-hidden toolbars.

toolbar_location = 'right'#

Type:: Nullable(Enum(Location))

Where the toolbar will be located. If set to None, no toolbar will be attached to the plot.

toolbar_sticky = True#

Type:: Bool

Stick the toolbar to the edge of the plot. Default: True. If False, the toolbar will be outside of the axes, titles etc.

visible = True#

Type:: Bool

Whether the component should be displayed on screen.

width = 600#

Type:: Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#

Type:: Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto": Use component’s preferred sizing policy.
"fixed": Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.
"fit": Use component’s preferred width (if set) and allow it to fit into the available horizontal space within the minimum and maximum width bounds (if set). Component’s width neither will be aggressively minimized nor maximized.
"min": Use as little horizontal space as possible, not less than the minimum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max": Use as much horizontal space as possible, not more than the maximum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.

Note

This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.

x_range = DataRange1d(id='p60993', ...)#

Type:: Instance(Range)

The (default) data range of the horizontal dimension of the plot.

x_scale = LinearScale(id='p61001', ...)#

Type:: Instance(Scale)

What kind of scale to use to convert x-coordinates in data space into x-coordinates in screen space.

y_range = DataRange1d(id='p61009', ...)#

Type:: Instance(Range)

The (default) data range of the vertical dimension of the plot.

y_scale = LinearScale(id='p61017', ...)#

Type:: Instance(Scale)

What kind of scale to use to convert y-coordinates in data space into y-coordinates in screen space.

add_glyph(source_or_glyph: Glyph | ColumnarDataSource, glyph: Glyph | None = None, **kwargs: Any) → GlyphRenderer#

Adds a glyph to the plot with associated data sources and ranges.

This function will take care of creating and configuring a Glyph object, and then add it to the plot’s list of renderers.

Parameters:

source (DataSource) – a data source for the glyphs to all use
glyph (Glyph) – the glyph to add to the Plot

Keyword Arguments:

the (Any additional keyword arguments are passed on as-is to)
initializer. (Glyph)

Returns:

GlyphRenderer

add_layout(obj: Renderer, place: Literal['above', 'below', 'left', 'right', 'center'] = 'center') → None#

Adds an object to the plot in a specified place.

Parameters:

obj (Renderer) – the object to add to the Plot
place (str, optional) – where to add the object (default: ‘center’) Valid places are: ‘left’, ‘right’, ‘above’, ‘below’, ‘center’.

Returns:

None

add_tile(tile_source: TileSource | TileProvider | str, retina: bool = False, **kwargs: Any) → TileRenderer#

Adds new TileRenderer into Plot.renderers

Parameters:

tile_source (TileSource, xyzservices.TileProvider, str) – A tile source instance which contain tileset configuration
retina (bool) – Whether to use retina version of tiles (if available)

Keyword Arguments:

renderer (Additional keyword arguments are passed on as-is to the tile)

Returns:

TileRenderer

Return type:

TileRenderer

add_tools(*tools: Tool | str) → None#

Adds tools to the plot.

Parameters:: *tools (Tool) – the tools to add to the Plot
Returns:: None

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.

column(col, gridplot)#

Return whether this plot is in a given column of a GridPlot.

Parameters:

col (int) – index of the column to test
gridplot (GridPlot) – the GridPlot to check

Returns:

bool

classmethod dataspecs() → dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

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

Returns:: names of DataSpec properties
Return type:: set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]#: List of property descriptors in the order of definition.

destroy() → None#: Clean up references to the document and property

equals(other: HasProps) → bool#

Structural equality of models.

Parameters:: other (HasProps) – the other instance to compare to
Returns:: True, if properties are structurally equal, otherwise False

hold(*, render: bool) → Generator[None, None, None]#

Takes care of turning a property on and off within a scope.

Parameters:: render (bool) – Turns the property hold_render on and off.

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:

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:: ValueError –

Examples

This code with js_link:

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

is equivalent to the following:

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

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

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

which is equivalent to:

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

js_on_change(event: str, *callbacks: JSChangeCallback) → None#

Attach a CustomJS callback to an arbitrary BokehJS model event.

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

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

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

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None#

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

Parameters:

name (str) – name of the property to search for
raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

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

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

Parameters:

attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None#

Run callbacks when the specified event occurs on this Model

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

classmethod parameters() → list[Parameter]#

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

Returns:: list(Parameter)

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

Collect the names of properties on this class.

Warning

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

Returns:: property names

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

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

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

Returns:: names of properties that have references
Return type:: set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

Collect a dict mapping property names to their values.

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

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

Parameters:: include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)
Returns:: mapping from property names to their values
Return type:: dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:

query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]#: Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None#: Remove a callback from this object

remove_tools(*tools: Tool) → None#

Removes tools from the plot.

Parameters:: *tools (Tool) – the tools to remove from the Plot
Returns:: None

row(row, gridplot)#

Return whether this plot is in a given row of a GridPlot.

Parameters:

row (int) – index of the row to test
gridplot (GridPlot) – the GridPlot to check

Returns:

bool

select(*args, **kwargs)#

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

There are a few different ways to call the select method. The most general is to supply a JSON-like query dictionary as the single argument or as keyword arguments:

Parameters:: selector (JSON-like) – some sample text
Keyword Arguments:: kwargs – query dict key/values as keyword arguments

Additionally, for compatibility with Model.select, a selector dict may be passed as selector keyword argument, in which case the value of kwargs['selector'] is used for the query.

For convenience, queries on just names can be made by supplying the name string as the single parameter:

Parameters:: name (str) – the name to query on

Also queries on just type can be made simply by supplying the Model subclass as the single parameter:

Parameters:: type (Model) – the type to query on
Returns:: seq[Model]

Examples

# These three are equivalent
p.select(selector={"type": HoverTool})
p.select({"type": HoverTool})
p.select(HoverTool)

# These two are also equivalent
p.select({"name": "mycircle"})
p.select("mycircle")

# Keyword arguments can be supplied in place of selector dict
p.select({"name": "foo", "type": HoverTool})
p.select(name="foo", type=HoverTool)

select_one(selector: SelectorType) → Model | None#

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

Returns:: Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None#

Set a property value on this object from JSON.

Parameters:

name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)

This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.

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

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None#

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

Parameters:

selector (JSON-like)
updates (dict)

Returns:

None

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

Get any theme-provided overrides.

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

Returns:: dict or None

to_serializable(serializer: Serializer) → ObjectRefRep#: Converts this object to a serializable representation.

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

unapply_theme() → None#

Remove any themed values and restore defaults.

Returns:: None

update(**kwargs: Any) → None#

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

Returns:: None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

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

# update properties together:
r.update(start=10, end=20)

property axis#: Splattable list of Axis objects.

property document: Document | None#: The Document this model is attached to (can be None)

property grid#: Splattable list of Grid objects.

property hover#: Splattable list of HoverTool objects.

property legend#: Splattable list of Legend objects.

property xaxis#: Splattable list of Axis objects for the x dimension.

property xgrid#: Splattable list of Grid objects for the x dimension.

property yaxis#: Splattable list of Axis objects for the y dimension.

property ygrid#: Splattable list of Grid objects for the y dimension.