panel.widgets Package

---

widgets Package

Panel widgets makes your data exploration and apps interactive

Panel provides a long range of basic and specialized widgets.

Check out the widget gallery https://panel.holoviz.org/reference/index.html#widgets for inspiration.

How to use Panel widgets in 4 simple steps

1. Define your function

>>> def my_func(value1, value2):
...    ...
...    return some_python_object

2. Define your widgets

>>> widget1 = pn.widgets.SomeWidget(value=..., ...).servable(area='sidebar')
>>> widget2 = pn.widgets.AnotherWidget(value=..., ...).servable(area='sidebar')

3. Bind the function to your widgets

>>> interactive_func = pn.bind(my_func, value1=widget1, value2=widget2)

4. Layout your interactive function in a panel, Column, Row or similar

>>> pn.panel(interactive_func).servable()

For more detail see the Getting Started Guide https://panel.holoviz.org/getting_started/index.html

class panel.widgets.Ace(**params)

Bases: CodeEditor

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, width, disabled

panel.widgets.codeeditor.CodeEditor: annotations, filename, language, print_margin, readonly, theme, value

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.ArrayInput(**params)

Bases: LiteralInput

The ArrayInput allows rendering and editing NumPy arrays in a text input widget.

Arrays larger than the max_array_size will be summarized and editing will be disabled.

Reference: https://panel.holoviz.org/reference/widgets/ArrayInput.html

Example:

>>> To be determined ...

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, disabled

panel.widgets.input.LiteralInput: width, description, placeholder, serializer, type, value

max_array_size = param.Number(default=1000, inclusive_bounds=(True, True), label=’Max array size’)

Arrays larger than this limit will be allowed in Python but will not be serialized into JavaScript. Although such large arrays will thus not be editable in the widget, such a restriction helps avoid overwhelming the browser and lets other widgets remain usable.

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.AutocompleteInput(**params)

Bases: Widget

The MultiChoice widget allows selecting multiple values from a list of options.

It falls into the broad category of multi-value, option-selection widgets that provide a compatible API and include the MultiSelect, CrossSelector, CheckBoxGroup and CheckButtonGroup widgets.

The MultiChoice widget provides a much more compact UI than MultiSelect.

Reference: https://panel.holoviz.org/reference/widgets/AutocompleteInput.html

Example:

>>> AutocompleteInput(
...     name='Study', options=['Biology', 'Chemistry', 'Physics'],
...     placeholder='Write your study here ...'
... )

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, disabled

width = param.Integer(allow_None=True, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’)

Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.

case_sensitive = param.Boolean(default=True, label=’Case sensitive’)

Enable or disable case sensitivity.

min_characters = param.Integer(default=2, inclusive_bounds=(True, True), label=’Min characters’)

The number of characters a user must type before completions are presented.

options = param.List(bounds=(0, None), default=[], label=’Options’)

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

placeholder = param.String(default=’’, label=’Placeholder’)

Placeholder for empty input field.

restrict = param.Boolean(default=True, label=’Restrict’)

Set to False in order to allow users to enter text that is not present in the list of completion strings.

value = param.String(allow_None=True, default=’’, label=’Value’)

Initial or entered text value updated when <enter> key is pressed.

value_input = param.String(allow_None=True, default=’’, label=’Value input’)

Initial or entered text value updated on every key press.

description = param.String(allow_None=True, label=’Description’)

An HTML string describing the function of this component.

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.BooleanStatus(**params)

Bases: BooleanIndicator

The BooleanStatus is a boolean indicator providing a visual representation of a boolean status as filled or non-filled circle.

If the value is set to True the indicator will be filled while setting it to False will cause it to be non-filled.

Reference: https://panel.holoviz.org/reference/indicators/BooleanStatus.html

Example:

>>> BooleanStatus(value=True, color='primary', width=100, height=100)

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: margin, disabled

panel.widgets.indicators.Indicator: sizing_mode

