forestploter.ForestReferenceLegendSpec

class forestploter.ForestReferenceLegendSpec(reference_label=None, ideal_label=None, location='bottom', column_key=None, ncol=2)[source]

Place and label reference-line and ideal-line legend entries.

Parameters:
reference_labelstr or None, default None

Legend label for ref_line.

ideal_labelstr or None, default None

Legend label for ideal_line.

location{“header”, “bottom”}, default “bottom”

Place the legend in a column-header region or below the table.

column_keystr or None, default None

Uses the same placement rules as ForestLegendSpec.

ncolint, default 2

Number of legend columns; must be a positive integer.

Parameters:

  • reference_label (str | None)

  • ideal_label (str | None)

  • location (Literal['header', 'bottom'])

  • column_key (str | None)

  • ncol (int)

__init__(reference_label=None, ideal_label=None, location='bottom', column_key=None, ncol=2)
Parameters:

  • reference_label (str | None)

  • ideal_label (str | None)

  • location (Literal['header', 'bottom'])

  • column_key (str | None)

  • ncol (int)

Return type:

None

Methods

__init__([reference_label, ideal_label, ...])

Attributes

column_key

ideal_label

location

ncol

reference_label