annotators Module¶

`annotators` Module¶

class holoviews.annotators.Annotator(object=None, **params)[source]¶

Bases: panel.pane.base.PaneBase

An Annotator allows drawing, editing and annotating a specific type of element. Each Annotator consists of the plot to draw and edit the element and the editor, which contains a list of tables, which make it possible to annotate each object in the element with additional properties defined in the annotations.

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, width, height, min_width, min_height, max_width, max_height, margin, width_policy, height_policy, sizing_mode

panel.pane.base.PaneBase: default_layout

object = param.ClassSelector(class_=<class ‘holoviews.core.element.Element’>): The Element to edit and annotate.
annotations = param.ClassSelector(class_=(<class ‘dict’>, <class ‘list’>), default=[]): Annotations to associate with each object.
default_opts = param.Dict(class_=<class ‘dict’>, default={‘responsive’: True, ‘min_height’: 400, ‘padding’: 0.1, ‘framewise’: True}): Opts to apply to the element.
empty_value = param.Parameter(): The value to insert on annotation columns when drawing a new element.
num_objects = param.Integer(bounds=(0, None), inclusive_bounds=(True, True)): The maximum number of objects to draw.
table_transforms = param.HookList(bounds=(0, None), default=[]): Transform(s) to apply to element when converting data to Table. The functions should accept the Annotator and the transformed element as input.
table_opts = param.Dict(class_=<class ‘dict’>, default={‘editable’: True, ‘width’: 400}): Opts to apply to the editor table(s).

add_periodic_callback(callback, period=500, count=None, timeout=None, start=True)¶

Schedules a periodic callback to be run at an interval set by the period. Returns a PeriodicCallback object with the option to stop and start the callback.

callback: callable: Callable function to be executed at periodic interval.
period: int: Interval in milliseconds at which callback will be executed.
count: int: Maximum number of times callback will be invoked.
timeout: int: Timeout in seconds when the callback should be stopped.
start: boolean (default=True): Whether to start callback immediately.

Return a PeriodicCallback object with start and stop methods.

app(notebook_url='localhost:8888', port=0)¶

Displays a bokeh server app inline in the notebook.

notebook_url: str: URL to the notebook server
port: int (optional, default=0): Allows specifying a specific port

classmethod applies(obj)[source]¶: Given the object return a boolean indicating whether the Pane can render the object. If the priority of the pane is set to None, this method may also be used to define a priority depending on the object being rendered.

clone(object=None, **params)¶

Makes a copy of the Pane sharing the same parameters.

params: Keyword arguments override the parameters on the clone.

Cloned Pane object

classmethod compose(*annotators)[source]¶

Composes multiple Annotator instances and elements

The composed Panel will contain all the elements in the supplied Annotators and Tabs containing all editors.

Args:: annotators: Annotator objects or elements to compose
Returns:: A new Panel consisting of the overlaid plots and tables

controls(parameters=[], jslink=True)¶

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.

A layout of the controls

default_layout¶: alias of panel.layout.base.Row

embed(max_states=1000, max_opts=3, json=False, json_prefix='', save_path='./', load_path=None, progress=False, states={})¶

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod get_pane_type(obj, **kwargs)¶

Returns the applicable Pane type given an object by resolving the precedence of all types whose applies method declares that the object is supported.

obj (object): The object type to return a Pane for

The applicable Pane type with the highest precedence.

get_root(doc=None, comm=None)¶

Returns the root model and applies pre-processing hooks

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook

Returns the bokeh model corresponding to this panel object

jscallback(args={}, **callbacks)¶

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

args: dict: A mapping of objects to make available to the JS callback
**callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

callback: Callback: The Callback which can be used to disable the callback.

jslink(target, code=None, args=None, bidirectional=False, **links)¶

Links properties on the source object to those on the target object in JS code. Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

target: HoloViews object or bokeh Model or panel Viewable: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
bidirectional: boolean: Whether to link source and target bi-directionally
**links: dict: A mapping between properties on the source model and the target model property to link it to.

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target, callbacks=None, bidirectional=False, **links)¶

Links the parameters on this object to attributes on another object in Python. Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

target: object: The target object of the link.
callbacks: dict: Maps from a parameter in the source object to a callback.
bidirectional: boolean: Whether to link source and target bi-directionally
**links: dict: Maps between parameters on this object to the parameters on the supplied object.

