Config#
- class lumen.dashboard.Config(**params)#
Config provides high-level configuration options for the
lumen.dashboard.Dashboard
.
Parameters#
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.
type: bool
default: False
Whether to load any layouts in the background.
type: bool
default: False
Whether the dashboard specification is editable from withinthe deployed dashboard.
type: Any
default: panel.FlexBox
Possible values: panel.Accordion | panel.Column | panel.GridBox | panel.Row | panel.Tabs | panel.FlexBox
Overall layout of the dashboard.
type: Any
default: '#00aa41'
Color of the loading indicator.
type: Any
default: 'dots'
Possible values: 'arc' | 'arcs' | 'bar' | 'dots' | 'petal'
Loading indicator to use when component loading parameter is set.
type: str
default: None
A logo to add to the theme.
type: str
default: 'Config'
String identifier for this object.
type: int
default: 3
bounds: (1, None)
Number of columns to lay out layouts in.
type: bool
default: True
Whether to allow reloading data from source(s) using a button.
type: bool
default: False
Whether to sync current state of the application.
type: Any
default: panel.template.MaterialTemplate
Possible values: panel.template.BootstrapTemplate | panel.template.ReactTemplate | panel.template.GoldenTemplate | panel.template.MaterialTemplate | panel.template.VanillaTemplate | panel.template.FastListTemplate | panel.template.FastGridTemplate
The Panel template to render the dashboard into.
type: Any
default: panel.template.DefaultTheme
Possible values: panel.template.DefaultTheme | panel.template.DarkTheme
The Panel template theme to style the dashboard with.
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.