IVisualizationMeta
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Metadata of the visualization.
export interface IVisualizationMeta
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) URL where documentation of the visualization can be found. | ||
boolean | (ALPHA) If true, the visualization supports being exported (if the currently used backend supports exports as well). | ||
boolean | (ALPHA) If true, the visualization supports zoom to detailed view. |
Property details
IVisualizationMeta.documentationUrlpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
URL where documentation of the visualization can be found.
documentationUrl?: string;
IVisualizationMeta.supportsExportpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
If true, the visualization supports being exported (if the currently used backend supports exports as well).
supportsExport: boolean;
IVisualizationMeta.supportsZoomingpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
If true, the visualization supports zoom to detailed view.
supportsZooming: boolean;