IReportContent
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Versioned content shared verbatim by report templates and reports.
export interface IReportContent
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Configuration of the content-level attribute filters, keyed by the filter’s local identifier. | |||
(ALPHA) (Optional) Content-level default filters; pages and slots may extend or override them. The report period is NOT stored here — it is derived from periodStart/periodEnd at execution time. | |||
(ALPHA) Ordered pages of the document. | |||
string | (ALPHA) (Optional) Instructions every AI-written text without instructions of its own is generated with. Supports | ||
(ALPHA) (Optional) Custom variable declarations. Values live on the report (IReportBase.variableValues). | |||
“1” | (ALPHA) Content model version, for stored-content evolution. |
Property details
IReportContent.attributeFilterConfigspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Configuration of the content-level attribute filters, keyed by the filter’s local identifier.
attributeFilterConfigs?: IReportAttributeFilterConfig[];
Remarks
A filter with a displayAsLabel must be stored on the attribute’s primary label: its selection is read as primary-label values and shown by displayAsLabel.
IReportContent.filterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Content-level default filters; pages and slots may extend or override them. The report period is NOT stored here — it is derived from periodStart/periodEnd at execution time.
filters?: FilterContextItem[];
IReportContent.pagespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Ordered pages of the document.
pages: IReportContentPage[];
IReportContent.takeawaysInstructionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Instructions every AI-written text without instructions of its own is generated with. Supports {variables}.
takeawaysInstruction?: string;
IReportContent.variablespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Custom variable declarations. Values live on the report (IReportBase.variableValues).
variables?: IReportVariableDefinition[];
IReportContent.versionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Content model version, for stored-content evolution.
version: "1";