pprint()¶: Prints a compositional repr of the class.

save(filename, title=None, resources=None, template=None, template_variables=None, embed=False, max_states=1000, max_opts=3, embed_json=False, json_prefix='', save_path='./', load_path=None, embed_states={})¶

Saves Panel objects to file.

filename: string or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget

select(selector=None)[source]¶

Iterates over the Viewable and any potential children in the applying the Selector.

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

viewables: list(Viewable)

servable(title=None, location=True)¶

Serves the object if in a panel serve context and returns the Panel object to allow it to display itself in a notebook context. Arguments ——— title : str

A string title to give the Document (if served as an app)

locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

The Panel object itself

server_doc(doc=None, title=None, location=True)¶

Returns a serveable bokeh Document with the panel attached

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

docbokeh.Document: The bokeh document the panel was attached to

show(title=None, port=0, address=None, websocket_origin=None, threaded=False, verbose=True, open=True, location=True, **kwargs)¶

Starts a Bokeh server and displays the Viewable in a new tab.

titlestr: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

server: bokeh.server.Server or threading.Thread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

holoviews.annotators.BoxAnnotator¶: alias of holoviews.annotators.RectangleAnnotator

class holoviews.annotators.CurveAnnotator(object=None, **params)[source]¶

Bases: holoviews.annotators._GeomAnnotator

Annotator which allows editing a Curve element and associating values with each vertex using a Table.

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, width, height, min_width, min_height, max_width, max_height, margin, width_policy, height_policy, sizing_mode

panel.pane.base.PaneBase: default_layout

holoviews.annotators.Annotator: annotations, empty_value, num_objects, table_transforms, table_opts

object = param.ClassSelector(class_=<class ‘holoviews.element.chart.Curve’>): Points element to edit and annotate.
default_opts = param.Dict(class_=<class ‘dict’>, default={‘responsive’: True, ‘min_height’: 400, ‘padding’: 0.1, ‘framewise’: True}): Opts to apply to the element.
vertex_style = param.Dict(class_=<class ‘dict’>, default={‘size’: 10}): Options to apply to vertices during drawing and editing.

add_periodic_callback(callback, period=500, count=None, timeout=None, start=True)¶

Schedules a periodic callback to be run at an interval set by the period. Returns a PeriodicCallback object with the option to stop and start the callback.

callback: callable: Callable function to be executed at periodic interval.
period: int: Interval in milliseconds at which callback will be executed.
count: int: Maximum number of times callback will be invoked.
timeout: int: Timeout in seconds when the callback should be stopped.
start: boolean (default=True): Whether to start callback immediately.

Return a PeriodicCallback object with start and stop methods.

app(notebook_url='localhost:8888', port=0)¶

Displays a bokeh server app inline in the notebook.

notebook_url: str: URL to the notebook server
port: int (optional, default=0): Allows specifying a specific port

classmethod applies(obj)¶: Given the object return a boolean indicating whether the Pane can render the object. If the priority of the pane is set to None, this method may also be used to define a priority depending on the object being rendered.

clone(object=None, **params)¶

Makes a copy of the Pane sharing the same parameters.

params: Keyword arguments override the parameters on the clone.

Cloned Pane object

classmethod compose(*annotators)¶

Composes multiple Annotator instances and elements

The composed Panel will contain all the elements in the supplied Annotators and Tabs containing all editors.

Args:: annotators: Annotator objects or elements to compose
Returns:: A new Panel consisting of the overlaid plots and tables

controls(parameters=[], jslink=True)¶

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.

A layout of the controls

default_layout¶: alias of panel.layout.base.Row

embed(max_states=1000, max_opts=3, json=False, json_prefix='', save_path='./', load_path=None, progress=False, states={})¶

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod get_pane_type(obj, **kwargs)¶

Returns the applicable Pane type given an object by resolving the precedence of all types whose applies method declares that the object is supported.

obj (object): The object type to return a Pane for

The applicable Pane type with the highest precedence.

get_root(doc=None, comm=None)¶

Returns the root model and applies pre-processing hooks

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook

Returns the bokeh model corresponding to this panel object

jscallback(args={}, **callbacks)¶

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

args: dict: A mapping of objects to make available to the JS callback
**callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

callback: Callback: The Callback which can be used to disable the callback.

