panel.layout Package#

`layout` Package#

Layout#

Layouts can layout your python objects and panel components.

Most layouts behave as the Python containers you already know. For example Column and Row behaves as lists. I.e. they have a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which make it possible to interactively update and modify them.

Check out the Panel gallery of layouts https://panel.holoviz.org/reference/index.html#layouts for inspiration.

How to use layouts in 2 simple steps#

Define your Python objects

>>> some_python_object = ...
>>> some_widget = pn.widgets...
>>> some_pane = pn.pane...

Define your layouts

>>> pn.Column(some_python_object, some_widget, some_pane)

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

class panel.layout.Accordion(*objects, **params)[source]#

Bases: NamedListPanel

The Accordion layout is a type of Card layout that allows switching between multiple objects by clicking on the corresponding card header.

The labels for each card will default to the name parameter of the card’s contents, but may also be defined explicitly as part of a tuple.

Like Column and Row, Accordion has a list-like API that allows interactively updating and modifying the cards using the methods append, extend, clear, insert, pop, remove and __setitem__.

Reference: https://panel.holoviz.org/reference/layouts/Accordion.html

Example:

>>> pn.Accordion(some_pane_with_a_name, ("Plot", some_plot))

Parameters inherited from:

active = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Active’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x134cdec10>): List of indexes of active cards.
active_header_background = param.String(allow_refs=False, default=’#ddd’, label=’Active header background’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137282d90>): Color for currently active headers.
header_color = param.String(allow_refs=False, default=’’, label=’Header color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1370b5dd0>): A valid CSS color to apply to the expand button.
header_background = param.String(allow_refs=False, default=’’, label=’Header background’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137282d90>): A valid CSS color for the header background.
toggle = param.Boolean(allow_refs=False, default=False, label=’Toggle’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13414c190>): Whether to toggle between active cards or allow multiple cards

append(pane: Any) → None[source]#: Appends an object to the tabs.

Arguments#

obj (object): Panel component to add as a tab.

clear() → None[source]#: Clears the tabs.

clone(*objects: Any, **params: Any) → NamedListLike[source]#: Makes a copy of the Tabs sharing the same parameters.

Arguments#

objects: Objects to add to the cloned Tabs object. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Tabs object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(panes: Iterable[Any]) → None[source]#: Extends the the tabs with a list.

Arguments#

objects (list): List of panel components to add as tabs.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

insert(index: int, pane: Any) → None[source]#: Inserts an object in the tabs at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert as tabs.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the tabs by index.

Arguments#

index (int): The index of the item to pop from the tabs.

remove(pane: Viewable) → None[source]#: Removes an object from the tabs.

Arguments#

obj (object): The object to remove from the tabs.

reverse() → None[source]#: Reverses the tabs.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.Card(*objects, **params)[source]#

Bases: Column

A Card layout allows arranging multiple panel objects in a collapsible, vertical container with a header bar.

Reference: https://panel.holoviz.org/reference/layouts/Card.html

Example:

>>> pn.Card(
...     some_widget, some_pane, some_python_object,
...     title='Card', styles=dict(background='WhiteSmoke'),
... )

Parameters inherited from:

css_classes = param.List(allow_refs=False, bounds=(0, None), default=[‘card’], label=’Css classes’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x137337e10>): CSS classes to apply to the overall Card.
active_header_background = param.String(allow_refs=False, default=’’, label=’Active header background’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137335490>): A valid CSS color for the header background when not collapsed.
button_css_classes = param.List(allow_refs=False, bounds=(0, None), default=[‘card-button’], label=’Button css classes’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137337650>): CSS classes to apply to the button element.
collapsible = param.Boolean(allow_refs=False, default=True, label=’Collapsible’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137335490>): Whether the Card should be expandable and collapsible.
collapsed = param.Boolean(allow_refs=False, default=False, label=’Collapsed’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137337290>): Whether the contents of the Card are collapsed.
header = param.Parameter(allow_None=True, allow_refs=False, label=’Header’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1366caf50>): A Panel component to display in the header bar of the Card. Will override the given title if defined.
header_background = param.String(allow_refs=False, default=’’, label=’Header background’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137336d10>): A valid CSS color for the header background.
header_color = param.String(allow_refs=False, default=’’, label=’Header color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137336fd0>): A valid CSS color to apply to the header text.
header_css_classes = param.List(allow_refs=False, bounds=(0, None), default=[‘card-header’], label=’Header css classes’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137336d10>): CSS classes to apply to the header element.
hide_header = param.Boolean(allow_refs=False, default=False, label=’Hide header’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137336ed0>): Whether to skip rendering the header.
title_css_classes = param.List(allow_refs=False, bounds=(0, None), default=[‘card-title’], label=’Title css classes’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137336e10>): CSS classes to apply to the header title.
title = param.String(allow_refs=False, default=’’, label=’Title’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137337650>): A title to be displayed in the Card header, will be overridden by the header if defined.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.Column(*objects: Any, **params: Any)[source]#

Bases: ListPanel

The Column layout allows arranging multiple panel objects in a vertical container.

It has a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which makes it possible to interactively update and modify the layout.

Reference: https://panel.holoviz.org/reference/layouts/Column.html

Example:

>>> pn.Column(some_widget, some_pane, some_python_object)

Parameters inherited from:

auto_scroll_limit = param.Integer(allow_refs=False, bounds=(0, None), default=0, inclusive_bounds=(True, True), label=’Auto scroll limit’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1357fd9d0>): Max pixel distance from the latest object in the Column to activate automatic scrolling upon update. Setting to 0 disables auto-scrolling.
scroll_button_threshold = param.Integer(allow_refs=False, bounds=(0, None), default=0, inclusive_bounds=(True, True), label=’Scroll button threshold’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137366dd0>): Min pixel distance from the latest object in the Column to display the scroll button. Setting to 0 disables the scroll button.
scroll_position = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Scroll position’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x136120e50>): Current scroll position of the Column. Setting this value will update the scroll position of the Column. Setting to 0 will scroll to the top.
view_latest = param.Boolean(allow_refs=False, default=False, label=’View latest’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137364450>): Whether to scroll to the latest object on init. If not enabled the view will be on the first object.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.Divider(refs=None, **params)[source]#

Bases: Reactive

A Divider draws a horizontal rule (a <hr> tag in HTML) to separate multiple components in a layout. It automatically spans the full width of the container.

Reference: https://panel.holoviz.org/reference/layouts/Divider.html

Example:

>>> pn.Column(
...     '# Lorem Ipsum',
...     pn.layout.Divider(),
...     'A very long text... '
>>> )

Parameters inherited from:

width_policy = param.ObjectSelector(allow_refs=False, constant=True, default=’fit’, label=’Width policy’, names={}, nested_refs=False, objects=[‘auto’, ‘fixed’, ‘fit’, ‘min’, ‘max’], readonly=True, rx=<param.reactive.reactive_ops object at 0x1373b7710>): Describes how the component should maintain its width. "auto" Use component’s preferred sizing policy. "fixed" Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space. "fit" Use component’s preferred width (if set) and allow it to fit into the available horizontal space within the minimum and maximum width bounds (if set). Component’s width neither will be aggressively minimized nor maximized. "min" Use as little horizontal space as possible, not less than the minimum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors. "max" Use as much horizontal space as possible, not more than the maximum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.Feed(*objects, **params)[source]#

Bases: Column

The Feed class inherits from the Column layout, thereby enabling the arrangement of multiple panel objects within a vertical container. However, it restrictively manages the number of objects displayed at any moment. This layout is particularly useful for efficiently rendering a substantial number of objects.

