Standard pages

Overview

The standard pages are a set of pre-defined pages that can be used as a starting point for building a content library. They provide a basic structure that could suffice for a quick-and-dirty dashboard application.

Reference

class algomancy_content.pages.standardhomepage.StandardHomePage

Bases: BaseHomePage

StandardHomePage is a subclass of BaseHomePage that provides a standard home page layout for an application. It includes a logo, status indicators for scenario processing, and a summary of scenario counts.

USAGE:

>>> config = AppConfig(
...     page_config=PageConfig(home_page="standard"),
...     ...
... )

static create_content()

Creates the content for the home page, including logo, status indicators, and a summary of scenario processing status.

Implements the HomePage Protocol

Returns:

A Dash HTML component representing the home page content

Return type:

html.Div

static register_callbacks()

Has no additional callbacks - navlinks do not require a callback

class algomancy_content.pages.standarddatapage.StandardDataPage

Bases: BaseDataPage

StandardDataPage is a subclass of BaseDataPage that provides a standard data page layout for an application. It includes a table view of the data.tables dictionary.

USAGE:

>>> config = AppConfig(
...     page_config=PageConfig(data_page="standard"),
...     ...
... )

static create_content(data)

Standard data page works on the data.tables dictionary. Creates an accordion of tables from the data.tables dictionary.

Parameters:

data (DataSource) – Derived from BaseDataSource with an attribute tables containing a dictionary of pandas DataFrames.

Note

This page works reasonably well for small to medium-sized datasets. It may become slow for very large datasets due to the rendering of multiple tables. Moreover, this page does not support interactive filtering or sorting of tables, nor is the table rendering optimized for datasets with many columns.

Returns:

Div that contains accordion of tables

Return type:

html.Div

static register_callbacks()

No additional callbacks

class algomancy_content.pages.standardoverviewpage.StandardOverviewPage

Bases: BaseOverviewPage

StandardOverviewPage is a subclass of BaseOverviewPage that provides a standard overview page layout for an application. It includes a table view of the scenarios and their KPIs.

USAGE:

>>> config = AppConfig(
...     page_config=PageConfig(overview_page="standard"),
...     ...
... )

static create_content(scenarios)

Creates the overview page layout with a table of completed scenarios and their KPIs.

This page displays a table where rows represent completed scenarios and columns represent KPIs.

Returns:

A Dash HTML component representing the overview page

Return type:

html.Div

static register_callbacks()

No additional callbacks