height = param.Integer(bounds=(0, None), default=20, inclusive_bounds=(True, True), label=’Height’)

height of the circle.

width = param.Integer(bounds=(0, None), default=20, inclusive_bounds=(True, True), label=’Width’)

Width of the circle.

value = param.Boolean(default=False, label=’Value’)

Whether the indicator is active or not.

color = param.ObjectSelector(default=’dark’, label=’Color’, names={}, objects=[‘primary’, ‘secondary’, ‘success’, ‘info’, ‘danger’, ‘warning’, ‘light’, ‘dark’])

The color of the circle, one of ‘primary’, ‘secondary’, ‘success’, ‘info’, ‘danger’, ‘warning’, ‘light’, ‘dark’

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.Button(**params)

Bases: _ClickButton

The Button widget allows triggering events when the button is clicked.

The Button provides a value parameter, which will toggle from False to True while the click event is being processed

It also provides an additional clicks parameter, that can be watched to subscribe to click events.

Reference: https://panel.holoviz.org/reference/widgets/Button.html#widgets-gallery-button

Example:

>>> pn.widgets.Button(name='Click me', icon='caret-right', button_type='primary')

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, width, disabled

panel.widgets.button.IconMixin: icon, icon_size

panel.widgets.button._ButtonBase: button_type, button_style

clicks = param.Integer(default=0, inclusive_bounds=(True, True), label=’Clicks’)

Number of clicks (can be listened to)

value = param.Event(default=False, label=’Value’)

Toggles from False to True while the event is being processed.

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

js_on_click(args: Dict[str, Any] = {}, code: str = '') → Callback

Allows defining a JS callback to be triggered when the button is clicked.

Parameters:

• args (dict) – A mapping of objects to make available to the JS callback

• code (str) – The Javascript code to execute when the button is clicked.

Returns:

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

Return type:

Callback

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

