|
13 | 13 | </div><h5 id="methods_addtomenu_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>grid</td><td><a href="" class="label type-hint type-hint-grid">Grid</a></td><td><div class="addtomenu-page"><p>the grid from which data should be exported</p>
|
14 | 14 | </div></td></tr></tbody></table></div>
|
15 | 15 | </li>
|
16 |
| -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1408" class="view-source icon-eye-open"> </a><h3 id="methods_calculatepdfheaderwidths">calculatePdfHeaderWidths(grid, exportHeaders)</h3> |
| 16 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1411" class="view-source icon-eye-open"> </a><h3 id="methods_calculatepdfheaderwidths">calculatePdfHeaderWidths(grid, exportHeaders)</h3> |
17 | 17 | <div class="calculatepdfheaderwidths"><div class="calculatepdfheaderwidths-page"><p>Determines the column widths base on the
|
18 | 18 | widths we got from the grid. If the column is drawn
|
19 | 19 | then we have a drawnWidth. If the column is not visible
|
|
41 | 41 | uiGridExporterConstants.SELECTED</p>
|
42 | 42 | </div></td></tr></tbody></table></div>
|
43 | 43 | </li>
|
44 |
| -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1173" class="view-source icon-eye-open"> </a><h3 id="methods_downloadfile">downloadFile(fileName, csvContent, columnSeparator, exporterOlderExcelCompatibility, exporterIsExcelCompatible)</h3> |
| 44 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1176" class="view-source icon-eye-open"> </a><h3 id="methods_downloadfile">downloadFile(fileName, csvContent, columnSeparator, exporterOlderExcelCompatibility, exporterIsExcelCompatible)</h3> |
45 | 45 | <div class="downloadfile"><div class="downloadfile-page"><p>Triggers download of a csv file. Logic provided
|
46 | 46 | by @cssensei (from his colleagues at <a href="https://github.com/ifeelgoods">https://github.com/ifeelgoods</a>) in issue #2391</p>
|
47 | 47 | </div><h5 id="methods_downloadfile_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>fileName</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="downloadfile-page"><p>the filename we'd like our file to be
|
|
53 | 53 | </div></td></tr><tr><td>exporterIsExcelCompatible</td><td><a href="" class="label type-hint type-hint-boolean">boolean</a></td><td><div class="downloadfile-page"><p>whether or not we add separator header ('sep=X')</p>
|
54 | 54 | </div></td></tr></tbody></table></div>
|
55 | 55 | </li>
|
56 |
| -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1285" class="view-source icon-eye-open"> </a><h3 id="methods_downloadpdf">downloadPdf(fileName, docDefinition)</h3> |
| 56 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1288" class="view-source icon-eye-open"> </a><h3 id="methods_downloadpdf">downloadPdf(fileName, docDefinition)</h3> |
57 | 57 | <div class="downloadpdf"><div class="downloadpdf-page"><p>Generates and retrieves the pdf as a blob, then downloads
|
58 | 58 | it as a file. Only used in IE, in all other browsers we use the native
|
59 | 59 | pdfMake.open function to just open the PDF</p>
|
|
74 | 74 | </div></td></tr></tbody></table><h5 id="methods_formatascsv_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="formatascsv-page"><p>csv the formatted csv as a string</p>
|
75 | 75 | </div></td></tr></table></div>
|
76 | 76 | </li>
|
77 |
| -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1505" class="view-source icon-eye-open"> </a><h3 id="methods_formatasexcel">formatAsExcel(exportColumnHeaders, exportData, separator)</h3> |
| 77 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1508" class="view-source icon-eye-open"> </a><h3 id="methods_formatasexcel">formatAsExcel(exportColumnHeaders, exportData, separator)</h3> |
78 | 78 | <div class="formatasexcel"><div class="formatasexcel-page"><p>Formats the column headers and data as a excel,
|
79 | 79 | and sends that data to the user</p>
|
80 | 80 | </div><h5 id="methods_formatasexcel_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>exportColumnHeaders</td><td><a href="" class="label type-hint type-hint-array">array</a></td><td><div class="formatasexcel-page"><p>an array of column headers,
|
|
85 | 85 | </div></td></tr></tbody></table><h5 id="methods_formatasexcel_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="formatasexcel-page"><p>csv the formatted excel as a string</p>
|
86 | 86 | </div></td></tr></table></div>
|
87 | 87 | </li>
|
88 |
| -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1466" class="view-source icon-eye-open"> </a><h3 id="methods_formatfieldascsv">formatFieldAsCsv(field)</h3> |
| 88 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1469" class="view-source icon-eye-open"> </a><h3 id="methods_formatfieldascsv">formatFieldAsCsv(field)</h3> |
89 | 89 | <div class="formatfieldascsv"><div class="formatfieldascsv-page"><p>Renders a single field as a pdf-able field, which
|
90 | 90 | is different from a csv field only in that strings don't have quotes
|
91 | 91 | around them</p>
|
|
102 | 102 | </div></td></tr></tbody></table><h5 id="methods_formatfieldascsv_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="formatfieldascsv-page"><p>a csv-ified version of the field</p>
|
103 | 103 | </div></td></tr></table></div>
|
104 | 104 | </li>
|
105 |
| -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1564" class="view-source icon-eye-open"> </a><h3 id="methods_formatfieldasexcel">formatFieldAsExcel(field)</h3> |
| 105 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1567" class="view-source icon-eye-open"> </a><h3 id="methods_formatfieldasexcel">formatFieldAsExcel(field)</h3> |
106 | 106 | <div class="formatfieldasexcel"><div class="formatfieldasexcel-page"><p>Renders a single field as a csv field, including
|
107 | 107 | quotes around the value</p>
|
108 | 108 | </div><h5 id="methods_formatfieldasexcel_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>field</td><td><a href="" class="label type-hint type-hint-field">field</a></td><td><div class="formatfieldasexcel-page"><p>the field to be turned into a csv string,
|
|
118 | 118 | </div></td></tr></tbody></table><h5 id="methods_formatrowascsv_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-function">function</a></td><td><div class="formatrowascsv-page"><p>A function that returns a csv-ified version of the row</p>
|
119 | 119 | </div></td></tr></table></div>
|
120 | 120 | </li>
|
121 |
| -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1543" class="view-source icon-eye-open"> </a><h3 id="methods_formatrowasexcel">formatRowAsExcel(exporter, row)</h3> |
| 121 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1546" class="view-source icon-eye-open"> </a><h3 id="methods_formatrowasexcel">formatRowAsExcel(exporter, row)</h3> |
122 | 122 | <div class="formatrowasexcel"><div class="formatrowasexcel-page"><p>Renders a single field as a csv field, including
|
123 | 123 | quotes around the value</p>
|
124 | 124 | </div><h5 id="methods_formatrowasexcel_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>exporter</td><td><a href="" class="label type-hint type-hint-exporterservice">exporterService</a></td><td><div class="formatrowasexcel-page"><p>pass in exporter</p>
|
125 | 125 | </div></td></tr><tr><td>row</td><td><a href="" class="label type-hint type-hint-array">array</a></td><td><div class="formatrowasexcel-page"><p>the row to be turned into a excel string</p>
|
126 | 126 | </div></td></tr></tbody></table><h5 id="methods_formatrowasexcel_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-array">array</a></td><td><div class="formatrowasexcel-page"><p>array of cell objects (i.e. {value: x, metadata: y})</p>
|
127 | 127 | </div></td></tr></table></div>
|
128 | 128 | </li>
|
129 |
| -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1448" class="view-source icon-eye-open"> </a><h3 id="methods_formatrowaspdf">formatRowAsPdf(exporter, row)</h3> |
| 129 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1451" class="view-source icon-eye-open"> </a><h3 id="methods_formatrowaspdf">formatRowAsPdf(exporter, row)</h3> |
130 | 130 | <div class="formatrowaspdf"><div class="formatrowaspdf-page"><p>Renders a row in a format consumable by PDF,
|
131 | 131 | mainly meaning casting everything to a string</p>
|
132 | 132 | </div><h5 id="methods_formatrowaspdf_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>exporter</td><td><a href="" class="label type-hint type-hint-exporterservice">exporterService</a></td><td><div class="formatrowaspdf-page"><p>pass in exporter</p>
|
|
178 | 178 | </div></td></tr></tbody></table><h5 id="methods_getrowsfromnode_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-array">Array</a></td><td><div class="getrowsfromnode-page"><p>an array of leaf nodes</p>
|
179 | 179 | </div></td></tr></table></div>
|
180 | 180 | </li>
|
181 |
| -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1147" class="view-source icon-eye-open"> </a><h3 id="methods_isie">isIE()</h3> |
| 181 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1150" class="view-source icon-eye-open"> </a><h3 id="methods_isie">isIE()</h3> |
182 | 182 | <div class="isie"><div class="isie-page"><p>Checks whether current browser is IE and returns it's version if it is</p>
|
183 | 183 | </div></div>
|
184 | 184 | </li>
|
|
196 | 196 | uiGridExporterConstants.SELECTED</p>
|
197 | 197 | </div></td></tr></tbody></table></div>
|
198 | 198 | </li>
|
199 |
| -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1256" class="view-source icon-eye-open"> </a><h3 id="methods_pdfexport">pdfExport(grid, rowTypes, colTypes)</h3> |
| 199 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1259" class="view-source icon-eye-open"> </a><h3 id="methods_pdfexport">pdfExport(grid, rowTypes, colTypes)</h3> |
200 | 200 | <div class="pdfexport"><div class="pdfexport-page"><p>Exports rows from the grid in pdf format,
|
201 | 201 | the data exported is selected based on the provided options.
|
202 | 202 | Note that this function has a dependency on pdfMake, which must
|
|
211 | 211 | uiGridExporterConstants.SELECTED</p>
|
212 | 212 | </div></td></tr></tbody></table></div>
|
213 | 213 | </li>
|
214 |
| -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1338" class="view-source icon-eye-open"> </a><h3 id="methods_renderaspdf">renderAsPdf(grid, exportColumnHeaders, exportData)</h3> |
| 214 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/src/features/exporter/js/exporter.js#L1341" class="view-source icon-eye-open"> </a><h3 id="methods_renderaspdf">renderAsPdf(grid, exportColumnHeaders, exportData)</h3> |
215 | 215 | <div class="renderaspdf"><div class="renderaspdf-page"><p>Renders the data into a pdf, and opens that pdf.</p>
|
216 | 216 | </div><h5 id="methods_renderaspdf_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>grid</td><td><a href="" class="label type-hint type-hint-grid">Grid</a></td><td><div class="renderaspdf-page"><p>the grid from which data should be exported</p>
|
217 | 217 | </div></td></tr><tr><td>exportColumnHeaders</td><td><a href="" class="label type-hint type-hint-array">array</a></td><td><div class="renderaspdf-page"><p>an array of column headers,
|
|
0 commit comments