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#
The Cheat Sheet provides a high-level overview of some of the most important functions in Panel.
The panel.config provides a way to set high-level configuration options.
The panel.state object holds session state and provide various methods to attach events and tasks to a session.
Module Structure#
panel.authModule containing authentication handlers.
panel.chatSubpackage containing Panel Chat components
panel.commandSubpackage containing Panel CLI commands
panel.compilerUtilities for bundling and compiling external JS and CSS resources.
panel.configModule containing Panel config and extension objects.
panel.customBaseclasses for creating custom components.
panel.dependsModule exposing
param.bindandparam.depends.panel.interactModule implementing the
interactAPI.panel.ioSubpackage containing all IO related functionality.
panel.layoutSubpackage containing layout components
panel.linksModule containing implementation responsible Javascript linking and callbacks.
panel.modelsSubpackage containing Bokeh model implementations of custom components.
panel.paneSubpackage containing
Panecomponents.panel.paramModule implementing components for integration with the param library.
panel.pipelineModule containing the
Pipelinecomponent.panel.reactiveModule containing baseclasses for Panel components with reactive APIs.
panel.templateSubpackage containing implementations for
Templatecomponents.panel.themeSubpackage implementing
DesignandThemecomponents.panel.utilSubpackage containing generic utilities.
panel.viewableModule containing baseclasses for all Panel components.
panel.widgetsSubpackage containing
Widgetcomponents.