Allows defining a Javascript (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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Optional[Dict[str, str]] = None, args: Optional[Dict[str, Any]] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Button to those on the target object in Javascript (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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value(s) to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

• bidirectional (boolean) – Whether to link source and target bi-directionally. Default is False.

• **links (dict[str,str]) – A mapping between properties on the source model and the target model property to link it to.

Returns:

The Link can be used unlink the widget and the target model.

Return type:

Link

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

on_click(callback: Callable[[Event], None]) → Watcher

Register a callback to be executed when the Button is clicked.

The callback is given an Event argument declaring the number of clicks

Parameters:

callback ((Callable[[param.parameterized.Event], None])) – The function to run on click events. Must accept a positional Event argument

Returns:

watcher – A Watcher that executes the callback when the button is clicked.

Return type:

param.Parameterized.Watcher

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.ChatBox(**params)

Bases: CompositeWidget

The ChatBox widget displays a conversation between multiple users composed of users’ icons, names, messages, and likes.

Reference: https://panel.holoviz.org/reference/widgets/ChatBox.html

Example:

>>> ChatBox(value=[{"You": "Hello!"}, {"Bot": ["How may I help?", "I'm a bot."]}])

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, width, disabled

value = param.List(bounds=(0, None), class_=typing.Dict, default=[], item_type=typing.Dict, label=’Value’)

List of messages as dicts, mapping user to message(s), e.g. [{‘You’: [‘Welcome!’, ‘Good bye!’]}] The message(s) can be any Python object that can be rendered by Panel.

primary_name = param.String(allow_None=True, label=’Primary name’)

Name of the primary user (the one who inputs messages); the first key found in value will be used if unspecified.

allow_input = param.Boolean(default=True, label=’Allow input’)

Whether to allow the primary user to interactively enter messages.

allow_likes = param.Boolean(default=False, label=’Allow likes’)

Whether to allow the primary user to interactively like messages.

ascending = param.Boolean(default=False, label=’Ascending’)

Whether to display messages in ascending time order. If true, the latest messages and message_input_widgets will be at the bottom of the chat box. Otherwise, they will be at the top.

default_message_callable = param.Callable(allow_None=True, label=’Default message callable’)

The type of Panel object to use for items in value if they are not already rendered as a Panel object; if None, uses the pn.panel function to render a displayable Panel object. If the item is not serializable, will fall back to pn.panel.

message_icons = param.Dict(class_=<class ‘dict’>, default={}, label=’Message icons’)

Dictionary mapping name of messages to their icons, e.g. [{‘You’: ‘path/to/icon.png’}]

message_colors = param.Dict(class_=<class ‘dict’>, default={}, label=’Message colors’)

Dictionary mapping name of messages to their colors, e.g. [{‘You’: ‘red’}]

message_hue = param.Integer(allow_None=True, bounds=(0, 360), inclusive_bounds=(True, True), label=’Message hue’)

Base hue of the message bubbles if message_colors is not specified for a user.

message_input_widgets = param.List(bounds=(0, None), default=[<class ‘panel.widgets.input.TextInput’>], label=’Message input widgets’)

List of widgets to use for message input. Multiple widgets will be nested under tabs.

show_names = param.Boolean(default=True, label=’Show names’)

Whether to show chat participant’s names below the message.

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

append(user_message: Dict[str, Union[List[Any], Any]]) → None

Appends a message to the chat log.

Parameters:

(dict) (user_message) –

clear() → None

Clears the chat log.

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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

extend(user_messages: List[Dict[str, Union[List[Any], Any]]]) → None

Extends the chat log with new users’ messages.

Parameters:

(list) (user_messages) –

classmethod from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

insert(index: int, user_message: Dict[str, Union[List[Any], Any]]) → None

Inserts a message into the chat log at the given index.

Parameters:

• (int) (index) –

• (dict) (user_message) –

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pop(index: int = -1) → Dict[str, Union[List[Any], Any]]

Pops the last message from the chat log.

Parameters:

(int) (index) –

Returns:

user_message (dict)

Return type:

Dictionary mapping user to message.

pprint() → None

Prints a compositional repr of the class.

replace(index: int, user_message: Dict[str, Union[List[Any], Any]])

Replaces a message in the chat log at the given index.

Parameters:

• (int) (index) –

• (dict) (user_message) –

property rows: List[ChatRow]

Returns a list of ChatRow objects.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List[Viewable]

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.CheckBoxGroup(**params)

Bases: _CheckGroupBase

The CheckBoxGroup widget allows selecting between a list of options by ticking the corresponding checkboxes.

It falls into the broad category of multi-option selection widgets that provide a compatible API and include the MultiSelect, CrossSelector and CheckButtonGroup widgets.

Reference: https://panel.holoviz.org/reference/widgets/CheckBoxGroup.html

Example:

>>> CheckBoxGroup(
...     name='Fruits', value=['Apple', 'Pear'], options=['Apple', 'Banana', 'Pear', 'Strawberry'],
...     inline=True
... )

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, width, disabled

panel.widgets.select.SelectBase: options

panel.widgets.select._CheckGroupBase: value

inline = param.Boolean(default=False, label=’Inline’)

Whether the items be arrange vertically (False) or horizontally in-line (True).

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.CheckButtonGroup(**params)

Bases: _CheckGroupBase, _ButtonBase

The CheckButtonGroup widget allows selecting between a list of options by toggling the corresponding buttons.

It falls into the broad category of multi-option selection widgets that provide a compatible API and include the MultiSelect, CrossSelector and CheckBoxGroup widgets.

Reference: https://panel.holoviz.org/reference/widgets/CheckButtonGroup.html

Example:

>>> CheckButtonGroup(
...     name='Regression Models', value=['Lasso', 'Ridge'],
...     options=['Lasso', 'Linear', 'Ridge', 'Polynomial']
... )

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, width, disabled

panel.widgets.button._ButtonBase: button_type, button_style

panel.widgets.select.SelectBase: options

panel.widgets.select._CheckGroupBase: value

orientation = param.Selector(default=’horizontal’, label=’Orientation’, names={}, objects=[‘horizontal’, ‘vertical’])

Button group orientation, either ‘horizontal’ (default) or ‘vertical’.

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.Checkbox(**params)

Bases: _BooleanWidget

The Checkbox allows toggling a single condition between True/False states by ticking a checkbox.

This widget is interchangeable with the Toggle widget.

Reference: https://panel.holoviz.org/reference/widgets/Checkbox.html

Example:

>>> Checkbox(name='Works with the tools you know and love', value=True)

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, width, disabled

panel.widgets.input._BooleanWidget: value

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.CodeEditor(**params)

Bases: Widget

The CodeEditor widget allows displaying and editing code in the powerful Ace editor.

Reference: https://panel.holoviz.org/reference/widgets/CodeEditor.html

Example:

>>> CodeEditor(value=py_code, language='python', theme='monokai')

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, width, disabled

annotations = param.List(bounds=(0, None), default=[], label=’Annotations’)

List of annotations to add to the editor.

filename = param.String(default=’’, label=’Filename’)

Filename from which to deduce language

language = param.String(default=’text’, label=’Language’)

Language of the editor

print_margin = param.Boolean(default=False, label=’Print margin’)

Whether to show the a print margin.

readonly = param.Boolean(default=False, label=’Readonly’)

Define if editor content can be modified. Alias for disabled.

theme = param.ObjectSelector(default=’chrome’, label=’Theme’, names={}, objects=[‘ambiance’, ‘chaos’, ‘chrome’, ‘clouds’, ‘clouds_midnight’, ‘cobalt’, ‘crimson_editor’, ‘dawn’, ‘dracula’, ‘dreamweaver’, ‘eclipse’, ‘github’, ‘gob’, ‘gruvbox’, ‘idle_fingers’, ‘iplastic’, ‘katzenmilch’, ‘kr_theme’, ‘kuroir’, ‘merbivore’, ‘merbivore_soft’, ‘mono_industrial’, ‘monokai’, ‘pastel_on_dark’, ‘solarized_dark’, ‘solarized_light’, ‘sqlserver’, ‘terminal’, ‘textmate’, ‘tomorrow’, ‘tomorrow_night’, ‘tomorrow_night_blue’, ‘tomorrow_night_bright’, ‘tomorrow_night_eighties’, ‘twilight’, ‘vibrant_ink’, ‘xcode’])

Theme of the editor

value = param.String(default=’’, label=’Value’)

State of the current code in the editor

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.ColorPicker(**params)

Bases: Widget

The ColorPicker widget allows selecting a hexadecimal RGB color value using the browser’s color-picking widget.

Reference: https://panel.holoviz.org/reference/widgets/ColorPicker.html

Example:

>>> ColorPicker(name='Color', value='#99ef78')

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, disabled

width = param.Integer(allow_None=True, bounds=(0, None), default=52, inclusive_bounds=(True, True), label=’Width’)

Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.

description = param.String(allow_None=True, label=’Description’)

An HTML string describing the function of this component.

value = param.Color(allow_None=True, allow_named=True, label=’Value’)

The selected color

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.CompositeWidget(**params)

Bases: Widget

A baseclass for widgets which are made up of two or more other widgets

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, width, disabled

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List[Viewable]

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.CrossSelector(**params)

Bases: CompositeWidget, MultiSelect

A composite widget which allows selecting from a list of items by moving them between two lists. Supports filtering values by name to select them in bulk.

Reference: https://panel.holoviz.org/reference/widgets/CrossSelector.html

Example:

>>> CrossSelector(
...     name='Fruits', value=['Apple', 'Pear'],
...     options=['Apple', 'Banana', 'Pear', 'Strawberry']
... )

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: margin, disabled

panel.widgets.select.SelectBase: options

panel.widgets.select._MultiSelectBase: value, description

height = param.Integer(allow_None=True, bounds=(0, None), default=200, inclusive_bounds=(True, True), label=’Height’)

The number of options shown at once (note this is the only way to control the height of this widget)

width = param.Integer(allow_None=True, bounds=(0, None), default=600, inclusive_bounds=(True, True), label=’Width’)

The number of options shown at once (note this is the only way to control the height of this widget)

size = param.Integer(default=10, inclusive_bounds=(True, True), label=’Size’)

The number of options shown at once (note this is the only way to control the height of this widget)

filter_fn = param.Callable(label=’Filter fn’)

The filter function applied when querying using the text fields, defaults to re.search. Function is two arguments, the query or pattern and the item label.

definition_order = param.Integer(default=True, inclusive_bounds=(True, True), label=’Definition order’)

Whether to preserve definition order after filtering. Disable to allow the order of selection to define the order of the selected list.

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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

filter_fn(string, flags=0)

Scan through string looking for a match to the pattern, returning a Match object, or None if no match was found.

classmethod from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List[Viewable]

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.DataFrame(value=None, **params)

Bases: BaseTable

The DataFrame widget allows displaying and editing a pandas DataFrame.

Note that editing is not possible for multi-indexed DataFrames, in which case you will need to reduce the DataFrame to a single index.

Also note that the DataFrame widget will eventually be replaced with the Tabulator widget, and so new code should be written to use Tabulator instead.

Reference: https://panel.holoviz.org/reference/widgets/DataFrame.html

Example:

>>> DataFrame(df, name='DataFrame')

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, width, disabled

panel.widgets.tables.BaseTable: selection, aggregators, editors, formatters, hierarchical, row_height, show_index, sorters, text_align, titles, widths, value

auto_edit = param.Boolean(default=False, label=’Auto edit’)

Whether clicking on a table cell automatically starts edit mode.

autosize_mode = param.ObjectSelector(default=’force_fit’, label=’Autosize mode’, names={}, objects=[‘none’, ‘fit_columns’, ‘fit_viewport’, ‘force_fit’])

Determines the column autosizing mode, as one of the following options: "fit_columns" Compute column widths based on cell contents while ensuring the table fits into the available viewport. This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available. "fit_viewport" Adjust the viewport size after computing column widths based on cell contents. "force_fit" Fit columns into available space dividing the table width across the columns equally (equivalent to fit_columns=True). This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available. "none" Do not automatically compute column widths.

fit_columns = param.Boolean(allow_None=True, label=’Fit columns’)

Whether columns should expand to the available width. This results in no horizontal scrollbar showing up, but data can get unreadable if there is no enough space available.

frozen_columns = param.Integer(allow_None=True, inclusive_bounds=(True, True), label=’Frozen columns’)

Integer indicating the number of columns to freeze. If set, the first N columns will be frozen, which prevents them from scrolling out of frame.

frozen_rows = param.Integer(allow_None=True, inclusive_bounds=(True, True), label=’Frozen rows’)

Integer indicating the number of rows to freeze. If set, the first N rows will be frozen, which prevents them from scrolling out of frame; if set to a negative value the last N rows will be frozen.

reorderable = param.Boolean(default=True, label=’Reorderable’)

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

sortable = param.Boolean(default=True, label=’Sortable’)

Allows to sort table’s contents. By default natural order is preserved. To sort a column, click on its header. Clicking one more time changes sort direction. Use Ctrl + click to return to natural order. Use Shift + click to sort multiple columns simultaneously.

add_filter(filter, column=None)

Adds a filter to the table which can be a static value or dynamic parameter based object which will automatically update the table when changed..

When a static value, widget or parameter is supplied the filtering will follow a few well defined behaviors:

• scalar: Filters by checking for equality

• tuple: A tuple will be interpreted as range.

• list: A list will be interpreted as a set of discrete

  scalars and the filter will check if the values in the column match any of the items in the list.

Parameters:

• filter (Widget, param.Parameter or FunctionType) – The value by which to filter the DataFrame along the declared column, or a function accepting the DataFrame to be filtered and returning a filtered copy of the DataFrame.

• column (str or None) – Column to which the filter will be applied, if the filter is a constant value, widget or parameter.

Raises:

ValueError – If the filter type is not supported or no column: was declared.

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

property current_view

Returns the current view of the table after filtering and sorting are applied.

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

patch(patch_value, as_index=True)

Efficiently patches (updates) the existing value with the patch_value.

Parameters:

• patch_value ((pd.DataFrame | pd.Series | Dict)) – The value(s) to patch the existing value with.

• as_index (boolean) – Whether to treat the patch index as DataFrame indexes (True) or as simple integer index.

Raises:

ValueError – Raised if the patch_value is not a supported type.:

Examples

Patch a DataFrame with a Dictionary row. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = {“x”: [(0, 3)]} >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 2], ‘y’: [‘a’, ‘b’]}

