PREPROD
ReaderAuthor

piper

Figure Included

`ReportFigure.included` is a boolean that controls whether the figure is generated and inserted into the next ReportVersion PDF, without deleting the figure definition.

1 min read · 2 depth levelsstratum-piper · vdevMatches production
Everyday

The included flag on a ReportFigure works the same way as on ReportSection — set it to false to temporarily exclude a figure from the next render without losing the configuration. This is useful when a figure is still being designed, when you are waiting for additional data to complete a time series, or when a chart is optional depending on the regulatory agency's requirements. Only figures with included set to true at render time appear in the PDF and are listed in the figureManifestJson.

Technical section
Data model, API, and internals — visible to developers.
View as developer →
Was this helpful?