bokeh.models.map_plots

Models for displaying maps in Bokeh plots.

class GMapOptions(*args, **kwargs)[source]

Bases: bokeh.models.map_plots.MapOptions

Options for GMapPlot objects.

js_event_callbacks

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

A mapping of event names to lists of CustomJS callbacks.

Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_event method:

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

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

Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_change method:

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
lat

property type: Float

The latitude where the map should be centered.

lng

property type: Float

The longitude where the map should be centered.

map_type

property type: Enum ( MapType )

The map type to use for the GMapPlot.

name

property type: 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

property type: Bool

Whether the Google map should display its distance scale control.

styles

property type: JSON

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

subscribed_events

property type: List ( String )

List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.

tags

property type: List ( Any )

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

property 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

property type: Int

The initial zoom level to use when displaying the map.

apply_theme(property_values)

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters

property_values (dict) – theme values to use in place of defaults

Returns

None

classmethod dataspecs()

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 dataspecs_with_props()

Collect a dict mapping the names of all DataSpec properties on this class to the associated properties.

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

Returns

mapping of names and DataSpec properties

Return type

dict[str, DataSpec]

equals(other)

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters
  • attr (str) – The name of a Bokeh property on this model

  • other (Model) – A Bokeh model to link to self.attr

  • other_attr (str) – The property on other to link together

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises

ValueError

Examples

This code with js_link:

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

is equivalent to the following:

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

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

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

which is equivalent to:

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

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)
layout(side, plot)
classmethod lookup(name)

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

Parameters

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

Returns

descriptor for property named name

Return type

PropertyDescriptor

on_change(attr, *callbacks)

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

Parameters
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

Collect the names of properties on this class.

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

Parameters

with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)

Returns

property names

Return type

set[str]

classmethod properties_containers()

Collect the names of all container properties on this class.

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

Returns

names of container properties

Return type

set[str]

classmethod properties_with_refs()

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) → 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, include_defaults=True)

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()

Returns all Models that this object has references to.

remove_on_change(attr, *callbacks)

Remove a callback from this object

select(selector)

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)

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, json, models=None, setter=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, updates)

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values()

Get any theme-provided overrides.

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

Returns

dict or None

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

Remove any themed values and restore defaults.

Returns

None

update(**kwargs)

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

Returns

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

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

# update properties together:
r.update(start=10, end=20)
update_from_json(json_attributes, models=None, setter=None)

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • setter (ClientSession or ServerSession or None, optional) –

    This is used to prevent “boomerang” updates to Bokeh apps.

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

Returns

None

property document

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

property struct

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

JSON Prototype
{
  "id": "12939",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "lat": null,
  "lng": null,
  "map_type": "roadmap",
  "name": null,
  "scale_control": false,
  "styles": null,
  "subscribed_events": [],
  "tags": [],
  "tilt": 45,
  "zoom": 12
}
class GMapPlot(*args, **kwargs)[source]

Bases: bokeh.models.map_plots.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.

above

property type: List ( Instance ( Renderer ) )

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

align

