Models for controlling the text and visual formatting of tick labels on Bokeh plot axes.
TickFormatter
Bases: bokeh.model.Model
bokeh.model.Model
A base class for all tick formatter 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.
js_event_callbacks
property type: Dict ( String , List ( Instance ( CustomJS ) ) )
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:
Model.js_on_event
callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
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.
Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_change method:
Model.js_on_change
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', ...)]
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 )
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.
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_theme
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).
HasProps
property_values (dict) – theme values to use in place of defaults
None
dataspecs
Collect the names of all DataSpec properties on this class.
DataSpec
This method always traverses the class hierarchy and includes properties defined on any parent classes.
names of DataSpec properties
set[str]
dataspecs_with_props
Collect a dict mapping the names of all DataSpec properties on this class to the associated properties.
mapping of names and DataSpec properties
dict[str, DataSpec]
equals
Structural equality of models.
other (HasProps) – the other instance to compare to
True, if properties are structurally equal, otherwise False
js_link
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.
attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
other
attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr
attr
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]" ) )
js_on_change
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:
"change:property_name"
"change:"
# 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:
ColumnDataSource
"stream"
source.js_on_change('streaming', callback)
layout
lookup
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
PropertyDescriptor
name (str) – name of the property to search for
descriptor for property named name
on_change
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
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
properties
Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)
property names
properties_containers
Collect the names of all container properties on this class.
names of container properties
properties_with_refs
Collect the names of all properties on this class that also have references.
names of properties that have references
properties_with_values
Collect a dict mapping property names to their values.
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.
include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)
mapping from property names to their values
dict
query_properties_with_values
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
references
Returns all Models that this object has references to.
Models
remove_on_change
Remove a callback from this object
select
Query this object and all of its references for objects that match the given selector.
selector (JSON-like) –
seq[Model]
select_one
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_from_json
Set a property value on this object from JSON.
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.
set_select
Update objects that match a given selector with the specified attribute/value updates.
updates (dict) –
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.
dict or None
to_json
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).
from_json()
For most purposes it’s best to serialize and deserialize entire documents.
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
to_json_string
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).
from_json_string()
trigger
unapply_theme
Remove any themed values and restore defaults.
update
Updates the object’s properties from the given keyword arguments.
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
Updates the object’s properties from a JSON attributes dictionary.
json_attributes – (JSON-dict) : attributes and values to update
document
The Document this model is attached to (can be None)
Document
struct
A Bokeh protocol “structure” of 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.
{ "id": "11047", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
BasicTickFormatter
Bases: bokeh.models.formatters.TickFormatter
bokeh.models.formatters.TickFormatter
Display tick values from continuous ranges as “basic numbers”, using scientific notation when appropriate by default.
power_limit_high
property type: Int
Int
Limit the use of scientific notation to when:
log(x) >= power_limit_high
power_limit_low
log(x) <= power_limit_low
precision
property type: Either ( Auto , Int )
Either
Auto
How many digits of precision to display in tick labels.
use_scientific
property type: Bool
Bool
Whether to ever display scientific notation. If True, then when to use scientific notation is controlled by power_limit_low and power_limit_high.
True
{ "id": "11053", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "power_limit_high": 5, "power_limit_low": -3, "precision": "auto", "subscribed_events": [], "tags": [], "use_scientific": true }
MercatorTickFormatter
Bases: bokeh.models.formatters.BasicTickFormatter
bokeh.models.formatters.BasicTickFormatter
A TickFormatter for values in WebMercator units.
Some map plot types internally use WebMercator to describe coordinates, plot bounds, etc. These units are not very human-friendly. This tick formatter will convert WebMercator units into Latitude and Longitude for display on axes.
dimension
property type: Enum ( LatLon )
Enum
LatLon
Specify whether to format ticks for Latitude or Longitude.
Projected coordinates are not separable, computing Latitude and Longitude tick labels from Web Mercator requires considering coordinates from both dimensions together. Use this property to specify which result should be used for display.
Typically, if the formatter is for an x-axis, then dimension should be "lon" and if the formatter is for a y-axis, then the dimension should be “lat”`.
"lon"
In order to prevent hard to debug errors, there is no default value for dimension. Using an un-configured MercatorTickFormatter will result in a validation error and a JavaScript console error.
{ "dimension": null, "id": "11063", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "power_limit_high": 5, "power_limit_low": -3, "precision": "auto", "subscribed_events": [], "tags": [], "use_scientific": true }
NumeralTickFormatter
Tick formatter based on a human-readable format string.
format
The number format, as defined in the following tables:
NUMBERS:
Number
Format
10000
‘0,0.0000’
10,000.0000
10000.23
‘0,0’
10,000
‘+0,0’
+10,000
-10000
‘0,0.0’
-10,000.0
10000.1234
‘0.000’
10000.123
‘0[.]00000’
10000.12340
‘(0,0.0000)’
(10,000.0000)
-0.23
‘.00’
-.23
‘(.00)’
(.23)
0.23
‘0.00000’
0.23000
‘0.0[0000]’
1230974
‘0.0a’
1.2m
1460
‘0 a’
1 k
-104000
‘0a’
-104k
1
‘0o’
1st
52
52nd
23
23rd
100
100th
CURRENCY:
1000.234
‘$0,0.00’
$1,000.23
1000.2
‘0,0[.]00 $’
1,000.20 $
1001
‘$ 0,0[.]00’
$ 1,001
-1000.234
‘($0,0)’
($1,000)
‘$0.00’
-$1000.23
‘($ 0.00 a)’
$ 1.23 m
BYTES:
‘0b’
100B
2048
‘0 b’
2 KB
7884486213
‘0.0b’
7.3GB
3467479682787
‘0.000 b’
3.154 TB
PERCENTAGES:
‘0%’
100%
0.974878234
‘0.000%’
97.488%
-0.43
‘0 %’
-43 %
0.43
‘(0.000 %)’
43.000 %
TIME:
25
‘00:00:00’
0:00:25
238
0:03:58
63846
17:44:06
For the complete specification, see http://numbrojs.com/format.html
language
property type: Enum ( NumeralLanguage )
NumeralLanguage
The language to use for formatting language-specific features (e.g. thousands separator).
rounding
property type: Enum ( RoundingFunction )
RoundingFunction
Rounding functions (round, floor, ceil) and their synonyms (nearest, rounddown, roundup).
{ "format": "0,0", "id": "11074", "js_event_callbacks": {}, "js_property_callbacks": {}, "language": "en", "name": null, "rounding": "round", "subscribed_events": [], "tags": [] }
PrintfTickFormatter
Tick formatter based on a printf-style format string.
The number format, as defined as follows: the placeholder in the format string is marked by % and is followed by one or more of these elements, in this order:
+
Causes the result to be preceded with a plus or minus sign on numeric values. By default, only the - sign is used on negative numbers.
-
Specifies what (if any) character to use for padding. Possible values are 0 or any other character preceded by a ' (single quote). The default is to pad with spaces.
'
Causes sprintf to left-align the result of this placeholder. The default is to right-align the result.
Specifies how many characters the result should have. If the value to be returned is shorter than this number, the result will be padded.
Consists of a . (dot) followed by a number, specifies how many digits should be displayed for floating point numbers. When used on a string, it causes the result to be truncated.
.
Can be any of:
% — yields a literal % character
%
b — yields an integer as a binary number
b
c — yields an integer as the character with that ASCII value
c
d or i — yields an integer as a signed decimal number
d
i
e — yields a float using scientific notation
e
u — yields an integer as an unsigned decimal number
u
f — yields a float as is
f
o — yields an integer as an octal number
o
s — yields a string as is
s
x — yields an integer as a hexadecimal number (lower-case)
x
X — yields an integer as a hexadecimal number (upper-case)
X
{ "format": "%s", "id": "11083", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
LogTickFormatter
Display tick values from continuous ranges as powers of some base.
Most often useful in conjunction with a LogTicker.
LogTicker
ticker
property type: Instance ( Ticker )
Ticker
The corresponding LogTicker, used to determine the correct base to use. If unset, the formatter will use base 10 as a default.
{ "id": "11090", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [], "ticker": null }
CategoricalTickFormatter
Display tick values from categorical ranges as string values.
{ "id": "11097", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
FuncTickFormatter
Display tick values that are formatted by a user-defined function.
Warning
The explicit purpose of this Bokeh Model is to embed raw JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.
args
property type: Dict ( String , AnyRef )
AnyRef
A mapping of names to Python objects. In particular those can be bokeh’s models. These objects are made available to the formatter’s code snippet as the values of named parameters to the callback.
code
A snippet of JavaScript code that reformats a single tick to the desired format. The variable tick will contain the unformatted tick value and can be expected to be present in the code snippet namespace at render time.
tick
Additionally available variables are:
ticks, an array of all axis ticks as positioned by the ticker, index, the position of tick within ticks, and the keys of args mapping, if any.
ticks, an array of all axis ticks as positioned by the ticker,
ticks
index, the position of tick within ticks, and
index
the keys of args mapping, if any.
Finding yourself needing to cache an expensive ticks-dependent computation, you can store it on the this variable.
this
code = ''' this.precision = this.precision || (ticks.length > 5 ? 1 : 2); return Math.floor(tick) + " + " + (tick % 1).toFixed(this.precision); '''
{ "args": {}, "code": "", "id": "11103", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
DatetimeTickFormatter
A TickFormatter for displaying datetime values nicely across a range of scales.
DatetimeTickFormatter has the following properties (listed together with their default values) that can be used to control the formatting of axis ticks at different scales scales:
microseconds = ['%fus'] milliseconds = ['%3Nms', '%S.%3Ns'] seconds = ['%Ss'] minsec = [':%M:%S'] minutes = [':%M', '%Mm'] hourmin = ['%H:%M'] hours = ['%Hh', '%H:%M'] days = ['%m/%d', '%a%d'] months = ['%m/%Y', '%b %Y'] years = ['%Y']
Each scale property can be set to format or list of formats to use for formatting datetime tick values that fall in in that “time scale”. By default, only the first format string passed for each time scale will be used. By default, all leading zeros are stripped away from the formatted labels.
This list of supported strftime formats is reproduced below.
The abbreviated name of the day of the week according to the current locale.
The full name of the day of the week according to the current locale.
The abbreviated month name according to the current locale.
The full month name according to the current locale.
The preferred date and time representation for the current locale.
The century number (year/100) as a 2-digit integer.
The day of the month as a decimal number (range 01 to 31).
Equivalent to %m/%d/%y. (Americans should note that in many other countries %d/%m/%y is rather common. This means that in international context this format is ambiguous and should not be used.)
Like %d, the day of the month as a decimal number, but a leading zero is replaced by a space.
Microsecond as a decimal number, zero-padded on the left (range 000000-999999). This is an extension to the set of directives available to timezone.
Equivalent to %Y-%m-%d (the ISO 8601 date format).
The ISO 8601 week-based year with century as a decimal number. The 4-digit year corresponding to the ISO week number (see %V). This has the same format and value as %Y, except that if the ISO week number belongs to the previous or next year, that year is used instead.
Like %G, but without century, that is, with a 2-digit year (00-99).
Equivalent to %b.
The hour as a decimal number using a 24-hour clock (range 00 to 23).
The hour as a decimal number using a 12-hour clock (range 01 to 12).
The day of the year as a decimal number (range 001 to 366).
The hour (24-hour clock) as a decimal number (range 0 to 23). Single digits are preceded by a blank. (See also %H.)
The hour (12-hour clock) as a decimal number (range 1 to 12). Single digits are preceded by a blank. (See also %I.) (TZ)
The month as a decimal number (range 01 to 12).
The minute as a decimal number (range 00 to 59).
A newline character. Bokeh text does not currently support newline characters.
Nanosecond as a decimal number, zero-padded on the left (range 000000000-999999999). Supports a padding width specifier, i.e. %3N displays 3 leftmost digits. However, this is only accurate to the millisecond level of precision due to limitations of timezone.
Either “AM” or “PM” according to the given time value, or the corresponding strings for the current locale. Noon is treated as “PM” and midnight as “AM”.
Like %p but in lowercase: “am” or “pm” or a corresponding string for the current locale.
The time in a.m. or p.m. notation. In the POSIX locale this is equivalent to %I:%M:%S %p.
The time in 24-hour notation (%H:%M). For a version including the seconds, see %T below.
The number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC).
The second as a decimal number (range 00 to 60). (The range is up to 60 to allow for occasional leap seconds.)
A tab character. Bokeh text does not currently support tab characters.
The time in 24-hour notation (%H:%M:%S).
The day of the week as a decimal, range 1 to 7, Monday being 1. See also %w.
The week number of the current year as a decimal number, range 00 to 53, starting with the first Sunday as the first day of week 01. See also %V and %W.
The ISO 8601 week number (see NOTES) of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the new year. See also %U and %W.
The day of the week as a decimal, range 0 to 6, Sunday being 0. See also %u.
The week number of the current year as a decimal number, range 00 to 53, starting with the first Monday as the first day of week 01.
The preferred date representation for the current locale without the time.
The preferred time representation for the current locale without the date.
The year as a decimal number without a century (range 00 to 99).
The year as a decimal number including the century.
The +hhmm or -hhmm numeric timezone (that is, the hour and minute offset from UTC).
The timezone name or abbreviation.
A literal ‘%’ character.
The client library BokehJS uses the timezone library to format datetimes. The inclusion of the list below is based on the claim that timezone makes to support “the full compliment of GNU date format specifiers.” However, this claim has not been tested exhaustively against this list. If you find formats that do not function as expected, please submit a github issue, so that the documentation can be updated appropriately.
days
Formats for displaying datetime values in the days range.
See the DatetimeTickFormatter help for a list of all supported formats.
hourmin
Formats for displaying datetime values in the hourmin (for combined hours and minutes) range.
hours
Formats for displaying datetime values in the hours range.
microseconds
Formats for displaying datetime values in the microseconds range.
milliseconds
Formats for displaying datetime values in the milliseconds range.
minsec
Formats for displaying datetime values in the minsec (for combined minutes and seconds) range.
minutes
Formats for displaying datetime values in the minutes range.
months
Formats for displaying datetime values in the months range.
seconds
Formats for displaying datetime values in the seconds range.
years
Formats for displaying datetime values in the years range.
{ "days": [ "%m/%d", "%a%d" ], "hourmin": [ "%H:%M" ], "hours": [ "%Hh", "%H:%M" ], "id": "11111", "js_event_callbacks": {}, "js_property_callbacks": {}, "microseconds": [ "%fus" ], "milliseconds": [ "%3Nms", "%S.%3Ns" ], "minsec": [ ":%M:%S" ], "minutes": [ ":%M", "%Mm" ], "months": [ "%m/%Y", "%b %Y" ], "name": null, "seconds": [ "%Ss" ], "subscribed_events": [], "tags": [], "years": [ "%Y" ] }