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.

Hierarchy

Hierarchy

Constructors

Accessors

  • get cancel(): boolean
  • cancel returns whether the event has been intercepted and stopped If the value becomes "true", it returns/exits from the method, instantiating the interface

    Returns boolean

  • set cancel(v): void
  • Parameters

    • v: boolean

    Returns void

  • get exporter(): IgrBaseExporter
  • 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

    Returns IgrBaseExporter

  • set exporter(v): void
  • Parameters

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get options(): IgrExporterOptionsBase
  • 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

    Returns IgrExporterOptionsBase

  • set options(v): void
  • Parameters

    Returns void

  • get owner(): any
  • Provides reference to the owner component.

    Returns any

  • set owner(v): void
  • Parameters

    • v: any

    Returns void

Methods

  • Parameters

    • name: string

    Returns any

  • Parameters

    • element: any

    Returns void