property type: Either ( 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

property type: Base64String

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.

aspect_ratio

property type: Either ( Enum ( Enumeration(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

property 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.

background

property type: Color

Background color of the component.

background_fill_alpha

property type: Percent

The fill alpha for the plot background style.

background_fill_color

property type: Color

The fill color for the plot background style.

below

property type: List ( Instance ( Renderer ) )

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

border_fill_alpha

property type: Percent

The fill alpha for the plot border style.

border_fill_color

property type: Color

The fill color for the plot border style.

center

property type: List ( Instance ( Renderer ) )

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

css_classes

property type: List ( String )

A list of CSS class names to add to this DOM element. Note: the class names are simply added as-is, no other guarantees are provided.

It is also permissible to assign from tuples, however these are adapted – the property will always contain a list.

disabled

property type: Bool

Whether the widget will be disabled when rendered.

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

extra_x_ranges

property type: Dict ( String , Instance ( Range ) )

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

This is useful for adding additional axes.

extra_y_ranges

property type: Dict ( String , Instance ( Range ) )

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

This is useful for adding additional axes.

frame_height

property type: Int

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

frame_width

property type: Int

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

height

property type: NonNegativeInt

The height of the component (in pixels).

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

height_policy

property 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

property type: Bool

Whether to use HiDPI mode when available.

inner_height

property type: Int

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

property type: Int

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.

js_event_callbacks

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

A mapping of event names to lists of CustomJS callbacks.

Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_event method:

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

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

Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_change method:

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
left

property type: List ( Instance ( Renderer ) )

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

lod_factor

property type: Int

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

lod_interval

property type: Int

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

lod_threshold

property type: 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

property 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

property type: Instance ( GMapOptions )

Options for displaying the plot.

margin

property type: 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

property 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 the 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 behaviour.

max_height

property type: NonNegativeInt

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

max_width

property type: NonNegativeInt

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

min_border

property type: 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

property type: 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

property type: 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

property type: 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

property type: 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

property type: NonNegativeInt

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

min_width

property type: NonNegativeInt

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

name

property type: 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

property type: Int

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

property type: Int

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

property type: Percent

The line alpha for the plot border outline.

outline_line_cap

property type: Enum ( LineCap )

The line cap for the plot border outline.

outline_line_color

property type: Color

The line color for the plot border outline.

outline_line_dash

property type: DashPattern

The line dash for the plot border outline.

outline_line_dash_offset

property type: Int

The line dash offset for the plot border outline.

outline_line_join

property type: Enum ( LineJoin )

The line join for the plot border outline.

outline_line_width

property type: Float

The line width for the plot border outline.

output_backend

property 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.

plot_height

property type: Int

The outer height of a plot, including any axes, titles, border padding, etc.

Note

This corresponds directly to the height of the HTML canvas.

plot_width

property type: Int

The outer width of a plot, including any axes, titles, border padding, etc.

Note

This corresponds directly to the width of the HTML canvas.

renderers

property type: List ( Instance ( Renderer ) )

A list of all renderers for this plot, including guides and annotations in addition to glyphs and markers.

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

reset_policy

property type: Enum ( ResetPolicy )

How a plot should respond to being reset. By deafult, 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.

right

property type: List ( Instance ( Renderer ) )

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

sizing_mode

property type: 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:

"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.

subscribed_events

property type: List ( String )

List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.

tags

property type: List ( Any )

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

property type: Instance ( Title )

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

title_location

property type: Enum ( Location )

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

toolbar

property type: Instance ( Toolbar )

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

toolbar_location

property type: Enum ( Location )

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

toolbar_sticky

property 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

property type: Bool

Whether the component will be visible and a part of a layout.

width

property type: NonNegativeInt

The width of the component (in pixels).

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

width_policy

property 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

property type: Instance ( Range )

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

x_scale

property type: Instance ( Scale )

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

y_range

property type: Instance ( Range )

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

y_scale

property 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=None, **kw)

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
  • additional keyword arguments are passed on as-is to the (Any) –

  • initializer. (Glyph) –

Returns

GlyphRenderer

add_layout(obj, place='center')

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, **kw)

Adds new TileRenderer into Plot.renderers

Parameters

tile_source (TileSource) – a tile source instance which contain tileset configuration

Keyword Arguments

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

Returns

TileRenderer

Return type

TileRenderer

add_tools(*tools)

Adds tools to the plot.

Parameters

*tools (Tool) – the tools to add to the Plot

Returns

None

apply_theme(property_values)

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

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()

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 dataspecs_with_props()

Collect a dict mapping the names of all DataSpec properties on this class to the associated properties.

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

Returns

mapping of names and DataSpec properties

Return type

dict[str, DataSpec]

equals(other)

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters
  • attr (str) – The name of a Bokeh property on this model

  • other (Model) – A Bokeh model to link to self.attr

  • other_attr (str) – The property on other to link together

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises

ValueError

Examples

This code with js_link:

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

is equivalent to the following:

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

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

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

which is equivalent to:

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

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)
layout(side, plot)
classmethod lookup(name)

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

Parameters

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

Returns

descriptor for property named name

Return type

PropertyDescriptor

on_change(attr, *callbacks)

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

Parameters
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

Collect the names of properties on this class.

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

Parameters

with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)

Returns

property names

Return type

set[str]

