bayesline.api.equity.BookColumnSettings

bayesline.api.equity.BookColumnSettings#

model BookColumnSettings#

A quantity a book holds at a date: its NAV, quantity, exposure or beta.

denominator="gross" needs leg="portfolio" wherever both are set.

Fields#

Field

Type

Required

Default

denominator

Literal[‘none’, ‘net’, ‘gross’] | Default

No

None

kind

Literal[‘book’]

No

'book'

leg

Literal[‘portfolio’, ‘benchmark’, ‘active’] | Default

No

None

metric

MetricT

Yes

reference

Literal[‘own’, ‘root’] | Default

No

None

field denominator: Literal['none', 'net', 'gross'] | Default [Optional]#
field kind: Literal['book'] [Optional]#
field leg: Literal['portfolio', 'benchmark', 'active'] | Default [Optional]#
field metric: MetricT [Required]#
field reference: Literal['own', 'root'] | Default [Optional]#