MatplotLibAPI 3.2.14__py3-none-any.whl → 3.2.16__py3-none-any.whl

MatplotLibAPI/Sankey.py

@@ -0,0 +1,39 @@
+"""Sankey plotting helpers."""
+
+from typing import Dict, List, Optional
+
+import pandas as pd
+import plotly.graph_objects as go
+
+from .StyleTemplate import SANKEY_STYLE_TEMPLATE, StyleTemplate, validate_dataframe
+
+
+def fplot_sankey(
+    pd_df: pd.DataFrame,
+    source: str,
+    target: str,
+    value: str,
+    title: Optional[str] = None,
+    style: StyleTemplate = SANKEY_STYLE_TEMPLATE,
+) -> go.Figure:
+    """Plot a Sankey diagram showing flows between categories."""
+    validate_dataframe(pd_df, cols=[source, target, value])
+
+    labels: List[str] = list(pd.unique(pd.concat([pd_df[source], pd_df[target]])))
+    label_to_index: Dict[str, int] = {name: idx for idx, name in enumerate(labels)}
+
+    sankey = go.Sankey(
+        node=dict(label=labels, pad=15, thickness=20, color=style.font_color),
+        link=dict(
+            source=[label_to_index[val] for val in pd_df[source]],
+            target=[label_to_index[val] for val in pd_df[target]],
+            value=pd_df[value],
+        ),
+    )
+
+    fig = go.Figure(sankey)
+    if title:
+        fig.update_layout(
+            title_text=title, font=dict(color=style.font_color, size=style.font_size)
+        )
+    return fig

MatplotLibAPI/StyleTemplate.py

@@ -306,4 +306,9 @@ PIVOTLINES_STYLE_TEMPLATE = StyleTemplate(
 )
 
 NETWORK_STYLE_TEMPLATE = StyleTemplate()
+DISTRIBUTION_STYLE_TEMPLATE = StyleTemplate(palette="magma")
+HEATMAP_STYLE_TEMPLATE = StyleTemplate(palette="viridis")
+AREA_STYLE_TEMPLATE = StyleTemplate(palette="crest")
+PIE_STYLE_TEMPLATE = StyleTemplate(palette="Set2")
+SANKEY_STYLE_TEMPLATE = StyleTemplate()
 # endregion

MatplotLibAPI/Sunburst.py

@@ -0,0 +1,83 @@
+"""Sunburst chart plotting utilities."""
+
+from typing import Optional
+
+import pandas as pd
+import plotly.graph_objects as go
+
+from .StyleTemplate import (
+    TREEMAP_STYLE_TEMPLATE,
+    StyleTemplate,
+    validate_dataframe,
+)
+
+
+def fplot_sunburst(
+    pd_df: pd.DataFrame,
+    labels: str,
+    parents: str,
+    values: str,
+    style: StyleTemplate = TREEMAP_STYLE_TEMPLATE,
+    title: Optional[str] = None,
+    sort_by: Optional[str] = None,
+    ascending: bool = False,
+    max_values: int = 100,
+    fig: Optional[go.Figure] = None,
+) -> go.Figure:
+    """Return a figure containing the sunburst plot.
+
+    Parameters
+    ----------
+    pd_df : pd.DataFrame
+        DataFrame containing the data to plot.
+    labels : str
+        Column representing the labels of the sectors.
+    parents : str
+        Column representing the parent of each sector.
+    values : str
+        Column containing values for each sunburst sector.
+    style : StyleTemplate, optional
+        Style configuration. The default is `TREEMAP_STYLE_TEMPLATE`.
+    title : str, optional
+        Plot title.
+    sort_by : str, optional
+        Column used to sort data.
+    ascending : bool, optional
+        Sort order for the data. The default is `False`.
+    max_values : int, optional
+        Maximum number of rows to plot. The default is 100.
+    fig : go.Figure, optional
+        Existing figure to add the sunburst chart to.
+
+    Returns
+    -------
+    go.Figure
+        Figure containing the sunburst plot.
+    """
+    cols = [labels, parents, values]
+    validate_dataframe(pd_df, cols=cols, sort_by=sort_by)
+    if not sort_by:
+        sort_by = values
+    df = pd_df.sort_values(by=sort_by, ascending=ascending)[cols].head(max_values)
+
+    trace = go.Sunburst(
+        labels=df[labels],
+        parents=df[parents],
+        values=df[values],
+        textinfo="label+percent entry",
+    )
+
+    if not fig:
+        fig = go.Figure(trace)
+    else:
+        fig.add_trace(trace)
+
+    fig.update_layout(
+        title=title,
+        plot_bgcolor=style.background_color,
+        paper_bgcolor=style.background_color,
+        font=dict(family=style.font_name, size=style.font_size, color=style.font_color),
+        showlegend=style.legend if style else True,
+    )
+
+    return fig

MatplotLibAPI/Waffle.py

@@ -0,0 +1,82 @@
+"""Waffle chart helpers."""
+
+from typing import Any, Optional, Tuple
+
+import pandas as pd
+import seaborn as sns
+from matplotlib.axes import Axes
+from matplotlib.figure import Figure
+from matplotlib.patches import Rectangle
+import matplotlib.pyplot as plt
+
+from .StyleTemplate import PIE_STYLE_TEMPLATE, StyleTemplate, validate_dataframe
+from ._visualization_utils import _get_axis, _wrap_aplot
+
+
+def aplot_waffle(
+    pd_df: pd.DataFrame,
+    category: str,
+    value: str,
+    rows: int = 10,
+    title: Optional[str] = None,
+    style: StyleTemplate = PIE_STYLE_TEMPLATE,
+    ax: Optional[Axes] = None,
+    **kwargs: Any,
+) -> Axes:
+    """Plot a simple waffle chart as a grid of proportional squares."""
+    validate_dataframe(pd_df, cols=[category, value])
+    plot_ax = _get_axis(ax)
+    total = float(pd_df[value].sum())
+    squares = rows * rows
+    colors = sns.color_palette(style.palette, n_colors=len(pd_df))
+    plot_ax.set_aspect("equal")
+
+    start = 0
+    for idx, (label, val) in enumerate(zip(pd_df[category], pd_df[value])):
+        count = int(round((val / total) * squares))
+        for square in range(start, min(start + count, squares)):
+            row = square // rows
+            col = square % rows
+            plot_ax.add_patch(
+                Rectangle(
+                    (col, rows - row),
+                    1,
+                    1,
+                    facecolor=colors[idx],
+                    edgecolor=style.background_color,
+                )
+            )
+        start += count
+
+    plot_ax.set_xlim(0, rows)
+    plot_ax.set_ylim(0, rows + 1)
+    plot_ax.axis("off")
+    if title:
+        plot_ax.set_title(title)
+    legend_handles = [Rectangle((0, 0), 1, 1, color=color) for color in colors]
+    plot_ax.legend(
+        legend_handles, pd_df[category], loc="upper center", ncol=3, frameon=False
+    )
+    return plot_ax
+
+
+def fplot_waffle(
+    pd_df: pd.DataFrame,
+    category: str,
+    value: str,
+    rows: int = 10,
+    title: Optional[str] = None,
+    style: StyleTemplate = PIE_STYLE_TEMPLATE,
+    figsize: Tuple[float, float] = (8, 8),
+) -> Figure:
+    """Plot waffle charts on a new figure."""
+    return _wrap_aplot(
+        aplot_waffle,
+        pd_df=pd_df,
+        figsize=figsize,
+        category=category,
+        value=value,
+        rows=rows,
+        title=title,
+        style=style,
+    )