Series view
A forecast or scenario series seen through a view: time bucket, cumulative or per period, cohort and variable from a config's fields, plus a fixed roll-up and history.
Presents a forecast or scenario series through a view: time bucket, cumulative or per period, cohort and variable. The view can be fixed in settings or arrive per run on view, which is how one chart follows a viewer's controls without a sim re-running behind it.
At a glance
Module type
SeriesView
Category
Primitives · Twins and IO
Default tier
reactive
Runs on
reactive, durable
Starts a flow
no
Holds a body
no
Keeps state between runs
no
Available in
every application type
Parameters
rollupBy
string | null · required · defaults to null
The cohort column the series is rolled up by.
rollupAll
boolean · required · defaults to false
Roll every cohort together rather than one series per cohort.
includeOverall
boolean · required · defaults to true
Include a series covering everything alongside the cohorts.
history
number | null · required · defaults to null
How many periods of actuals to show before the forecast starts.
series
object[] · required · defaults to []
Per-variable overrides of the application's series declaration: for a named variable, how it measures and how it combines across environments.
Inputs
on
event
no
Implicit on every module that does not itself start a flow: wire an event here to make this module the start of what that event runs.
series
dataframe
yes
The series to present.
view
json
no
The view to apply, overriding what is in settings.
Outputs
output
dataframe
dataframe, signal
The series as the view asks for it, plus history periods of actuals when set.
Last updated