Similar to Column, the Feed provides a list-like API, including methods such as append, extend, clear, insert, pop, remove, and __setitem__. These methods facilitate interactive updates and modifications to the layout.

Reference: https://panel.holoviz.org/reference/layouts/Feed.html

Example:

>>> pn.Feed(some_widget, some_pane, some_python_object, ..., python_object_1002)

Parameters inherited from:

scroll = param.Selector(allow_refs=False, default=’y’, label=’Scroll’, names={}, nested_refs=False, objects=[False, True, ‘both-auto’, ‘y-auto’, ‘x-auto’, ‘both’, ‘x’, ‘y’], rx=<param.reactive.reactive_ops object at 0x13742c810>): Whether to add scrollbars if the content overflows the size of the container. If “both-auto”, will only add scrollbars if the content overflows in either directions. If “x-auto” or “y-auto”, will only add scrollbars if the content overflows in the respective direction. If “both”, will always add scrollbars. If “x” or “y”, will always add scrollbars in the respective direction. If False, overflowing content will be clipped. If True, will only add scrollbars in the direction of the container, (e.g. Column: vertical, Row: horizontal).
load_buffer = param.Integer(allow_refs=False, bounds=(0, None), default=50, inclusive_bounds=(True, True), label=’Load buffer’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13740fc10>): The number of objects loaded on each side of the visible objects. When scrolled halfway into the buffer, the feed will automatically load additional objects while unloading objects on the opposite side.
visible_range = param.Range(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Visible range’, length=2, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x136fbe850>): Read-only upper and lower bounds of the currently visible feed objects. This list is automatically updated based on scrolling.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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.

scroll_to_latest()[source]#: Scrolls the Feed to the latest entry.

select(selector=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.FlexBox(*objects, **params)[source]#

Bases: ListLike, ReactiveHTML

The FlexBox is a list-like layout (unlike GridSpec) that wraps objects into a CSS flex container.

It has a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which makes it possible to interactively update and modify the layout. It exposes all the CSS options for controlling the behavior and layout of the flex box.

Reference: https://panel.holoviz.org/reference/layouts/FlexBox.html

Example:

>>> pn.FlexBox(
...    some_python_object, another_python_object, ...,
...    the_last_python_object
... )

Parameters inherited from:

align_content = param.Selector(allow_refs=False, default=’flex-start’, label=’Align content’, names={}, nested_refs=False, objects=[‘normal’, ‘flex-start’, ‘flex-end’, ‘center’, ‘space-between’, ‘space-around’, ‘space-evenly’, ‘stretch’, ‘start’, ‘end’, ‘baseline’, ‘first baseline’, ‘last baseline’], rx=<param.reactive.reactive_ops object at 0x137377f90>): Defines how a flex container’s lines align when there is extra space in the cross-axis.
align_items = param.Selector(allow_refs=False, default=’flex-start’, label=’Align items’, names={}, nested_refs=False, objects=[‘stretch’, ‘flex-start’, ‘flex-end’, ‘center’, ‘baseline’, ‘first baseline’, ‘last baseline’, ‘start’, ‘end’, ‘self-start’, ‘self-end’], rx=<param.reactive.reactive_ops object at 0x13737a010>): Defines the default behavior for how flex items are laid out along the cross axis on the current line.
flex_direction = param.Selector(allow_refs=False, default=’row’, label=’Flex direction’, names={}, nested_refs=False, objects=[‘row’, ‘row-reverse’, ‘column’, ‘column-reverse’], rx=<param.reactive.reactive_ops object at 0x137377bd0>): This establishes the main-axis, thus defining the direction flex items are placed in the flex container.
flex_wrap = param.Selector(allow_refs=False, default=’wrap’, label=’Flex wrap’, names={}, nested_refs=False, objects=[‘nowrap’, ‘wrap’, ‘wrap-reverse’], rx=<param.reactive.reactive_ops object at 0x13737a010>): Whether and how to wrap items in the flex container.
gap = param.String(allow_refs=False, default=’’, label=’Gap’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137377110>): Defines the spacing between flex items, supporting various units (px, em, rem, %, vw/vh).
justify_content = param.Selector(allow_refs=False, default=’flex-start’, label=’Justify content’, names={}, nested_refs=False, objects=[‘flex-start’, ‘flex-end’, ‘center’, ‘space-between’, ‘space-around’, ‘space-evenly’, ‘start’, ‘end’, ‘left’, ‘right’], rx=<param.reactive.reactive_ops object at 0x13737a010>): Defines the alignment along the main axis.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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_event(node: str, event: str, callback: Callable) → None[source]#

Registers a callback to be executed when the specified DOM event is triggered on the named node. Note that the named node must be declared in the HTML. To create a named node you must give it an id of the form id=”name”, where name will be the node identifier.

Arguments#

node: str: Named node in the HTML identifiable via id of the form id=”name”.
event: str: Name of the DOM event to add an event listener to.
callback: callable: A callable which will be given the DOMEvent object.

pop(index: int) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.FloatPanel(*objects, name='', **params)[source]#

Bases: ListLike, ReactiveHTML

Float provides a floating panel layout.

Reference: https://panel.holoviz.org/reference/layouts/FloatPanel.html

Example:

>>> import panel as pn
>>> pn.extension("floatpanel")
>>> pn.layout.FloatPanel("**I can float**!", position="center", width=300).servable()

Parameters inherited from:

config = param.Dict(allow_refs=False, class_=<class ‘dict’>, default={}, label=’Config’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13755b150>): Additional jsPanel configuration with precedence over parameter values.
contained = param.Boolean(allow_refs=False, default=True, label=’Contained’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137564950>): Whether the component is contained within parent container or completely free floating.
position = param.Selector(allow_refs=False, default=’right-top’, label=’Position’, names={}, nested_refs=False, objects=[‘center’, ‘left-top’, ‘center-top’, ‘right-top’, ‘right-center’, ‘right-bottom’, ‘center-bottom’, ‘left-bottom’, ‘left-center’], rx=<param.reactive.reactive_ops object at 0x13755b410>): The initial position if the container is free-floating.
offsetx = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Offsetx’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137566490>): Horizontal offset in pixels.
offsety = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Offsety’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137566d10>): Vertical offset in pixels.
theme = param.String(allow_refs=False, default=’primary’, label=’Theme’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137564750>): The theme which can be one of: - Built-ins: ‘default’, ‘primary’, ‘secondary’, ‘info’, ‘success’, ‘warning’, ‘danger’, ‘light’, ‘dark’ and ‘none’ - HEX, RGB and HSL color values like ‘#123456’ Any standardized color name like ‘forestgreen’ and color names from the Material Design Color System like ‘purple900’ - Additionally a theme string may include one of the modifiers ‘filled’, ‘filledlight’, ‘filleddark’ or ‘fillcolor’ separated from the theme color by a space like ‘primary
status = param.Selector(allow_refs=False, default=’normalized’, label=’Status’, names={}, nested_refs=False, objects=[‘normalized’, ‘maximized’, ‘minimized’, ‘smallified’, ‘smallifiedmax’, ‘closed’], rx=<param.reactive.reactive_ops object at 0x13755b410>): The current status of the panel.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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_event(node: str, event: str, callback: Callable) → None[source]#

Registers a callback to be executed when the specified DOM event is triggered on the named node. Note that the named node must be declared in the HTML. To create a named node you must give it an id of the form id=”name”, where name will be the node identifier.

Arguments#

node: str: Named node in the HTML identifiable via id of the form id=”name”.
event: str: Name of the DOM event to add an event listener to.
callback: callable: A callable which will be given the DOMEvent object.

pop(index: int) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.GridBox(*objects: Any, **params: Any)[source]#

