IPublisherVisualizationWidgetV2
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
export interface IPublisherVisualizationWidgetV2 extends IPublisherWidgetBaseV2
Extends: IPublisherWidgetBaseV2
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) Defaults to the visualization’s description. | ||
(ALPHA) (Optional) The date dataset that the document period filters. | |||
(ALPHA) (Optional) | |||
(ALPHA) (Optional) | |||
(ALPHA) (Optional) May name a filter the document no longer has. | |||
boolean | (ALPHA) (Optional) | ||
(ALPHA) (Optional) | |||
(ALPHA) (Optional) | |||
“visualization” | (ALPHA) | ||
(ALPHA) (Optional) |
Property details
IPublisherVisualizationWidgetV2.altTextpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Defaults to the visualization’s description.
altText?: string;
IPublisherVisualizationWidgetV2.dateDataSetpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
The date dataset that the document period filters.
dateDataSet?: IPublisherDataSetRefV2;
IPublisherVisualizationWidgetV2.displaypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
display?: IPublisherVisualizationDisplayV2;
IPublisherVisualizationWidgetV2.filterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
filters?: FilterContextItem[];
IPublisherVisualizationWidgetV2.ignoreDocumentFilterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
May name a filter the document no longer has.
ignoreDocumentFilters?: IDashboardFilterReference[];
IPublisherVisualizationWidgetV2.ignoreDocumentPeriodpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
ignoreDocumentPeriod?: boolean;
IPublisherVisualizationWidgetV2.stylepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
style?: IPublisherVisualizationStyleV2;
IPublisherVisualizationWidgetV2.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
title?: IPublisherWidgetTitleV2;
IPublisherVisualizationWidgetV2.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
type: "visualization";
IPublisherVisualizationWidgetV2.visualizationpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
visualization?: IPublisherVisualizationRefV2;