Models for mapping values from one range or space to another in the client.
Mappers (as opposed to scales) are not presumed to be invertible.
Bases: CategoricalMapper, ColorMapper
Map categorical factors to colors.
Values that are passed to this mapper that are not in the factors list will be mapped to nan_color.
{
"end": null,
"factors": {
"name": "unset",
"type": "symbol"
},
"id": "p63236",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"nan_color": "gray",
"palette": {
"name": "unset",
"type": "symbol"
},
"start": 0,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
A start index to âsliceâ data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as ["2016", "sales"] and ["2017", "marketing"], then setting end=1 will perform color mapping only based on the first sub-factor (i.e. in this case based on the year "2016" or "2017")
If None then all sub-factors from start to the end of the factor will be used for color mapping.
FactorSeq
A sequence of factors / categories that map to the some target range. For example the following color mapper:
mapper = CategoricalColorMapper(palette=["red", "blue"], factors=["foo", "bar"])
will map the factor "foo" to red and the factor "bar" to blue.
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.
Color to be used if data is NaN or otherwise not mappable.
Acceptable values are:
any of the named CSS colors, e.g 'green', 'indigo'
RGB(A) hex strings, e.g., '#FF0000', '#44444444'
CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', or 'hsl(60deg 100% 50% / 1.0)'
a 3-tuple of integers (r, g, b) between 0 and 255
a 4-tuple of (r, g, b, a) where r, g, b are integers between 0 and 255, and a is between 0 and 1
a 32-bit unsigned integer using the 0xRRGGBBAA byte order pattern
A sequence of colors to use as the target palette for mapping.
This property can also be set as a String, to the name of any of the palettes shown in bokeh.palettes.
A start index to âsliceâ data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as ["2016", "sales"] and ["2016", "marketing"], then setting start=1 will perform color mapping only based on the second sub-factor (i.e. in this case based on the department "sales" or "marketing")
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: Mapper
Base class for mappers that map categorical factors to other values.
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.
{
"end": null,
"factors": {
"name": "unset",
"type": "symbol"
},
"id": "p63245",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"start": 0,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
A start index to âsliceâ data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as ["2016", "sales"] and ["2017", "marketing"], then setting end=1 will perform color mapping only based on the first sub-factor (i.e. in this case based on the year "2016" or "2017")
If None then all sub-factors from start to the end of the factor will be used for color mapping.
FactorSeq
A sequence of factors / categories that map to the some target range. For example the following color mapper:
mapper = CategoricalColorMapper(palette=["red", "blue"], factors=["foo", "bar"])
will map the factor "foo" to red and the factor "bar" to blue.
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.
A start index to âsliceâ data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as ["2016", "sales"] and ["2016", "marketing"], then setting start=1 will perform color mapping only based on the second sub-factor (i.e. in this case based on the department "sales" or "marketing")
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: CategoricalMapper
Map categorical factors to marker types.
Values that are passed to this mapper that are not in the factors list will be mapped to default_value.
Note
This mappers is primarily only useful with the Scatter marker glyph that be parameterized by marker type.
{
"default_value": "circle",
"end": null,
"factors": {
"name": "unset",
"type": "symbol"
},
"id": "p63252",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"markers": {
"name": "unset",
"type": "symbol"
},
"name": null,
"start": 0,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
A marker type to use in case an unrecognized factor is passed in to be mapped.
A start index to âsliceâ data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as ["2016", "sales"] and ["2017", "marketing"], then setting end=1 will perform color mapping only based on the first sub-factor (i.e. in this case based on the year "2016" or "2017")
If None then all sub-factors from start to the end of the factor will be used for color mapping.
FactorSeq
A sequence of factors / categories that map to the some target range. For example the following color mapper:
mapper = CategoricalColorMapper(palette=["red", "blue"], factors=["foo", "bar"])
will map the factor "foo" to red and the factor "bar" to blue.
A sequence of marker types to use as the target for mapping.
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.
A start index to âsliceâ data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as ["2016", "sales"] and ["2016", "marketing"], then setting start=1 will perform color mapping only based on the second sub-factor (i.e. in this case based on the department "sales" or "marketing")
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: CategoricalMapper
Map categorical factors to hatch fill patterns.
Values that are passed to this mapper that are not in the factors list will be mapped to default_value.
Added in version 1.1.1
{
"default_value": " ",
"end": null,
"factors": {
"name": "unset",
"type": "symbol"
},
"id": "p63261",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"patterns": {
"name": "unset",
"type": "symbol"
},
"start": 0,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
HatchPatternType
A hatch pattern to use in case an unrecognized factor is passed in to be mapped.
A start index to âsliceâ data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as ["2016", "sales"] and ["2017", "marketing"], then setting end=1 will perform color mapping only based on the first sub-factor (i.e. in this case based on the year "2016" or "2017")
If None then all sub-factors from start to the end of the factor will be used for color mapping.
FactorSeq
A sequence of factors / categories that map to the some target range. For example the following color mapper:
mapper = CategoricalColorMapper(palette=["red", "blue"], factors=["foo", "bar"])
will map the factor "foo" to red and the factor "bar" to blue.
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.
Seq(HatchPatternType)
A sequence of marker types to use as the target for mapping.
A start index to âsliceâ data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as ["2016", "sales"] and ["2016", "marketing"], then setting start=1 will perform color mapping only based on the second sub-factor (i.e. in this case based on the department "sales" or "marketing")
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: Mapper
Base class for color mapper types.
Note
This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.
{
"id": "p63270",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"nan_color": "gray",
"palette": {
"name": "unset",
"type": "symbol"
},
"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.
Color to be used if data is NaN or otherwise not mappable.
Acceptable values are:
any of the named CSS colors, e.g 'green', 'indigo'
RGB(A) hex strings, e.g., '#FF0000', '#44444444'
CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', or 'hsl(60deg 100% 50% / 1.0)'
a 3-tuple of integers (r, g, b) between 0 and 255
a 4-tuple of (r, g, b, a) where r, g, b are integers between 0 and 255, and a is between 0 and 1
a 32-bit unsigned integer using the 0xRRGGBBAA byte order pattern
A sequence of colors to use as the target palette for mapping.
This property can also be set as a String, to the name of any of the palettes shown in bokeh.palettes.
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: ColorMapper
Base class for continuous color mapper types.
Note
This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.
{
"domain": [],
"high": null,
"high_color": null,
"id": "p63276",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"low": null,
"low_color": null,
"name": null,
"nan_color": "gray",
"palette": {
"name": "unset",
"type": "symbol"
},
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
A collection of glyph renderers to pool data from for establishing data metrics. If empty, mapped data will be used instead.
The maximum value of the range to map into the palette. Values above this are clamped to high. If None, the value is inferred from data.
Color to be used if data is higher than high value. If None, values higher than high are mapped to the last color in the palette.
The minimum value of the range to map into the palette. Values below this are clamped to low. If None, the value is inferred from data.
Color to be used if data is lower than low value. If None, values lower than low are mapped to the first color in the palette.
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.
Color to be used if data is NaN or otherwise not mappable.
Acceptable values are:
any of the named CSS colors, e.g 'green', 'indigo'
RGB(A) hex strings, e.g., '#FF0000', '#44444444'
CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', or 'hsl(60deg 100% 50% / 1.0)'
a 3-tuple of integers (r, g, b) between 0 and 255
a 4-tuple of (r, g, b, a) where r, g, b are integers between 0 and 255, and a is between 0 and 1
a 32-bit unsigned integer using the 0xRRGGBBAA byte order pattern
A sequence of colors to use as the target palette for mapping.
This property can also be set as a String, to the name of any of the palettes shown in bokeh.palettes.
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: ScanningColorMapper
{
"bins": 65536,
"domain": [],
"high": null,
"high_color": null,
"id": "p63287",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"low": null,
"low_color": null,
"name": null,
"nan_color": "gray",
"palette": {
"name": "unset",
"type": "symbol"
},
"rescale_discrete_levels": false,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
Number of histogram bins
A collection of glyph renderers to pool data from for establishing data metrics. If empty, mapped data will be used instead.
The maximum value of the range to map into the palette. Values above this are clamped to high. If None, the value is inferred from data.
Color to be used if data is higher than high value. If None, values higher than high are mapped to the last color in the palette.
The minimum value of the range to map into the palette. Values below this are clamped to low. If None, the value is inferred from data.
Color to be used if data is lower than low value. If None, values lower than low are mapped to the first color in the palette.
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.
Color to be used if data is NaN or otherwise not mappable.
Acceptable values are:
any of the named CSS colors, e.g 'green', 'indigo'
RGB(A) hex strings, e.g., '#FF0000', '#44444444'
CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', or 'hsl(60deg 100% 50% / 1.0)'
a 3-tuple of integers (r, g, b) between 0 and 255
a 4-tuple of (r, g, b, a) where r, g, b are integers between 0 and 255, and a is between 0 and 1
a 32-bit unsigned integer using the 0xRRGGBBAA byte order pattern
A sequence of colors to use as the target palette for mapping.
This property can also be set as a String, to the name of any of the palettes shown in bokeh.palettes.
If there are only a few discrete levels in the values that are color mapped then rescale_discrete_levels=True decreases the lower limit of the span so that the values are rendered towards the top end of the palette.
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: ContinuousColorMapper
Map numbers in a range [low, high] linearly into a sequence of colors (a palette).
For example, if the range is [0, 99] and the palette is ['red', 'green', 'blue'], the values would be mapped as follows:
x < 0 : 'red' # values < low are clamped 0 <= x < 33 : 'red' 33 <= x < 66 : 'green' 66 <= x < 99 : 'blue' 99 <= x : 'blue' # values > high are clamped
{
"domain": [],
"high": null,
"high_color": null,
"id": "p63300",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"low": null,
"low_color": null,
"name": null,
"nan_color": "gray",
"palette": {
"name": "unset",
"type": "symbol"
},
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
A collection of glyph renderers to pool data from for establishing data metrics. If empty, mapped data will be used instead.
The maximum value of the range to map into the palette. Values above this are clamped to high. If None, the value is inferred from data.
Color to be used if data is higher than high value. If None, values higher than high are mapped to the last color in the palette.
The minimum value of the range to map into the palette. Values below this are clamped to low. If None, the value is inferred from data.
Color to be used if data is lower than low value. If None, values lower than low are mapped to the first color in the palette.
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.
Color to be used if data is NaN or otherwise not mappable.
Acceptable values are:
any of the named CSS colors, e.g 'green', 'indigo'
RGB(A) hex strings, e.g., '#FF0000', '#44444444'
CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', or 'hsl(60deg 100% 50% / 1.0)'
a 3-tuple of integers (r, g, b) between 0 and 255
a 4-tuple of (r, g, b, a) where r, g, b are integers between 0 and 255, and a is between 0 and 1
a 32-bit unsigned integer using the 0xRRGGBBAA byte order pattern
A sequence of colors to use as the target palette for mapping.
This property can also be set as a String, to the name of any of the palettes shown in bokeh.palettes.
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: ContinuousColorMapper
Map numbers in a range [low, high] into a sequence of colors (a palette) on a natural logarithm scale.
For example, if the range is [0, 25] and the palette is ['red', 'green', 'blue'], the values would be mapped as follows:
x < 0 : 'red' # values < low are clamped 0 <= x < 2.72 : 'red' # math.e ** 1 2.72 <= x < 7.39 : 'green' # math.e ** 2 7.39 <= x < 20.09 : 'blue' # math.e ** 3 20.09 <= x : 'blue' # values > high are clamped
Warning
The LogColorMapper only works for images with scalar values that are non-negative.
{
"domain": [],
"high": null,
"high_color": null,
"id": "p63311",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"low": null,
"low_color": null,
"name": null,
"nan_color": "gray",
"palette": {
"name": "unset",
"type": "symbol"
},
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
A collection of glyph renderers to pool data from for establishing data metrics. If empty, mapped data will be used instead.
The maximum value of the range to map into the palette. Values above this are clamped to high. If None, the value is inferred from data.
Color to be used if data is higher than high value. If None, values higher than high are mapped to the last color in the palette.
The minimum value of the range to map into the palette. Values below this are clamped to low. If None, the value is inferred from data.
Color to be used if data is lower than low value. If None, values lower than low are mapped to the first color in the palette.
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.
Color to be used if data is NaN or otherwise not mappable.
Acceptable values are:
any of the named CSS colors, e.g 'green', 'indigo'
RGB(A) hex strings, e.g., '#FF0000', '#44444444'
CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', or 'hsl(60deg 100% 50% / 1.0)'
a 3-tuple of integers (r, g, b) between 0 and 255
a 4-tuple of (r, g, b, a) where r, g, b are integers between 0 and 255, and a is between 0 and 1
a 32-bit unsigned integer using the 0xRRGGBBAA byte order pattern
A sequence of colors to use as the target palette for mapping.
This property can also be set as a String, to the name of any of the palettes shown in bokeh.palettes.
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: Transform
Base class for mappers.
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": "p63322",
"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: ColorMapper
Abstract base class for color mappers that operate on ImageStack glyphs.
These map 3D data arrays of shape (ny, nx, nstack) to 2D RGBA images of shape (ny, nx).
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": "p63326",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"nan_color": "gray",
"palette": {
"name": "unset",
"type": "symbol"
},
"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.
Color to be used if data is NaN or otherwise not mappable.
Acceptable values are:
any of the named CSS colors, e.g 'green', 'indigo'
RGB(A) hex strings, e.g., '#FF0000', '#44444444'
CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', or 'hsl(60deg 100% 50% / 1.0)'
a 3-tuple of integers (r, g, b) between 0 and 255
a 4-tuple of (r, g, b, a) where r, g, b are integers between 0 and 255, and a is between 0 and 1
a 32-bit unsigned integer using the 0xRRGGBBAA byte order pattern
A sequence of colors to use as the target palette for mapping.
This property can also be set as a String, to the name of any of the palettes shown in bokeh.palettes.
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: StackColorMapper
Maps 3D data arrays of shape (ny, nx, nstack) to 2D RGBA images of shape (ny, nx) using a palette of length nstack.
The mapping occurs in two stages. Firstly the RGB values are calculated using a weighted sum of the palette colors in the nstack direction. Then the alpha values are calculated using the alpha_mapper applied to the sum of the array in the nstack direction.
The RGB values calculated by the alpha_mapper are ignored by the color mapping but are used in any ColorBar that is displayed.
{
"alpha_mapper": {
"name": "unset",
"type": "symbol"
},
"color_baseline": null,
"id": "p63332",
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"name": null,
"nan_color": "gray",
"palette": {
"name": "unset",
"type": "symbol"
},
"stack_labels": null,
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": []
}
Color mapper used to calculate the alpha values of the mapped data.
Baseline value used for the weights when calculating the weighted sum of palette colors. If None then the minimum of the supplied data is used meaning that values at this minimum have a weight of zero and do not contribute to the weighted sum. As a special case, if all data for a particular output pixel are at the color baseline then the color is an evenly weighted average of the colors corresponding to all such values, to avoid the color being undefined.
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.
Color to be used if data is NaN or otherwise not mappable.
Acceptable values are:
any of the named CSS colors, e.g 'green', 'indigo'
RGB(A) hex strings, e.g., '#FF0000', '#44444444'
CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', or 'hsl(60deg 100% 50% / 1.0)'
a 3-tuple of integers (r, g, b) between 0 and 255
a 4-tuple of (r, g, b, a) where r, g, b are integers between 0 and 255, and a is between 0 and 1
a 32-bit unsigned integer using the 0xRRGGBBAA byte order pattern
A sequence of colors to use as the target palette for mapping.
This property can also be set as a String, to the name of any of the palettes shown in bokeh.palettes.
An optional sequence of strings to use as labels for the nstack stacks. If set, the number of labels should match the number of stacks and hence also the number of palette colors.
The labels are used in hover tooltips for ImageStack glyphs that use a WeightedStackColorMapper as their color mapper.
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