jslink(target, code=None, args=None, bidirectional=False, **links)¶

target: HoloViews object or bokeh Model or panel Viewable: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
bidirectional: boolean: Whether to link source and target bi-directionally
**links: dict: A mapping between properties on the source model and the target model property to link it to.

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target, callbacks=None, bidirectional=False, **links)¶

target: object: The target object of the link.
callbacks: dict: Maps from a parameter in the source object to a callback.
bidirectional: boolean: Whether to link source and target bi-directionally
**links: dict: Maps between parameters on this object to the parameters on the supplied object.

pprint()¶: Prints a compositional repr of the class.

Saves Panel objects to file.

filename: string or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget

select(selector=None)¶

Iterates over the Viewable and any potential children in the applying the Selector.

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

viewables: list(Viewable)

servable(title=None, location=True)¶

Serves the object if in a panel serve context and returns the Panel object to allow it to display itself in a notebook context. Arguments ——— title : str

A string title to give the Document (if served as an app)

locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

The Panel object itself

server_doc(doc=None, title=None, location=True)¶

Returns a serveable bokeh Document with the panel attached

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

docbokeh.Document: The bokeh document the panel was attached to

show(title=None, port=0, address=None, websocket_origin=None, threaded=False, verbose=True, open=True, location=True, **kwargs)¶

Starts a Bokeh server and displays the Viewable in a new tab.

titlestr: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

server: bokeh.server.Server or threading.Thread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class holoviews.annotators.PathAnnotator(object=None, **params)[source]¶

Bases: holoviews.annotators.Annotator

Annotator which allows drawing and editing Paths and associating values with each path and each vertex of a path using a table.

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, width, height, min_width, min_height, max_width, max_height, margin, width_policy, height_policy, sizing_mode

panel.pane.base.PaneBase: default_layout

holoviews.annotators.Annotator: annotations, default_opts, empty_value, num_objects, table_transforms, table_opts

object = param.ClassSelector(class_=<class ‘holoviews.element.path.Path’>): Path object to edit and annotate.
edit_vertices = param.Boolean(bounds=(0, 1), default=True): Whether to add tool to edit vertices.
show_vertices = param.Boolean(bounds=(0, 1), default=True): Whether to show vertices when drawing the Path.
vertex_annotations = param.ClassSelector(class_=(<class ‘dict’>, <class ‘list’>), default=[]): Columns to annotate the Polygons with.
vertex_style = param.Dict(class_=<class ‘dict’>, default={‘nonselection_alpha’: 0.5}): Options to apply to vertices during drawing and editing.

add_periodic_callback(callback, period=500, count=None, timeout=None, start=True)¶

Schedules a periodic callback to be run at an interval set by the period. Returns a PeriodicCallback object with the option to stop and start the callback.

callback: callable: Callable function to be executed at periodic interval.
period: int: Interval in milliseconds at which callback will be executed.
count: int: Maximum number of times callback will be invoked.
timeout: int: Timeout in seconds when the callback should be stopped.
start: boolean (default=True): Whether to start callback immediately.

Return a PeriodicCallback object with start and stop methods.

app(notebook_url='localhost:8888', port=0)¶

Displays a bokeh server app inline in the notebook.

notebook_url: str: URL to the notebook server
port: int (optional, default=0): Allows specifying a specific port

classmethod applies(obj)¶: Given the object return a boolean indicating whether the Pane can render the object. If the priority of the pane is set to None, this method may also be used to define a priority depending on the object being rendered.

clone(object=None, **params)¶

Makes a copy of the Pane sharing the same parameters.

params: Keyword arguments override the parameters on the clone.

Cloned Pane object

classmethod compose(*annotators)¶

Composes multiple Annotator instances and elements

The composed Panel will contain all the elements in the supplied Annotators and Tabs containing all editors.

Args:: annotators: Annotator objects or elements to compose
Returns:: A new Panel consisting of the overlaid plots and tables

controls(parameters=[], jslink=True)¶

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.

A layout of the controls

default_layout¶: alias of panel.layout.base.Row

embed(max_states=1000, max_opts=3, json=False, json_prefix='', save_path='./', load_path=None, progress=False, states={})¶

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod get_pane_type(obj, **kwargs)¶

Returns the applicable Pane type given an object by resolving the precedence of all types whose applies method declares that the object is supported.

