Anaconda Enterprise: Documentation

# bokeh.models.widgets.inputs

Various kinds of input widgets and form controls.

class `bokeh.models.widgets.inputs.``AutocompleteInput`(**kwargs)

  Bases: `bokeh.models.widgets.inputs.TextInput`

  Single-line input widget with auto-completion.

  `completions`

    property type: `List` ( `String` )

    A list of completion strings. This will be used to guide the user upon typing the beginning of a desired value.

JSON Prototype

    {
      "callback": null,
      "completions": [],
      "css_classes": null,
      "disabled": false,
      "height": null,
      "id": "8b85c371-ffbd-4e78-b8ee-07d20a8c28a9",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "placeholder": "",
      "sizing_mode": "fixed",
      "subscribed_events": [],
      "tags": [],
      "title": "",
      "value": "",
      "width": null
    }

class `bokeh.models.widgets.inputs.``DatePicker`(**kwargs)

  Bases: `bokeh.models.widgets.inputs.InputWidget`

  Calendar-based date picker widget.

  `callback`

    property type: `Instance` ( `Callback` )

    A callback to run in the browser whenever the current date value changes.

  `max_date`

    property type: `Date`

    Optional latest allowable date.

  `min_date`

    property type: `Date`

    Optional earliest allowable date.

  `value`

    property type: `Date`

    The initial or picked date.

JSON Prototype

    {
      "callback": null,
      "css_classes": null,
      "disabled": false,
      "height": null,
      "id": "47d8e6fa-57a0-482a-9650-790e0975ebbf",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "max_date": null,
      "min_date": null,
      "name": null,
      "sizing_mode": "fixed",
      "subscribed_events": [],
      "tags": [],
      "title": "",
      "value": null,
      "width": null
    }

class `bokeh.models.widgets.inputs.``InputWidget`(**kwargs)

  Bases: `bokeh.models.widgets.widget.Widget`

  Abstract base class for input 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.

  `title`

    property type: `String`

    Widget’s label.

  classmethod `coerce_value`(val)

JSON Prototype

    {
      "css_classes": null,
      "disabled": false,
      "height": null,
      "id": "b1f3083a-5c9a-45ba-9473-243d285d6a1a",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "sizing_mode": "fixed",
      "subscribed_events": [],
      "tags": [],
      "title": "",
      "width": null
    }

class `bokeh.models.widgets.inputs.``MultiSelect`(**kwargs)

  Bases: `bokeh.models.widgets.inputs.InputWidget`

  Multi-select widget.

  `callback`

    property type: `Instance` ( `Callback` )

    A callback to run in the browser whenever the current selection value changes.

  `options`

    property type: `List` ( `Either` ( `String` , `Tuple` ( `String` , `String` ) ) )

    Available selection options. Options may be provided either as a list of possible string values, or as a list of tuples, each of the form `(value, label)`. In the latter case, the visible widget text for each value will be corresponding given label.

  `size`

    property type: `Int`

    The number of visible options in the dropdown list. (This uses the `select` HTML element’s `size` attribute. Some browsers might not show less than 3 options.)

  `value`

    property type: `List` ( `String` )

    Initial or selected values.

JSON Prototype

    {
      "callback": null,
      "css_classes": null,
      "disabled": false,
      "height": null,
      "id": "4c8aa516-0025-4402-97f8-8d58cebecc30",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "options": [],
      "size": 4,
      "sizing_mode": "fixed",
      "subscribed_events": [],
      "tags": [],
      "title": "",
      "value": [],
      "width": null
    }

class `bokeh.models.widgets.inputs.``PasswordInput`(**kwargs)

  Bases: `bokeh.models.widgets.inputs.TextInput`

  Single-line password input widget. Note: Despite PasswordInput inheriting from TextInput the password cannot be inspected on the field `value`. Also, note that this field functionally just hides the input on the browser, transmiting safely a password as a callback, e.g., to the a bokeh server would require some secure connection.

JSON Prototype

    {
      "callback": null,
      "css_classes": null,
      "disabled": false,
      "height": null,
      "id": "6ac96d62-960c-41b8-b9e4-1f3a4d2e402f",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "placeholder": "",
      "sizing_mode": "fixed",
      "subscribed_events": [],
      "tags": [],
      "title": "",
      "value": "",
      "width": null
    }

class `bokeh.models.widgets.inputs.``Select`(**kwargs)

  Bases: `bokeh.models.widgets.inputs.InputWidget`

  Single-select widget.

  `callback`

    property type: `Instance` ( `Callback` )

    A callback to run in the browser whenever the current Select dropdown value changes.

  `options`

    property type: `List` ( `Either` ( `String` , `Tuple` ( `String` , `String` ) ) )

    Available selection options. Options may be provided either as a list of possible string values, or as a list of tuples, each of the form `(value, label)`. In the latter case, the visible widget text for each value will be corresponding given label.

  `value`

    property type: `String`

    Initial or selected value.

JSON Prototype

    {
      "callback": null,
      "css_classes": null,
      "disabled": false,
      "height": null,
      "id": "bb8c4720-d828-4a9d-b265-e5ae0ec68839",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "options": [],
      "sizing_mode": "fixed",
      "subscribed_events": [],
      "tags": [],
      "title": "",
      "value": "",
      "width": null
    }

class `bokeh.models.widgets.inputs.``TextInput`(**kwargs)

  Bases: `bokeh.models.widgets.inputs.InputWidget`

  Single-line input widget.

  `callback`

    property type: `Instance` ( `Callback` )

    A callback to run in the browser whenever the user unfocuses the TextInput widget by hitting Enter or clicking outside of the text box area.

  `placeholder`

    property type: `String`

    Placeholder for empty input field

  `value`

    property type: `String`

    Initial or entered text value.

JSON Prototype

    {
      "callback": null,
      "css_classes": null,
      "disabled": false,
      "height": null,
      "id": "78652d21-36b0-4c5c-b3ff-9042c65ffd5b",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "placeholder": "",
      "sizing_mode": "fixed",
      "subscribed_events": [],
      "tags": [],
      "title": "",
      "value": "",
      "width": null
    }