igniteui-react-grids
Version:
Ignite UI React grid components.
46 lines (45 loc) • 2.17 kB
TypeScript
import { IgrGridBaseDirective } from "./igr-grid-base-directive";
import { IgrBaseExporter } from "./igr-base-exporter";
import { IgrExporterOptionsBase } from "./igr-exporter-options-base";
import { IgrBaseEventArgsDetail } from "./igr-base-event-args-detail";
import { GridToolbarExportEventArgsDetail as GridToolbarExportEventArgsDetail_internal } from "./GridToolbarExportEventArgsDetail";
/**
* Represents the arguments for the grid toolbar export event.
* It provides information about the grid instance, exporter service, export options,
* and allows the event to be canceled.
*/
export declare class IgrGridToolbarExportEventArgsDetail extends IgrBaseEventArgsDetail {
protected createImplementation(): GridToolbarExportEventArgsDetail_internal;
/**
* @hidden
*/
get i(): GridToolbarExportEventArgsDetail_internal;
constructor();
/**
* `grid` represents a reference to the instance of the grid te event originated from
*/
get grid(): IgrGridBaseDirective;
set grid(v: IgrGridBaseDirective);
/**
* The `exporter` is a base service.
* The type (an abstract class `IgxBaseExporter`) has it's own properties and methods
* It is used to define the format and options of the export, the exported element
* and methods for preparing the data from the elements for exporting
*/
get exporter(): IgrBaseExporter;
set exporter(v: IgrBaseExporter);
/**
* Represents the different settings, that can be given to an export
* The type (an abstract class `IgxExporterOptionsBase`) has properties for column settings
* (whether they should be ignored) as well as method for generating a file name
*/
get options(): IgrExporterOptionsBase;
set options(v: IgrExporterOptionsBase);
/**
* `cancel` returns whether the event has been intercepted and stopped
* If the value becomes "true", it returns/exits from the method, instantiating the interface
*/
get cancel(): boolean;
set cancel(v: boolean);
findByName(name: string): any;
}