Bases: ListPanel

The GridBox is a list-like layout (unlike GridSpec) that wraps objects into a grid according to the specified nrows and ncols parameters.

It has a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which makes it possible to interactively update and modify the layout.

Reference: https://panel.holoviz.org/reference/layouts/GridBox.html

Example:

>>> pn.GridBox(
...    python_object_1, python_object_2, ...,
...    python_object_24, ncols=6
... )

Parameters inherited from:

nrows = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Nrows’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13759f590>): Number of rows to reflow the layout into.
ncols = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Ncols’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1375a4190>): Number of columns to reflow the layout into.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.GridSpec(*, mode, ncols, nrows, objects, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, name)[source]#

Bases: Panel

The GridSpec is an array like layout that allows arranging multiple Panel objects in a grid using a simple API to assign objects to individual grid cells or to a grid span.

Other layout containers function like lists, but a GridSpec has an API similar to a 2D array, making it possible to use 2D assignment to populate, index, and slice the grid.

See GridStack for a similar layout that allows the user to resize and drag the cells.

Reference: https://panel.holoviz.org/reference/layouts/GridSpec.html

Example:

>>> import panel as pn
>>> gspec = pn.GridSpec(width=800, height=600)
>>> gspec[:,   0  ] = pn.Spacer(styles=dict(background='red'))
>>> gspec[0,   1:3] = pn.Spacer(styles=dict(background='green'))
>>> gspec[1,   2:4] = pn.Spacer(styles=dict(background='orange'))
>>> gspec[2,   1:4] = pn.Spacer(styles=dict(background='blue'))
>>> gspec[0:1, 3:4] = pn.Spacer(styles=dict(background='purple'))
>>> gspec

Parameters inherited from:

objects = param.ChildDict(allow_refs=False, class_=<class ‘dict’>, default={}, label=’Objects’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1375e6150>): The dictionary of child objects that make up the grid.
mode = param.ObjectSelector(allow_refs=False, default=’warn’, label=’Mode’, names={}, nested_refs=False, objects=[‘warn’, ‘error’, ‘override’], rx=<param.reactive.reactive_ops object at 0x1375e9fd0>): Whether to warn, error or simply override on overlapping assignment.
ncols = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Ncols’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1375ea5d0>): Limits the number of columns that can be assigned.
nrows = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Nrows’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1375eb510>): Limits the number of rows that can be assigned.

clone(**params)[source]#: Makes a copy of the GridSpec sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned GridSpec object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.GridStack(*, allow_drag, allow_resize, state, mode, ncols, nrows, objects, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, name)[source]#

Bases: ReactiveHTML, GridSpec

The GridStack layout allows arranging multiple Panel objects in a grid using a simple API to assign objects to individual grid cells or to a grid span.

Other layout containers function like lists, but a GridSpec has an API similar to a 2D array, making it possible to use 2D assignment to populate, index, and slice the grid.

Reference: https://panel.holoviz.org/reference/layouts/GridStack.html

Example:

>>> pn.extension('gridstack')
>>> gstack = GridStack(sizing_mode='stretch_both')
>>> gstack[ : , 0: 3] = pn.Spacer(styles=dict(background='red'))
>>> gstack[0:2, 3: 9] = pn.Spacer(styles=dict(background='green'))
>>> gstack[2:4, 6:12] = pn.Spacer(styles=dict(background='orange'))
>>> gstack[4:6, 3:12] = pn.Spacer(styles=dict(background='blue'))
>>> gstack[0:2, 9:12] = pn.Spacer(styles=dict(background='purple'))

Parameters inherited from:

height = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1373afdd0>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137628b10>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
allow_resize = param.Boolean(allow_refs=False, default=True, label=’Allow resize’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1373ade90>): Allow resizing the grid cells.
allow_drag = param.Boolean(allow_refs=False, default=True, label=’Allow drag’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x137623b10>): Allow dragging the grid cells.
state = param.List(allow_refs=False, bounds=(0, None), default=[], label=’State’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1373ad250>): Current state of the grid (updated as items are resized and dragged).

clone(**params)[source]#: Makes a copy of the GridSpec sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned GridSpec object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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_event(node: str, event: str, callback: Callable) → None[source]#

Registers a callback to be executed when the specified DOM event is triggered on the named node. Note that the named node must be declared in the HTML. To create a named node you must give it an id of the form id=”name”, where name will be the node identifier.

Arguments#

node: str: Named node in the HTML identifiable via id of the form id=”name”.
event: str: Name of the DOM event to add an event listener to.
callback: callable: A callable which will be given the DOMEvent object.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.HSpacer(refs=None, **params)[source]#

Bases: Spacer

The HSpacer layout provides responsive horizontal spacing.

Using this component we can space objects equidistantly in a layout and allow the empty space to shrink when the browser is resized.

How-to: https://panel.holoviz.org/how_to/layout/spacing.html#spacer-components

Example:

>>> pn.Row(
...     pn.layout.HSpacer(), 'Item 1',
...     pn.layout.HSpacer(), 'Item 2',
...     pn.layout.HSpacer()
... )

Parameters inherited from:

sizing_mode = param.Parameter(allow_refs=False, constant=True, default=’stretch_width’, label=’Sizing mode’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x13765f2d0>): How the component should size itself. This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode). "fixed" Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events. "stretch_width" Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_height" Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_both" Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component. "scale_width" Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio. "scale_height" Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio. "scale_both" Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.ListLike(*objects: Any, **params: Any)[source]#

Bases: Parameterized

objects = param.Children(allow_refs=False, bounds=(0, None), class_=<class ‘panel.viewable.Viewable’>, default=[], item_type=<class ‘panel.viewable.Viewable’>, label=’Objects’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1376bf890>): The list of child objects that make up the layout.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

