@progress/kendo-angular-grid 19.1.2-develop.3 → 19.1.2-develop.5

package/excel/excel.component.d.ts

@@ -10,64 +10,63 @@ import { FetchDataCallback } from '../common/fetch-data-callback';
 import { ContextService } from '../common/provider.service';
 import * as i0 from "@angular/core";
 /**
- * Configures the settings for the export of Grid in Excel ([see example]({% slug excelexport_grid %})).
+ * The component is required when exporting the data to an Excel file. The componnet provides different options to further configure the Excel export settings of the Grid ([see example]({% slug excelexport_grid %})).
+ *
+ * @example
+ * ```html
+ * <kendo-grid>
+ *   <kendo-grid-excel fileName="Export.xlsx"></kendo-grid-excel>
+ * </kendo-grid>
+ * ```
  */
 export declare class ExcelComponent implements OnDestroy {
     private ctx;
     private zone;
     /**
-     * Specifies the file name of the exported Excel file.
+     * Sets the file name for the exported Excel file.
      * @default "Export.xlsx"
      */
     fileName: string;
     /**
-     * Enables or disables column filtering in the Excel file. This behavior is different from the filtering feature of the Grid.
+     * Enables or disables column filtering in the Excel file. This option is different from the Grid's filtering feature.
      */
     filterable: boolean;
     /**
-     * The author of the workbook.
+     * Sets the author of the workbook.
      */
     creator?: string;
     /**
-     * The date on which the workbook was created. Defaults to `new Date()`.
+     * Sets the creation date of the workbook.
      */
     date?: Date;
     /**
-     * If set to `true`, the content is forwarded to [proxyURL](#toc-proxyurl) even if the browser supports the saving of files locally.
+     * Forwards the content to [`proxyURL`](#toc-proxyurl) even if the browser supports local file saving when set to `true`.
      */
     forceProxy: boolean;
     /**
-     * The URL of the server-side proxy which streams the file to the end user.
-     *
-     * Using a proxy is required if the browser is not capable of saving files locally.
-     *
-     * Optionally, set up a proxy to reduce memory usage. This avoids copying the file contents in memory,
-     * but transmits it over the network instead. For this use case, set [forceProxy](#toc-forceproxy) to `true`
-     * to skip client-side saving even in browser that support it.
-     *
-     * In the request body, the proxy receives a POST request with the specific parameters. [See example](slug:server_proxy#toc-implementations).
-     * The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.xslx>"`.
-     *
-     * For details on the server-side proxy usage and implementation, see the [File Saver]({% slug overview_filesaver %}) documentation.
+     * Sets the URL of the server-side proxy that streams the file to the user. Use a proxy if the browser cannot save files locally.
+     * You can also use a proxy to reduce memory usage by transmitting the file over the network.
+     * Set [`forceProxy`](#toc-forceproxy) to `true` to skip client-side saving.
+     * The proxy receives a POST request with specific parameters and returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.xslx>"`.
+     * For more details, see the [File Saver]({% slug overview_filesaver %}) documentation.
      */
     proxyURL: string;
     /**
-     * The function that is used to get the exported data options. By default, uses the current data and group of the Grid.
-     * To export data that is different from the current Grid data, provide a custom function.
+     * Provides a function to get the exported data options. By default, uses the current Grid data and group.
+     * Supply a custom function to export different data. Typically used to export all data, not just the current page [see example](slug:excelexport_grid#exporting-specific-data).
      */
     fetchData: FetchDataCallback;
     /**
-     * If the data is grouped, the options of the cells that are inserted before the data,
-     * group, and footer cells to indicate the group hierarchy.
+     * Sets options for cells inserted before the data, group, and footer cells to indicate the group hierarchy if the data is grouped.
+     *
      */
     paddingCellOptions: CellOptions;
     /**
-     * If the data is grouped, the options of the cells that are inserted before the
-     * header cells to align the headers and the column values.
+     * Sets the options for cells inserted before the header cells to align the headers and the column values when the data is grouped.
      */
     headerPaddingCellOptions: CellOptions;
     /**
-     * Specifies if the groups in the Excel file are collapsible.
+     * Specifies if groups in the Excel file are collapsible.
      */
     collapsible: boolean;
     /**

package/excel/excel.module.d.ts

@@ -9,11 +9,9 @@ import * as i3 from "./excel-command.directive";
 import * as i4 from "./excel-command-tool.directive";
 import * as i5 from "@progress/kendo-angular-excel-export";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the Excel component of the Grid.
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Excel component of the Grid.
  *
  * @example
- *
  * ```ts
  * import { NgModule } from '@angular/core';
  * import { BrowserModule } from "@angular/platform-browser";
@@ -21,12 +19,11 @@ import * as i5 from "@progress/kendo-angular-excel-export";
  * import { AppComponent } from './app.component';
  *
  * _@NgModule({
- *     declarations: [AppComponent],
- *     imports:      [BrowserModule, GridModule, ExcelModule],
- *     bootstrap:    [AppComponent]
+ *   declarations: [AppComponent],
+ *   imports: [BrowserModule, GridModule, ExcelModule],
+ *   bootstrap: [AppComponent]
  * })
  * export class AppModule {}
- *
  * ```
  */
 export declare class ExcelModule {