ex_gantt_chart.py

"""Example Gantt Chart."""

from pathlib import Path

import pandas as pd
from dash import html
from implements import implements
from palettable.wesanderson import FantasticFox2_5

from dash_charts.gantt_chart import GanttChart
from dash_charts.utils_app import AppBase, AppInterface
from dash_charts.utils_fig import min_graph
from dash_charts.utils_helpers import parse_dash_cli_args


@implements(AppInterface)  # noqa: H601
class GanttDemo(AppBase):
    """Example creating a Gantt chart."""

    name = 'Example Gantt Chart'
    """Application name"""

    chart_main = None
    """Main chart (Gantt)."""

    id_chart = 'Gantt'
    """Unique name for the main chart."""

    def initialization(self) -> None:
        """Initialize ids with `self.register_uniq_ids([...])` and other one-time actions."""
        super().initialization()
        self.register_uniq_ids([self.id_chart])

    def create_elements(self) -> None:
        """Initialize the charts, tables, and other Dash elements."""
        self.chart_main = GanttChart(
            title='Sample Gantt Chart',
            xlabel=None,
            ylabel=None,
        )
        self.chart_main.pallette = FantasticFox2_5.hex_colors

    def generate_data(self) -> None:
        """Create self.data_raw with sample data."""
        csv_filename = Path(__file__).parent / 'ex_gantt_data.csv'
        self.data_raw = pd.read_csv(csv_filename)

    def return_layout(self) -> dict:
        """Return Dash application layout.

        Returns:
            dict: Dash HTML object

        """
        return html.Div(
            style={
                'maxWidth': '1000px',
                'marginRight': 'auto',
                'marginLeft': 'auto',
            }, children=[
                html.H4(children=self.name),
                html.Div([
                    min_graph(
                        id=self._il[self.id_chart],
                        figure=self.chart_main.create_figure(df_raw=self.data_raw),
                    ),
                ]),
            ],
        )

    def create_callbacks(self) -> None:
        """Create Dash callbacks."""
        ...  # No callbacks necessary for this simple example


instance = GanttDemo
app = instance()
app.create()
if __name__ == '__main__':
    app.run(**parse_dash_cli_args())
else:
    FLASK_HANDLE = app.get_server()