extend(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

pop(index: int) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

class panel.layout.ListPanel(*objects: Any, **params: Any)[source]#

Bases: ListLike, Panel

An abstract baseclass for Panel objects with list-like children.

Parameters inherited from:

scroll = param.Selector(allow_refs=False, default=False, label=’Scroll’, names={}, nested_refs=False, objects=[False, True, ‘both-auto’, ‘y-auto’, ‘x-auto’, ‘both’, ‘x’, ‘y’], rx=<param.reactive.reactive_ops object at 0x1376e2290>): Whether to add scrollbars if the content overflows the size of the container. If “both-auto”, will only add scrollbars if the content overflows in either directions. If “x-auto” or “y-auto”, will only add scrollbars if the content overflows in the respective direction. If “both”, will always add scrollbars. If “x” or “y”, will always add scrollbars in the respective direction. If False, overflowing content will be clipped. If True, will only add scrollbars in the direction of the container, (e.g. Column: vertical, Row: horizontal).

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.Panel(refs=None, **params)[source]#

Bases: Reactive

Abstract baseclass for a layout of Viewables.

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.Row(*objects: Any, **params: Any)[source]#

Bases: ListPanel

The Row layout allows arranging multiple panel objects in a horizontal container.

It has a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which makes it possible to interactively update and modify the layout.

Reference: https://panel.holoviz.org/reference/layouts/Row.html

Example:

>>> pn.Row(some_widget, some_pane, some_python_object)

Parameters inherited from:

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.Spacer(refs=None, **params)[source]#

Bases: Reactive

The Spacer layout is a very versatile component which makes it easy to put fixed or responsive spacing between objects.

Like all other components spacers support both absolute and responsive sizing modes.

How-to: https://panel.holoviz.org/how_to/layout/spacing.html#spacer-components

Example:

>>> pn.Row(
...    1, pn.Spacer(width=200),
...    2, pn.Spacer(width=100),
...    3
... )

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.Swipe(*objects, **params)[source]#

Bases: ListLike, ReactiveHTML

The Swipe layout enables you to quickly compare two panels laid out on top of each other with a part of the before panel shown on one side of a slider and a part of the after panel shown on the other side.

Parameters inherited from:

objects = param.List(allow_refs=False, bounds=(0, 2), default=[], item_type=<class ‘panel.viewable.Viewable’>, label=’Objects’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1377eee90>): The list of child objects that make up the layout.
slider_width = param.Integer(allow_refs=False, bounds=(0, 25), default=5, inclusive_bounds=(True, True), label=’Slider width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1377f3e50>): The width of the slider in pixels
slider_color = param.Color(allow_named=True, allow_refs=False, default=’black’, label=’Slider color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1372b5b10>): The color of the slider
value = param.Integer(allow_refs=False, bounds=(0, 100), default=50, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1377f33d0>): The percentage of the after panel to show.

_before = param.Parameter(allow_None=True, allow_refs=False, label=’ before’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1377ef310>)

_after = param.Parameter(allow_None=True, allow_refs=False, label=’ after’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1377f28d0>)

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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_event(node: str, event: str, callback: Callable) → None[source]#

Registers a callback to be executed when the specified DOM event is triggered on the named node. Note that the named node must be declared in the HTML. To create a named node you must give it an id of the form id=”name”, where name will be the node identifier.

Arguments#

node: str: Named node in the HTML identifiable via id of the form id=”name”.
event: str: Name of the DOM event to add an event listener to.
callback: callable: A callable which will be given the DOMEvent object.

pop(index: int) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.Tabs(*objects, **params)[source]#

Bases: NamedListPanel

The Tabs layout allows switching between multiple objects by clicking on the corresponding tab header.

Tab labels may be defined explicitly as part of a tuple or will be inferred from the name parameter of the tab’s contents.

Like Column and Row, Tabs has a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which make it possible to interactively update and modify the tabs.

Reference: https://panel.holoviz.org/reference/layouts/Tabs.html

Example:

>>> pn.Tabs(('Scatter', plot1), some_pane_with_a_name)

Parameters inherited from:

height = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13783be50>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1376b6290>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
closable = param.Boolean(allow_refs=False, default=False, label=’Closable’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13783b390>): Whether it should be possible to close tabs.
dynamic = param.Boolean(allow_refs=False, default=False, label=’Dynamic’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1378441d0>): Dynamically populate only the active tab.
tabs_location = param.ObjectSelector(allow_refs=False, default=’above’, label=’Tabs location’, names={}, nested_refs=False, objects=[‘above’, ‘below’, ‘left’, ‘right’], rx=<param.reactive.reactive_ops object at 0x13783b7d0>): The location of the tabs relative to the tab contents.

append(pane: Any) → None[source]#: Appends an object to the tabs.

Arguments#

obj (object): Panel component to add as a tab.

clear() → None[source]#: Clears the tabs.

clone(*objects: Any, **params: Any) → NamedListLike[source]#: Makes a copy of the Tabs sharing the same parameters.

Arguments#

objects: Objects to add to the cloned Tabs object. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Tabs object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(panes: Iterable[Any]) → None[source]#: Extends the the tabs with a list.

Arguments#

objects (list): List of panel components to add as tabs.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

insert(index: int, pane: Any) → None[source]#: Inserts an object in the tabs at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert as tabs.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the tabs by index.

Arguments#

index (int): The index of the item to pop from the tabs.

remove(pane: Viewable) → None[source]#: Removes an object from the tabs.

Arguments#

obj (object): The object to remove from the tabs.

reverse() → None[source]#: Reverses the tabs.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.VSpacer(refs=None, **params)[source]#

Bases: Spacer

The VSpacer layout provides responsive vertical spacing.

Using this component we can space objects equidistantly in a layout and allow the empty space to shrink when the browser is resized.

Reference: https://panel.holoviz.org/how_to/layout/spacing.html#spacer-components

Example:

>>> pn.Column(
...     pn.layout.VSpacer(), 'Item 1',
...     pn.layout.VSpacer(), 'Item 2',
...     pn.layout.VSpacer()
... )

Parameters inherited from:

sizing_mode = param.Parameter(allow_refs=False, constant=True, default=’stretch_height’, label=’Sizing mode’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x137439790>): How the component should size itself. This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode). "fixed" Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events. "stretch_width" Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_height" Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_both" Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component. "scale_width" Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio. "scale_height" Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio. "scale_both" Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.WidgetBox(*objects: Any, **params: Any)[source]#

Bases: ListPanel

The WidgetBox layout allows arranging multiple panel objects in a vertical (or horizontal) container.

It is largely identical to the Column layout, but has some default styling that makes widgets be clearly grouped together visually.

It has a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which make it possible to interactively update and modify the layout.

Reference: https://panel.holoviz.org/reference/layouts/WidgetBox.html

Example:

>>> pn.WidgetBox(some_widget, another_widget)

Parameters inherited from:

css_classes = param.List(allow_refs=False, bounds=(0, None), default=[‘panel-widget-box’], label=’Css classes’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x1354ac8d0>): CSS classes to apply to the layout.
disabled = param.Boolean(allow_refs=False, default=False, label=’Disabled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1376f2e10>): Whether the widget is disabled.
horizontal = param.Boolean(allow_refs=False, default=False, label=’Horizontal’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x135bf8ad0>): Whether to lay out the widgets in a Row layout as opposed to a Column layout.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

`accordion` Module#

class panel.layout.accordion.Accordion(*objects, **params)[source]#

Bases: NamedListPanel

The Accordion layout is a type of Card layout that allows switching between multiple objects by clicking on the corresponding card header.

The labels for each card will default to the name parameter of the card’s contents, but may also be defined explicitly as part of a tuple.

Like Column and Row, Accordion has a list-like API that allows interactively updating and modifying the cards using the methods append, extend, clear, insert, pop, remove and __setitem__.

Reference: https://panel.holoviz.org/reference/layouts/Accordion.html

Example:

>>> pn.Accordion(some_pane_with_a_name, ("Plot", some_plot))

Parameters inherited from:

active = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Active’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1451f70d0>): List of indexes of active cards.
active_header_background = param.String(allow_refs=False, default=’#ddd’, label=’Active header background’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1451f5c10>): Color for currently active headers.
header_color = param.String(allow_refs=False, default=’’, label=’Header color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1451f6f90>): A valid CSS color to apply to the expand button.
header_background = param.String(allow_refs=False, default=’’, label=’Header background’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1451f60d0>): A valid CSS color for the header background.
toggle = param.Boolean(allow_refs=False, default=False, label=’Toggle’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1451f7450>): Whether to toggle between active cards or allow multiple cards

append(pane: Any) → None[source]#: Appends an object to the tabs.

Arguments#

obj (object): Panel component to add as a tab.

clear() → None[source]#: Clears the tabs.

clone(*objects: Any, **params: Any) → NamedListLike[source]#: Makes a copy of the Tabs sharing the same parameters.

Arguments#

objects: Objects to add to the cloned Tabs object. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Tabs object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(panes: Iterable[Any]) → None[source]#: Extends the the tabs with a list.

Arguments#

objects (list): List of panel components to add as tabs.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

insert(index: int, pane: Any) → None[source]#: Inserts an object in the tabs at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert as tabs.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the tabs by index.

Arguments#

index (int): The index of the item to pop from the tabs.

remove(pane: Viewable) → None[source]#: Removes an object from the tabs.

Arguments#

obj (object): The object to remove from the tabs.

reverse() → None[source]#: Reverses the tabs.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

`base` Module#

Defines Layout classes which may be used to arrange panes and widgets in flexible ways to build complex dashboards.

class panel.layout.base.Column(*objects: Any, **params: Any)[source]#

Bases: ListPanel

The Column layout allows arranging multiple panel objects in a vertical container.

It has a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which makes it possible to interactively update and modify the layout.

Reference: https://panel.holoviz.org/reference/layouts/Column.html

Example:

>>> pn.Column(some_widget, some_pane, some_python_object)

Parameters inherited from:

auto_scroll_limit = param.Integer(allow_refs=False, bounds=(0, None), default=0, inclusive_bounds=(True, True), label=’Auto scroll limit’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145294290>): Max pixel distance from the latest object in the Column to activate automatic scrolling upon update. Setting to 0 disables auto-scrolling.
scroll_button_threshold = param.Integer(allow_refs=False, bounds=(0, None), default=0, inclusive_bounds=(True, True), label=’Scroll button threshold’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1454d8510>): Min pixel distance from the latest object in the Column to display the scroll button. Setting to 0 disables the scroll button.
scroll_position = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Scroll position’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145228c50>): Current scroll position of the Column. Setting this value will update the scroll position of the Column. Setting to 0 will scroll to the top.
view_latest = param.Boolean(allow_refs=False, default=False, label=’View latest’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1454d3b50>): Whether to scroll to the latest object on init. If not enabled the view will be on the first object.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.base.ListLike(*objects: Any, **params: Any)[source]#