obj (object): The object type to return a Pane for

The applicable Pane type with the highest precedence.

get_root(doc=None, comm=None)¶

Returns the root model and applies pre-processing hooks

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook

Returns the bokeh model corresponding to this panel object

jscallback(args={}, **callbacks)¶

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

args: dict: A mapping of objects to make available to the JS callback
**callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

callback: Callback: The Callback which can be used to disable the callback.

jslink(target, code=None, args=None, bidirectional=False, **links)¶

target: HoloViews object or bokeh Model or panel Viewable: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
bidirectional: boolean: Whether to link source and target bi-directionally
**links: dict: A mapping between properties on the source model and the target model property to link it to.

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target, callbacks=None, bidirectional=False, **links)¶

target: object: The target object of the link.
callbacks: dict: Maps from a parameter in the source object to a callback.
bidirectional: boolean: Whether to link source and target bi-directionally
**links: dict: Maps between parameters on this object to the parameters on the supplied object.

pprint()¶: Prints a compositional repr of the class.

Saves Panel objects to file.

filename: string or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget

select(selector=None)¶

Iterates over the Viewable and any potential children in the applying the Selector.

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

viewables: list(Viewable)

servable(title=None, location=True)¶

Serves the object if in a panel serve context and returns the Panel object to allow it to display itself in a notebook context. Arguments ——— title : str

A string title to give the Document (if served as an app)

locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

The Panel object itself

server_doc(doc=None, title=None, location=True)¶

Returns a serveable bokeh Document with the panel attached

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

docbokeh.Document: The bokeh document the panel was attached to

show(title=None, port=0, address=None, websocket_origin=None, threaded=False, verbose=True, open=True, location=True, **kwargs)¶

Starts a Bokeh server and displays the Viewable in a new tab.

titlestr: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

server: bokeh.server.Server or threading.Thread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class holoviews.annotators.PointAnnotator(object=None, **params)[source]¶

Bases: holoviews.annotators._GeomAnnotator

Annotator which allows drawing and editing Points and associating values with each point using a table.

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, width, height, min_width, min_height, max_width, max_height, margin, width_policy, height_policy, sizing_mode

panel.pane.base.PaneBase: default_layout

holoviews.annotators.Annotator: annotations, empty_value, num_objects, table_transforms, table_opts

object = param.ClassSelector(class_=<class ‘holoviews.element.geom.Points’>): Points element to edit and annotate.
default_opts = param.Dict(class_=<class ‘dict’>, default={‘responsive’: True, ‘min_height’: 400, ‘padding’: 0.1, ‘size’: 10, ‘framewise’: True}): Opts to apply to the element.

add_periodic_callback(callback, period=500, count=None, timeout=None, start=True)¶

Schedules a periodic callback to be run at an interval set by the period. Returns a PeriodicCallback object with the option to stop and start the callback.

callback: callable: Callable function to be executed at periodic interval.
period: int: Interval in milliseconds at which callback will be executed.
count: int: Maximum number of times callback will be invoked.
timeout: int: Timeout in seconds when the callback should be stopped.
start: boolean (default=True): Whether to start callback immediately.

Return a PeriodicCallback object with start and stop methods.

app(notebook_url='localhost:8888', port=0)¶

Displays a bokeh server app inline in the notebook.

notebook_url: str: URL to the notebook server
port: int (optional, default=0): Allows specifying a specific port

classmethod applies(obj)¶: Given the object return a boolean indicating whether the Pane can render the object. If the priority of the pane is set to None, this method may also be used to define a priority depending on the object being rendered.

clone(object=None, **params)¶

Makes a copy of the Pane sharing the same parameters.

params: Keyword arguments override the parameters on the clone.

Cloned Pane object

classmethod compose(*annotators)¶

Composes multiple Annotator instances and elements

The composed Panel will contain all the elements in the supplied Annotators and Tabs containing all editors.

Args:: annotators: Annotator objects or elements to compose
Returns:: A new Panel consisting of the overlaid plots and tables

controls(parameters=[], jslink=True)¶

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.

A layout of the controls

default_layout¶: alias of panel.layout.base.Row

embed(max_states=1000, max_opts=3, json=False, json_prefix='', save_path='./', load_path=None, progress=False, states={})¶

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod get_pane_type(obj, **kwargs)¶

