API Docs for:
Show:

flexiciousNmsp.Exporter Class

Extends TypedObject

psuedo abstract class responsible for most export functionality.

Constructor

flexiciousNmsp.Exporter

()

Methods

getColumnHeader

(
  • col
  • colIndex
)

Gets the header for the row

Parameters:

  • col Object
  • colIndex Object

Returns:

:

getContentType

() String

Returns the content type so the appropriate application launches when the exporter is run.

Returns:

String:

getExtension

() String

Extension of the download file.

Returns:

String:

getName

() String

Name of the exporter

Returns:

String:

getNestDepth

() Number

The current nest depth of the record being exported

Returns:

Number:

getNestIndent

() Number

The nest indent on basis of the nest depth

Returns:

Number:

getSpaces

(
  • col
  • spChar
)
String

Depending on the level, gets indentation spaces

Parameters:

  • col Object
  • spChar Object

Returns:

String:

isIncludedInExport

(
  • col
)
Boolean |

Checks whether this column should be exported

Parameters:

  • col Object

Returns:

Boolean | :

saveFile

(
  • body
  • fileName
  • exportOptions
)

Saves the file to disk, or sends it to a remote server to buffer back.

Parameters:

  • body Object
  • fileName Object
  • exportOptions Object

uploadForEcho

(
  • body
  • exportOptions
)

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

Parameters:

  • body Object
  • exportOptions Object

uploadToServer

()

Not used

writeFooter

(
  • grid
)
String

Writes out the footer for the row

Parameters:

  • grid Object

Returns:

String:

writeHeader

(
  • grid
)
String

Writes out the header for the row

Parameters:

  • grid Object

Returns:

String:

writeRecord

(
  • grid
  • record
)
String

Writes out the record for the row

Parameters:

  • grid Object
  • record Object

Returns:

String: