IPublisherDocumentBaseV1
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Fields shared by document definitions and persisted documents.
export interface IPublisherDocumentBaseV1
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) Content of the document. When created from a template the content is deep-copied and NO reference to the template is kept — the document stays frozen while pages and templates evolve. | |||
string | (ALPHA) (Optional) | ||
(ALPHA) Reported period end, ISO 8601 date (YYYY-MM-DD), inclusive. | |||
(ALPHA) Reported period start, ISO 8601 date (YYYY-MM-DD), inclusive. | |||
string[] | (ALPHA) (Optional) | ||
string | (ALPHA) | ||
Record<string, string> | (ALPHA) (Optional) Values for variables declared in content.variables, keyed by variable name. |
Property details
IPublisherDocumentBaseV1.contentpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Content of the document. When created from a template the content is deep-copied and NO reference to the template is kept — the document stays frozen while pages and templates evolve.
content: IPublisherDocumentContentV1;
IPublisherDocumentBaseV1.descriptionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
description?: string;
IPublisherDocumentBaseV1.periodEndpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Reported period end, ISO 8601 date (YYYY-MM-DD), inclusive.
periodEnd: PublisherDateStringV1;
IPublisherDocumentBaseV1.periodStartpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Reported period start, ISO 8601 date (YYYY-MM-DD), inclusive.
periodStart: PublisherDateStringV1;
Remarks
At execution time the period materializes as an absolute date filter on each visualization slot’s dateDataSet (lowest precedence, per-slot opt-out via ignoreReportPeriod). Also available as {periodStart} in text.
IPublisherDocumentBaseV1.tagspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
tags?: string[];
IPublisherDocumentBaseV1.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
title: string;
IPublisherDocumentBaseV1.variableValuespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Values for variables declared in content.variables, keyed by variable name.
variableValues?: Record<string, string>;