Returns the applicable Pane type given an object by resolving the precedence of all types whose applies method declares that the object is supported.

obj (object): The object type to return a Pane for

The applicable Pane type with the highest precedence.

get_root(doc=None, comm=None)¶

Returns the root model and applies pre-processing hooks

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook

Returns the bokeh model corresponding to this panel object

jscallback(args={}, **callbacks)¶

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

args: dict: A mapping of objects to make available to the JS callback
**callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

callback: Callback: The Callback which can be used to disable the callback.

jslink(target, code=None, args=None, bidirectional=False, **links)¶

target: HoloViews object or bokeh Model or panel Viewable: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
bidirectional: boolean: Whether to link source and target bi-directionally
**links: dict: A mapping between properties on the source model and the target model property to link it to.

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target, callbacks=None, bidirectional=False, **links)¶

target: object: The target object of the link.
callbacks: dict: Maps from a parameter in the source object to a callback.
bidirectional: boolean: Whether to link source and target bi-directionally
**links: dict: Maps between parameters on this object to the parameters on the supplied object.

pprint()¶: Prints a compositional repr of the class.

Saves Panel objects to file.

filename: string or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget

select(selector=None)¶

Iterates over the Viewable and any potential children in the applying the Selector.

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

viewables: list(Viewable)

servable(title=None, location=True)¶

Serves the object if in a panel serve context and returns the Panel object to allow it to display itself in a notebook context. Arguments ——— title : str

A string title to give the Document (if served as an app)

locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

The Panel object itself

server_doc(doc=None, title=None, location=True)¶

Returns a serveable bokeh Document with the panel attached

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

docbokeh.Document: The bokeh document the panel was attached to

show(title=None, port=0, address=None, websocket_origin=None, threaded=False, verbose=True, open=True, location=True, **kwargs)¶

Starts a Bokeh server and displays the Viewable in a new tab.

titlestr: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

server: bokeh.server.Server or threading.Thread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class holoviews.annotators.PolyAnnotator(object=None, **params)[source]¶

Bases: holoviews.annotators.PathAnnotator

Annotator which allows drawing and editing Polygons and associating values with each polygon and each vertex of a Polygon using a table.

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, width, height, min_width, min_height, max_width, max_height, margin, width_policy, height_policy, sizing_mode

panel.pane.base.PaneBase: default_layout

holoviews.annotators.Annotator: annotations, default_opts, empty_value, num_objects, table_transforms, table_opts

holoviews.annotators.PathAnnotator: edit_vertices, show_vertices, vertex_annotations, vertex_style

object = param.ClassSelector(class_=<class ‘holoviews.element.path.Polygons’>): Polygon element to edit and annotate.

add_periodic_callback(callback, period=500, count=None, timeout=None, start=True)¶

Schedules a periodic callback to be run at an interval set by the period. Returns a PeriodicCallback object with the option to stop and start the callback.

callback: callable: Callable function to be executed at periodic interval.
period: int: Interval in milliseconds at which callback will be executed.
count: int: Maximum number of times callback will be invoked.
timeout: int: Timeout in seconds when the callback should be stopped.
start: boolean (default=True): Whether to start callback immediately.

Return a PeriodicCallback object with start and stop methods.

app(notebook_url='localhost:8888', port=0)¶

Displays a bokeh server app inline in the notebook.

notebook_url: str: URL to the notebook server
port: int (optional, default=0): Allows specifying a specific port

classmethod applies(obj)¶: Given the object return a boolean indicating whether the Pane can render the object. If the priority of the pane is set to None, this method may also be used to define a priority depending on the object being rendered.

clone(object=None, **params)¶

Makes a copy of the Pane sharing the same parameters.

params: Keyword arguments override the parameters on the clone.

Cloned Pane object

classmethod compose(*annotators)¶

Composes multiple Annotator instances and elements

The composed Panel will contain all the elements in the supplied Annotators and Tabs containing all editors.

Args:: annotators: Annotator objects or elements to compose
Returns:: A new Panel consisting of the overlaid plots and tables

controls(parameters=[], jslink=True)¶

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.

A layout of the controls

default_layout¶: alias of panel.layout.base.Row

embed(max_states=1000, max_opts=3, json=False, json_prefix='', save_path='./', load_path=None, progress=False, states={})¶

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod get_pane_type(obj, **kwargs)¶

