Options
All
  • Public
  • Public/Protected
  • All
Menu

Export options section of Adaptable Options.

Allows users to provide a function to specify whether a Column will export its diaplay value (the default) or raw value when sending Grid data.

Hierarchy

  • ExportOptions

Index

Properties

Optional exportColumnRawValue

exportColumnRawValue: (column: AdaptableColumn, report: Report) => boolean

A function allowing you to specify for each Column (and Report) whether to export the DisplayValue (the default) or the RawValue.

adaptableOptions.exportOptions = {
   exportColumnRawValue: (column: AdaptableColumn, report: Report) => {
     if (column.ColumnId === 'bid') {
       return true;
     } else if (column.ColumnId === 'tradeDate' && report.Name === 'Visible Data') {
       return true;
     }
     return false;
   },
 };

In this example, the 'bid' column (for any report) and the 'tradeDate' column (for 'Visible Data' report) will export the RawValue.

And all other columns will always export the DisplayValue.

Type declaration

Generated using TypeDoc