Patch a Dataframe with a Dictionary of Columns. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = {“x”: [(slice(2), (3,4))], “y”: [(1,’d’)]} >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘a’, ‘d’]}

Patch a DataFrame with a Series. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = pd.Series({“index”: 1, “x”: 4, “y”: “d”}) >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 4], ‘y’: [‘a’, ‘d’]}

Patch a Dataframe with a Dataframe. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘c’, ‘d’]}

pprint() → None

Prints a compositional repr of the class.

remove_filter(filter)

Removes a filter which was previously added.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

property selected_dataframe

Returns a DataFrame of the currently selected rows.

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

stream(stream_value, rollover=None, reset_index=True)

Streams (appends) the stream_value provided to the existing value in an efficient manner.

Parameters:

• stream_value ((pd.DataFrame | pd.Series | Dict)) – The new value(s) to append to the existing value.

• rollover (int) – A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded.

• reset_index ((bool, default=True)) – If True and the stream_value is a DataFrame, then its index is reset. Helps to keep the index unique and named index

Raises:

ValueError – Raised if the stream_value is not a supported type.:

Examples

Stream a Series to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = pd.Series({“x”: 4, “y”: “d”}) >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dataframe to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

Stream a Dictionary row to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = {“x”: 4, “y”: “d”} >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dictionary of Columns to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = {“x”: [3, 4], “y”: [“c”, “d”]} >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