Returns the applicable Pane type given an object by resolving the precedence of all types whose applies method declares that the object is supported.

obj (object): The object type to return a Pane for

The applicable Pane type with the highest precedence.

get_root(doc=None, comm=None)¶

Returns the root model and applies pre-processing hooks

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook

Returns the bokeh model corresponding to this panel object

jscallback(args={}, **callbacks)¶

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

args: dict: A mapping of objects to make available to the JS callback
**callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

callback: Callback: The Callback which can be used to disable the callback.

jslink(target, code=None, args=None, bidirectional=False, **links)¶

target: HoloViews object or bokeh Model or panel Viewable: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
bidirectional: boolean: Whether to link source and target bi-directionally
**links: dict: A mapping between properties on the source model and the target model property to link it to.

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target, callbacks=None, bidirectional=False, **links)¶

target: object: The target object of the link.
callbacks: dict: Maps from a parameter in the source object to a callback.
bidirectional: boolean: Whether to link source and target bi-directionally
**links: dict: Maps between parameters on this object to the parameters on the supplied object.

pprint()¶: Prints a compositional repr of the class.

Saves Panel objects to file.

filename: string or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget

select(selector=None)¶

Iterates over the Viewable and any potential children in the applying the Selector.

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

viewables: list(Viewable)

servable(title=None, location=True)¶

Serves the object if in a panel serve context and returns the Panel object to allow it to display itself in a notebook context. Arguments ——— title : str

A string title to give the Document (if served as an app)

locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

The Panel object itself

server_doc(doc=None, title=None, location=True)¶

Returns a serveable bokeh Document with the panel attached

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

docbokeh.Document: The bokeh document the panel was attached to

show(title=None, port=0, address=None, websocket_origin=None, threaded=False, verbose=True, open=True, location=True, **kwargs)¶

Starts a Bokeh server and displays the Viewable in a new tab.

titlestr: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

server: bokeh.server.Server or threading.Thread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class holoviews.annotators.RectangleAnnotator(object=None, **params)[source]¶

Bases: holoviews.annotators._GeomAnnotator

Annotator which allows drawing and editing Rectangles and associating values with each point using a table.

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, width, height, min_width, min_height, max_width, max_height, margin, width_policy, height_policy, sizing_mode

panel.pane.base.PaneBase: default_layout

holoviews.annotators.Annotator: annotations, empty_value, num_objects, table_transforms, table_opts

holoviews.annotators._GeomAnnotator: default_opts

object = param.ClassSelector(class_=<class ‘holoviews.element.geom.Rectangles’>): Points element to edit and annotate.

add_periodic_callback(callback, period=500, count=None, timeout=None, start=True)¶

Schedules a periodic callback to be run at an interval set by the period. Returns a PeriodicCallback object with the option to stop and start the callback.

callback: callable: Callable function to be executed at periodic interval.
period: int: Interval in milliseconds at which callback will be executed.
count: int: Maximum number of times callback will be invoked.
timeout: int: Timeout in seconds when the callback should be stopped.
start: boolean (default=True): Whether to start callback immediately.

Return a PeriodicCallback object with start and stop methods.

app(notebook_url='localhost:8888', port=0)¶

Displays a bokeh server app inline in the notebook.

notebook_url: str: URL to the notebook server
port: int (optional, default=0): Allows specifying a specific port

classmethod applies(obj)¶: Given the object return a boolean indicating whether the Pane can render the object. If the priority of the pane is set to None, this method may also be used to define a priority depending on the object being rendered.

clone(object=None, **params)¶

Makes a copy of the Pane sharing the same parameters.

params: Keyword arguments override the parameters on the clone.

Cloned Pane object

classmethod compose(*annotators)¶

Composes multiple Annotator instances and elements

The composed Panel will contain all the elements in the supplied Annotators and Tabs containing all editors.

Args:: annotators: Annotator objects or elements to compose
Returns:: A new Panel consisting of the overlaid plots and tables

controls(parameters=[], jslink=True)¶

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.

A layout of the controls

default_layout¶: alias of panel.layout.base.Row

embed(max_states=1000, max_opts=3, json=False, json_prefix='', save_path='./', load_path=None, progress=False, states={})¶

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod get_pane_type(obj, **kwargs)¶

Returns the applicable Pane type given an object by resolving the precedence of all types whose applies method declares that the object is supported.

