forestploter.ForestLegendSpec

class forestploter.ForestLegendSpec(location='header', column_key=None, ncol=2)[source]

Place and arrange the series legend.

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

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

column_keystr or None, default None

Required for location="header" and may point to any display or CI column. For location="bottom", omit it to center the legend below all active CI columns, or provide it to center below one column.

ncolint, default 2

Number of legend columns; must be a positive integer.

Parameters:

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

  • column_key (str | None)

  • ncol (int)

__init__(location='header', column_key=None, ncol=2)
Parameters:

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

  • column_key (str | None)

  • ncol (int)

Return type:

None

Methods

__init__([location, column_key, ncol])

Attributes

column_key

location

ncol