classmethod properties_containers()

Collect the names of all container properties on this class.

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

Returns

names of container properties

Return type

set[str]

classmethod properties_with_refs()

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) → 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, include_defaults=True)

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()

Returns all Models that this object has references to.

remove_on_change(attr, *callbacks)

Remove a callback from this object

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)

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, json, models=None, setter=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, updates)

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values()

Get any theme-provided overrides.

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

Returns

dict or None

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

Remove any themed values and restore defaults.

Returns

None

update(**kwargs)

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

Returns

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

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

# update properties together:
r.update(start=10, end=20)
update_from_json(json_attributes, models=None, setter=None)

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • setter (ClientSession or ServerSession or None, optional) –

    This is used to prevent “boomerang” updates to Bokeh apps.

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

Returns

None

property axis

Splattable list of Axis objects.

property document

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 struct

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

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.

JSON Prototype
{
  "above": [],
  "align": "start",
  "api_key": null,
  "aspect_ratio": null,
  "aspect_scale": 1,
  "background": null,
  "background_fill_alpha": 1.0,
  "background_fill_color": "#ffffff",
  "below": [],
  "border_fill_alpha": 1.0,
  "border_fill_color": "#ffffff",
  "center": [],
  "css_classes": [],
  "disabled": false,
  "extra_x_ranges": {},
  "extra_y_ranges": {},
  "frame_height": null,
  "frame_width": null,
  "height": 600,
  "height_policy": "auto",
  "hidpi": true,
  "id": "12952",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "left": [],
  "lod_factor": 10,
  "lod_interval": 300,
  "lod_threshold": 2000,
  "lod_timeout": 500,
  "map_options": null,
  "margin": [
    0,
    0,
    0,
    0
  ],
  "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",
  "plot_height": 600,
  "plot_width": 600,
  "renderers": [],
  "reset_policy": "standard",
  "right": [],
  "sizing_mode": null,
  "subscribed_events": [],
  "tags": [],
  "title": {
    "id": "12956"
  },
  "title_location": "above",
  "toolbar": {
    "id": "12958"
  },
  "toolbar_location": "right",
  "toolbar_sticky": true,
  "visible": true,
  "width": 600,
  "width_policy": "auto",
  "x_range": {
    "id": "12953"
  },
  "x_scale": {
    "id": "12957"
  },
  "y_range": {
    "id": "12954"
  },
  "y_scale": {
    "id": "12955"
  }
}
class MapOptions(*args, **kwargs)[source]

Bases: bokeh.model.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.

js_event_callbacks

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

A mapping of event names to lists of CustomJS callbacks.

Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_event method:

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

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

Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_change method:

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
lat

property type: Float

The latitude where the map should be centered.

lng

property type: Float

The longitude where the map should be centered.

name

property type: 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.

subscribed_events

property type: List ( String )

List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.

tags

property type: List ( Any )

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

property type: Int

The initial zoom level to use when displaying the map.

apply_theme(property_values)

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters

property_values (dict) – theme values to use in place of defaults

Returns

None

classmethod dataspecs()

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 dataspecs_with_props()

Collect a dict mapping the names of all DataSpec properties on this class to the associated properties.

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

Returns

mapping of names and DataSpec properties

Return type

dict[str, DataSpec]

equals(other)

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters
  • attr (str) – The name of a Bokeh property on this model

  • other (Model) – A Bokeh model to link to self.attr

  • other_attr (str) – The property on other to link together

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises

ValueError

Examples

This code with js_link:

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

is equivalent to the following:

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

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

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

which is equivalent to:

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

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)
layout(side, plot)
classmethod lookup(name)

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

Parameters

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

Returns

descriptor for property named name

Return type

PropertyDescriptor

on_change(attr, *callbacks)

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

Parameters
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

Collect the names of properties on this class.

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

Parameters

with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)

Returns

property names

Return type

set[str]

classmethod properties_containers()

Collect the names of all container properties on this class.

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

Returns

names of container properties

Return type

set[str]

classmethod properties_with_refs()

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) → 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, include_defaults=True)

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()

Returns all Models that this object has references to.

remove_on_change(attr, *callbacks)

Remove a callback from this object

