IPublisherVisualizationSlotV1
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Slot rendering an insight, with its own filter context.
export interface IPublisherVisualizationSlotV1 extends IPublisherSlotBaseV1
Extends: IPublisherSlotBaseV1
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Date dataset the document’s period (periodStart/periodEnd) is applied to as an absolute date filter at execution time. Undefined = backend date-dataset auto-resolution applies. | |||
(ALPHA) (Optional) Slot-level filters, applied on top of the effective content and page filters. A slot filter targeting the same object replaces the inherited one. | |||
(ALPHA) (Optional) Content- and page-level filters this slot ignores (matched by display form / date dataset). | |||
boolean | (ALPHA) (Optional) When true, the implicit date filter derived from the document’s period is not applied to this slot. | ||
(ALPHA) (Optional) Insight to render. Undefined = declared-but-empty slot; renderers show a placeholder. | |||
(ALPHA) (Optional) Visualization properties overriding the insight’s own. | |||
boolean | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) Optional title rendered above the visualization. Supports | ||
“visualization” | (ALPHA) |
Property details
IPublisherVisualizationSlotV1.dateDataSetpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Date dataset the document’s period (periodStart/periodEnd) is applied to as an absolute date filter at execution time. Undefined = backend date-dataset auto-resolution applies.
dateDataSet?: ObjRef;
IPublisherVisualizationSlotV1.filterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Slot-level filters, applied on top of the effective content and page filters. A slot filter targeting the same object replaces the inherited one.
filters?: FilterContextItem[];
IPublisherVisualizationSlotV1.ignoredFilterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Content- and page-level filters this slot ignores (matched by display form / date dataset).
ignoredFilters?: IDashboardFilterReference[];
IPublisherVisualizationSlotV1.ignoreReportPeriodpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
When true, the implicit date filter derived from the document’s period is not applied to this slot.
ignoreReportPeriod?: boolean;
IPublisherVisualizationSlotV1.insightpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Insight to render. Undefined = declared-but-empty slot; renderers show a placeholder.
insight?: ObjRef;
IPublisherVisualizationSlotV1.propertiespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Visualization properties overriding the insight’s own.
properties?: VisualizationProperties;
IPublisherVisualizationSlotV1.showTitlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
showTitle?: boolean;
IPublisherVisualizationSlotV1.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Optional title rendered above the visualization. Supports {variables}.
title?: string;
IPublisherVisualizationSlotV1.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
type: "visualization";