Provides a pre-configured exporter component for the grid.

Constructors

Section titled "Constructors"

IgcGridToolbarExporterComponent 

new IgcGridToolbarExporterComponent(args: any[]): IgcGridToolbarExporterComponent

Returns IgcGridToolbarExporterComponent

Properties

Section titled "Properties"

tagName

Section titled "tagName"

The tagName read-only property of the Element interface returns the tag name of the element on which it's called.

MDN Reference

 
tagName: string

Accessors

Section titled "Accessors"

columnListHeight

Section titled "columnListHeight"

Inherited from: EventEmitterMixin<IgcGridToolbarExporterComponentEventMap, AbstractConstructor<IgcBaseToolbarDirective>>(IgcBaseToolbarDirective) 

get columnListHeight(): string

Returns string

Sets the height of the column list in the dropdown.

 
set columnListHeight(value: string): void

Parameters

  • value: string

Returns void

exportCSV

Section titled "exportCSV" 
get exportCSV(): boolean

Returns boolean

Show entry for CSV export.

 
set exportCSV(value: boolean): void

Parameters

  • value: boolean

Returns void

exportExcel

Section titled "exportExcel" 
get exportExcel(): boolean

Returns boolean

Show entry for Excel export.

 
set exportExcel(value: boolean): void

Parameters

  • value: boolean

Returns void

exportPDF

Section titled "exportPDF" 
get exportPDF(): boolean

Returns boolean

Show entry for PDF export.

 
set exportPDF(value: boolean): void

Parameters

  • value: boolean

Returns void

filename

Section titled "filename" 
get filename(): string

Returns string

The name for the exported file.

 
set filename(value: string): void

Parameters

  • value: string

Returns void

overlaySettings

Section titled "overlaySettings"

Inherited from: EventEmitterMixin<IgcGridToolbarExporterComponentEventMap, AbstractConstructor<IgcBaseToolbarDirective>>(IgcBaseToolbarDirective) 

get overlaySettings(): IgcOverlaySettings

Returns IgcOverlaySettings

Sets overlay settings

 
set overlaySettings(value: IgcOverlaySettings): void

Parameters

Returns void

prompt

Section titled "prompt"

Inherited from: EventEmitterMixin<IgcGridToolbarExporterComponentEventMap, AbstractConstructor<IgcBaseToolbarDirective>>(IgcBaseToolbarDirective) 

get prompt(): string

Returns string

The placeholder text for the search input.

 
set prompt(value: string): void

Parameters

  • value: string

Returns void

title

Section titled "title"

Inherited from: EventEmitterMixin<IgcGridToolbarExporterComponentEventMap, AbstractConstructor<IgcBaseToolbarDirective>>(IgcBaseToolbarDirective)

The HTMLElement.title property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.

MDN Reference

 
get title(): string

Returns string

Title text for the column action component

 
set title(value: string): void

Parameters

  • value: string

Returns void

Methods

Section titled "Methods"

addEventListener

Section titled "addEventListener"

Inherited from: EventEmitterMixin<IgcGridToolbarExporterComponentEventMap, AbstractConstructor<IgcBaseToolbarDirective>>(IgcBaseToolbarDirective) 

addEventListener(type: K, listener: object, options: boolean | AddEventListenerOptions): void

Parameters

  • type: K
  • listener: object
  • options: boolean | AddEventListenerOptions

Returns void

export

Section titled "export"

Export the grid's data

 
export(type: GridToolbarExporterType): void

Parameters

Returns void

removeEventListener

Section titled "removeEventListener"

Inherited from: EventEmitterMixin<IgcGridToolbarExporterComponentEventMap, AbstractConstructor<IgcBaseToolbarDirective>>(IgcBaseToolbarDirective) 

removeEventListener(type: K, listener: object, options: boolean | EventListenerOptions): void

Parameters

  • type: K
  • listener: object
  • options: boolean | EventListenerOptions

Returns void

register

Section titled "register" 
register(): void

Returns void

Events

Section titled "Events"

closed

Section titled "closed"

Emits an event after the toggle container is closed.

 
closed: CustomEvent<IgcToggleViewEventArgs>

closing

Section titled "closing"

Emits an event before the toggle container is closed.

 
closing: CustomEvent<IgcToggleViewEventArgs>

columnToggle

Section titled "columnToggle"

Emits when after a column's checked state is changed

 
columnToggle: CustomEvent<IgcColumnToggledEventArgs>

exportEnded

Section titled "exportEnded"

Emitted on successful ending of an export operation.

 
exportEnded: CustomEvent<void>

exportStarted

Section titled "exportStarted"

Emitted when starting an export operation. Re-emitted additionally by the grid itself.

 
exportStarted: CustomEvent<IgcExporterEventArgs>

opened

Section titled "opened"

Emits an event after the toggle container is opened.

 
opened: CustomEvent<IgcToggleViewEventArgs>

opening

Section titled "opening"

Emits an event before the toggle container is opened.

 
opening: CustomEvent<IgcToggleViewCancelableEventArgs>