IWidgetAttachment
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Warning: This API is now obsolete.
- use IExportDefinitionMetadataObject instead
Email attachment - widget exported as csv or/and xlsx.
export interface IWidgetAttachment
Remarks
You can setup specific filter context to use for the widget export
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) | |||
(ALPHA) (Optional) Export filter context | |||
(“csv” | “xlsx”)[] | (ALPHA) File format | ||
(ALPHA) Widget object ref | |||
(ALPHA) The dashboard on which is the widget to be exported |
Property details
IWidgetAttachment.exportOptionspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
exportOptions?: IExportOptions;
IWidgetAttachment.filterContextpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Export filter context
filterContext?: ObjRef;
IWidgetAttachment.formatspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
File format
formats: ("csv" | "xlsx")[];
IWidgetAttachment.widgetpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Widget object ref
widget: ObjRef;
IWidgetAttachment.widgetDashboardpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
The dashboard on which is the widget to be exported
widgetDashboard: ObjRef;