class panel.widgets.DatePicker(**params)

Bases: Widget

The DatePicker allows selecting selecting a date value using a text box and a date-picking utility.

Reference: https://panel.holoviz.org/reference/widgets/DatePicker.html

Example:

>>> DatePicker(
...     value=date(2025,1,1),
...     start=date(2025,1,1), end=date(2025,12,31),
...     name='Date'
... )

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, disabled

width = param.Integer(allow_None=True, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’)

Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.

value = param.CalendarDate(allow_None=True, inclusive_bounds=(True, True), label=’Value’)

The current value

start = param.CalendarDate(allow_None=True, inclusive_bounds=(True, True), label=’Start’)

Inclusive lower bound of the allowed date selection

end = param.CalendarDate(allow_None=True, inclusive_bounds=(True, True), label=’End’)

Inclusive upper bound of the allowed date selection

disabled_dates = param.List(allow_None=True, bounds=(0, None), class_=(<class ‘datetime.date’>, <class ‘str’>), item_type=(<class ‘datetime.date’>, <class ‘str’>), label=’Disabled dates’)

enabled_dates = param.List(allow_None=True, bounds=(0, None), class_=(<class ‘datetime.date’>, <class ‘str’>), item_type=(<class ‘datetime.date’>, <class ‘str’>), label=’Enabled dates’)

