bokeh.models.glyphs.ImageRGBA¶

class ImageRGBA(**kwargs)[source]¶

Render images given as RGBA data.

dh¶

property type: DistanceSpec

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.

dilate¶

property type: Bool

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¶

property type: DistanceSpec

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.

image¶

property type: NumberSpec

The arrays of RGBA data for the images.

js_event_callbacks¶

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

A mapping of event names to lists of CustomJS callbacks.

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

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

js_property_callbacks¶

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

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

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

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

name¶

property type: String

An arbitrary, user-supplied name for this model.

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

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

Note

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

subscribed_events¶

property type: List ( String )

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

tags¶

property type: List ( Any )

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

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

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

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

Note

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

x¶

property type: NumberSpec

The x-coordinates to locate the image anchors.

y¶

property type: NumberSpec

The y-coordinates to locate the image anchors.

apply_theme(property_values)¶

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

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

Parameters:	property_values (dict) – theme values to use in place of defaults
Returns:	None

dataspecs()¶

Collect the names of all DataSpec properties on this class.

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

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

dataspecs_with_props()¶

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

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

Returns:	mapping of names and `DataSpec` properties
Return type:	dict[str, DataSpec]

equals(other)¶

Structural equality of models.

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

js_on_change(event, *callbacks)¶

Attach a CustomJS callback to an arbitrary BokehJS model event.

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

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

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

source.js_on_change('streaming', callback)

layout(side, plot)¶

lookup(name)¶

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

Parameters:	name (str) – name of the property to search for
Returns:	descriptor for property named `name`
Return type:	PropertyDescriptor

on_change(attr, *callbacks)¶

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

Parameters:	attr (str) – an attribute name on this object callback (callable) – a callback function to register
Returns:	None

pprint(verbose=False, max_width=79, newline='\n')¶

Print a “pretty” string representation of the object to stdout.

Note

This function only functions in the IPython shell or Jupyter Notebooks.

Parameters:	Verbose (bool, optional) – This is a conventional argument for IPython representation printers but is unused by Bokeh. (default: False) max_width (int, optional) – Minimum width to start breaking lines when possible. (default: 79) newline (str, optional) – Character to use to separate each line (default: `\n`)
Returns:	None
Raises:	ValueError, if `IPython` cannot be imported

Examples

In [1]: from bokeh.models import Range1d

In [1]: r = Range1d(start=10, end=20)

In [2]: r.pprint()
bokeh.models.ranges.Range1d(
    id='1576d21a-0c74-4214-8d8f-ad415e1e4ed4',
    bounds=None,
    callback=None,
    end=20,
    js_property_callbacks={},
    max_interval=None,
    min_interval=None,
    name=None,
    start=10,
    tags=[])

pretty(verbose=False, max_width=79, newline='\n')¶

Generate a “pretty” string representation of the object.

Note

This function only functions in the IPython shell or Jupyter Notebooks.

Parameters:	Verbose (bool, optional) – This is a conventional argument for IPython representation printers but is unused by Bokeh. (default: False) max_width (int, optional) – Minimum width to start breaking lines when possible. (default: 79) newline (str, optional) – Character to use to separate each line (default: `\n`)
Returns:	pretty object representation
Return type:	str
Raises:	ValueError, if `IPython` cannot be imported

properties(with_bases=True)¶

Collect the names of properties on this class.

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

Parameters:	with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)
Returns:	property names
Return type:	set[str]

properties_containers()¶

Collect the names of all container properties on this class.

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

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

properties_with_refs()¶

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

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

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

properties_with_values(include_defaults=True)¶

Collect a dict mapping property names to their values.

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

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

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

query_properties_with_values(query, include_defaults=True)¶

Query the properties values of HasProps instances with a predicate.

Parameters:	query (callable) – A callable that accepts property descriptors and returns True or False include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
Returns:	mapping of property names and values for matching properties
Return type:	dict

references()¶: Returns all Models that this object has references to.

remove_on_change(attr, *callbacks)¶: Remove a callback from this object

select(selector)¶

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

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

select_one(selector)¶

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

Returns:	Model

set_from_json(name, json, models=None, setter=None)¶

Set a property value on this object from JSON.

Parameters:

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

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

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

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

Returns:

None

set_select(selector, updates)¶

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

Parameters:	selector (JSON-like) – updates (dict) –
Returns:	None

themed_values()¶

Get any theme-provided overrides.

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

Returns:	dict or None

to_json(include_defaults)¶

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

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

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

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

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

to_json_string(include_defaults)¶

Returns a JSON string encoding the attributes of this object.

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

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

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

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

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

unapply_theme()¶

Remove any themed values and restore defaults.

Returns:	None

update(**kwargs)¶

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

Returns:	None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

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

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

update_from_json(json_attributes, models=None, setter=None)¶

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

Parameters:

Parameters:	json_attributes – (JSON-dict) : attributes and values to update models (dict or None, optional) – Mapping of model ids to models (default: None) This is needed in cases where the attributes to update also have values that have references. setter (ClientSession or ServerSession or None, optional) – This is used to prevent “boomerang” updates to Bokeh apps. In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
Returns:	None

json_attributes – (JSON-dict) : attributes and values to update
models (dict or None, optional) –
Mapping of model ids to models (default: None)

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

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

Returns:

None

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

ref¶

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

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

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