Bases: Parameterized

objects = param.Children(allow_refs=False, bounds=(0, None), class_=<class ‘panel.viewable.Viewable’>, default=[], item_type=<class ‘panel.viewable.Viewable’>, label=’Objects’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1454ba5d0>): The list of child objects that make up the layout.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

extend(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

pop(index: int) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

class panel.layout.base.ListPanel(*objects: Any, **params: Any)[source]#

Bases: ListLike, Panel

An abstract baseclass for Panel objects with list-like children.

Parameters inherited from:

scroll = param.Selector(allow_refs=False, default=False, label=’Scroll’, names={}, nested_refs=False, objects=[False, True, ‘both-auto’, ‘y-auto’, ‘x-auto’, ‘both’, ‘x’, ‘y’], rx=<param.reactive.reactive_ops object at 0x145470590>): Whether to add scrollbars if the content overflows the size of the container. If “both-auto”, will only add scrollbars if the content overflows in either directions. If “x-auto” or “y-auto”, will only add scrollbars if the content overflows in the respective direction. If “both”, will always add scrollbars. If “x” or “y”, will always add scrollbars in the respective direction. If False, overflowing content will be clipped. If True, will only add scrollbars in the direction of the container, (e.g. Column: vertical, Row: horizontal).

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.base.NamedListLike(*items: list[Any | tuple[str, Any]], **params: Any)[source]#

Bases: Parameterized

objects = param.Children(allow_refs=False, bounds=(0, None), class_=<class ‘panel.viewable.Viewable’>, default=[], item_type=<class ‘panel.viewable.Viewable’>, label=’Objects’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1455127d0>): The list of child objects that make up the layout.

append(pane: Any) → None[source]#: Appends an object to the tabs.

Arguments#

obj (object): Panel component to add as a tab.

clear() → None[source]#: Clears the tabs.

clone(*objects: Any, **params: Any) → NamedListLike[source]#: Makes a copy of the Tabs sharing the same parameters.

Arguments#

objects: Objects to add to the cloned Tabs object. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Tabs object

extend(panes: Iterable[Any]) → None[source]#: Extends the the tabs with a list.

Arguments#

objects (list): List of panel components to add as tabs.

insert(index: int, pane: Any) → None[source]#: Inserts an object in the tabs at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert as tabs.

pop(index: int) → Viewable[source]#: Pops an item from the tabs by index.

Arguments#

index (int): The index of the item to pop from the tabs.

remove(pane: Viewable) → None[source]#: Removes an object from the tabs.

Arguments#

obj (object): The object to remove from the tabs.

reverse() → None[source]#: Reverses the tabs.

class panel.layout.base.NamedListPanel(*items: list[Any | tuple[str, Any]], **params: Any)[source]#

Bases: NamedListLike, Panel

Parameters inherited from:

active = param.Integer(allow_refs=False, bounds=(0, None), default=0, inclusive_bounds=(True, True), label=’Active’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145514950>): Index of the currently displayed objects.
scroll = param.ObjectSelector(allow_refs=False, default=False, label=’Scroll’, names={}, nested_refs=False, objects=[False, True, ‘both-auto’, ‘y-auto’, ‘x-auto’, ‘both’, ‘x’, ‘y’], rx=<param.reactive.reactive_ops object at 0x145515310>): Whether to add scrollbars if the content overflows the size of the container. If “both-auto”, will only add scrollbars if the content overflows in either directions. If “x-auto” or “y-auto”, will only add scrollbars if the content overflows in the respective direction. If “both”, will always add scrollbars. If “x” or “y”, will always add scrollbars in the respective direction. If False, overflowing content will be clipped. If True, will only add scrollbars in the direction of the container, (e.g. Column: vertical, Row: horizontal).

append(pane: Any) → None[source]#: Appends an object to the tabs.

Arguments#

obj (object): Panel component to add as a tab.

clear() → None[source]#: Clears the tabs.

clone(*objects: Any, **params: Any) → NamedListLike[source]#: Makes a copy of the Tabs sharing the same parameters.

Arguments#

objects: Objects to add to the cloned Tabs object. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Tabs object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(panes: Iterable[Any]) → None[source]#: Extends the the tabs with a list.

Arguments#

objects (list): List of panel components to add as tabs.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

insert(index: int, pane: Any) → None[source]#: Inserts an object in the tabs at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert as tabs.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the tabs by index.

Arguments#

index (int): The index of the item to pop from the tabs.

remove(pane: Viewable) → None[source]#: Removes an object from the tabs.

Arguments#

obj (object): The object to remove from the tabs.

reverse() → None[source]#: Reverses the tabs.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.base.Panel(refs=None, **params)[source]#

Bases: Reactive

Abstract baseclass for a layout of Viewables.

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.base.Row(*objects: Any, **params: Any)[source]#

Bases: ListPanel

The Row layout allows arranging multiple panel objects in a horizontal container.

It has a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which makes it possible to interactively update and modify the layout.

Reference: https://panel.holoviz.org/reference/layouts/Row.html

Example:

>>> pn.Row(some_widget, some_pane, some_python_object)

Parameters inherited from:

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.base.WidgetBox(*objects: Any, **params: Any)[source]#

Bases: ListPanel

The WidgetBox layout allows arranging multiple panel objects in a vertical (or horizontal) container.

It is largely identical to the Column layout, but has some default styling that makes widgets be clearly grouped together visually.

It has a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which make it possible to interactively update and modify the layout.

Reference: https://panel.holoviz.org/reference/layouts/WidgetBox.html

Example:

>>> pn.WidgetBox(some_widget, another_widget)

Parameters inherited from:

css_classes = param.List(allow_refs=False, bounds=(0, None), default=[‘panel-widget-box’], label=’Css classes’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x14557c990>): CSS classes to apply to the layout.
disabled = param.Boolean(allow_refs=False, default=False, label=’Disabled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x14557e050>): Whether the widget is disabled.
horizontal = param.Boolean(allow_refs=False, default=False, label=’Horizontal’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x14557c410>): Whether to lay out the widgets in a Row layout as opposed to a Column layout.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

`card` Module#

class panel.layout.card.Card(*objects, **params)[source]#

Bases: Column

A Card layout allows arranging multiple panel objects in a collapsible, vertical container with a header bar.

Reference: https://panel.holoviz.org/reference/layouts/Card.html

Example:

>>> pn.Card(
...     some_widget, some_pane, some_python_object,
...     title='Card', styles=dict(background='WhiteSmoke'),
... )

Parameters inherited from:

css_classes = param.List(allow_refs=False, bounds=(0, None), default=[‘card’], label=’Css classes’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x145c6c290>): CSS classes to apply to the overall Card.
active_header_background = param.String(allow_refs=False, default=’’, label=’Active header background’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x141505990>): A valid CSS color for the header background when not collapsed.
button_css_classes = param.List(allow_refs=False, bounds=(0, None), default=[‘card-button’], label=’Button css classes’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145c6c290>): CSS classes to apply to the button element.
collapsible = param.Boolean(allow_refs=False, default=True, label=’Collapsible’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145d8a1d0>): Whether the Card should be expandable and collapsible.
collapsed = param.Boolean(allow_refs=False, default=False, label=’Collapsed’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145c6c290>): Whether the contents of the Card are collapsed.
header = param.Parameter(allow_None=True, allow_refs=False, label=’Header’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145d66150>): A Panel component to display in the header bar of the Card. Will override the given title if defined.
header_background = param.String(allow_refs=False, default=’’, label=’Header background’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145c6c290>): A valid CSS color for the header background.
header_color = param.String(allow_refs=False, default=’’, label=’Header color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145d71310>): A valid CSS color to apply to the header text.
header_css_classes = param.List(allow_refs=False, bounds=(0, None), default=[‘card-header’], label=’Header css classes’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145c6c290>): CSS classes to apply to the header element.
hide_header = param.Boolean(allow_refs=False, default=False, label=’Hide header’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145d71310>): Whether to skip rendering the header.
title_css_classes = param.List(allow_refs=False, bounds=(0, None), default=[‘card-title’], label=’Title css classes’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145d6c590>): CSS classes to apply to the header title.
title = param.String(allow_refs=False, default=’’, label=’Title’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145d66150>): A title to be displayed in the Card header, will be overridden by the header if defined.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

`feed` Module#

class panel.layout.feed.Feed(*objects, **params)[source]#

Bases: Column

The Feed class inherits from the Column layout, thereby enabling the arrangement of multiple panel objects within a vertical container. However, it restrictively manages the number of objects displayed at any moment. This layout is particularly useful for efficiently rendering a substantial number of objects.

Similar to Column, the Feed provides a list-like API, including methods such as append, extend, clear, insert, pop, remove, and __setitem__. These methods facilitate interactive updates and modifications to the layout.

Reference: https://panel.holoviz.org/reference/layouts/Feed.html

Example:

>>> pn.Feed(some_widget, some_pane, some_python_object, ..., python_object_1002)

Parameters inherited from:

scroll = param.Selector(allow_refs=False, default=’y’, label=’Scroll’, names={}, nested_refs=False, objects=[False, True, ‘both-auto’, ‘y-auto’, ‘x-auto’, ‘both’, ‘x’, ‘y’], rx=<param.reactive.reactive_ops object at 0x145f1ef90>): Whether to add scrollbars if the content overflows the size of the container. If “both-auto”, will only add scrollbars if the content overflows in either directions. If “x-auto” or “y-auto”, will only add scrollbars if the content overflows in the respective direction. If “both”, will always add scrollbars. If “x” or “y”, will always add scrollbars in the respective direction. If False, overflowing content will be clipped. If True, will only add scrollbars in the direction of the container, (e.g. Column: vertical, Row: horizontal).
load_buffer = param.Integer(allow_refs=False, bounds=(0, None), default=50, inclusive_bounds=(True, True), label=’Load buffer’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145f25e10>): The number of objects loaded on each side of the visible objects. When scrolled halfway into the buffer, the feed will automatically load additional objects while unloading objects on the opposite side.
visible_range = param.Range(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Visible range’, length=2, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x145f1ff50>): Read-only upper and lower bounds of the currently visible feed objects. This list is automatically updated based on scrolling.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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.

scroll_to_latest()[source]#: Scrolls the Feed to the latest entry.

select(selector=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

`flex` Module#

class panel.layout.flex.FlexBox(*objects, **params)[source]#

Bases: ListLike, ReactiveHTML

The FlexBox is a list-like layout (unlike GridSpec) that wraps objects into a CSS flex container.

It has a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which makes it possible to interactively update and modify the layout. It exposes all the CSS options for controlling the behavior and layout of the flex box.

Reference: https://panel.holoviz.org/reference/layouts/FlexBox.html

Example:

>>> pn.FlexBox(
...    some_python_object, another_python_object, ...,
...    the_last_python_object
... )

Parameters inherited from:

align_content = param.Selector(allow_refs=False, default=’flex-start’, label=’Align content’, names={}, nested_refs=False, objects=[‘normal’, ‘flex-start’, ‘flex-end’, ‘center’, ‘space-between’, ‘space-around’, ‘space-evenly’, ‘stretch’, ‘start’, ‘end’, ‘baseline’, ‘first baseline’, ‘last baseline’], rx=<param.reactive.reactive_ops object at 0x14611fbd0>): Defines how a flex container’s lines align when there is extra space in the cross-axis.
align_items = param.Selector(allow_refs=False, default=’flex-start’, label=’Align items’, names={}, nested_refs=False, objects=[‘stretch’, ‘flex-start’, ‘flex-end’, ‘center’, ‘baseline’, ‘first baseline’, ‘last baseline’, ‘start’, ‘end’, ‘self-start’, ‘self-end’], rx=<param.reactive.reactive_ops object at 0x1461550d0>): Defines the default behavior for how flex items are laid out along the cross axis on the current line.
flex_direction = param.Selector(allow_refs=False, default=’row’, label=’Flex direction’, names={}, nested_refs=False, objects=[‘row’, ‘row-reverse’, ‘column’, ‘column-reverse’], rx=<param.reactive.reactive_ops object at 0x1461632d0>): This establishes the main-axis, thus defining the direction flex items are placed in the flex container.
flex_wrap = param.Selector(allow_refs=False, default=’wrap’, label=’Flex wrap’, names={}, nested_refs=False, objects=[‘nowrap’, ‘wrap’, ‘wrap-reverse’], rx=<param.reactive.reactive_ops object at 0x146163610>): Whether and how to wrap items in the flex container.
gap = param.String(allow_refs=False, default=’’, label=’Gap’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x146163390>): Defines the spacing between flex items, supporting various units (px, em, rem, %, vw/vh).
justify_content = param.Selector(allow_refs=False, default=’flex-start’, label=’Justify content’, names={}, nested_refs=False, objects=[‘flex-start’, ‘flex-end’, ‘center’, ‘space-between’, ‘space-around’, ‘space-evenly’, ‘start’, ‘end’, ‘left’, ‘right’], rx=<param.reactive.reactive_ops object at 0x1461635d0>): Defines the alignment along the main axis.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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_event(node: str, event: str, callback: Callable) → None[source]#

Registers a callback to be executed when the specified DOM event is triggered on the named node. Note that the named node must be declared in the HTML. To create a named node you must give it an id of the form id=”name”, where name will be the node identifier.

Arguments#

node: str: Named node in the HTML identifiable via id of the form id=”name”.
event: str: Name of the DOM event to add an event listener to.
callback: callable: A callable which will be given the DOMEvent object.

pop(index: int) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

`float` Module#

class panel.layout.float.FloatPanel(*objects, name='', **params)[source]#

Bases: ListLike, ReactiveHTML

Float provides a floating panel layout.

Reference: https://panel.holoviz.org/reference/layouts/FloatPanel.html

Example:

>>> import panel as pn
>>> pn.extension("floatpanel")
>>> pn.layout.FloatPanel("**I can float**!", position="center", width=300).servable()

Parameters inherited from:

config = param.Dict(allow_refs=False, class_=<class ‘dict’>, default={}, label=’Config’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x14631d950>): Additional jsPanel configuration with precedence over parameter values.
contained = param.Boolean(allow_refs=False, default=True, label=’Contained’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x146325d50>): Whether the component is contained within parent container or completely free floating.
position = param.Selector(allow_refs=False, default=’right-top’, label=’Position’, names={}, nested_refs=False, objects=[‘center’, ‘left-top’, ‘center-top’, ‘right-top’, ‘right-center’, ‘right-bottom’, ‘center-bottom’, ‘left-bottom’, ‘left-center’], rx=<param.reactive.reactive_ops object at 0x14631da50>): The initial position if the container is free-floating.
offsetx = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Offsetx’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x146326510>): Horizontal offset in pixels.
offsety = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Offsety’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x146324390>): Vertical offset in pixels.
theme = param.String(allow_refs=False, default=’primary’, label=’Theme’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x146325b10>): The theme which can be one of: - Built-ins: ‘default’, ‘primary’, ‘secondary’, ‘info’, ‘success’, ‘warning’, ‘danger’, ‘light’, ‘dark’ and ‘none’ - HEX, RGB and HSL color values like ‘#123456’ Any standardized color name like ‘forestgreen’ and color names from the Material Design Color System like ‘purple900’ - Additionally a theme string may include one of the modifiers ‘filled’, ‘filledlight’, ‘filleddark’ or ‘fillcolor’ separated from the theme color by a space like ‘primary
status = param.Selector(allow_refs=False, default=’normalized’, label=’Status’, names={}, nested_refs=False, objects=[‘normalized’, ‘maximized’, ‘minimized’, ‘smallified’, ‘smallifiedmax’, ‘closed’], rx=<param.reactive.reactive_ops object at 0x14631da50>): The current status of the panel.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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_event(node: str, event: str, callback: Callable) → None[source]#