select(selector)

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)

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, json, models=None, setter=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, updates)

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values()

Get any theme-provided overrides.

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

Returns

dict or None

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

Remove any themed values and restore defaults.

Returns

None

update(**kwargs)

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

Returns

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

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

# update properties together:
r.update(start=10, end=20)
update_from_json(json_attributes, models=None, setter=None)

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • setter (ClientSession or ServerSession or None, optional) –

    This is used to prevent “boomerang” updates to Bokeh apps.

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

Returns

None

property document

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

property struct

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

JSON Prototype
{
  "id": "13032",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "lat": null,
  "lng": null,
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "zoom": 12
}
class MapPlot(*args, **kwargs)[source]

Bases: bokeh.models.plots.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.

above

property type: List ( Instance ( Renderer ) )

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

align

property type: Either ( 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

property type: Either ( Enum ( Enumeration(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

property 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.

background

property type: Color

Background color of the component.

background_fill_alpha

property type: Percent

The fill alpha for the plot background style.

background_fill_color

property type: Color

The fill color for the plot background style.

below

property type: List ( Instance ( Renderer ) )

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

border_fill_alpha

property type: Percent

The fill alpha for the plot border style.

border_fill_color

property type: Color

The fill color for the plot border style.

center

property type: List ( Instance ( Renderer ) )

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

css_classes

property type: List ( String )

A list of CSS class names to add to this DOM element. Note: the class names are simply added as-is, no other guarantees are provided.

It is also permissible to assign from tuples, however these are adapted – the property will always contain a list.

disabled

property type: Bool

Whether the widget will be disabled when rendered.

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

extra_x_ranges

property type: Dict ( String , Instance ( Range ) )

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

This is useful for adding additional axes.

extra_y_ranges

property type: Dict ( String , Instance ( Range ) )

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

This is useful for adding additional axes.

frame_height

property type: Int

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

frame_width

property type: Int

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

height

property type: NonNegativeInt

The height of the component (in pixels).

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

height_policy

property 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

property type: Bool

Whether to use HiDPI mode when available.

inner_height

property type: Int

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

property type: Int

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.

js_event_callbacks

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

A mapping of event names to lists of CustomJS callbacks.

Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_event method:

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

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

Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_change method:

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
left

property type: List ( Instance ( Renderer ) )

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

lod_factor

property type: Int

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

lod_interval

property type: Int

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

lod_threshold

property type: 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

property 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

property type: 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

property 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 the 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 behaviour.

max_height

property type: NonNegativeInt

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

max_width

property type: NonNegativeInt

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

min_border

property type: 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

property type: 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

property type: 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

property type: 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

property type: 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

property type: NonNegativeInt

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

min_width

property type: NonNegativeInt

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

name

property type: 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

property type: Int

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

property type: Int

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

property type: Percent

The line alpha for the plot border outline.

outline_line_cap

property type: Enum ( LineCap )

The line cap for the plot border outline.

outline_line_color

property type: Color

The line color for the plot border outline.

outline_line_dash

property type: DashPattern

The line dash for the plot border outline.

outline_line_dash_offset

property type: Int

The line dash offset for the plot border outline.

outline_line_join

property type: Enum ( LineJoin )

The line join for the plot border outline.

outline_line_width

property type: Float

The line width for the plot border outline.

output_backend

property 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.

plot_height

property type: Int

The outer height of a plot, including any axes, titles, border padding, etc.

Note

This corresponds directly to the height of the HTML canvas.

plot_width

property type: Int

The outer width of a plot, including any axes, titles, border padding, etc.

Note

This corresponds directly to the width of the HTML canvas.

renderers

property type: List ( Instance ( Renderer ) )

A list of all renderers for this plot, including guides and annotations in addition to glyphs and markers.

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

reset_policy

property type: Enum ( ResetPolicy )

How a plot should respond to being reset. By deafult, 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.

right

property type: List ( Instance ( Renderer ) )

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

sizing_mode

property type: 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:

"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.

subscribed_events

property type: List ( String )

List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.

tags

property type: List ( Any )

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

property type: Instance ( Title )

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

title_location

property type: Enum ( Location )

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

toolbar

property type: Instance ( Toolbar )

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

toolbar_location

property type: Enum ( Location )

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

toolbar_sticky

property 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

property type: Bool

Whether the component will be visible and a part of a layout.

width

property type: NonNegativeInt

The width of the component (in pixels).

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

width_policy

property 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

property type: Instance ( Range )

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

x_scale

property type: Instance ( Scale )

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

y_range

property type: Instance ( Range )

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

y_scale

property 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=None, **kw)

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
  • additional keyword arguments are passed on as-is to the (Any) –

  • initializer. (Glyph) –

Returns

GlyphRenderer

add_layout(obj, place='center')

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, **kw)

Adds new TileRenderer into Plot.renderers

Parameters

tile_source (TileSource) – a tile source instance which contain tileset configuration

Keyword Arguments

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

Returns

TileRenderer

Return type

TileRenderer

add_tools(*tools)

Adds tools to the plot.

Parameters

*tools (Tool) – the tools to add to the Plot

Returns

None

apply_theme(property_values)

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

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()

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 dataspecs_with_props()

Collect a dict mapping the names of all DataSpec properties on this class to the associated properties.

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

Returns

mapping of names and DataSpec properties

Return type

dict[str, DataSpec]

equals(other)

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters
  • attr (str) – The name of a Bokeh property on this model

  • other (Model) – A Bokeh model to link to self.attr

  • other_attr (str) – The property on other to link together

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises

ValueError

Examples

This code with js_link:

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

is equivalent to the following:

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

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

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

which is equivalent to:

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

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)
layout(side, plot)
classmethod lookup(name)

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

Parameters

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

Returns

descriptor for property named name

Return type

PropertyDescriptor

on_change(attr, *callbacks)

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

Parameters
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

Collect the names of properties on this class.

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

Parameters

with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)

