igniteui-webcomponents-grids
Version:
Ignite UI Web Components grid components.
87 lines (62 loc) • 2.14 kB
TypeScript
import { IgcExporterOptionsBase } from './igc-exporter-options-base';
/* csSuppress */
/**
* Objects of this class are used to configure the Excel exporting process.
*/
export declare class IgcExcelExporterOptions extends IgcExporterOptionsBase
{
/**
* Specifies if column pinning should be ignored. If ignoreColumnsOrder is set to true,
* this option will always be considered as set to true.
* ```typescript
* let ignorePinning = this.exportOptions.ignorePinning;
* this.exportOptions.ignorePinning = true;
* ```
*
* @memberof IgxExcelExporterOptions
*/
public set ignorePinning(value: boolean);
public get ignorePinning(): boolean;
/**
* Specifies whether the exported data should be formatted as Excel table. (True by default)
* ```typescript
* let exportAsTable = this.exportOptions.exportAsTable;
* this.exportOptions.exportAsTable = false;
* ```
*
* @memberof IgxExcelExporterOptions
*/
public set exportAsTable(value: boolean);
public get exportAsTable(): boolean;
/**
* Gets the width of the columns in the exported excel file.
* ```typescript
* let width = this.exportOptions.columnWidth;
* ```
*
* @memberof IgxExcelExporterOptions
*/
public set columnWidth(value: number);
public get columnWidth(): number;
/**
* Gets the height of the rows in the exported excel file.
* ```typescript
* let height = this.exportOptions.rowHeight;
* ```
*
* @memberof IgxExcelExporterOptions
*/
public set rowHeight(value: number);
public get rowHeight(): number;
/**
* Gets the name of the worksheet in the exported excel file.
* ```typescript
* let worksheetName = this.exportOptions.worksheetName;
* ```
*
* @memberof IgxExcelExporterOptions
*/
public set worksheetName(value: string);
public get worksheetName(): string;
constructor(fileName: string);
}