description = param.String(allow_None=True, label=’Description’)

An HTML string describing the function of this component.

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.DateRangeSlider(**params)

Bases: _SliderBase

The DateRangeSlider widget allows selecting a date range using a slider with two handles. Supports datetime.datetime, datetime.date and np.datetime64 ranges.

Reference: https://panel.holoviz.org/reference/widgets/DateRangeSlider.html

Example:

>>> import datetime as dt
>>> DateRangeSlider(
...     value=(dt.datetime(2025, 1, 9), dt.datetime(2025, 1, 16)),
...     start=dt.datetime(2025, 1, 1),
...     end=dt.datetime(2025, 1, 31),
...     step=2,
...     name="A tuple of datetimes"
... )

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, width, disabled

panel.widgets.slider._SliderBase: bar_color, direction, orientation, show_value, tooltips

value = param.DateRange(allow_None=True, inclusive_bounds=(True, True), label=’Value’, length=2)

The selected range as a tuple of values. Updated when one of the handles is dragged. Supports datetime.datetime, datetime.date, and np.datetime64 ranges.

value_start = param.Date(allow_None=True, constant=True, inclusive_bounds=(True, True), label=’Value start’, readonly=True)

The lower value of the selected range.

value_end = param.Date(allow_None=True, constant=True, inclusive_bounds=(True, True), label=’Value end’, readonly=True)

