bokeh.models.callbacks — Anaconda Enterprise 4.4 documentation

Anaconda Enterprise: Documentation

# bokeh.models.callbacks

Client-side interactivity.

class `bokeh.models.callbacks.` `Callback`(**kwargs)

  Bases: `bokeh.model.Model`

  Base class for interactive callback.

  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": "21cfeca6-658c-49d6-bb36-dfcf50736aaf",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.callbacks.` `CustomJS`(**kwargs)

  Bases: `bokeh.models.callbacks.Callback`

  Execute a JavaScript function.

  `args`

    property type: `Dict` ( `String` , `Instance` ( `Model` ) )

    A mapping of names to Bokeh plot objects. These objects are made available to the callback code snippet as the values of named parameters to the callback.

  `code`

    property type: `String`

    A snippet of JavaScript code to execute in the browser. The code is made into the body of a function, and all of of the named objects in `args` are available as parameters that the code can use. Additionally, a `cb_obj` parameter contains the object that triggered the callback and an optional `cb_data` parameter that contains any tool-specific data (i.e. mouse coordinates and hovered glyph indices for the HoverTool).

    Note

    Use `CustomJS.from_coffeescript()` for CoffeeScript source code.

  classmethod `from_coffeescript`(code, args={})

    Create a `CustomJS` instance from CoffeeScript code.

  classmethod `from_py_func`(func)

    Create a CustomJS instance from a Python function. The function is translated to JavaScript using PyScript.

JSON Prototype

    {
      "args": {},
      "code": "",
      "id": "9697c5d7-e1c8-4437-b2ed-faede5346871",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.callbacks.` `OpenURL`(**kwargs)

  Bases: `bokeh.models.callbacks.Callback`

  Open a URL in a new tab or window (browser dependent).

  `url`

    property type: `String`

    The URL to direct the web browser to. This can be a template string, which will be formatted with data from the data source.

JSON Prototype

    {
      "id": "3d7c8588-5146-4a6a-839a-9dfd8237fd06",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": [],
      "url": "http://"
    }