igniteui-webcomponents-grids/grids/lib/igc-csv-exporter-service.d.ts

Ignite UI Web Components grid components.

import { IgcBaseExporter } from './igc-base-exporter';
import { IgcCsvExportEndedEventArgs } from './igc-csv-export-ended-event-args';
import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from './common';
import { IgcBaseExporterEventMap } from './igc-base-exporter';




/* csSuppress */
/**
 * **Ignite UI for Angular CSV Exporter Service** -
 * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter-csv)
 *
 * The Ignite UI for Angular CSV Exporter service can export data in a Character Separated Values 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 csvExportService: IgxCsvExporterService) {
 * }
 *
 * const opt: IgxCsvExporterOptions = new IgxCsvExporterOptions("FileName", CsvFileTypes.CSV);
 * this.csvExportService.exportData(this.localData, opt);
 * ```
 */

    export declare class IgcCsvExporterService extends EventEmitterMixin<IgcCsvExporterServiceEventMap, AbstractConstructor<IgcBaseExporter>>(IgcBaseExporter)

    {

    }

export declare interface IgcCsvExporterServiceEventMap extends IgcBaseExporterEventMap {
            
        		    /**
		     * This event is emitted when the export process finishes.
		     * ```typescript
		     * this.exporterService.exportEnded.subscribe((args: ICsvExportEndedEventArgs) => {
		     * // put event handler code here
		     * });
		     * ```
		     *
		     * @memberof IgxCsvExporterService
		     */
exportEnded: CustomEvent<IgcCsvExportEndedEventArgs>;

}