bokeh.models.widgets.tables¶

Various kinds of data table (data grid) widgets.

class BooleanFormatter(**kwargs)[source]¶

Bases: 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) )

The icon visualizing the check mark.

{
  "icon": "check",
  "id": "de331695-bd4d-41be-93a1-8ce21ecdf193",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class CellEditor(**kwargs)[source]¶

Bases: bokeh.model.Model

Abstract base class for data table’s cell editors.

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.

{
  "id": "1c21cf63-e474-48bc-ac9e-78f83673cec4",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class CellFormatter(**kwargs)[source]¶

Bases: bokeh.model.Model

Abstract base class for data table’s cell formatters.

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.

{
  "id": "a710d7cc-a410-44df-8102-632de679df10",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class CheckboxEditor(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellEditor

Boolean value cell editor.

{
  "id": "3dbc624a-8ab7-443b-a973-5181f232c7f5",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class DataTable(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.TableWidget

Two dimensional grid for visualisation and editing large amounts of data.

columns¶

property type: List ( Instance ( TableColumn ) )

The list of child column widgets.

editable¶

property type: Bool

Allows to edit table’s contents. Needs cell editors to be configured on columns that are required to be editable.

fit_columns¶

property type: Bool

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 no enough space available. If set to True, columns’ width is understood as maximum width.

row_headers¶

property type: Bool

Enable or disable row headers, i.e. the index column.

scroll_to_selection¶

property type: Bool

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.

sortable¶

property type: Bool

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.

{
  "columns": [],
  "css_classes": null,
  "disabled": false,
  "editable": false,
  "fit_columns": true,
  "height": 400,
  "id": "0b182f59-c747-47dd-8e66-750ab579ae44",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "row_headers": true,
  "scroll_to_selection": true,
  "selectable": true,
  "sizing_mode": "fixed",
  "sortable": true,
  "source": null,
  "subscribed_events": [],
  "tags": [],
  "width": null
}

class DateEditor(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellEditor

Calendar-based date cell editor.

{
  "id": "d62da25f-9aa5-45e9-9cbb-0e8a1cc65d32",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class DateFormatter(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellFormatter

Date cell formatter.

format¶

property type: Either ( Enum ( DateFormat ), String )

The date format can be combinations of the following:

d

day of month (no leading zero)

dd

day of month (two digit)

o

day of year (no leading zeros)

oo

day of year (three digit)

D

day name short

DD

day name long

m

month of year (no leading zero)

mm

month of year (two digit)

M

month name short

MM

month name long

y

year (two digit)

yy

year (four digit)

@

Unix timestamp (ms since 01/01/1970)

!

Windows ticks (100ns since 01/01/0001)

”...”

literal text

‘’

single quote

{
  "format": "yy M d",
  "id": "26d542e4-aa6c-4b76-a522-d7a8e9bfa147",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class HTMLTemplateFormatter(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellFormatter

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¶

property type: String

Template string to be used by Underscore’s template method.

{
  "id": "85f8189f-16ed-41e6-8748-3f8991270705",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "template": "<%= value %>"
}

class IntEditor(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellEditor

Spinner-based integer cell editor.

step¶

property type: Int

The major step value.

{
  "id": "9f85302d-f22b-4ee1-a6ed-19648aeb7ee1",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "step": 1,
  "subscribed_events": [],
  "tags": []
}

class NumberEditor(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellEditor

Spinner-based number cell editor.

step¶

property type: Float

The major step value.

{
  "id": "44022a39-9a4f-419b-a704-87dd3edd9710",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "step": 0.01,
  "subscribed_events": [],
  "tags": []
}

class NumberFormatter(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.StringFormatter

Number cell formatter.

format¶

property type: String

The number format, as defined in the following tables:

NUMBERS:

Number	Format	String
10000	‘0,0.0000’	10,000.0000
10000.23	‘0,0’	10,000
10000.23	‘+0,0’	+10,000
-10000	‘0,0.0’	-10,000.0
10000.1234	‘0.000’	10000.123
10000.1234	‘0[.]00000’	10000.12340
-10000	‘(0,0.0000)’	(10,000.0000)
-0.23	‘.00’	-.23
-0.23	‘(.00)’	(.23)
0.23	‘0.00000’	0.23000
0.23	‘0.0[0000]’	0.23
1230974	‘0.0a’	1.2m
1460	‘0 a’	1 k
-104000	‘0a’	-104k
1	‘0o’	1st
52	‘0o’	52nd
23	‘0o’	23rd
100	‘0o’	100th

CURRENCY:

Number	Format	String
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)
-1000.234	‘$0.00’	-$1000.23
1230974	‘($ 0.00 a)’	$ 1.23 m

BYTES:

Number	Format	String
100	‘0b’	100B
2048	‘0 b’	2 KB
7884486213	‘0.0b’	7.3GB
3467479682787	‘0.000 b’	3.154 TB

PERCENTAGES:

Number	Format	String
1	‘0%’	100%
0.974878234	‘0.000%’	97.488%
-0.43	‘0 %’	-43 %
0.43	‘(0.000 %)’	43.000 %

TIME:

Number	Format	String
25	‘00:00:00’	0:00:25
238	‘00:00:00’	0:03:58
63846	‘00:00:00’	17:44:06

For the complete specification, see http://numbrojs.com/format.html

language¶

property type: Enum ( NumeralLanguage )

The language to use for formatting language-specific features (e.g. thousands separator).

rounding¶

property type: Enum ( RoundingFunction )

Rounding functions (round, floor, ceil) and their synonyms (nearest, rounddown, roundup).

{
  "font_style": "normal",
  "format": "0,0",
  "id": "6c8261b8-6c5c-4a4c-bd20-57b4e702b7df",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "language": "en",
  "name": null,
  "rounding": "round",
  "subscribed_events": [],
  "tags": [],
  "text_align": "left",
  "text_color": null
}

class PercentEditor(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellEditor

IntEditor optimized for editing percentages.

{
  "id": "0317ee15-4d36-4312-afcb-319668d12fa7",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class SelectEditor(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellEditor

Select cell editor.

options¶

property type: List ( String )

The list of options to select from.

{
  "id": "755f8582-a1c9-4053-8599-b886a854a6e4",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "options": [],
  "subscribed_events": [],
  "tags": []
}

class StringEditor(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellEditor

Basic string cell editor with auto-completion.

completions¶

property type: List ( String )

An optional list of completion strings.

{
  "completions": [],
  "id": "5e63c18f-a8ef-4afd-a75f-3ac9c2e0b9b2",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class StringFormatter(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellFormatter

Basic string cell formatter.

font_style¶

property type: Enum ( FontStyle )

An optional text font style, e.g. bold, italic.

text_align¶

property type: Enum ( TextAlign )

An optional text align, i.e. left, center or right.

text_color¶

property type: Color

An optional text color. See bokeh.core.properties.Color for details.

{
  "font_style": "normal",
  "id": "78f94edf-88eb-49dc-81e3-4ed4ee9b27a2",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "text_align": "left",
  "text_color": null
}

class TableColumn(**kwargs)[source]¶

Bases: bokeh.model.Model

Table column widget.

default_sort¶

property type: Enum ( Enumeration(ascending, descending) )

The default sorting order. By default ascending order is used.

editor¶

property type: Instance ( CellEditor )

The cell editor for this column. By default, a simple string editor is used.

field¶

property type: String

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.

sortable¶

property type: Bool

Whether this column is sortable or not. Note that data table has to have sorting enabled to allow sorting in general.

title¶

property type: String

The title of this column. If not set, column’s data field is used instead.

width¶

property type: Int

The width or maximum width (depending on data table’s configuration) in pixels of this column.

{
  "default_sort": "ascending",
  "editor": {
    "id": "6dd28b94-a26a-4dfb-a731-0720cbb3079e",
    "type": "StringEditor"
  },
  "field": null,
  "formatter": {
    "id": "38818132-e11f-4a6f-92ff-a6de1f8971f3",
    "type": "StringFormatter"
  },
  "id": "e0513a89-74e3-4cb9-90b1-ea029b25527c",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "sortable": true,
  "subscribed_events": [],
  "tags": [],
  "title": null,
  "width": 300
}

class TableWidget(**kwargs)[source]¶

Bases: bokeh.models.widgets.widget.Widget

Abstract base class for data table (data grid) widgets.

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.

source¶

property type: Instance ( DataSource )

The source of data for the widget.

{
  "css_classes": null,
  "disabled": false,
  "height": null,
  "id": "a6c11679-82b2-41d3-b702-c063b3ccd648",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "sizing_mode": "fixed",
  "source": null,
  "subscribed_events": [],
  "tags": [],
  "width": null
}

class TextEditor(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellEditor

Multi-line string cell editor.

{
  "id": "21412849-7e03-4e7d-89f3-f7227acdfcaf",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class TimeEditor(**kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellEditor

Spinner-based time cell editor.

{
  "id": "2a9aaf96-cb54-4d84-9cde-815e982cf703",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}