IDashboardAttachment
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Warning: This API is now obsolete.
- use IExportDefinitionMetadataObject instead
Email attachment - dashboard exported as pdf.
export interface IDashboardAttachment
Remarks
You can setup specific filter context to use for the dashboard export
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) Dashboard object ref | |||
(ALPHA) (Optional) Export filter context | |||
“pdf” | (ALPHA) File format |
Property details
IDashboardAttachment.dashboardpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard object ref
dashboard: ObjRef;
IDashboardAttachment.filterContextpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Export filter context
filterContext?: ObjRef;
IDashboardAttachment.formatpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
File format
format: "pdf";