panel.fast Package#
fast
Package#
The Fast Templates provide easy to use, great looking templates for Panel based on the https://fast.design framework.
base
Module#
- class panel.template.fast.base.FastBaseTemplate(*, accent_base_color, background_color, corner_radius, font, font_url, header_accent_base_color, header_neutral_color, main_layout, neutral_color, shadow, sidebar_footer, theme_toggle, _actions, base_target, base_url, busy_indicator, collapsed_sidebar, favicon, header, header_background, header_color, logo, main, main_max_width, manifest, meta_author, meta_description, meta_keywords, meta_refresh, meta_viewport, modal, notifications, sidebar, sidebar_width, site, site_url, title, config, design, location, theme, name)[source]#
Bases:
BasicTemplate
Parameters inherited from:
panel.template.base.BaseTemplate
: config, themepanel.template.base.BasicTemplate
: location, busy_indicator, collapsed_sidebar, header, main, main_max_width, sidebar, sidebar_width, modal, notifications, logo, favicon, title, site, site_url, manifest, meta_description, meta_keywords, meta_author, meta_refresh, meta_viewport, base_url, base_target, header_background, header_color, _actionsdesign
= param.ClassSelector(allow_refs=False, class_=<class βpanel.theme.base.Designβ>, default=<class βpanel.theme.fast.Fastβ>, label=βDesignβ, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x308928790>)A Design applies a specific design system to a template.
accent_base_color
= param.Color(allow_named=True, allow_refs=False, default=β#0072B5β, label=βAccent base colorβ, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x30880b8d0>)Optional body accent color override.
background_color
= param.Color(allow_None=True, allow_named=True, allow_refs=False, label=βBackground colorβ, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x3085a8f50>)Optional body background color override.
corner_radius
= param.Integer(allow_refs=False, bounds=(0, 25), default=3, inclusive_bounds=(True, True), label=βCorner radiusβ, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x3085a9690>)The corner radius applied to controls.
font
= param.String(allow_refs=False, default=ββ, label=βFontβ, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x3085a8ed0>)The font name(s) to apply.
font_url
= param.String(allow_refs=False, default=ββ, label=βFont urlβ, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x3085a94d0>)A font url to import.
header_neutral_color
= param.Color(allow_None=True, allow_named=True, allow_refs=False, label=βHeader neutral colorβ, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x3085a8e90>)Optional header neutral color override.
header_accent_base_color
= param.Color(allow_None=True, allow_named=True, allow_refs=False, label=βHeader accent base colorβ, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x3085a9550>)Optional header accent color override.
neutral_color
= param.Color(allow_None=True, allow_named=True, allow_refs=False, label=βNeutral colorβ, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x3085a8ed0>)Optional body neutral color override.
theme_toggle
= param.Boolean(allow_refs=False, default=True, label=βTheme toggleβ, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x3085a9350>)If True a switch to toggle the Theme is shown.
shadow
= param.Boolean(allow_refs=False, default=False, label=βShadowβ, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x3085a8e90>)Optional shadow override. Whether or not to apply shadow.
sidebar_footer
= param.String(allow_refs=False, default=ββ, label=βSidebar footerβ, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x3085a9350>)A HTML string appended to the sidebar
main_layout
= param.Selector(allow_refs=False, default=βcardβ, names={}, nested_refs=False, objects=[None, βcardβ], rx=<param.reactive.reactive_ops object at 0x3085a8dd0>)What to wrap the main components into. Options are ββ (i.e. none) and βcardβ (Default). Could be extended to Accordion, Tab etc. in the future.
- resolve_resources(cdn: bool | Literal['auto'] = 'auto', extras: dict[str, dict[str, str]] | None = None) ResourcesType [source]#
Resolves the resources required for this template component.
- Parameters:
cdn (bool | Literal['auto']) β Whether to load resources from CDN or local server. If set to βautoβ value will be automatically determine based on global settings.
extras (dict[str, dict[str, str]] | None) β Additional resources to add to the bundle. Valid resource types include js, js_modules and css.
- Return type:
Dictionary containing JS and CSS resources.
- save(filename: str | PathLike | IO, title: str | None = None, resources=None, 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) None [source]#
Saves Panel objects to file.
- Parameters:
filename (string or file-like object) β Filename to save the plot to
title (string) β Optional title for the plot
resources (bokeh resources) β One of the valid bokeh.resources (e.g. CDN or INLINE)
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.
- select(selector=None)[source]#
Iterates over the Template and any potential children in the applying the Selector.
- Parameters:
selector (type or callable or None) β The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.
- Returns:
viewables
- Return type:
list(Viewable)
- servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) BaseTemplate [source]#
Serves the template and returns self to allow it to display itself in a notebook context.
- Parameters:
title (str) β A string title to give the Document (if served as an app)
location (boolean or panel.io.location.Location) β Whether to create a Location component to observe and set the URL location.
area (str (deprecated)) β The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target (str) β Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.
- Return type:
The template
- server_doc(doc: Document | None = None, title: str = None, location: bool | Location = True) Document [source]#
Returns a servable bokeh Document with the panel attached
- Parameters:
doc (bokeh.Document (optional)) β The Bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
title (str) β A string title to give the Document
location (boolean or panel.io.location.Location) β Whether to create a Location component to observe and set the URL location.
- Returns:
doc β The Bokeh document the panel was attached to
- Return type:
bokeh.Document
- show(title: 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.
- Parameters:
title (str | None) β A string title to give the Document (if served as an app)
port (int (optional, default=0)) β Allows specifying a specific port
address (str) β The address the server should listen on for HTTP requests.
websocket_origin (str or list(str) (optional)) β A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, βlocalhostβ is used.
threaded (boolean (optional, default=False)) β Whether to launch the Server on a separate thread, allowing interactive use.
verbose (boolean (optional, default=True)) β Whether to print the address and port
open (boolean (optional, default=True)) β Whether to open the server in a new browser tab
location (boolean or panel.io.location.Location) β Whether to create a Location component to observe and set the URL location.
- Returns:
server β Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)
- Return type:
bokeh.server.Server or panel.io.server.StoppableThread
- theme[source]#
alias of
DefaultTheme
- class panel.template.fast.base.FastGridBaseTemplate(*, accent_base_color, background_color, corner_radius, font, font_url, header_accent_base_color, header_neutral_color, main_layout, neutral_color, shadow, sidebar_footer, theme_toggle, breakpoints, cols, compact, dimensions, prevent_collision, row_height, save_layout, _actions, base_target, base_url, busy_indicator, collapsed_sidebar, favicon, header, header_background, header_color, logo, main, main_max_width, manifest, meta_author, meta_description, meta_keywords, meta_refresh, meta_viewport, modal, notifications, sidebar, sidebar_width, site, site_url, title, config, design, location, theme, name)[source]#
Bases:
FastBaseTemplate
,ReactTemplate
Combines the FastTemplate and the React template.
Parameters inherited from:
panel.template.base.BaseTemplate
: config, themepanel.template.base.BasicTemplate
: location, busy_indicator, collapsed_sidebar, header, main_max_width, sidebar, sidebar_width, modal, notifications, logo, favicon, title, site, site_url, manifest, meta_description, meta_keywords, meta_author, meta_refresh, meta_viewport, base_url, base_target, header_background, header_color, _actionspanel.template.react.ReactTemplate
: main, compact, cols, breakpoints, row_height, dimensions, prevent_collision, save_layoutpanel.template.fast.base.FastBaseTemplate
: design, accent_base_color, background_color, corner_radius, font, font_url, header_neutral_color, header_accent_base_color, neutral_color, theme_toggle, shadow, sidebar_footer, main_layout- resolve_resources(cdn: bool | Literal['auto'] = 'auto', extras: dict[str, dict[str, str]] | None = None) ResourcesType [source]#
Resolves the resources required for this template component.
- Parameters:
cdn (bool | Literal['auto']) β Whether to load resources from CDN or local server. If set to βautoβ value will be automatically determine based on global settings.
extras (dict[str, dict[str, str]] | None) β Additional resources to add to the bundle. Valid resource types include js, js_modules and css.
- Return type:
Dictionary containing JS and CSS resources.
- save(filename: str | PathLike | IO, title: str | None = None, resources=None, 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) None [source]#
Saves Panel objects to file.
- Parameters:
filename (string or file-like object) β Filename to save the plot to
title (string) β Optional title for the plot
resources (bokeh resources) β One of the valid bokeh.resources (e.g. CDN or INLINE)
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.
- select(selector=None)[source]#
Iterates over the Template and any potential children in the applying the Selector.
- Parameters:
selector (type or callable or None) β The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.
- Returns:
viewables
- Return type:
list(Viewable)
- servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) BaseTemplate [source]#
Serves the template and returns self to allow it to display itself in a notebook context.
- Parameters:
title (str) β A string title to give the Document (if served as an app)
location (boolean or panel.io.location.Location) β Whether to create a Location component to observe and set the URL location.
area (str (deprecated)) β The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target (str) β Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.
- Return type:
The template
- server_doc(doc: Document | None = None, title: str = None, location: bool | Location = True) Document [source]#
Returns a servable bokeh Document with the panel attached
- Parameters:
doc (bokeh.Document (optional)) β The Bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
title (str) β A string title to give the Document
location (boolean or panel.io.location.Location) β Whether to create a Location component to observe and set the URL location.
- Returns:
doc β The Bokeh document the panel was attached to
- Return type:
bokeh.Document
- show(title: 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.
- Parameters:
title (str | None) β A string title to give the Document (if served as an app)
port (int (optional, default=0)) β Allows specifying a specific port
address (str) β The address the server should listen on for HTTP requests.
websocket_origin (str or list(str) (optional)) β A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, βlocalhostβ is used.
threaded (boolean (optional, default=False)) β Whether to launch the Server on a separate thread, allowing interactive use.
verbose (boolean (optional, default=True)) β Whether to print the address and port
open (boolean (optional, default=True)) β Whether to open the server in a new browser tab
location (boolean or panel.io.location.Location) β Whether to create a Location component to observe and set the URL location.
- Returns:
server β Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)
- Return type:
bokeh.server.Server or panel.io.server.StoppableThread
- theme[source]#
alias of
DefaultTheme