The upper value of the selected range.

value_throttled = param.DateRange(allow_None=True, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, length=2)

The selected range as a tuple of values. Updated one of the handles is released. Supports datetime.datetime, datetime.date and np.datetime64 ranges

start = param.Date(allow_None=True, inclusive_bounds=(True, True), label=’Start’)

The lower bound.

end = param.Date(allow_None=True, inclusive_bounds=(True, True), label=’End’)

The upper bound.

step = param.Number(default=1, inclusive_bounds=(True, True), label=’Step’)

The step size in days. Default is 1 day.

format = param.String(allow_None=True, label=’Format’)

Datetime format used for parsing and formatting the date.

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server

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

Parameters:

• title (str | None) – A string title to give the Document (if served as an app)

• port (int (optional, default=0)) – Allows specifying a specific port

• address (str) – 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

• open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread

class panel.widgets.DateSlider(**params)

Bases: _SliderBase

The DateSlider widget allows selecting a value within a set of bounds using a slider. Supports datetime.datetime, datetime.date and np.datetime64 values. The step size is fixed at 1 day.

Reference: https://panel.holoviz.org/reference/widgets/DateSlider.html

Example:

>>> import datetime as dt
>>> DateSlider(
...     value=dt.datetime(2025, 1, 1),
...     start=dt.datetime(2025, 1, 1),
...     end=dt.datetime(2025, 1, 7),
...     name="A datetime value"
... )

Parameters inherited from:

panel.viewable.Layoutable: align, aspect_ratio, background, css_classes, design, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width_policy, height_policy, sizing_mode, visible

panel.viewable.Viewable: loading

panel.widgets.base.Widget: height, margin, width, disabled

panel.widgets.slider._SliderBase: bar_color, direction, orientation, show_value, tooltips

value = param.Date(allow_None=True, inclusive_bounds=(True, True), label=’Value’)

The selected date value of the slider. Updated when the slider handle is dragged. Supports datetime.datetime, datetime.date or np.datetime64 types.

value_throttled = param.Date(allow_None=True, constant=True, inclusive_bounds=(True, True), label=’Value throttled’)

The value of the slider. Updated when the slider handle is released.

start = param.Date(allow_None=True, inclusive_bounds=(True, True), label=’Start’)

The lower bound.

end = param.Date(allow_None=True, inclusive_bounds=(True, True), label=’End’)

The upper bound.

as_datetime = param.Boolean(default=False, label=’As datetime’)

Whether to store the date as a datetime.

step = param.Number(allow_None=True, inclusive_bounds=(True, True), label=’Step’)

