Skip to content

TotalsConfig

TotalsConfig dataclass

Configuration for the totals panels of a bar or word shift plot.

The totals panels show one cumulative-contribution bar per contribution type, plus a grand total bar summing them all. Each bar is labeled with the text of its contribution type, so only the labels matching the plotted comparison apply: reference_label and comparison_label for contributions attributed by frequency or rank, reinforce_label and offset_label for those attributed by score sign, and the six remaining labels for a word shift plot. The labels that do not apply are ignored. Every bar's color, the grand total's included, comes from the color config.

Attributes:

Name Type Description
grand_total_label str

Label for the grand total bar

reference_label str

Label for the contribution attributed to the reference corpus

comparison_label str

Label for the contribution attributed to the comparison corpus

reinforce_label str

Label for the contribution that reinforces the overall difference

offset_label str

Label for the contribution that offsets the overall difference

more_of_negative_label str

Label for the more_of_negative contribution

more_of_positive_label str

Label for the more_of_positive contribution

less_of_positive_label str

Label for the less_of_positive contribution

less_of_negative_label str

Label for the less_of_negative contribution

lower_score_label str

Label for the lower_score contribution

higher_score_label str

Label for the higher_score contribution

grand_total_outline_color str | None

Color of the outline around the grand total bar. If None, BarConfig.outline_color is used

grand_total_outline_width float | None

Width of the outline around the grand total bar, in pixels. If None, BarConfig.outline_width is used

Source