CustomDestination

Defines a custom Export destination

TypeScript
export interface

Properties

PropertyTypeDescription
formAdaptableForm<ExportFormContext>Optional Adaptable Form; if provided, it must include Buttons that will execute the Export
namestringName of Custom Destination (mandatory)
onExport(reportContext:ReportContext) => voidOptional Function invoked when Export is applied (used if no form is supplied)

Property Details

form

Optional Adaptable Form; if provided, it must include Buttons that will execute the Export

TypeScript
form?: AdaptableForm<ExportFormContext>;
Property Value

AdaptableForm<ExportFormContext>

name

Name of Custom Destination (mandatory)

TypeScript
name: string;
Property Value

string

onExport

Optional Function invoked when Export is applied (used if no form is supplied)

TypeScript
onExport?: (reportContext: ReportContext) => void;
Property Value

(reportContext:ReportContext) => void