Reference
This section documents the public JavaScript API, run configuration, calculation context, result shape, and known limits. See Learn the framework for a guided introduction or the How-to guide for recipes.
- API overview
- Complete public API reference
- Dashboard presentation widgets
- App languages
- Embedded Calculator App host integration
- Engine concepts
- Run configuration and inputs
- Calculation progress and optional Web API feedback
- Nominal money and today's value
- Time, phases, and schedules
- Calculation context
- Static bindings and explicit dynamic callbacks
- Result format
- Valuation and uncertainty
- Nordic household composition
- Packs
- Pack design notes
- Errors, ordering, and limits
Run lifecycle
- Create references with API factories and collect them in
defineModel(). compileModel()checks declarations, references, schedules, the entity tree, agreement windows, and dependency ordering.run()normalizes its options and validates overridden inputs.- Each period is calculated in order: fields and states, agreement boundaries, events, cashflows, options, and flow distributors.
- The result is created with series, metrics, and convenience accessors.
run() compiles a model automatically unless given a compiled plan. Call compileModel() separately when you want to validate before several runs.