Skip to content

Commit

Permalink
Documentation updated
Browse files Browse the repository at this point in the history
Added documentation
  • Loading branch information
Rohitbels authored Jan 24, 2018
1 parent a9cca98 commit 86714eb
Showing 1 changed file with 21 additions and 24 deletions.
45 changes: 21 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,24 @@ Following are the functions provided under the Service::

Note:
Arugements:
1 - GripApi is the gridApi of that particular grid.
2 - Options is the following set of object you can set according to your need (showing the default values):

{
visibleRowsOnly: false,
fileName: "download",
txtDelim: '"',
decimalSep: '.',
quoteStrings: "",
addByteOrderMarker: "",
header: [],
columnOrder: [],
fieldSep: ",",
fieldColumnNames: [],
displayColumnNames: [],
listOfFieldColumnsToBeNewlyAdded: [],
listOfFieldColumnsToBeSkipped: [],
listOfDisplayColumnsToBeNewlyAdded: []
}





1 - GripApi is the gridApi of that particular grid.(Required)
2 - Options is the following set of object you can set according to your need (Optional):


Option Name | Type | Default | Description | Requirement
------------|------|---------|-------------|------------
visibleRowsOnly | boolean | false | Property will make sure that only currently visible row data is exported | optional
fileName | String | download | Name of resultant File | optional
txtDelim | String | " (Double Quote)| | optional
decimalSep|String| .(dot)|| optional
quoteStrings |String|blank || optional
header | Array | [] | CSV Column headers to be Exported| optional
columnOrder | Array | [] | Order of columns| optional(Only if the order should be changed)
fieldSep |String|, (Comma) | Delimiter for the CSV File.| optional
fieldColumnNames |Array|[]| This is the field Name provided under column defs (Action data object keys)| optional(Will fetch from Gridapi Automaticallu)
displayColumnNames |Array|[]|This is the Display Name field from Column Def (Actaul Names you wish to see while exporting)
listOfFieldColumnsToBeNewlyAdded|Array|[]|These are field names(actual data key name) of columns the are part of Grid data object but not of Column Defs|optional.
listOfDisplayColumnsToBeNewlyAdded|Array|[]|These are Display names for the option listOfFieldColumnsToBeNewlyAdded order should be maintained
listOfFieldColumnsToBeSkipped|Array|[]|Columns to be skipped from the grid


0 comments on commit 86714eb

Please sign in to comment.