bokeh.models.Legend#
- class Legend(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
AnnotationRender informational legends for a plot.
See Legends for information on plotting legends.
Properties#
- background_fill_color = '#ffffff'#
-
The fill color for the legend background style.
- background_hatch_color = 'black'#
-
The hatch color for the legend background style.
- background_hatch_extra = {}#
-
The hatch extra for the legend background style.
- background_hatch_pattern = None#
-
The hatch pattern for the legend background style.
- border_line_dash = []#
- Type:
The line dash for the legend border outline.
- border_radius = 0#
- Type:
Allows the box to have rounded corners.
- click_policy = 'none'#
- Type:
Defines what happens when a lengend’s item is clicked.
-
A menu to display when user right clicks on the component.
Note
Use shift key when right clicking to display the native context menu.
- coordinates = None#
- Type:
- css_variables = {}#
-
Allows to define dynamically computed CSS variables.
This can be used, for example, to coordinate positioning and styling between canvas’ renderers and/or visuals and HTML-based UI elements.
Variables defined here are equivalent to setting the same variables under
:host { ... }in a CSS stylesheet.Note
This property is experimental and may change at any point.
- elements = []#
- Type:
A collection of DOM-based UI elements attached to this renderer.
This can include floating elements like tooltips, allowing to establish a parent-child relationship between this renderer and its UI elements.
Note
This property is an equivalent of
Pane.elementsin DOM-based UIs.
- group = None#
- Type:
Note
This property is experimental and may change at any point.
- html_attributes = {}#
-
Allows to configure HTML attributes on the underlying HTML element.
- html_id = None#
-
Sets the
idattribute of the underlying HTML element.This is a shorthand for the common HTML
idattribute. Alternatively theidcan be set in thehtml_attributesdictionary.html_idtakes precedence.
- inactive_fill_alpha = 0.7#
- Type:
The fill alpha for the legend item style when inactive. These control an overlay on the item that can be used to obscure it when the corresponding glyph is inactive (e.g. by making it semi-transparent).
- inactive_fill_color = 'white'#
-
The fill color for the legend item style when inactive. These control an overlay on the item that can be used to obscure it when the corresponding glyph is inactive (e.g. by making it semi-transparent).
- inactive_hatch_alpha = 1.0#
- Type:
The hatch alpha for the legend item style when inactive. These control an overlay on the item that can be used to obscure it when the corresponding glyph is inactive (e.g. by making it semi-transparent).
- inactive_hatch_color = 'black'#
-
The hatch color for the legend item style when inactive. These control an overlay on the item that can be used to obscure it when the corresponding glyph is inactive (e.g. by making it semi-transparent).
- inactive_hatch_extra = {}#
-
The hatch extra for the legend item style when inactive. These control an overlay on the item that can be used to obscure it when the corresponding glyph is inactive (e.g. by making it semi-transparent).
- inactive_hatch_pattern = None#
-
The hatch pattern for the legend item style when inactive. These control an overlay on the item that can be used to obscure it when the corresponding glyph is inactive (e.g. by making it semi-transparent).
- inactive_hatch_scale = 12.0#
- Type:
The hatch scale for the legend item style when inactive. These control an overlay on the item that can be used to obscure it when the corresponding glyph is inactive (e.g. by making it semi-transparent).
- inactive_hatch_weight = 1.0#
- Type:
The hatch weight for the legend item style when inactive. These control an overlay on the item that can be used to obscure it when the corresponding glyph is inactive (e.g. by making it semi-transparent).
- item_background_fill_alpha = 0.8#
- Type:
The fill alpha for the legend items’ background style.
- item_background_fill_color = '#f1f1f1'#
-
The fill color for the legend items’ background style.
- item_background_hatch_alpha = 1.0#
- Type:
The hatch alpha for the legend items’ background style.
- item_background_hatch_color = 'black'#
-
The hatch color for the legend items’ background style.
- item_background_hatch_extra = {}#
-
The hatch extra for the legend items’ background style.
- item_background_hatch_pattern = None#
-
The hatch pattern for the legend items’ background style.
- item_background_hatch_scale = 12.0#
- Type:
The hatch scale for the legend items’ background style.
- item_background_hatch_weight = 1.0#
- Type:
The hatch weight for the legend items’ background style.
- item_background_policy = 'none'#
- Type:
Defines which items to style, if
item_background_fillis configured.
- items = []#
- Type:
A list of
LegendIteminstances to be rendered in the legend.This can be specified explicitly, for instance:
legend = Legend(items=[ LegendItem(label="sin(x)", renderers=[r0, r1]), LegendItem(label="2*sin(x)", renderers=[r2]), LegendItem(label="3*sin(x)", renderers=[r3, r4]) ])
But as a convenience, can also be given more compactly as a list of tuples:
legend = Legend(items=[ ("sin(x)", [r0, r1]), ("2*sin(x)", [r2]), ("3*sin(x)", [r3, r4]) ])
where each tuple is of the form: (label, renderers).
- label_height = 'auto'#
-
The minimum height (in pixels) of the area that legend labels should occupy.
- label_standoff = 5#
- Type:
The distance (in pixels) to separate the label from its associated glyph.
- label_text_baseline = 'middle'#
- Type:
The text baseline for the legend labels.
- label_text_outline_color = None#
-
The text outline color for the legend labels.
- label_width = 20#
- Type:
The minimum width (in pixels) of the area that legend labels should occupy.
- level = 'annotation'#
- Type:
Specifies the level in which to paint this renderer.
- location = 'top_right'#
-
The location where the legend should draw itself. It’s either one of
LegendLocation’s enumerated values, or a(x, y)tuple indicating an absolute location in screen coordinates (pixels from the bottom-left corner).
- 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.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.
- ncols = 'auto'#
-
The number of columns in the legend’s layout. By default it’s either one column if the orientation is vertical or the number of items in the legend otherwise.
ncolstakes precedence overnrowsfor horizontal orientation.
- nrows = 'auto'#
-
The number of rows in the legend’s layout. By default it’s either one row if the orientation is horizontal or the number of items in the legend otherwise.
nrowstakes precedence overncolsfor vertical orientation.
- orientation = 'vertical'#
- Type:
Whether the legend entries should be placed vertically or horizontally when they are drawn.
- padding = 10#
- Type:
- ),),)
Amount of padding between the contents of the legend and its border.
Only applicable when border is visible.
- propagate_hover = False#
- Type:
Allows to propagate hover events to the parent renderer, frame or canvas.
Note
This property is experimental and may change at any point.
- renderers = []#
- Type:
A collection of renderers attached to this renderer.
Note
This property is experimental and may change at any point.
- styles = {}#
- Type:
Inline CSS styles applied to the underlying DOM element.
- stylesheets = []#
- Type:
Additional style-sheets to use for the underlying DOM element.
Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use
:hostCSS pseudo selector to access the root DOM element.
- syncable = True#
- Type:
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to
Falsemay be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.Note
Setting this property to
Falsewill 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.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
CustomJScallbacks, etc.Note
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
- title_location = 'above'#
-
Specifies on which side of the legend the title will be located. Titles on the left or right side will be rotated accordingly.
- title_text_baseline = 'bottom'#
- Type:
The text baseline values for the title text.
- title_text_font_style = 'italic'#
-
The text font style values for the title text.
- title_text_outline_color = None#
-
The text outline color values for the title text.
- x_range_name = 'default'#
- Type:
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.
- y_range_name = 'default'#
- Type:
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.
Methods#
- 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
HasPropsinstance should modify it).- Parameters:
property_values (dict) – theme values to use in place of defaults
- Returns:
None
- classmethod clear_extensions() 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.
- clone(**overrides: Any) Self#
Duplicate a
HasPropsobject.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.
- classmethod dataspecs() dict[str, DataSpec]#
Collect the names of all
DataSpecproperties 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
CustomJScallback 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: JSChangeCallback) None#
Attach a
CustomJScallback 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)
- js_on_click(handler: JsEventCallback) None[source]#
Set up a JavaScript handler for legend item clicks.
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#
Find the
PropertyDescriptorfor 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
attrchanges.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Examples
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
Parametervalues 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
HasPropsinstances 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:
- 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.
- Parameters:
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
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.
- 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
Noneif 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)
JSON Prototype
{
"background_fill_alpha": 0.95,
"background_fill_color": "#ffffff",
"background_hatch_alpha": 1.0,
"background_hatch_color": "black",
"background_hatch_extra": {
"type": "map"
},
"background_hatch_pattern": null,
"background_hatch_scale": 12.0,
"background_hatch_weight": 1.0,
"border_line_alpha": 0.5,
"border_line_cap": "butt",
"border_line_color": "#e5e5e5",
"border_line_dash": [],
"border_line_dash_offset": 0,
"border_line_join": "bevel",
"border_line_width": 1,
"border_radius": 0,
"click_policy": "none",
"context_menu": null,
"coordinates": null,
"css_classes": [],
"css_variables": {
"type": "map"
},
"elements": [],
"glyph_height": 20,
"glyph_width": 20,
"group": null,
"html_attributes": {
"type": "map"
},
"html_id": null,
"id": "p56708",
"inactive_fill_alpha": 0.7,
"inactive_fill_color": "white",
"inactive_hatch_alpha": 1.0,
"inactive_hatch_color": "black",
"inactive_hatch_extra": {
"type": "map"
},
"inactive_hatch_pattern": null,
"inactive_hatch_scale": 12.0,
"inactive_hatch_weight": 1.0,
"item_background_fill_alpha": 0.8,
"item_background_fill_color": "#f1f1f1",
"item_background_hatch_alpha": 1.0,
"item_background_hatch_color": "black",
"item_background_hatch_extra": {
"type": "map"
},
"item_background_hatch_pattern": null,
"item_background_hatch_scale": 12.0,
"item_background_hatch_weight": 1.0,
"item_background_policy": "none",
"items": [],
"js_event_callbacks": {
"type": "map"
},
"js_property_callbacks": {
"type": "map"
},
"label_height": "auto",
"label_standoff": 5,
"label_text_align": "left",
"label_text_alpha": 1.0,
"label_text_baseline": "middle",
"label_text_color": "#444444",
"label_text_font": "helvetica",
"label_text_font_size": "13px",
"label_text_font_style": "normal",
"label_text_line_height": 1.2,
"label_text_outline_color": null,
"label_text_outline_width": 1,
"label_width": 20,
"level": "annotation",
"location": "top_right",
"margin": 10,
"name": null,
"ncols": "auto",
"nrows": "auto",
"orientation": "vertical",
"padding": 10,
"propagate_hover": false,
"renderers": [],
"spacing": 3,
"styles": {
"type": "map"
},
"stylesheets": [],
"subscribed_events": {
"type": "set"
},
"syncable": true,
"tags": [],
"title": null,
"title_location": "above",
"title_standoff": 5,
"title_text_align": "left",
"title_text_alpha": 1.0,
"title_text_baseline": "bottom",
"title_text_color": "#444444",
"title_text_font": "helvetica",
"title_text_font_size": "13px",
"title_text_font_style": "italic",
"title_text_line_height": 1.2,
"title_text_outline_color": null,
"title_text_outline_width": 1,
"visible": true,
"x_range_name": "default",
"y_range_name": "default"
}