forestploter.ForestColumn

class forestploter.ForestColumn(key, header, role, width, alignment='left')

Define a display column or a confidence-interval plotting area.

Parameters:

keystr

Unique column identifier. For role="text" or "numeric", it must name a display field in the long table. For role="ci", it must match values in the record-level _ci_column field.

headerstr

Header text. Newline characters are allowed. The column-header row automatically grows to fit the rendered text with vertical padding.

role{“text”, “numeric”, “ci”}

Rendering role. The first two draw cell text; "ci" draws point estimates and intervals.

widthfloat

Finite positive relative column width.

alignment{“left”, “center”, “right”}, default “left”

Horizontal alignment for the header and body cells.

Parameters:

• key (str)

• header (str)

• role (str)

• width (float)

• alignment (str)

Notes

Display fields may use supported vertical XLSX merges. A CI column is a layout slot and does not need to be a physical file field; records target it through _ci_column. The sequence passed as columns is the sole authority for final left-to-right order, so text columns can follow CI columns even when the input-file fields are arranged differently.

__init__(key, header, role, width, alignment='left')

Parameters:

• key (str)

• header (str)

• role (str)

• width (float)

• alignment (str)

Return type:

None

Methods

__init__(key, header, role, width[, alignment])

Attributes

alignment
key
header
role
width