Class DownloadCsvService

Hierarchy

DownloadCsvService

Index

Constructors

Properties

encoding_ extension_ includeHeader_ quote_ separator_ subscriptions

Methods

generateCsv getRow_ startDownload

Constructors

constructor

new DownloadCsvService(): DownloadCsvService
Returns DownloadCsvService
- Defined in src/download/Csv.ts:52

Properties

encoding_

encoding_: string

extension_

extension_: string

includeHeader_

includeHeader_: boolean

quote_

quote_: string

separator_

separator_: string

subscriptions

subscriptions: Subscription[] = []

Methods

generateCsv

generateCsv(data: {
[x: string]: any;
}[], columnDefs: GridColumnDef[]): string
Generate a CSV.

Returns
The CSV file as string.
Parameters
- data: {
  [x: string]: any;
  }[]
  
  Entries/objects to include in the CSV.
- columnDefs: GridColumnDef[]
  
  Column definitions.
Returns string
- Defined in src/download/Csv.ts:75

getRow_

getRow_(values: any[]): string
Returns
CSV row.
Parameters
- values: any[]
  
  Values.
Returns string
- Defined in src/download/Csv.ts:99

startDownload

startDownload(data: {
[x: string]: any;
}[], columnDefs: GridColumnDef[], fileName: string): void
Generate a CSV and start a download with the generated file.
Parameters
- data: {
  [x: string]: any;
  }[]
  
  Entries/objects to include in the CSV.
- columnDefs: GridColumnDef[]
  
  Column definitions.
- fileName: string
  
  The CSV file name, without the extension.
Returns void
- Defined in src/download/Csv.ts:124

Generated using TypeDoc