Anaconda Enterprise: Documentation

# bokeh.models.widgets.tables

Various kinds of data table (data grid) widgets.

class `bokeh.models.widgets.tables.``BooleanFormatter`(**kwargs)

  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.

JSON Prototype

    {
      "icon": "check",
      "id": "7585f8ee-67ce-429e-a339-5f891d228375",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.widgets.tables.``CellEditor`(**kwargs)

  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.

JSON Prototype

    {
      "id": "26ad44b5-b272-4fdb-b152-a38be14daeb5",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.widgets.tables.``CellFormatter`(**kwargs)

  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.

JSON Prototype

    {
      "id": "2652ebbd-14eb-4868-a0d6-83ed4576c669",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.widgets.tables.``CheckboxEditor`(**kwargs)

  Bases: `bokeh.models.widgets.tables.CellEditor`

  Boolean value cell editor.

JSON Prototype

    {
      "id": "53afc24d-416c-4217-a059-318bd8d142da",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.widgets.tables.``DataTable`(**kw)

  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.

  `reorderable`

    property type: `Bool`

    Allows the reordering of a tables’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_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.

JSON Prototype

    {
      "columns": [],
      "css_classes": null,
      "disabled": false,
      "editable": false,
      "fit_columns": true,
      "height": 400,
      "id": "631f106d-9a11-4c05-960b-0e346eb9979b",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "reorderable": true,
      "row_headers": true,
      "scroll_to_selection": true,
      "selectable": true,
      "sizing_mode": "fixed",
      "sortable": true,
      "source": null,
      "subscribed_events": [],
      "tags": [],
      "view": {
        "id": "84eb5317-8c4e-41c9-ba66-ca78cd425a11",
        "type": "CDSView"
      },
      "width": null
    }

class `bokeh.models.widgets.tables.``DateEditor`(**kwargs)

  Bases: `bokeh.models.widgets.tables.CellEditor`

  Calendar-based date cell editor.

JSON Prototype

    {
      "id": "75c30f69-eba7-4fcf-af45-c38aad24cc3c",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.widgets.tables.``DateFormatter`(**kwargs)

  Bases: `bokeh.models.widgets.tables.CellFormatter`

  Date cell formatter.

  `format`

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

    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` | `"%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` | `"%a, %e %b %Y"` | Sat, 1 Mar 2014
    `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.

    %a
      The abbreviated name of the day of the week according to the current locale.
    %A
      The full name of the day of the week according to the current locale.
    %b
      The abbreviated month name according to the current locale.
    %B
      The full month name according to the current locale.
    %c
      The preferred date and time representation for the current locale.
    %C
      The century number (year/100) as a 2-digit integer.
    %d
      The day of the month as a decimal number (range 01 to 31).
    %D
      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.)
    %e
      Like %d, the day of the month as a decimal number, but a leading zero is replaced by a space.
    %f
      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.
    %F
      Equivalent to %Y-%m-%d (the ISO 8601 date format).
    %G
      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.
    %g
      Like %G, but without century, that is, with a 2-digit year (00-99).
    %h
      Equivalent to %b.
    %H
      The hour as a decimal number using a 24-hour clock (range 00 to 23).
    %I
      The hour as a decimal number using a 12-hour clock (range 01 to 12).
    %j
      The day of the year as a decimal number (range 001 to 366).
    %k
      The hour (24-hour clock) as a decimal number (range 0 to 23). Single digits are preceded by a blank. (See also %H.)
    %l
      The hour (12-hour clock) as a decimal number (range 1 to 12). Single digits are preceded by a blank. (See also %I.) (TZ)
    %m
      The month as a decimal number (range 01 to 12).
    %M
      The minute as a decimal number (range 00 to 59).
    %n
      A newline character. Bokeh text does not currently support newline characters.
    %N
      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.
    %p
      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”.
    %P
      Like %p but in lowercase: “am” or “pm” or a corresponding string for the current locale.
    %r
      The time in a.m. or p.m. notation. In the POSIX locale this is equivalent to %I:%M:%S %p.
    %R
      The time in 24-hour notation (%H:%M). For a version including the seconds, see %T below.
    %s
      The number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC).
    %S
      The second as a decimal number (range 00 to 60). (The range is up to 60 to allow for occasional leap seconds.)
    %t
      A tab character. Bokeh text does not currently support tab characters.
    %T
      The time in 24-hour notation (%H:%M:%S).
    %u
      The day of the week as a decimal, range 1 to 7, Monday being 1. See also %w.
    %U
      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.
    %V
      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.
    %w
      The day of the week as a decimal, range 0 to 6, Sunday being 0. See also %u.
    %W
      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.
    %x
      The preferred date representation for the current locale without the time.
    %X
      The preferred time representation for the current locale without the date.
    %y
      The year as a decimal number without a century (range 00 to 99).
    %Y
      The year as a decimal number including the century.
    %z
      The +hhmm or -hhmm numeric timezone (that is, the hour and minute offset from UTC).
    %Z
      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.

JSON Prototype

    {
      "format": "ISO-8601",
      "id": "5253fb9a-b1f7-474d-bcfa-3dc017fa9195",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.widgets.tables.``HTMLTemplateFormatter`(**kwargs)

  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.

JSON Prototype

    {
      "id": "14e40dd8-ea6b-4bad-b06b-db8a0e8ea618",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": [],
      "template": "<%= value %>"
    }

class `bokeh.models.widgets.tables.``IntEditor`(**kwargs)

  Bases: `bokeh.models.widgets.tables.CellEditor`

  Spinner-based integer cell editor.

  `step`

    property type: `Int`

    The major step value.

JSON Prototype

    {
      "id": "84a610f9-4622-4e35-a8de-ffff2acae738",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "step": 1,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.widgets.tables.``NumberEditor`(**kwargs)

  Bases: `bokeh.models.widgets.tables.CellEditor`

  Spinner-based number cell editor.

  `step`

    property type: `Float`

    The major step value.

JSON Prototype

    {
      "id": "7a609faf-8b19-4e15-82f7-ee3058eeaefb",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "step": 0.01,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.widgets.tables.``NumberFormatter`(**kwargs)

  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).

JSON Prototype

    {
      "font_style": "normal",
      "format": "0,0",
      "id": "6c685ae8-6ac4-42c3-ae3e-1d796296d001",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "language": "en",
      "name": null,
      "rounding": "round",
      "subscribed_events": [],
      "tags": [],
      "text_align": "left",
      "text_color": null
    }

class `bokeh.models.widgets.tables.``PercentEditor`(**kwargs)

  Bases: `bokeh.models.widgets.tables.CellEditor`

  `IntEditor` optimized for editing percentages.

JSON Prototype

    {
      "id": "581ef611-d3ec-43c0-9239-1f1692b9d5be",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.widgets.tables.``SelectEditor`(**kwargs)

  Bases: `bokeh.models.widgets.tables.CellEditor`

  Select cell editor.

  `options`

    property type: `List` ( `String` )

    The list of options to select from.

JSON Prototype

    {
      "id": "c98a4ca0-8d37-415c-b9ca-9778b61c1b47",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "options": [],
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.widgets.tables.``StringEditor`(**kwargs)

  Bases: `bokeh.models.widgets.tables.CellEditor`

  Basic string cell editor with auto-completion.

  `completions`

    property type: `List` ( `String` )

    An optional list of completion strings.

JSON Prototype

    {
      "completions": [],
      "id": "5072d9bd-6824-4bcb-8bfa-f96692d61216",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.widgets.tables.``StringFormatter`(**kwargs)

  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.

JSON Prototype

    {
      "font_style": "normal",
      "id": "5ce1b8fc-145a-4243-9dd7-d93780203ee7",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": [],
      "text_align": "left",
      "text_color": null
    }

class `bokeh.models.widgets.tables.``TableColumn`(**kwargs)

  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.

JSON Prototype

    {
      "default_sort": "ascending",
      "editor": {
        "id": "abbdbf95-3f64-411a-9da9-5fa07f421727",
        "type": "StringEditor"
      },
      "field": null,
      "formatter": {
        "id": "d35a2dee-08bc-4b08-9bb9-9b9c38eeebc2",
        "type": "StringFormatter"
      },
      "id": "0103389c-d9f0-46c7-b646-79481522816c",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "sortable": true,
      "subscribed_events": [],
      "tags": [],
      "title": null,
      "width": 300
    }

class `bokeh.models.widgets.tables.``TableWidget`(**kw)

  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.

  `view`

    property type: `Instance` ( `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.

JSON Prototype

    {
      "css_classes": null,
      "disabled": false,
      "height": null,
      "id": "85a64ebf-bf89-4a7f-a15f-fba423baf79a",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "sizing_mode": "fixed",
      "source": null,
      "subscribed_events": [],
      "tags": [],
      "view": {
        "id": "b56ecbf7-db8d-4cf3-9dbe-b431fe1ccab9",
        "type": "CDSView"
      },
      "width": null
    }

class `bokeh.models.widgets.tables.``TextEditor`(**kwargs)

  Bases: `bokeh.models.widgets.tables.CellEditor`

  Multi-line string cell editor.

JSON Prototype

    {
      "id": "145234fa-458c-4dc4-8333-00ac512e5e89",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.widgets.tables.``TimeEditor`(**kwargs)

  Bases: `bokeh.models.widgets.tables.CellEditor`

  Spinner-based time cell editor.

JSON Prototype

    {
      "id": "9dd53692-bbad-4e26-82b7-732d0a78177a",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }