Various kinds of data table (data grid) widgets.
AvgAggregator
Bases: bokeh.models.widgets.tables.RowAggregator
bokeh.models.widgets.tables.RowAggregator
Simple average across multiple rows.
field_
property type: String
String
Refers to the table column being aggregated
js_event_callbacks
property type: Dict ( String , List ( Instance ( CustomJS ) ) )
Dict
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
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 )
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.
{ "field_": "", "id": "17596", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
BooleanFormatter
Bases: bokeh.models.widgets.tables.CellFormatter
bokeh.models.widgets.tables.CellFormatter
Boolean (check mark) cell formatter.
icon
property type: Enum ( Enumeration(check, check-circle, check-circle-o, check-square, check-square-o) )
Enum
The icon visualizing the check mark.
{ "icon": "check", "id": "17603", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
CellEditor
Bases: bokeh.model.Model
bokeh.model.Model
Abstract base class for data table’s cell editors.
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": "17610", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
CellFormatter
Abstract base class for data table’s cell formatters.
{ "id": "17616", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
CheckboxEditor
Bases: bokeh.models.widgets.tables.CellEditor
bokeh.models.widgets.tables.CellEditor
Boolean value cell editor.
{ "id": "17622", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
DataCube
Bases: bokeh.models.widgets.tables.DataTable
bokeh.models.widgets.tables.DataTable
Specialized DataTable with collapsing groups, totals, and sub-totals.
align
property type: Either ( Enum ( Align ), Tuple ( Enum ( Align ), Enum ( Align ) ) )
Either
Align
Tuple
The alignment point within the parent container.
This property is useful only if this component is a child element of a layout (e.g. a grid). Self alignment can be overridden by the parent container (e.g. grid track align).
aspect_ratio
property type: Either ( Enum ( Enumeration(auto) ), Float )
Float
Describes the proportional relationship between component’s width and height.
This works if any of component’s dimensions are flexible in size. If set to a number, width / height = aspect_ratio relationship will be maintained. Otherwise, if set to "auto", component’s preferred width and height will be used to determine the aspect (if not set, no aspect will be preserved).
width / height = aspect_ratio
"auto"
auto_edit
property type: Bool
Bool
When enabled editing mode is enabled after a single click on a table cell.
autosize_mode
property type: Enum ( AutosizeMode )
AutosizeMode
Describes the column autosizing mode with one of the following options:
"fit_columns"
Compute columns widths based on cell contents but ensure the table fits into the available viewport. This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available.
"fit_viewport"
Adjust the viewport size after computing columns widths based on cell contents.
"force_fit"
Fit columns into available space dividing the table width across the columns equally (equivalent to fit_columns=True). This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available.
"none"
Do not automatically compute column widths.
background
property type: Color
Color
Background color of the component.
columns
property type: List ( Instance ( TableColumn ) )
TableColumn
The list of child column widgets.
css_classes
A list of CSS class names to add to this DOM element. Note: the class names are simply added as-is, no other guarantees are provided.
It is also permissible to assign from tuples, however these are adapted – the property will always contain a list.
default_size
property type: Int
Int
The default size (width or height) in the dominating dimension.
The dominating dimension is determined by widget orientation.
disabled
Whether the widget will be disabled when rendered.
If True, the widget will be greyed-out and not responsive to UI events.
True
editable
Allows to edit table’s contents. Needs cell editors to be configured on columns that are required to be editable.
fit_columns
Whether columns should be fit to the available width. This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available. If set to True, columns’ width is understood as maximum width.
frozen_columns
Integer indicating the number of columns to freeze. If set the first N columns will be frozen which prevents them from scrolling out of frame.
frozen_rows
Integer indicating the number of rows to freeze. If set the first N rows will be frozen which prevents them from scrolling out of frame, if set to a negative value last N rows will be frozen.
grouping
property type: List ( Instance ( GroupingInfo ) )
GroupingInfo
Describe what aggregation operations used to define sub-totals and totals
header_row
Whether to show a header row with column names at the top of the table.
height
property type: NonNegativeInt
NonNegativeInt
The height of the component (in pixels).
This can be either fixed or preferred height, depending on height sizing policy.
height_policy
property type: Either ( Auto , Enum ( SizingPolicy ) )
Auto
SizingPolicy
Describes how the component should maintain its height.
Use component’s preferred sizing policy.
"fixed"
Use exactly height pixels. Component will overflow if it can’t fit in the available vertical space.
"fit"
Use component’s preferred height (if set) and allow to fit into the available vertical space within the minimum and maximum height bounds (if set). Component’s height neither will be aggressively minimized nor maximized.
"min"
Use as little vertical space as possible, not less than the minimum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max"
Use as much vertical space as possible, not more than the maximum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.
This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.
sizing_mode
index_header
The column header to display for the index column, if it is present.
index_position
Where among the list of columns to insert a column displaying the row index. Negative indices are supported, and specify an index position from the end of the list of columns (i.e. standard Python behaviour).
To prevent the index column from being added, set to None.
If the absolute value of index_position is larger than the length of the columns, then the index will appear at the beginning or end, depending on the sign.
index_width
The width of the index column, if present.
margin
property type: Tuple ( Int , Int , Int , Int )
Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.
max_height
Maximal height of the component (in pixels) if height is adjustable.
max_width
Maximal width of the component (in pixels) if width is adjustable.
min_height
Minimal height of the component (in pixels) if height is adjustable.
min_width
Minimal width of the component (in pixels) if width is adjustable.
orientation
property type: Enum ( Enumeration(horizontal, vertical) )
Orient the widget either horizontally (default) or vertically.
Note that not all widgets support vertical orientation.
reorderable
Allows the reordering of a table’s columns. To reorder a column, click and drag a table’s header to the desired location in the table. The columns on either side will remain in their previous order.
row_height
The height of each row in pixels.
scroll_to_selection
Whenever a selection is made on the data source, scroll the selected rows into the table’s viewport if none of the selected rows are already in the viewport.
selectable
property type: Either ( Bool , Enum ( Enumeration(checkbox) ) )
Whether a table’s rows can be selected or not. Using checkbox is equivalent to True, but makes selection visible through a checkbox for each row, instead of highlighting rows. Multiple selection is allowed and can be achieved by either clicking multiple checkboxes (if enabled) or using Shift + click on rows.
checkbox
property type: Enum ( SizingMode )
SizingMode
How the component should size itself.
This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode).
width_policy
Possible scenarios:
Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events.
"stretch_width"
Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_height"
Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_both"
Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component.
"scale_width"
Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio.
"scale_height"
Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio.
"scale_both"
Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.
sortable
Allows to sort table’s contents. By default natural order is preserved. To sort a column, click on it’s header. Clicking one more time changes sort direction. Use Ctrl + click to return to natural order. Use Shift + click to sort multiple columns simultaneously.
source
property type: Instance ( DataSource )
DataSource
The source of data for the widget.
target
Two column datasource (row_indices & labels) describing which rows of the data cubes are expanded or collapsed
view
property type: Instance ( CDSView )
CDSView
A view into the data source to use when rendering table rows. A default view of the entire data source is created if a view is not passed in during initialization.
visible
Whether the component will be visible and a part of a layout.
width
The width of the component (in pixels).
This can be either fixed or preferred width, depending on width sizing policy.
Describes how the component should maintain its width.
Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.
Use component’s preferred width (if set) and allow it to fit into the available horizontal space within the minimum and maximum width bounds (if set). Component’s width neither will be aggressively minimized nor maximized.
Use as little horizontal space as possible, not less than the minimum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.
Use as much horizontal space as possible, not more than the maximum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.
{ "align": "start", "aspect_ratio": null, "auto_edit": false, "autosize_mode": "force_fit", "background": null, "columns": [], "css_classes": [], "default_size": 300, "disabled": false, "editable": false, "fit_columns": null, "frozen_columns": null, "frozen_rows": null, "grouping": [], "header_row": true, "height": 400, "height_policy": "auto", "id": "17628", "index_header": "#", "index_position": 0, "index_width": 40, "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "orientation": "horizontal", "reorderable": true, "row_height": 25, "scroll_to_selection": true, "selectable": true, "sizing_mode": null, "sortable": true, "source": null, "subscribed_events": [], "tags": [], "target": null, "view": { "id": "17629" }, "visible": true, "width": 600, "width_policy": "auto" }
DataTable
Bases: bokeh.models.widgets.tables.TableWidget
bokeh.models.widgets.tables.TableWidget
Two dimensional grid for visualisation and editing large amounts of data.
{ "align": "start", "aspect_ratio": null, "auto_edit": false, "autosize_mode": "force_fit", "background": null, "columns": [], "css_classes": [], "default_size": 300, "disabled": false, "editable": false, "fit_columns": null, "frozen_columns": null, "frozen_rows": null, "header_row": true, "height": 400, "height_policy": "auto", "id": "17716", "index_header": "#", "index_position": 0, "index_width": 40, "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "orientation": "horizontal", "reorderable": true, "row_height": 25, "scroll_to_selection": true, "selectable": true, "sizing_mode": null, "sortable": true, "source": null, "subscribed_events": [], "tags": [], "view": { "id": "17717" }, "visible": true, "width": 600, "width_policy": "auto" }
DateEditor
Calendar-based date cell editor.
{ "id": "17800", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
DateFormatter
Bases: bokeh.models.widgets.tables.StringFormatter
bokeh.models.widgets.tables.StringFormatter
Date cell formatter.
font_style
property type: Enum ( FontStyle )
FontStyle
An optional text font style, e.g. bold, italic.
format
property type: Either ( Enum ( DateFormat ), String )
DateFormat
The date format can be any standard strftime format string, as well as any of the following predefined format names:
Format name(s)
Format string
Example Output
ATOM / W3C / RFC-3339 / ISO-8601
ATOM
W3C
RFC-3339
ISO-8601
"%Y-%m-%d"
2014-03-01
COOKIE
"%a, %d %b %Y"
Sat, 01 Mar 2014
RFC-850
"%A, %d-%b-%y"
Saturday, 01-Mar-14
RFC-1123 / RFC-2822
RFC-1123
RFC-2822
"%a, %e %b %Y"
Sat, 1 Mar 2014
RSS / RFC-822 / RFC-1036
RSS
RFC-822
RFC-1036
"%a, %e %b %y"
Sat, 1 Mar 14
TIMESTAMP
(ms since epoch)
1393632000000
Note that in the table some of the format names are synonymous, with identical format names separated by slashes.
This list of supported strftime format codes 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.
Warning
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.
nan_format
Formatting to apply to NaN and None values (falls back to regular date formatting if not set).
text_align
property type: Enum ( TextAlign )
TextAlign
An optional text align, i.e. left, center or right.
text_color
An optional text color. See bokeh.core.properties.Color for details.
bokeh.core.properties.Color
{ "font_style": "normal", "format": "ISO-8601", "id": "17806", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "nan_format": null, "subscribed_events": [], "tags": [], "text_align": "left", "text_color": null }
Describes how to calculate totals and sub-totals
aggregators
property type: List ( Instance ( RowAggregator ) )
RowAggregator
Describes how to aggregate the columns which will populate this sub-total.
collapsed
Whether the corresponding sub-total is expanded or collapsed by default.
getter
References the column which generates the unique keys of this sub-total (groupby).
{ "aggregators": [], "collapsed": false, "getter": "", "id": "17817", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
HTMLTemplateFormatter
HTML formatter using a template. This uses Underscore’s template method and syntax. http://underscorejs.org/#template The formatter has access other items in the row via the dataContext object passed to the formatter. So, for example, if another column in the datasource was named url, the template could access it as:
<a href="<%= url %>"><%= value %></a>
To use a different set of template delimiters, pass the appropriate values for evaluate, interpolate’, or `escape. See the Underscore template documentation for more information. http://underscorejs.org/#template
Example: Simple HTML template to format the column value as code.
HTMLTemplateFormatter(template='<code><%= value %></code>')
Example: Use values from other columns (manufacturer and model) to build a hyperlink.
HTMLTemplateFormatter(template= '<a href="https:/www.google.com/search?q=<%= manufacturer %>+<%= model %>" target="_blank"><%= value %></a>' )
template
Template string to be used by Underscore’s template method.
{ "id": "17826", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [], "template": "<%= value %>" }
IntEditor
Spinner-based integer cell editor.
step
The major step value.
{ "id": "17833", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "step": 1, "subscribed_events": [], "tags": [] }
MaxAggregator
Largest value across multiple rows.
{ "field_": "", "id": "17840", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
MinAggregator
Smallest value across multiple rows.
{ "field_": "", "id": "17847", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
NumberEditor
Spinner-based number cell editor.
property type: Float
{ "id": "17854", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "step": 0.01, "subscribed_events": [], "tags": [] }
NumberFormatter
Number cell formatter.
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).
Formatting to apply to NaN and None values (falls back to Numbro formatting if not set).
rounding
property type: Enum ( RoundingFunction )
RoundingFunction
Rounding functions (round, floor, ceil) and their synonyms (nearest, rounddown, roundup).
{ "font_style": "normal", "format": "0,0", "id": "17861", "js_event_callbacks": {}, "js_property_callbacks": {}, "language": "en", "name": null, "nan_format": null, "rounding": "round", "subscribed_events": [], "tags": [], "text_align": "left", "text_color": null }
PercentEditor
IntEditor optimized for editing percentages.
{ "id": "17874", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
ScientificFormatter
Display numeric values from continuous ranges as “basic numbers”, using scientific notation when appropriate by default.
Formatting to apply to NaN and None values (falls back to scientific formatting if not set).
power_limit_high
log(x) >= power_limit_high
power_limit_low
log(x) <= power_limit_low
precision
How many digits of precision to display.
{ "font_style": "normal", "id": "17880", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "nan_format": null, "power_limit_high": 5, "power_limit_low": -3, "precision": 10, "subscribed_events": [], "tags": [], "text_align": "left", "text_color": null }
SelectEditor
Select cell editor.
options
The list of options to select from.
{ "id": "17893", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "options": [], "subscribed_events": [], "tags": [] }
StringEditor
Basic string cell editor with auto-completion.
completions
An optional list of completion strings.
{ "completions": [], "id": "17900", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
StringFormatter
Basic string cell formatter.
{ "font_style": "normal", "id": "17907", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [], "text_align": "left", "text_color": null }
SumAggregator
Simple sum across multiple rows.
{ "field_": "", "id": "17916", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
Table column widget.
default_sort
property type: Enum ( Enumeration(ascending, descending) )
The default sorting order. By default ascending order is used.
ascending
editor
property type: Instance ( CellEditor )
The cell editor for this column. By default, a simple string editor is used.
field
The name of the field mapping to a column in the data source.
formatter
property type: Instance ( CellFormatter )
The cell formatter for this column. By default, a simple string formatter is used.
Whether this column is sortable or not. Note that data table has to have sorting enabled to allow sorting in general.
title
The title of this column. If not set, column’s data field is used instead.
The width or maximum width (depending on data table’s configuration) in pixels of this column.
{ "default_sort": "ascending", "editor": { "id": "17925" }, "field": null, "formatter": { "id": "17924" }, "id": "17923", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "sortable": true, "subscribed_events": [], "tags": [], "title": null, "width": 300 }
TableWidget
Bases: bokeh.models.widgets.widget.Widget
bokeh.models.widgets.widget.Widget
Abstract base class for data table (data grid) widgets.
{ "align": "start", "aspect_ratio": null, "background": null, "css_classes": [], "default_size": 300, "disabled": false, "height": null, "height_policy": "auto", "id": "17938", "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "orientation": "horizontal", "sizing_mode": null, "source": null, "subscribed_events": [], "tags": [], "view": { "id": "17939" }, "visible": true, "width": null, "width_policy": "auto" }
TextEditor
Multi-line string cell editor.
{ "id": "17990", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
TimeEditor
Spinner-based time cell editor.
{ "id": "17996", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }