Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextItem

A configured item of text used in model explanations, etc.

Hierarchy

  • Item<"text">
    • TextItem

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Optional #temporal

#temporal: Temporal<TextItem> = ...

Readonly categories

categories: Category[]

Optional Readonly end

end: boolean

Readonly id

id: string

Readonly name

name: string

Optional notes

notes: string

prettyName

prettyName: string

Readonly scenario

scenario: IFScenario

Readonly scenarios

scenarios: string[]

sort

sort: number

Sort order

Readonly start

start: Date

text

text: string

Readonly type

type: "text"

Accessors

temporal

Methods

hasCategory

  • hasCategory(category: Category): boolean

inScenario

  • inScenario(scenario: string): boolean

states

  • states(start: CalendarStep): Generator<IItemState<"scenario" | "incomeStream" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "person" | "text">, any, IItemState<"scenario" | "incomeStream" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "person" | "text">>

  • Parameters

    Returns Generator<IItemState<"scenario" | "incomeStream" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "person" | "text">, any, IItemState<"scenario" | "incomeStream" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "person" | "text">>

Generated using TypeDoc