obj (object): The object type to return a Pane for

The applicable Pane type with the highest precedence.

get_root(doc=None, comm=None)¶

Returns the root model and applies pre-processing hooks

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook

Returns the bokeh model corresponding to this panel object

jscallback(args={}, **callbacks)¶

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

args: dict: A mapping of objects to make available to the JS callback
**callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

callback: Callback: The Callback which can be used to disable the callback.

jslink(target, code=None, args=None, bidirectional=False, **links)¶

target: HoloViews object or bokeh Model or panel Viewable: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
bidirectional: boolean: Whether to link source and target bi-directionally
**links: dict: A mapping between properties on the source model and the target model property to link it to.

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target, callbacks=None, bidirectional=False, **links)¶

target: object: The target object of the link.
callbacks: dict: Maps from a parameter in the source object to a callback.
bidirectional: boolean: Whether to link source and target bi-directionally
**links: dict: Maps between parameters on this object to the parameters on the supplied object.

pprint()¶: Prints a compositional repr of the class.

Saves Panel objects to file.

filename: string or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget

select(selector=None)¶

Iterates over the Viewable and any potential children in the applying the Selector.

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

viewables: list(Viewable)

servable(title=None, location=True)¶

Serves the object if in a panel serve context and returns the Panel object to allow it to display itself in a notebook context. Arguments ——— title : str

A string title to give the Document (if served as an app)

locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

The Panel object itself

server_doc(doc=None, title=None, location=True)¶

Returns a serveable bokeh Document with the panel attached

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

docbokeh.Document: The bokeh document the panel was attached to

show(title=None, port=0, address=None, websocket_origin=None, threaded=False, verbose=True, open=True, location=True, **kwargs)¶

Starts a Bokeh server and displays the Viewable in a new tab.

titlestr: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

server: bokeh.server.Server or threading.Thread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class holoviews.annotators.annotate(*args, **params)[source]¶

Bases: param.parameterized.ParameterizedFunction

The annotate function allows drawing, editing and annotating any given Element (if it is supported). The annotate function returns a Layout of the editable plot and an Overlay of table(s), which allow editing the data of the element. The edited and annotated data may be accessed using the element and selected properties.

annotator = param.Parameter(): The current Annotator instance.
annotations = param.ClassSelector(class_=(<class ‘dict’>, <class ‘list’>), default=[]): Annotations to associate with each object.
edit_vertices = param.Boolean(bounds=(0, 1), default=True): Whether to add tool to edit vertices.
empty_value = param.Parameter(): The value to insert on annotation columns when drawing a new element.
num_objects = param.Integer(bounds=(0, None), inclusive_bounds=(True, True)): The maximum number of objects to draw.
show_vertices = param.Boolean(bounds=(0, 1), default=True): Whether to show vertices when drawing the Path.
table_transforms = param.HookList(bounds=(0, None), default=[]): Transform(s) to apply to element when converting data to Table. The functions should accept the Annotator and the transformed element as input.
table_opts = param.Dict(class_=<class ‘dict’>, default={‘editable’: True, ‘width’: 400}): Opts to apply to the editor table(s).
vertex_annotations = param.ClassSelector(class_=(<class ‘dict’>, <class ‘list’>), default=[]): Columns to annotate the Polygons with.
vertex_style = param.Dict(class_=<class ‘dict’>, default={‘nonselection_alpha’: 0.5}): Options to apply to vertices during drawing and editing.

classmethod compose(*annotators)[source]¶

Composes multiple annotator layouts and elements

The composed Layout will contain all the elements in the supplied annotators and an overlay of all editor tables.

Args:: annotators: Annotator layouts or elements to compose
Returns:: A new layout consisting of the overlaid plots and tables

instance(**params)¶: Return an instance of this class, copying parameters from any existing instance provided.

pprint(imports=None, prefix='\n ', unknown_value='<?>', qualify=False, separator='')¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

script_repr(imports=[], prefix=' ')¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

holoviews.annotators.preprocess(function, current=[])[source]¶: Turns a param.depends watch call into a preprocessor method, i.e. skips all downstream events triggered by it. NOTE: This is a temporary hack while the addition of preprocessors

in param is under discussion. This only works for the first method which depends on a particular parameter. (see https://github.com/pyviz/param/issues/332)