The step parameter in milliseconds.

format = param.String(allow_None=True, label=’Format’)

Datetime format used for parsing and formatting the date.

app(notebook_url: str = 'localhost:8888', port: int = 0) → Server

Displays a bokeh server app inline in the notebook.

Parameters:

• notebook_url (str) – URL to the notebook server

• port (int (optional, default=0)) – Allows specifying a specific port

clone(**params) → Viewable

Makes a copy of the object sharing the same parameters.

Parameters:

params (Keyword arguments override the parameters on the clone.) –

Return type:

Cloned Viewable object

controls(parameters: List[str] = [], jslink: bool = True, **kwargs) → Panel

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:

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

• kwargs (dict) – Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Return type:

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = False, states={}) → None

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.

Parameters:

• 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 from_param(parameter: param.Parameter, **params) → Self

Construct a widget from a Parameter and link the two bi-directionally.

Parameters:

• parameter (param.Parameter) – A parameter to create the widget from.

• params (dict) – Keyword arguments to be passed to the widget constructor

Return type:

Widget instance linked to the supplied parameter

get_root(doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True) → Model

Returns the root model and applies pre-processing hooks

Parameters:

• doc (bokeh.Document) – Bokeh document the bokeh model will be attached to.

• comm (pyviz_comms.Comm) – Optional pyviz_comms when working in notebook

• preprocess (boolean (default=True)) – Whether to run preprocessing hooks

Return type:

Returns the bokeh model corresponding to this panel object

jscallback(args: Dict[str, Any] = {}, **callbacks: str) → Callback

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.

Parameters:

• 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

Returns:

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

Return type:

Callback

jslink(target: JSLinkTarget, code: Dict[str, str] = None, args: Optional[Dict] = None, bidirectional: bool = False, **links: str) → Link

Links properties on the this Reactive object to those on the target Reactive 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.

Parameters:

• target (panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned) – The target to link the value to.

• code (dict) – Custom code which will be executed when the widget value changes.

• args (dict) – A mapping of objects to make available to the JS callback

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

Returns:

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

Return type:

GenericLink

link(target: param.Parameterized, callbacks: Optional[Dict[str, str | Callable]] = None, bidirectional: bool = False, **links: str) → Watcher

Links the parameters on this Reactive object to attributes on the target Parameterized object.

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.

Parameters:

• target (param.Parameterized) – The target object of the link.

• callbacks (dict | None) – Maps from a parameter in the source object to a callback.

• bidirectional (bool) – Whether to link source and target bi-directionally

• **links (dict) – Maps between parameters on this object to the parameters on the supplied object.

pprint() → None

Prints a compositional repr of the class.

save(filename: str | os.PathLike | IO, title: Optional[str] = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: Dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: Optional[str] = None, progress: bool = True, embed_states: Dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None

Saves Panel objects to file.

Parameters:

• filename (str 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.

• progress (boolean (default=True)) – Whether to report progress

• embed_states (dict (default={})) – A dictionary specifying the widget values to embed for each widget

• as_png (boolean (default=None)) – To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: Optional[type | Callable[['Viewable'], bool]] = None) → List['Viewable']

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

Parameters:

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

Returns:

viewables

Return type:

list(Viewable)

servable(title: Optional[str] = None, location: bool | 'Location' = True, area: str = 'main', target: Optional[str] = None) → ServableMixin

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:

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

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

• area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

• target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

server_doc(doc: Optional[Document] = None, title: Optional[str] = None, location: bool | 'Location' = True) → Document

Returns a serveable bokeh Document with the panel attached

Parameters:

• doc (bokeh.Document (optional)) – The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()

• title (str) – A string title to give the Document

• location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

doc – The bokeh document the panel was attached to

Return type:

bokeh.Document

show(title: Optional[str] = None, port: int = 0, address: Optional[str] = None, websocket_origin: Optional[str] = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs