CustomItemExportInfo Interface

Provides options for custom item exporting.

Declaration

export interface CustomItemExportInfo

Remarks

Use the CustomItemViewer.allowExportSingleItem method to specify whether end-users can export a custom item as a single dashboard item.

Override the CustomItemViewer.getExportInfo method and provide an object containing the image field. Encode the image in the ASCII format using the Base64 scheme to display a custom item in the exported document.

Note that getExportInfo is a synchronous method and it cannot be used with libraries exporting data asynchronously. You can export your custom item to an image when the custom item rendering is updated and caches the resulting image. After that, return the cached image in the getExportInfo method.

Note

See the getExportInfo method in the FunnelD3 custom dashboard item code to find an export implementation example: FunnelD3.

Properties

image Property

Specifies an image that represents a custom item in the exported document.

Declaration

image: string

Property Value

Type Description
string

A string that contain an image in the ASCII format using the Base64 scheme.

Remarks

Override the CustomItemViewer.getExportInfo method and provide an object containing the image field. Encode the image in the ASCII format using the Base64 scheme to display a custom item in the exported document.