Registers a callback to be executed when the specified DOM event is triggered on the named node. Note that the named node must be declared in the HTML. To create a named node you must give it an id of the form id=”name”, where name will be the node identifier.

Arguments#

node: str: Named node in the HTML identifiable via id of the form id=”name”.
event: str: Name of the DOM event to add an event listener to.
callback: callable: A callable which will be given the DOMEvent object.

pop(index: int) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

`grid` Module#

Layout components to lay out objects in a grid.

class panel.layout.grid.GridBox(*objects: Any, **params: Any)[source]#

Bases: ListPanel

The GridBox is a list-like layout (unlike GridSpec) that wraps objects into a grid according to the specified nrows and ncols parameters.

It has a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which makes it possible to interactively update and modify the layout.

Reference: https://panel.holoviz.org/reference/layouts/GridBox.html

Example:

>>> pn.GridBox(
...    python_object_1, python_object_2, ...,
...    python_object_24, ncols=6
... )

Parameters inherited from:

nrows = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Nrows’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1464e8790>): Number of rows to reflow the layout into.
ncols = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Ncols’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x146547310>): Number of columns to reflow the layout into.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.grid.GridSpec(*, mode, ncols, nrows, objects, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, name)[source]#

Bases: Panel

The GridSpec is an array like layout that allows arranging multiple Panel objects in a grid using a simple API to assign objects to individual grid cells or to a grid span.

