Page

Page

Page(
    *,
    content: PageContent,
    title: TemplatedStringItem | None = None,
    route: Route | None = None,
    description: str | None = None,
)

Provides a flexible way to structure dashboard content.

Constructor for Page.

Parameters:

Name	Type	Description	Default
content	PageContent	Dashboard content.	required
title	TemplatedStringItem | None	Dashboard title to be displayed.	None
route	Route | None	Route for the page.	None
description	str | None	page description.	None

Route

Route(data: DataType | DataFrame, *, query_parameter: str)

Specs for dashboard Route.

Constructor for dashboard Route.

Parameters:

Name	Type	Description	Default
data	DataType | DataFrame	data for the widget. Can be a pandas dataframe or Storage object if the data is to be retrieved from a storage.	required
query_parameter	str	parameter that will be used to apply url queries.	required

RootGrid

RootGrid(*items: RootGridItem)

Spec for a root grid in a dashboard.

Construct dashboard grid.

Parameters:

Name	Type	Description	Default
items	RootGridItem	items to add to grid. Can be widgets, rows or selectable sections (e.g tabs).	()

Types

PageContent module-attribute

PageContent: TypeAlias = (
    PageContentStrict | RootGridItem | list[RootGridItem]
)

PageContentStrict module-attribute

PageContentStrict = RootGrid

RootGridItem module-attribute

RootGridItem: TypeAlias = RootGridItemStrict | RowItem

RootGridItemStrict module-attribute

RootGridItemStrict: TypeAlias = (
    Row
    | FluidRow
    | CollapsibleSection
    | CollapsibleTabSection
)