igniteui-webcomponents-grids
Version:
Ignite UI Web Components grid components.
54 lines (42 loc) • 1.7 kB
TypeScript
import { IgcBaseExporter } from './igc-base-exporter';
import { IgcExcelExportEndedEventArgs } from './igc-excel-export-ended-event-args';
import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from './common';
import { IgcBaseExporterEventMap } from './igc-base-exporter';
/* csSuppress */
/**
* **Ignite UI for Angular Excel Exporter Service** -
* [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter_excel.html)
*
* The Ignite UI for Angular Excel Exporter service can export data in Microsoft® Excel® format from both raw data
* (array) or from an `IgxGrid`.
*
* Example:
* ```typescript
* public localData = [
* { Name: "Eric Ridley", Age: "26" },
* { Name: "Alanis Brook", Age: "22" },
* { Name: "Jonathan Morris", Age: "23" }
* ];
*
* constructor(private excelExportService: IgxExcelExporterService) {
* }
*
* this.excelExportService.exportData(this.localData, new IgxExcelExporterOptions("FileName"));
* ```
*/
export declare class IgcExcelExporterService extends EventEmitterMixin<IgcExcelExporterServiceEventMap, AbstractConstructor<IgcBaseExporter>>(IgcBaseExporter)
{
}
export declare interface IgcExcelExporterServiceEventMap extends IgcBaseExporterEventMap {
/**
* This event is emitted when the export process finishes.
* ```typescript
* this.exporterService.exportEnded.subscribe((args: IExcelExportEndedEventArgs) => {
* // put event handler code here
* });
* ```
*
* @memberof IgxExcelExporterService
*/
exportEnded: CustomEvent<IgcExcelExportEndedEventArgs>;
}