Other layout containers function like lists, but a GridSpec has an API similar to a 2D array, making it possible to use 2D assignment to populate, index, and slice the grid.

See GridStack for a similar layout that allows the user to resize and drag the cells.

Reference: https://panel.holoviz.org/reference/layouts/GridSpec.html

Example:

>>> import panel as pn
>>> gspec = pn.GridSpec(width=800, height=600)
>>> gspec[:,   0  ] = pn.Spacer(styles=dict(background='red'))
>>> gspec[0,   1:3] = pn.Spacer(styles=dict(background='green'))
>>> gspec[1,   2:4] = pn.Spacer(styles=dict(background='orange'))
>>> gspec[2,   1:4] = pn.Spacer(styles=dict(background='blue'))
>>> gspec[0:1, 3:4] = pn.Spacer(styles=dict(background='purple'))
>>> gspec

Parameters inherited from:

objects = param.ChildDict(allow_refs=False, class_=<class ‘dict’>, default={}, label=’Objects’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x146568150>): The dictionary of child objects that make up the grid.
mode = param.ObjectSelector(allow_refs=False, default=’warn’, label=’Mode’, names={}, nested_refs=False, objects=[‘warn’, ‘error’, ‘override’], rx=<param.reactive.reactive_ops object at 0x146570190>): Whether to warn, error or simply override on overlapping assignment.
ncols = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Ncols’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x146570450>): Limits the number of columns that can be assigned.
nrows = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Nrows’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x146570810>): Limits the number of rows that can be assigned.

clone(**params)[source]#: Makes a copy of the GridSpec sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned GridSpec object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

`gridstack` Module#

class panel.layout.gridstack.GridStack(*, allow_drag, allow_resize, state, mode, ncols, nrows, objects, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, name)[source]#

Bases: ReactiveHTML, GridSpec

The GridStack layout allows arranging multiple Panel objects in a grid using a simple API to assign objects to individual grid cells or to a grid span.

Other layout containers function like lists, but a GridSpec has an API similar to a 2D array, making it possible to use 2D assignment to populate, index, and slice the grid.

Reference: https://panel.holoviz.org/reference/layouts/GridStack.html

Example:

>>> pn.extension('gridstack')
>>> gstack = GridStack(sizing_mode='stretch_both')
>>> gstack[ : , 0: 3] = pn.Spacer(styles=dict(background='red'))
>>> gstack[0:2, 3: 9] = pn.Spacer(styles=dict(background='green'))
>>> gstack[2:4, 6:12] = pn.Spacer(styles=dict(background='orange'))
>>> gstack[4:6, 3:12] = pn.Spacer(styles=dict(background='blue'))
>>> gstack[0:2, 9:12] = pn.Spacer(styles=dict(background='purple'))

Parameters inherited from:

height = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1468d9bd0>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1468d2c50>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
allow_resize = param.Boolean(allow_refs=False, default=True, label=’Allow resize’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1468dab10>): Allow resizing the grid cells.
allow_drag = param.Boolean(allow_refs=False, default=True, label=’Allow drag’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1468d8750>): Allow dragging the grid cells.
state = param.List(allow_refs=False, bounds=(0, None), default=[], label=’State’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x145f92250>): Current state of the grid (updated as items are resized and dragged).

clone(**params)[source]#: Makes a copy of the GridSpec sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned GridSpec object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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_event(node: str, event: str, callback: Callable) → None[source]#

Registers a callback to be executed when the specified DOM event is triggered on the named node. Note that the named node must be declared in the HTML. To create a named node you must give it an id of the form id=”name”, where name will be the node identifier.

Arguments#

node: str: Named node in the HTML identifiable via id of the form id=”name”.
event: str: Name of the DOM event to add an event listener to.
callback: callable: A callable which will be given the DOMEvent object.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

`spacer` Module#

Spacer components to add horizontal or vertical space to a layout.

class panel.layout.spacer.Divider(refs=None, **params)[source]#

Bases: Reactive

A Divider draws a horizontal rule (a <hr> tag in HTML) to separate multiple components in a layout. It automatically spans the full width of the container.

Reference: https://panel.holoviz.org/reference/layouts/Divider.html

Example:

