- class ImageRGBA(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
ImageBase
Render images given as RGBA data.
JSON Prototype
{ "anchor": "bottom_left", "decorations": [], "dh": { "field": "dh", "type": "field" }, "dilate": false, "dw": { "field": "dw", "type": "field" }, "global_alpha": { "type": "value", "value": 1.0 }, "id": "p120041", "image": { "field": "image", "type": "field" }, "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "name": null, "origin": "bottom_left", "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "x": { "field": "x", "type": "field" }, "y": { "field": "y", "type": "field" } }
Public Data Attributes:
The arrays of RGBA data for the images.
Inherited from
ImageBase
The x-coordinates to locate the image anchors.
The y-coordinates to locate the image anchors.
Units to use for the associated property: screen or data
The widths of the plot regions that the images will occupy.
Units to use for the associated property: screen or data
The height of the plot region that the image will occupy.
The global alpha values for the images.
Whether to always round fractional pixel locations in such a way as to make the images bigger.
Defines the coordinate space of an image.
Position of the image should be anchored at the x, y coordinates.
Inherited from
Glyph
A collection of glyph decorations, e.g.
Inherited from
Model
id
ref
An arbitrary, user-supplied name for this model.
An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks
A mapping of event names to lists of
CustomJS
callbacks.js_property_callbacks
A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.subscribed_events
Collection of events that are subscribed to by Python callbacks.
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
Public Methods:
__init__
([x, y, dw, dh, dilate, anchor, ...])Inherited from
ImageBase
__init__
(*[, decorations, dh, dh_units, ...])Inherited from
XYGlyph
__init__
(*[, name, syncable, tags])Inherited from
Glyph
__init__
(*[, name, syncable, tags])Inherited from
Model
__init_subclass__
()This method is called when a class is subclassed.
__new__
(cls, *args[, id])__init__
(*args, **kwargs)__str__
()Return str(self).
__str__
()Return str(self).
destroy
()Clean up references to the document and property
Generate Python
Parameter
values suitable for functions that are derived from the glyph.js_on_event
(event, *callbacks)js_link
(attr, other, other_attr[, attr_selector])Link two Bokeh model properties using JavaScript.
js_on_change
(event, *callbacks)Attach a
CustomJS
callback to an arbitrary BokehJS model event.on_change
(attr, *callbacks)Add a callback on this object to trigger when
attr
changes.references
()Returns all
Models
that this object has references to.select
(selector)Query this object and all of its references for objects that match the given selector.
select_one
(selector)Query this object and all of its references for objects that match the given selector.
set_select
(selector, updates)Update objects that match a given selector with the specified attribute/value updates.
to_serializable
(serializer)Converts this object to a serializable representation.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init_subclass__
()This method is called when a class is subclassed.
__init__
(**properties)__setattr__
(name, value)Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__
(name)Intercept attribute setting on HasProps in order to special case a few situations:
__str__
()Return str(self).
__str__
()Return str(self).
equals
(other)Structural equality of models.
to_serializable
(serializer)Converts this object to a serializable representation.
set_from_json
(name, value, *[, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
lookup
(name, *[, raises])Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.properties
(*[, _with_props])Collect the names of properties on this class.
List of property descriptors in the order of definition.
Collect the names of all properties on this class that also have references.
Collect the names of all
DataSpec
properties on this class.properties_with_values
(*[, ...])Collect a dict mapping property names to their values.
query_properties_with_values
(query, *[, ...])Query the properties values of
HasProps
instances with a predicate.Get any theme-provided overrides.
apply_theme
(property_values)Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
Remove any themed values and restore defaults.
Inherited from
Serializable
to_serializable
(serializer)Converts this object to a serializable representation.
Inherited from
HasDocumentRef
__init__
(*args, **kw)Inherited from
PropertyCallbackManager
__init__
(*args, **kw)on_change
(attr, *callbacks)Add a callback on this object to trigger when
attr
changes.remove_on_change
(attr, *callbacks)Remove a callback from this object
trigger
(attr, old, new[, hint, setter])Trigger callbacks for
attr
on this object.Inherited from
EventCallbackManager
__init__
(*args, **kw)on_event
(event, *callbacks)Run callbacks when the specified event occurs on this Model
- anchor = 'bottom_left'#
- Type:
Either
(Enum
(Anchor
),Tuple
(Either
(Enum
(Align
),Enum
(HAlign
),Percent
),Either
(Enum
(Align
),Enum
(VAlign
),Percent
)))
Position of the image should be anchored at the x, y coordinates.
- decorations = []#
- Type:
A collection of glyph decorations, e.g. arrow heads.
Use
GlyphRenderer.add_decoration()
for easy setup for all glyphs of a glyph renderer. Use this property when finer control is needed.Note
Decorations are only for aiding visual appearance of a glyph, but they don’t participate in hit testing, etc.
- dh = Field(field='dh', transform=Unspecified, units=Unspecified)#
- Type:
The height of the plot region that the image will occupy.
Note
This is not the number of pixels that an image is tall. That number is fixed by the image itself.
- dh_units = 'data'#
- Type:
Units to use for the associated property: screen or data
- dilate = False#
- Type:
Whether to always round fractional pixel locations in such a way as to make the images bigger.
This setting may be useful if pixel rounding errors are causing images to have a gap between them, when they should appear flush.
- dw = Field(field='dw', transform=Unspecified, units=Unspecified)#
- Type:
The widths of the plot regions that the images will occupy.
Note
This is not the number of pixels that an image is wide. That number is fixed by the image itself.
- dw_units = 'data'#
- Type:
Units to use for the associated property: screen or data
- image = Field(field='image', transform=Unspecified, units=Unspecified)#
- Type:
The arrays of RGBA data for the images.
- name = None#
-
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
- origin = 'bottom_left'#
- Type:
Defines the coordinate space of an image.
- syncable = True#
- Type:
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to
False
may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.Note
Setting this property to
False
will prevent anyon_change()
callbacks on this object from triggering. However, any JS-side callbacks will still work.
- tags = []#
- Type:
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by
CustomJS
callbacks, etc.Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
- x = Field(field='x', transform=Unspecified, units=Unspecified)#
- Type:
The x-coordinates to locate the image anchors.
- y = Field(field='y', transform=Unspecified, units=Unspecified)#
- Type:
The y-coordinates to locate the image anchors.
- apply_theme(property_values: dict[str, Any]) None #
Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the
HasProps
instance should modify it).- Parameters:
property_values (dict) – theme values to use in place of defaults
- Returns:
None
- classmethod dataspecs() dict[str, DataSpec] #
Collect the names of all
DataSpec
properties on this class.This method always traverses the class hierarchy and includes properties defined on any parent classes.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- equals(other: HasProps) bool #
Structural equality of models.
- Parameters:
other (HasProps) – the other instance to compare to
- Returns:
True, if properties are structurally equal, otherwise False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding a
CustomJS
callback to update one Bokeh model property whenever another changes value.- Parameters:
Added in version 1.1
- Raises:
Examples
This code with
js_link
:select.js_link('value', plot, 'sizing_mode')
is equivalent to the following:
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
which is equivalent to:
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
- js_on_change(event: str, *callbacks: JSEventCallback) None #
Attach a
CustomJS
callback to an arbitrary BokehJS model event.On the BokehJS side, change events for model properties have the form
"change:property_name"
. As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with"change:"
automatically:# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a
ColumnDataSource
, use the"stream"
event on the source:source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | Type[Event], *callbacks: EventCallback) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod parameters() list[Parameter] #
Generate Python
Parameter
values suitable for functions that are derived from the glyph.- Returns:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
Collect the names of properties on this class.
Warning
In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in
list
.- Returns:
property names
- classmethod properties_with_refs() dict[str, Property[Any]] #
Collect the names of all properties on this class that also have references.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
Collect a dict mapping property names to their values.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
Query the properties values of
HasProps
instances with a predicate.- Parameters:
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
- Returns:
mapping of property names and values for matching properties
- Return type:
- remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None #
Remove a callback from this object
- select(selector: SelectorType) Iterable[Model] #
Query this object and all of its references for objects that match the given selector.
- Parameters:
selector (JSON-like) –
- Returns:
seq[Model]
- select_one(selector: SelectorType) Model | None #
Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like
- Returns:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
Set a property value on this object from JSON.
- Parameters:
name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns:
None
- set_select(selector: Type[Model] | SelectorType, updates: dict[str, Any]) None #
Update objects that match a given selector with the specified attribute/value updates.
- Parameters:
selector (JSON-like) –
updates (dict) –
- Returns:
None
- themed_values() dict[str, Any] | None #
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or
None
if no theme overrides any values for this instance.- Returns:
dict or None
- to_serializable(serializer: Serializer) ObjectRefRep #
Converts this object to a serializable representation.
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- update(**kwargs: Any) None #
Updates the object’s properties from the given keyword arguments.
- Returns:
None
Examples
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)