@bryntum/grid-trial 7.3.3 → 7.3.4

package/grid.thin.d.ts

@@ -243,6 +243,16 @@ type ExportConfig = {
      * Set to true to output as a CSV file, or as an object where you can specify delimiters.
      */
     csv?: boolean|object
+    /**
+     * MIME type used when creating the CSV Blob. Defaults to `text/csv`. Use
+     * `application/octet-stream` in Salesforce LWS environments.
+     */
+    csvMimeType?: string
+    /**
+     * MIME type used when creating the XLSX download Blob. Use
+     * `application/octet-stream` in Salesforce LWS environments.
+     */
+    xlsxMimeType?: string
 }
 
 type XLSColumn = {
@@ -25608,6 +25618,11 @@ type ExcelExporterConfig = {
      * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-convertEmptyValueToEmptyString)
      */
     convertEmptyValueToEmptyString?: boolean
+    /**
+     * MIME type used when creating the CSV Blob for download. Some environments (e.g. Salesforce Lightning Web
+     * Security) block `text/csv` for `URL.createObjectURL`. Use `application/octet-stream` there instead.
+     */
+    csvMimeType?: string
     /**
      * Defines how dates in a cell will be formatted
      */
@@ -25663,6 +25678,12 @@ type ExcelExporterConfig = {
      * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsProvider)
      */
     xlsProvider?: typeof XlsProviderBase
+    /**
+     * MIME type used when creating the XLSX download Blob. Some environments (e.g. Salesforce Lightning Web
+     * Security) block the default XLSX MIME type for `URL.createObjectURL`. Use `application/octet-stream` in such case
+     * instead.
+     */
+    xlsxMimeType?: string
     /**
      * Fires before an object is destroyed.
      * @param {object} event Event object
@@ -25745,10 +25766,12 @@ export class ExcelExporter extends InstancePlugin {
      * @param {boolean,object} [config.csv] Set to `true` to output as a CSV file, or as an object where you can specify delimiters.
      * @param {string} [config.csv.columnDelimiter] The CSV delimiter to separate values on one line, defaults to `,`.
      * @param {string} [config.csv.lineDelimiter] The CSV delimiter to separate lines, defaults to `\n`.
+     * @param {string} [config.csvMimeType] MIME type used when creating the CSV Blob. Overrides [csvMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-csvMimeType).
+     * @param {string} [config.xlsxMimeType] MIME type used when creating the XLSX download Blob. Overrides [xlsxMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsxMimeType).
      * @param {string[],object[]} [config.columns] An array of column configuration objects
      * @param {Core.data.Model[]} [config.rows] An array of records to export
      */
-    export(config: { filename?: string, dateFormat?: string, csv?: boolean|{ columnDelimiter?: string, lineDelimiter?: string }, columns?: string[]|object[], rows?: Model[] }): Promise<any>;
+    export(config: { filename?: string, dateFormat?: string, csv?: boolean|{ columnDelimiter?: string, lineDelimiter?: string }, csvMimeType?: string, xlsxMimeType?: string, columns?: string[]|object[], rows?: Model[] }): Promise<any>;
 }
 
 /**
@@ -25972,9 +25995,10 @@ export class WriteExcelFileProvider {
      * @param {object} config.sheet *deprecated, to be removed in 7.0* Object with columns and data
      * @param {any[][]} config.sheet.data Array of rows, each row is an array of cells
      * @param {XLSColumn[]} config.sheet.cols Array of columns
-     * @param {string} config.MIME File MIME type
+     * @param {string} config.mimeType MIME type used when creating the download Blob, passed from [xlsxMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsxMimeType).
+     * @param {string} [config.MIME] *deprecated, use `mimeType` instead*
      */
-    static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] }, MIME: string }): void;
+    static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] }, mimeType: string, MIME?: string }): Promise<any>;
 }
 
 /**
@@ -25983,17 +26007,18 @@ export class WriteExcelFileProvider {
  */
 export class XlsProviderBase {
     /**
-     * Implement this method to write data to an xls file
+     * Implement this method to write data to an xls file. May return a Promise if the
+     * implementation needs to perform asynchronous work (e.g. awaiting a 3rd-party library).
+     * [ExcelExporter](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter) awaits the return value, so both sync
+     * and async implementations are supported.
      * @param {object} config
      * @param {string} config.filename Name of the exported file
      * @param {any[][]} config.rows Array of rows, each row is an array of cells
      * @param {XLSColumn[]} config.columns Array of columns
-     * @param {object} config.sheet *deprecated, to be removed in 7.0* Object with columns and data
-     * @param {any[][]} config.sheet.data Array of rows, each row is an array of cells
-     * @param {XLSColumn[]} config.sheet.cols Array of columns
-     * @param {string} config.MIME File MIME type
+     * @param {string} config.mimeType MIME type to use when creating the download Blob. Configured via [xlsxMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsxMimeType).
+     * @param {string} [config.MIME] *deprecated, use `mimeType` instead*
      */
-    static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] }, MIME: string }): void;
+    static write(config: { filename: string, rows: any[], columns: XLSColumn[], mimeType: string, MIME?: string }): Promise<void|any>;
 }
 
 /**
@@ -45489,6 +45514,7 @@ type AIFilterFieldConfig = {
      * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
      * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-clearable)
      */
     clearable?: boolean|FieldTriggerConfig
     /**
@@ -46673,6 +46699,7 @@ type ChecklistFilterComboConfig = {
      * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
      * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-clearable)
      */
     clearable?: boolean|FieldTriggerConfig
     /**
@@ -52027,6 +52054,7 @@ type TreeComboConfig = {
      * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
      * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-clearable)
      */
     clearable?: boolean|FieldTriggerConfig
     /**