API Reference#

The Panel API Reference Manual provides a comprehensive reference for all methods and parameters on Panel components. For more information on how to use the components see the Component Gallery.

Overview#

Cheat Sheet

The Cheat Sheet provides a high-level overview of some of the most important functions in Panel.

Cheat Sheet
Config

The panel.config provides a way to set high-level configuration options.

Config
State

The panel.state object holds session state and provide various methods to attach events and tasks to a session.

State

Module Structure#

panel.auth

Module containing authentication handlers.

panel.chat

Subpackage containing Panel Chat components

panel.command

Subpackage containing Panel CLI commands

panel.compiler

Utilities for bundling and compiling external JS and CSS resources.

panel.config

Module containing Panel config and extension objects.

panel.custom

Baseclasses for creating custom components.

panel.depends

Module exposing param.bind and param.depends.

panel.interact

Module implementing the interact API.

panel.io

Subpackage containing all IO related functionality.

panel.layout

Subpackage containing layout components

panel.links

Module containing implementation responsible Javascript linking and callbacks.

panel.models

Subpackage containing Bokeh model implementations of custom components.

panel.pane

Subpackage containing Pane components.

panel.param

Module implementing components for integration with the param library.

panel.pipeline

Module containing the Pipeline component.

panel.reactive

Module containing baseclasses for Panel components with reactive APIs.

panel.template

Subpackage containing implementations for Template components.

panel.theme

Subpackage implementing Design and Theme components.

panel.util

Subpackage containing generic utilities.

panel.viewable

Module containing baseclasses for all Panel components.

panel.widgets

Subpackage containing Widget components.