Config#

class lumen.dashboard.Config(*, auto_update, background_load, editable, layout, loading_color, loading_spinner, logo, ncols, on_error, on_loaded, on_session_created, on_session_destroyed, on_update, raise_with_notifications, reloadable, show_traceback, sync_with_url, template, theme, title, name)#

Config provides high-level configuration options for the lumen.dashboard.Dashboard.

Parameters#

auto_update

type: bool
default: None
Whether changes in filters, transforms and references automaticallytrigger updates in the data or whether an update has to be triggeredmanually using the update event or the update button in the UI.

background_load

type: bool
default: False
Whether to load any layouts in the background.

editable

type: bool
default: False
Whether the dashboard specification is editable from withinthe deployed dashboard.

layout

type: Any
default: panel.FlexBox
Possible values: panel.Accordion | panel.Column | panel.GridBox | panel.Row | panel.Tabs | panel.FlexBox
Overall layout of the dashboard.

loading_color

type: Any
default: '#0072B5'
Color of the loading indicator.

loading_spinner

type: Any
default: 'arc'
Possible values: 'arc' | 'arcs' | 'bar' | 'dots' | 'petal'
Loading indicator to use when component loading parameter is set.

logo

type: str
default: None
A logo to add to the theme.

name

type: str
default: 'Config'
String identifier for this object.

ncols

type: int
default: 3
bounds: (1, None)
Number of columns to lay out layouts in.

on_error

type: Any
default: None
Callback that fires if an error occurs in a dashboard callback.The exception is passed as the first argument.

on_loaded

type: Any
default: None
Callback that fires when a user frontend session is fully loaded.

on_session_created

type: Any
default: None
Callback that fires when a user session is created.

on_session_destroyed

type: Any
default: None
Callback that fires when a user session is destroyed.

on_update

type: Any
default: None
Callback that fires when a pipeline is updated. The updatedpipeline is passed as the first argument.

raise_with_notifications

type: bool
default: True
Whether to raise exceptions when notifications are enabled.

reloadable

type: bool
default: True
Whether to allow reloading data from source(s) using a button.

show_traceback

type: bool
default: True
Whether to show the traceback if an error happens.

sync_with_url

type: bool
default: False
Whether to sync current state of the application.

template

type: Any
default: panel.template.MaterialTemplate
The Panel template to render the dashboard into.

theme

type: Any
default: panel.theme.DefaultTheme
Possible values: panel.theme.DefaultTheme | panel.theme.DarkTheme
The Panel template theme to style the dashboard with.

title

type: str
default: 'Lumen Dashboard'
The title of the dashboard.

Methods#

Config.construct_template()#
Config.to_spec(context: dict[str, Any] | None = None) → dict[str, Any]#

Exports the full specification to reconstruct this component.

Parameters:

context (Dict[str, Any]) – Context contains the specification of all previously serialized components, e.g. to allow resolving of references.

Return type:

Declarative specification of this component.