>>> pn.Column(
...     '# Lorem Ipsum',
...     pn.layout.Divider(),
...     'A very long text... '
>>> )

Parameters inherited from:

width_policy = param.ObjectSelector(allow_refs=False, constant=True, default=’fit’, label=’Width policy’, names={}, nested_refs=False, objects=[‘auto’, ‘fixed’, ‘fit’, ‘min’, ‘max’], readonly=True, rx=<param.reactive.reactive_ops object at 0x146a9f790>): Describes how the component should maintain its width. "auto" Use component’s preferred sizing policy. "fixed" Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space. "fit" Use component’s preferred width (if set) and allow it to fit into the available horizontal space within the minimum and maximum width bounds (if set). Component’s width neither will be aggressively minimized nor maximized. "min" Use as little horizontal space as possible, not less than the minimum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors. "max" Use as much horizontal space as possible, not more than the maximum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.spacer.HSpacer(refs=None, **params)[source]#

Bases: Spacer

The HSpacer layout provides responsive horizontal spacing.

Using this component we can space objects equidistantly in a layout and allow the empty space to shrink when the browser is resized.

How-to: https://panel.holoviz.org/how_to/layout/spacing.html#spacer-components

Example:

>>> pn.Row(
...     pn.layout.HSpacer(), 'Item 1',
...     pn.layout.HSpacer(), 'Item 2',
...     pn.layout.HSpacer()
... )

Parameters inherited from:

sizing_mode = param.Parameter(allow_refs=False, constant=True, default=’stretch_width’, label=’Sizing mode’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x146a0aa90>): How the component should size itself. This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode). "fixed" Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events. "stretch_width" Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_height" Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_both" Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component. "scale_width" Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio. "scale_height" Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio. "scale_both" Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.spacer.Spacer(refs=None, **params)[source]#

Bases: Reactive

The Spacer layout is a very versatile component which makes it easy to put fixed or responsive spacing between objects.

Like all other components spacers support both absolute and responsive sizing modes.

How-to: https://panel.holoviz.org/how_to/layout/spacing.html#spacer-components

Example:

>>> pn.Row(
...    1, pn.Spacer(width=200),
...    2, pn.Spacer(width=100),
...    3
... )

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

class panel.layout.spacer.VSpacer(refs=None, **params)[source]#

Bases: Spacer

The VSpacer layout provides responsive vertical spacing.

Using this component we can space objects equidistantly in a layout and allow the empty space to shrink when the browser is resized.

Reference: https://panel.holoviz.org/how_to/layout/spacing.html#spacer-components

Example:

>>> pn.Column(
...     pn.layout.VSpacer(), 'Item 1',
...     pn.layout.VSpacer(), 'Item 2',
...     pn.layout.VSpacer()
... )

Parameters inherited from:

sizing_mode = param.Parameter(allow_refs=False, constant=True, default=’stretch_height’, label=’Sizing mode’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x146aef110>): How the component should size itself. This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode). "fixed" Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events. "stretch_width" Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_height" Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_both" Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component. "scale_width" Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio. "scale_height" Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio. "scale_both" Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

`swipe` Module#

The Swipe layout enables you to quickly compare two panels

class panel.layout.swipe.Swipe(*objects, **params)[source]#

Bases: ListLike, ReactiveHTML

The Swipe layout enables you to quickly compare two panels laid out on top of each other with a part of the before panel shown on one side of a slider and a part of the after panel shown on the other side.

Parameters inherited from:

objects = param.List(allow_refs=False, bounds=(0, 2), default=[], item_type=<class ‘panel.viewable.Viewable’>, label=’Objects’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x146be4290>): The list of child objects that make up the layout.
slider_width = param.Integer(allow_refs=False, bounds=(0, 25), default=5, inclusive_bounds=(True, True), label=’Slider width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x146fa59d0>): The width of the slider in pixels
slider_color = param.Color(allow_named=True, allow_refs=False, default=’black’, label=’Slider color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x147109b10>): The color of the slider
value = param.Integer(allow_refs=False, bounds=(0, 100), default=50, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1470f9e10>): The percentage of the after panel to show.

_before = param.Parameter(allow_None=True, allow_refs=False, label=’ before’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x147109e10>)

_after = param.Parameter(allow_None=True, allow_refs=False, label=’ after’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1470f95d0>)

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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_event(node: str, event: str, callback: Callable) → None[source]#

Registers a callback to be executed when the specified DOM event is triggered on the named node. Note that the named node must be declared in the HTML. To create a named node you must give it an id of the form id=”name”, where name will be the node identifier.

Arguments#

node: str: Named node in the HTML identifiable via id of the form id=”name”.
event: str: Name of the DOM event to add an event listener to.
callback: callable: A callable which will be given the DOMEvent object.

pop(index: int) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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

`tabs` Module#

Layout component to lay out objects in a set of tabs.

class panel.layout.tabs.Tabs(*objects, **params)[source]#

Bases: NamedListPanel

The Tabs layout allows switching between multiple objects by clicking on the corresponding tab header.

Tab labels may be defined explicitly as part of a tuple or will be inferred from the name parameter of the tab’s contents.

Like Column and Row, Tabs has a list-like API with methods to append, extend, clear, insert, pop, remove and __setitem__, which make it possible to interactively update and modify the tabs.

Reference: https://panel.holoviz.org/reference/layouts/Tabs.html

Example:

>>> pn.Tabs(('Scatter', plot1), some_pane_with_a_name)

Parameters inherited from:

height = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1472e2850>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1472ffcd0>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
closable = param.Boolean(allow_refs=False, default=False, label=’Closable’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1472e1d10>): Whether it should be possible to close tabs.
dynamic = param.Boolean(allow_refs=False, default=False, label=’Dynamic’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1472e2fd0>): Dynamically populate only the active tab.
tabs_location = param.ObjectSelector(allow_refs=False, default=’above’, label=’Tabs location’, names={}, nested_refs=False, objects=[‘above’, ‘below’, ‘left’, ‘right’], rx=<param.reactive.reactive_ops object at 0x147177950>): The location of the tabs relative to the tab contents.

append(pane: Any) → None[source]#: Appends an object to the tabs.

Arguments#

obj (object): Panel component to add as a tab.

clear() → None[source]#: Clears the tabs.

clone(*objects: Any, **params: Any) → NamedListLike[source]#: Makes a copy of the Tabs sharing the same parameters.

Arguments#

objects: Objects to add to the cloned Tabs object. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Tabs object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

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.

Arguments#

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.

Returns#

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: str | None = None, progress: bool = False, states={}) → None[source]#

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.

Arguments#

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(panes: Iterable[Any]) → None[source]#: Extends the the tabs with a list.

Arguments#

objects (list): List of panel components to add as tabs.

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

Returns the root model and applies pre-processing hooks

Arguments#

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

Returns#

Returns the bokeh model corresponding to this panel object

insert(index: int, pane: Any) → None[source]#: Inserts an object in the tabs at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert as tabs.

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

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.

Arguments#

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: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

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.

Arguments#

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: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

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.

Arguments#

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) → Viewable[source]#: Pops an item from the tabs by index.

Arguments#

index (int): The index of the item to pop from the tabs.

remove(pane: Viewable) → None[source]#: Removes an object from the tabs.

Arguments#

obj (object): The object to remove from the tabs.

reverse() → None[source]#: Reverses the tabs.

save(filename: str | PathLike | IO, title: str | None = 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: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

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=None)[source]#

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

Arguments#

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: list(Viewable)

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

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.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
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.

Returns#

The Panel object itself

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

Returns a serveable bokeh Document with the panel attached

Arguments#

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

Returns#

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

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

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

Arguments#

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

Returns#

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