Returns

property names

Return type

set[str]

classmethod properties_containers()

Collect the names of all container properties on this class.

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

Returns

names of container properties

Return type

set[str]

classmethod properties_with_refs()

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) → 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, include_defaults=True)

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()

Returns all Models that this object has references to.

remove_on_change(attr, *callbacks)

Remove a callback from this object

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)

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, json, models=None, setter=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, updates)

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values()

Get any theme-provided overrides.

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

Returns

dict or None

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

Remove any themed values and restore defaults.

Returns

None

update(**kwargs)

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

Returns

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

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

# update properties together:
r.update(start=10, end=20)
update_from_json(json_attributes, models=None, setter=None)

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • setter (ClientSession or ServerSession or None, optional) –

    This is used to prevent “boomerang” updates to Bokeh apps.

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

Returns

None

property axis

Splattable list of Axis objects.

property document

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 struct

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

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.

JSON Prototype
{
  "above": [],
  "align": "start",
  "aspect_ratio": null,
  "aspect_scale": 1,
  "background": null,
  "background_fill_alpha": 1.0,
  "background_fill_color": "#ffffff",
  "below": [],
  "border_fill_alpha": 1.0,
  "border_fill_color": "#ffffff",
  "center": [],
  "css_classes": [],
  "disabled": false,
  "extra_x_ranges": {},
  "extra_y_ranges": {},
  "frame_height": null,
  "frame_width": null,
  "height": 600,
  "height_policy": "auto",
  "hidpi": true,
  "id": "13041",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "left": [],
  "lod_factor": 10,
  "lod_interval": 300,
  "lod_threshold": 2000,
  "lod_timeout": 500,
  "margin": [
    0,
    0,
    0,
    0
  ],
  "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",
  "plot_height": 600,
  "plot_width": 600,
  "renderers": [],
  "reset_policy": "standard",
  "right": [],
  "sizing_mode": null,
  "subscribed_events": [],
  "tags": [],
  "title": {
    "id": "13045"
  },
  "title_location": "above",
  "toolbar": {
    "id": "13047"
  },
  "toolbar_location": "right",
  "toolbar_sticky": true,
  "visible": true,
  "width": 600,
  "width_policy": "auto",
  "x_range": {
    "id": "13042"
  },
  "x_scale": {
    "id": "13046"
  },
  "y_range": {
    "id": "13043"
  },
  "y_scale": {
    "id": "13044"
  }
}