Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Infobulles personnalisées

Signature

sp.build_hover_json(
    *,
    fields: list[str],
    values: list[list[str | float]],
    format: str = "table",
) -> str

Description

Builds a JSON string suitable for the hover_json parameter accepted by most chart functions.


Parameters

ParameterTypeDefaultDescription
fieldslist[str]requiredColumn headers for the tooltip
valueslist[list[str | float]]requiredOne inner list per data point
formatstr"table"Tooltip layout: "table" or "list"

Signature

sp.build_hover_json(
    *,
    fields: list[str],
    values: list[list[str | float]],
    format: str = "table",
) -> str

Description

Construit une chaîne JSON adaptée au paramètre hover_json accepté par la plupart des fonctions graphiques.


Paramètres

ParamètreTypeDéfautDescription
fieldslist[str]requisEn-têtes de colonnes de l'infobulle
valueslist[list[str | float]]requisUne liste par point de données
formatstr"table"Mise en page : "table" ou "list"

Retourne

str — Chaîne JSON à passer au paramètre hover_json=.


Exemples

import seraplot as sp

hover = sp.build_hover_json(
    fields=["Produit", "Revenu (€)", "Croissance"],
    values=[
        ["Alpha", 420, "+12%"],
        ["Bêta",  380, "+5%"],
        ["Gamma", 290, "-3%"],
    ],
)

chart = sp.build_bar_chart(
    "Revenus par produit",
    labels=["Alpha", "Bêta", "Gamma"],
    values=[420, 380, 290],
    hover_json=hover,
)

Voir aussi