import PdfExporter from 'flexicious-react-datagrid/js/flexgrid/export/PdfExporter.js'

public class | source

PdfExporter

Extends:

TypedObject → Exporter → PdfExporter

Exports the grid in CSV format

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	columns: *[] object representing the columns
public	data: *[] object representing the data

Method Summary

Public Methods
public	getClassNames(): string[]
public	getContentType(): string Returns the content type so MS Excel launches when the exporter is run.
public	getExtension(): string Extension of the download file.
public	getName(): string Name of the exporter
public	uploadForEcho(body: , exportOptions: ) Just in case in the client wants to customize the upload behavior of their exporters.
public	writeFooter(grid: , dataProvider: ): string Writes the footer in PDF format
public	writeHeader(grid: *): string Builds the PDF representation of a header row.
public	writeRecord(grid: , record: ): string Writes an individual record in PDF format

Inherited Summary

From class TypedObject
public	typeCache: {}
public	constructed()
public	getClassNames(): Array Returns a list of strings that represent the object hierarchy for this object.
public	implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class.

From class Exporter
public static	getColumnHeader(col: , colIndex: ): * Gets the header for the row
public	allRecords: *[]
public	exportOptions: *
public	nestDepth: number
public	nestIndent: number
public	reusePreviousLevelColumns: boolean
public	getClassNames(): string[]
public	getContentType(): String Returns the content type so the appropriate application launches when the exporter is run.
public	getExtension(): String Extension of the download file.
public	getName(): String Name of the exporter
public	getNestDepth(): Number The current nest depth of the record being exported
public	getNestIndent(): Number The nest indent on basis of the nest depth
public	getSpaces(col: , spChar: ): String Depending on the level, gets indentation spaces
public	isIncludedInExport(col: ): Boolean \| Checks whether this column should be exported
public	saveFile(body: , fileName: , exportOptions: ): Saves the file to disk, or sends it to a remote server to buffer back.
public	uploadForEcho(body: , exportOptions: ) Just in case in the client wants to customize the upload behavior of their exporters.
public	uploadToServer(body: , exportOptions: ) Not used
public	writeFooter(grid: , dataProvider: ): String Writes out the footer for the row
public	writeHeader(grid: *): String Writes out the header for the row
public	writeRecord(grid: , record: ): String Writes out the record for the row

Public Constructors

public constructor() source

Override:

Exporter#constructor

Public Members

public columns: *[] source

object representing the columns

public data: *[] source

object representing the data

Public Methods

public getClassNames(): string[] source

Returns a list of strings that represent the object hierarchy for this object.

Override:

Exporter#getClassNames

Return:

string[]

public getContentType(): string source

Returns the content type so MS Excel launches when the exporter is run.

Override:

Exporter#getContentType

Return:

string

public getExtension(): string source

Extension of the download file.

Override:

Exporter#getExtension

Return:

string

public getName(): string source

Name of the exporter

Override:

Exporter#getName

Return:

string

public uploadForEcho(body: , exportOptions: ) source

Just in case in the client wants to customize the upload behavior of their exporters.

Override:

Exporter#uploadForEcho

Params:

Name	Type	Attribute	Description
body	*
exportOptions	*

public writeFooter(grid: , dataProvider: ): string source

Writes the footer in PDF format

Override:

Exporter#writeFooter

Params:

Name	Type	Attribute	Description
grid	*
dataProvider	*

Return:

string

public writeHeader(grid: *): string source

Builds the PDF representation of a header row.

Override:

Exporter#writeHeader

Params:

Name	Type	Attribute	Description
grid	*

Return:

string

public writeRecord(grid: , record: ): string source

Writes an individual record in PDF format

Override:

Exporter#writeRecord

Params:

Name	Type	Attribute	Description
grid	*
record	*

Return:

string

PdfExporter

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Override:

Public Members

public columns: *[] source

public data: *[] source

Public Methods

public getClassNames(): string[] source

Override:

Return:

public getContentType(): string source

Override:

Return:

public getExtension(): string source

Override:

Return:

public getName(): string source

Override:

Return:

public uploadForEcho(body: *, exportOptions: *) source

Override:

Params:

public writeFooter(grid: *, dataProvider: *): string source

Override:

Params:

Return:

public writeHeader(grid: *): string source

Override:

Params:

Return:

public writeRecord(grid: *, record: *): string source

Override:

Params:

Return:

public uploadForEcho(body: , exportOptions: ) source

public writeFooter(grid: , dataProvider: ): string source

public writeRecord(grid: , record: ): string source