plotly_dashboard
plotly_dashboard ¶
Module for generating interactive Plotly dashboards from data products.
PlotlyDashboardGenerator ¶
Class for generating interactive Plotly dashboards from data products.
This class provides a way to create interactive dashboards from trendify data products, similar to how the static matplotlib plots are generated, but with interactive features.
Initialize the dashboard generator.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
debug
|
bool
|
Whether to enable debug logging |
False
|
Source code in src/trendify/plotly_dashboard.py
process_collection ¶
process_collection(collection: DataProductCollection, title: str = 'Trendify Dashboard') -> Dash
Process collection of data products and generate a Plotly dashboard.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
collection
|
DataProductCollection
|
Collection of data products to visualize |
required |
title
|
str
|
Title for the dashboard |
'Trendify Dashboard'
|
Returns:
Type | Description |
---|---|
Dash
|
dash.Dash: The configured Dash application |
Source code in src/trendify/plotly_dashboard.py
generate_plotly_dashboard ¶
generate_plotly_dashboard(
collection: DataProductCollection, title: str = "Trendify Dashboard", debug: bool = False
) -> Dash
Generate a Plotly dashboard from a data product collection.
This function creates an interactive dashboard that visualizes the data products in the collection, similar to how DataProductCollection.process_collection works with matplotlib, but with interactive Plotly features.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
collection
|
DataProductCollection
|
Collection of data products to visualize |
required |
title
|
str
|
Title for the dashboard |
'Trendify Dashboard'
|
debug
|
bool
|
Whether to enable debug logging |
False
|
Returns:
Type | Description |
---|---|
Dash
|
dash.Dash: The configured Dash application ready to run |