Bases: GraphCoordinates
Node coordinate expression obtained from LayoutProvider
{
"id": "p61243",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"layout": {
"name": "unset",
"type": "symbol"
},
"name": null,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we donât need.
Note
Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
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).
property_values (dict) â theme values to use in place of defaults
None
Clear any currently defined custom extensions.
Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.
Duplicate a HasProps object.
This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
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.
List of property descriptors in the order of definition.
Clean up references to the document and property
Structural equality of models.
other (HasProps) â the other instance to compare to
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.
Added in version 1.1
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]"
)
)
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)
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
descriptor for property named name
Add a callback on this object to trigger when attr changes.
attr (str) â an attribute name on this object
*callbacks (callable) â callback functions to register
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
Generate Python Parameter values suitable for functions that are derived from the glyph.
list(Parameter)
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.
property names
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.
Collect a dict mapping property names to their values.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
Non-serializable properties are skipped and property values are in âserializedâ format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
Returns all Models that this object has references to.
Remove a callback from this object
Query this object and all of its references for objects that match the given selector.
selector (JSON-like)
seq[Model]
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
Model
Set a property value on this object from JSON.
name (str) â name of the attribute to set
value (JSON-value) â value to set to the attribute to
setter (ClientSession or ServerSession or None, optional) â
This is used to prevent âboomerangâ updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
None
Update objects that match a given selector with the specified attribute/value updates.
selector (JSON-like)
updates (dict)
None
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
Converts this object to a serializable representation.
Remove any themed values and restore defaults.
None
Updates the objectâs properties from the given keyword arguments.
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)
The Document this model is attached to (can be None)
Bases: GraphHitTestPolicy
With the EdgesAndLinkedNodes policy, inspection or selection of graph edges will result in the inspection or selection of the edge and of the linked graph nodes. There is no direct selection or inspection of graph nodes.
{
"id": "p61247",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we donât need.
Note
Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
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).
property_values (dict) â theme values to use in place of defaults
None
Clear any currently defined custom extensions.
Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.
Duplicate a HasProps object.
This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
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.
List of property descriptors in the order of definition.
Clean up references to the document and property
Structural equality of models.
other (HasProps) â the other instance to compare to
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.
Added in version 1.1
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]"
)
)
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)
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
descriptor for property named name
Add a callback on this object to trigger when attr changes.
attr (str) â an attribute name on this object
*callbacks (callable) â callback functions to register
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
Generate Python Parameter values suitable for functions that are derived from the glyph.
list(Parameter)
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.
property names
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.
Collect a dict mapping property names to their values.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
Non-serializable properties are skipped and property values are in âserializedâ format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
Returns all Models that this object has references to.
Remove a callback from this object
Query this object and all of its references for objects that match the given selector.
selector (JSON-like)
seq[Model]
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
Model
Set a property value on this object from JSON.
name (str) â name of the attribute to set
value (JSON-value) â value to set to the attribute to
setter (ClientSession or ServerSession or None, optional) â
This is used to prevent âboomerangâ updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
None
Update objects that match a given selector with the specified attribute/value updates.
selector (JSON-like)
updates (dict)
None
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
Converts this object to a serializable representation.
Remove any themed values and restore defaults.
None
Updates the objectâs properties from the given keyword arguments.
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)
The Document this model is attached to (can be None)
Bases: GraphHitTestPolicy
With the EdgesOnly policy, only graph edges are able to be selected and inspected. There is no selection or inspection of graph nodes.
{
"id": "p61251",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we donât need.
Note
Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
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).
property_values (dict) â theme values to use in place of defaults
None
Clear any currently defined custom extensions.
Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.
Duplicate a HasProps object.
This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
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.
List of property descriptors in the order of definition.
Clean up references to the document and property
Structural equality of models.
other (HasProps) â the other instance to compare to
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.
Added in version 1.1
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]"
)
)
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)
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
descriptor for property named name
Add a callback on this object to trigger when attr changes.
attr (str) â an attribute name on this object
*callbacks (callable) â callback functions to register
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
Generate Python Parameter values suitable for functions that are derived from the glyph.
list(Parameter)
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.
property names
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.
Collect a dict mapping property names to their values.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
Non-serializable properties are skipped and property values are in âserializedâ format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
Returns all Models that this object has references to.
Remove a callback from this object
Query this object and all of its references for objects that match the given selector.
selector (JSON-like)
seq[Model]
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
Model
Set a property value on this object from JSON.
name (str) â name of the attribute to set
value (JSON-value) â value to set to the attribute to
setter (ClientSession or ServerSession or None, optional) â
This is used to prevent âboomerangâ updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
None
Update objects that match a given selector with the specified attribute/value updates.
selector (JSON-like)
updates (dict)
None
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
Converts this object to a serializable representation.
Remove any themed values and restore defaults.
None
Updates the objectâs properties from the given keyword arguments.
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)
The Document this model is attached to (can be None)
Bases: CoordinateTransform
Abstract class for coordinate transform expression obtained from LayoutProvider
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.
{
"id": "p61255",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"layout": {
"name": "unset",
"type": "symbol"
},
"name": null,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we donât need.
Note
Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
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).
property_values (dict) â theme values to use in place of defaults
None
Clear any currently defined custom extensions.
Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.
Duplicate a HasProps object.
This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
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.
List of property descriptors in the order of definition.
Clean up references to the document and property
Structural equality of models.
other (HasProps) â the other instance to compare to
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.
Added in version 1.1
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]"
)
)
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)
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
descriptor for property named name
Add a callback on this object to trigger when attr changes.
attr (str) â an attribute name on this object
*callbacks (callable) â callback functions to register
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
Generate Python Parameter values suitable for functions that are derived from the glyph.
list(Parameter)
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.
property names
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.
Collect a dict mapping property names to their values.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
Non-serializable properties are skipped and property values are in âserializedâ format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
Returns all Models that this object has references to.
Remove a callback from this object
Query this object and all of its references for objects that match the given selector.
selector (JSON-like)
seq[Model]
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
Model
Set a property value on this object from JSON.
name (str) â name of the attribute to set
value (JSON-value) â value to set to the attribute to
setter (ClientSession or ServerSession or None, optional) â
This is used to prevent âboomerangâ updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
None
Update objects that match a given selector with the specified attribute/value updates.
selector (JSON-like)
updates (dict)
None
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
Converts this object to a serializable representation.
Remove any themed values and restore defaults.
None
Updates the objectâs properties from the given keyword arguments.
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)
The Document this model is attached to (can be None)
Bases: Model
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.
{
"id": "p61259",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we donât need.
Note
Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
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).
property_values (dict) â theme values to use in place of defaults
None
Clear any currently defined custom extensions.
Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.
Duplicate a HasProps object.
This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
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.
List of property descriptors in the order of definition.
Clean up references to the document and property
Structural equality of models.
other (HasProps) â the other instance to compare to
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.
Added in version 1.1
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]"
)
)
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)
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
descriptor for property named name
Add a callback on this object to trigger when attr changes.
attr (str) â an attribute name on this object
*callbacks (callable) â callback functions to register
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
Generate Python Parameter values suitable for functions that are derived from the glyph.
list(Parameter)
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.
property names
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.
Collect a dict mapping property names to their values.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
Non-serializable properties are skipped and property values are in âserializedâ format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
Returns all Models that this object has references to.
Remove a callback from this object
Query this object and all of its references for objects that match the given selector.
selector (JSON-like)
seq[Model]
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
Model
Set a property value on this object from JSON.
name (str) â name of the attribute to set
value (JSON-value) â value to set to the attribute to
setter (ClientSession or ServerSession or None, optional) â
This is used to prevent âboomerangâ updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
None
Update objects that match a given selector with the specified attribute/value updates.
selector (JSON-like)
updates (dict)
None
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
Converts this object to a serializable representation.
Remove any themed values and restore defaults.
None
Updates the objectâs properties from the given keyword arguments.
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)
The Document this model is attached to (can be None)
Bases: Model
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.
{
"id": "p61263",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we donât need.
Note
Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
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).
property_values (dict) â theme values to use in place of defaults
None
Clear any currently defined custom extensions.
Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.
Duplicate a HasProps object.
This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
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.
List of property descriptors in the order of definition.
Clean up references to the document and property
Structural equality of models.
other (HasProps) â the other instance to compare to
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.
Added in version 1.1
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]"
)
)
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)
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
descriptor for property named name
Add a callback on this object to trigger when attr changes.
attr (str) â an attribute name on this object
*callbacks (callable) â callback functions to register
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
Generate Python Parameter values suitable for functions that are derived from the glyph.
list(Parameter)
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.
property names
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.
Collect a dict mapping property names to their values.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
Non-serializable properties are skipped and property values are in âserializedâ format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
Returns all Models that this object has references to.
Remove a callback from this object
Query this object and all of its references for objects that match the given selector.
selector (JSON-like)
seq[Model]
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
Model
Set a property value on this object from JSON.
name (str) â name of the attribute to set
value (JSON-value) â value to set to the attribute to
setter (ClientSession or ServerSession or None, optional) â
This is used to prevent âboomerangâ updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
None
Update objects that match a given selector with the specified attribute/value updates.
selector (JSON-like)
updates (dict)
None
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
Converts this object to a serializable representation.
Remove any themed values and restore defaults.
None
Updates the objectâs properties from the given keyword arguments.
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)
The Document this model is attached to (can be None)
Bases: GraphCoordinates
Node coordinate expression obtained from LayoutProvider
{
"id": "p61267",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"layout": {
"name": "unset",
"type": "symbol"
},
"name": null,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we donât need.
Note
Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
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).
property_values (dict) â theme values to use in place of defaults
None
Clear any currently defined custom extensions.
Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.
Duplicate a HasProps object.
This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
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.
List of property descriptors in the order of definition.
Clean up references to the document and property
Structural equality of models.
other (HasProps) â the other instance to compare to
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.
Added in version 1.1
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]"
)
)
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)
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
descriptor for property named name
Add a callback on this object to trigger when attr changes.
attr (str) â an attribute name on this object
*callbacks (callable) â callback functions to register
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
Generate Python Parameter values suitable for functions that are derived from the glyph.
list(Parameter)
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.
property names
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.
Collect a dict mapping property names to their values.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
Non-serializable properties are skipped and property values are in âserializedâ format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
Returns all Models that this object has references to.
Remove a callback from this object
Query this object and all of its references for objects that match the given selector.
selector (JSON-like)
seq[Model]
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
Model
Set a property value on this object from JSON.
name (str) â name of the attribute to set
value (JSON-value) â value to set to the attribute to
setter (ClientSession or ServerSession or None, optional) â
This is used to prevent âboomerangâ updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
None
Update objects that match a given selector with the specified attribute/value updates.
selector (JSON-like)
updates (dict)
None
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
Converts this object to a serializable representation.
Remove any themed values and restore defaults.
None
Updates the objectâs properties from the given keyword arguments.
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)
The Document this model is attached to (can be None)
Bases: GraphHitTestPolicy
With the NodesAndAdjacentNodes policy, inspection or selection of graph nodes will also result in the inspection or selection any nodes that are immediately adjacent (connected by a single edge). There is no selection or inspection of graph edges, and no indication of which node is the tool-selected one from the policy-selected nodes.
{
"id": "p61271",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we donât need.
Note
Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
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).
property_values (dict) â theme values to use in place of defaults
None
Clear any currently defined custom extensions.
Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.
Duplicate a HasProps object.
This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
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.
List of property descriptors in the order of definition.
Clean up references to the document and property
Structural equality of models.
other (HasProps) â the other instance to compare to
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.
Added in version 1.1
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]"
)
)
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)
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
descriptor for property named name
Add a callback on this object to trigger when attr changes.
attr (str) â an attribute name on this object
*callbacks (callable) â callback functions to register
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
Generate Python Parameter values suitable for functions that are derived from the glyph.
list(Parameter)
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.
property names
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.
Collect a dict mapping property names to their values.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
Non-serializable properties are skipped and property values are in âserializedâ format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
Returns all Models that this object has references to.
Remove a callback from this object
Query this object and all of its references for objects that match the given selector.
selector (JSON-like)
seq[Model]
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
Model
Set a property value on this object from JSON.
name (str) â name of the attribute to set
value (JSON-value) â value to set to the attribute to
setter (ClientSession or ServerSession or None, optional) â
This is used to prevent âboomerangâ updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
None
Update objects that match a given selector with the specified attribute/value updates.
selector (JSON-like)
updates (dict)
None
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
Converts this object to a serializable representation.
Remove any themed values and restore defaults.
None
Updates the objectâs properties from the given keyword arguments.
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)
The Document this model is attached to (can be None)
Bases: GraphHitTestPolicy
With the NodesAndLinkedEdges policy, inspection or selection of graph nodes will result in the inspection or selection of the node and of the linked graph edges. There is no direct selection or inspection of graph edges.
{
"id": "p61275",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we donât need.
Note
Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
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).
property_values (dict) â theme values to use in place of defaults
None
Clear any currently defined custom extensions.
Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.
Duplicate a HasProps object.
This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
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.
List of property descriptors in the order of definition.
Clean up references to the document and property
Structural equality of models.
other (HasProps) â the other instance to compare to
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.
Added in version 1.1
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]"
)
)
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)
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
descriptor for property named name
Add a callback on this object to trigger when attr changes.
attr (str) â an attribute name on this object
*callbacks (callable) â callback functions to register
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
Generate Python Parameter values suitable for functions that are derived from the glyph.
list(Parameter)
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.
property names
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.
Collect a dict mapping property names to their values.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
Non-serializable properties are skipped and property values are in âserializedâ format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
Returns all Models that this object has references to.
Remove a callback from this object
Query this object and all of its references for objects that match the given selector.
selector (JSON-like)
seq[Model]
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
Model
Set a property value on this object from JSON.
name (str) â name of the attribute to set
value (JSON-value) â value to set to the attribute to
setter (ClientSession or ServerSession or None, optional) â
This is used to prevent âboomerangâ updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
None
Update objects that match a given selector with the specified attribute/value updates.
selector (JSON-like)
updates (dict)
None
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
Converts this object to a serializable representation.
Remove any themed values and restore defaults.
None
Updates the objectâs properties from the given keyword arguments.
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)
The Document this model is attached to (can be None)
Bases: GraphHitTestPolicy
With the NodesOnly policy, only graph nodes are able to be selected and inspected. There is no selection or inspection of graph edges.
{
"id": "p61279",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we donât need.
Note
Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
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).
property_values (dict) â theme values to use in place of defaults
None
Clear any currently defined custom extensions.
Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.
Duplicate a HasProps object.
This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
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.
List of property descriptors in the order of definition.
Clean up references to the document and property
Structural equality of models.
other (HasProps) â the other instance to compare to
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.
Added in version 1.1
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]"
)
)
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)
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
descriptor for property named name
Add a callback on this object to trigger when attr changes.
attr (str) â an attribute name on this object
*callbacks (callable) â callback functions to register
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
Generate Python Parameter values suitable for functions that are derived from the glyph.
list(Parameter)
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.
property names
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.
Collect a dict mapping property names to their values.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
Non-serializable properties are skipped and property values are in âserializedâ format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
Returns all Models that this object has references to.
Remove a callback from this object
Query this object and all of its references for objects that match the given selector.
selector (JSON-like)
seq[Model]
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
Model
Set a property value on this object from JSON.
name (str) â name of the attribute to set
value (JSON-value) â value to set to the attribute to
setter (ClientSession or ServerSession or None, optional) â
This is used to prevent âboomerangâ updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
None
Update objects that match a given selector with the specified attribute/value updates.
selector (JSON-like)
updates (dict)
None
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
Converts this object to a serializable representation.
Remove any themed values and restore defaults.
None
Updates the objectâs properties from the given keyword arguments.
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)
The Document this model is attached to (can be None)
Bases: LayoutProvider
{
"graph_layout": {
"type": "map"
},
"id": "p61283",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
The coordinates of the graph nodes in cartesian space. The keys of the dictionary correspond to node indices or labels and the values are two element sequences containing the x and y coordinates of the nodes.
{
0 : [0.5, 0.5],
1 : [1.0, 0.86],
2 : [0.86, 1],
}
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we donât need.
Note
Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
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).
property_values (dict) â theme values to use in place of defaults
None
Clear any currently defined custom extensions.
Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.
Duplicate a HasProps object.
This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.
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.
List of property descriptors in the order of definition.
Clean up references to the document and property
Structural equality of models.
other (HasProps) â the other instance to compare to
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.
Added in version 1.1
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]"
)
)
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)
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
descriptor for property named name
Add a callback on this object to trigger when attr changes.
attr (str) â an attribute name on this object
*callbacks (callable) â callback functions to register
None
Examples
widget.on_change('value', callback1, callback2, ..., callback_n)
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
Generate Python Parameter values suitable for functions that are derived from the glyph.
list(Parameter)
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.
property names
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.
Collect a dict mapping property names to their values.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
Non-serializable properties are skipped and property values are in âserializedâ format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
Returns all Models that this object has references to.
Remove a callback from this object
Query this object and all of its references for objects that match the given selector.
selector (JSON-like)
seq[Model]
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
Model
Set a property value on this object from JSON.
name (str) â name of the attribute to set
value (JSON-value) â value to set to the attribute to
setter (ClientSession or ServerSession or None, optional) â
This is used to prevent âboomerangâ updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
None
Update objects that match a given selector with the specified attribute/value updates.
selector (JSON-like)
updates (dict)
None
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
Converts this object to a serializable representation.
Remove any themed values and restore defaults.
None
Updates the objectâs properties from the given keyword arguments.
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)
The Document this model is attached to (can be None)
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4