-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
exporter.js
executable file
·1620 lines (1480 loc) · 68.1 KB
/
exporter.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* global pdfMake */
/* global ExcelBuilder */
/* global console */
(function () {
'use strict';
/**
* @ngdoc overview
* @name ui.grid.exporter
* @description
*
* # ui.grid.exporter
*
* <div class="alert alert-success" role="alert"><strong>Stable</strong> This feature is stable. There should no longer be breaking api changes without a deprecation warning.</div>
*
* This module provides the ability to export data from the grid.
*
* Data can be exported in a range of formats, and all data, visible
* data, or selected rows can be exported, with all columns or visible
* columns.
*
* No UI is provided, the caller should provide their own UI/buttons
* as appropriate, or enable the gridMenu
*
* <br/>
* <br/>
*
* <div doc-module-components="ui.grid.exporter"></div>
*/
var module = angular.module('ui.grid.exporter', ['ui.grid']);
/**
* @ngdoc object
* @name ui.grid.exporter.constant:uiGridExporterConstants
*
* @description constants available in exporter module
*/
/**
* @ngdoc property
* @propertyOf ui.grid.exporter.constant:uiGridExporterConstants
* @name ALL
* @description export all data, including data not visible. Can
* be set for either rowTypes or colTypes
*/
/**
* @ngdoc property
* @propertyOf ui.grid.exporter.constant:uiGridExporterConstants
* @name VISIBLE
* @description export only visible data, including data not visible. Can
* be set for either rowTypes or colTypes
*/
/**
* @ngdoc property
* @propertyOf ui.grid.exporter.constant:uiGridExporterConstants
* @name SELECTED
* @description export all data, including data not visible. Can
* be set only for rowTypes, selection of only some columns is
* not supported
*/
module.constant('uiGridExporterConstants', {
featureName: 'exporter',
ALL: 'all',
VISIBLE: 'visible',
SELECTED: 'selected',
CSV_CONTENT: 'CSV_CONTENT',
BUTTON_LABEL: 'BUTTON_LABEL',
FILE_NAME: 'FILE_NAME'
});
/**
* @ngdoc service
* @name ui.grid.exporter.service:uiGridExporterService
*
* @description Services for exporter feature
*/
module.service('uiGridExporterService', ['$q', 'uiGridExporterConstants', 'gridUtil', '$compile', '$interval', 'i18nService',
function ($q, uiGridExporterConstants, gridUtil, $compile, $interval, i18nService) {
var service = {
delay: 100,
initializeGrid: function (grid) {
//add feature namespace and any properties to grid for needed state
grid.exporter = {};
this.defaultGridOptions(grid.options);
/**
* @ngdoc object
* @name ui.grid.exporter.api:PublicApi
*
* @description Public Api for exporter feature
*/
var publicApi = {
events: {
exporter: {
}
},
methods: {
exporter: {
/**
* @ngdoc function
* @name csvExport
* @methodOf ui.grid.exporter.api:PublicApi
* @description Exports rows from the grid in csv format,
* the data exported is selected based on the provided options
* @param {string} rowTypes which rows to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
* uiGridExporterConstants.SELECTED
* @param {string} colTypes which columns to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE
*/
csvExport: function (rowTypes, colTypes) {
service.csvExport(grid, rowTypes, colTypes);
},
/**
* @ngdoc function
* @name pdfExport
* @methodOf ui.grid.exporter.api:PublicApi
* @description Exports rows from the grid in pdf format,
* the data exported is selected based on the provided options
* Note that this function has a dependency on pdfMake, all
* going well this has been installed for you.
* The resulting pdf opens in a new browser window.
* @param {string} rowTypes which rows to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
* uiGridExporterConstants.SELECTED
* @param {string} colTypes which columns to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE
*/
pdfExport: function (rowTypes, colTypes) {
service.pdfExport(grid, rowTypes, colTypes);
},
/**
* @ngdoc function
* @name excelExport
* @methodOf ui.grid.exporter.api:PublicApi
* @description Exports rows from the grid in excel format,
* the data exported is selected based on the provided options
* @param {string} rowTypes which rows to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
* uiGridExporterConstants.SELECTED
* @param {string} colTypes which columns to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE
*/
excelExport: function (rowTypes, colTypes) {
service.excelExport(grid, rowTypes, colTypes);
}
}
}
};
grid.api.registerEventsFromObject(publicApi.events);
grid.api.registerMethodsFromObject(publicApi.methods);
if (grid.api.core.addToGridMenu){
service.addToMenu( grid );
} else {
// order of registration is not guaranteed, register in a little while
$interval( function() {
if (grid.api.core.addToGridMenu){
service.addToMenu( grid );
}
}, this.delay, 1);
}
},
defaultGridOptions: function (gridOptions) {
//default option to true unless it was explicitly set to false
/**
* @ngdoc object
* @name ui.grid.exporter.api:GridOptions
*
* @description GridOptions for exporter feature, these are available to be
* set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
*/
/**
* @ngdoc object
* @name ui.grid.exporter.api:ColumnDef
* @description ColumnDef settings for exporter
*/
/**
* @ngdoc object
* @name exporterSuppressMenu
* @propertyOf ui.grid.exporter.api:GridOptions
* @description Don't show the export menu button, implying the user
* will roll their own UI for calling the exporter
* <br/>Defaults to false
*/
gridOptions.exporterSuppressMenu = gridOptions.exporterSuppressMenu === true;
/**
* @ngdoc object
* @name exporterMenuLabel
* @propertyOf ui.grid.exporter.api:GridOptions
* @description The text to show on the exporter menu button
* link
* <br/>Defaults to 'Export'
*/
gridOptions.exporterMenuLabel = gridOptions.exporterMenuLabel ? gridOptions.exporterMenuLabel : 'Export';
/**
* @ngdoc object
* @name exporterSuppressColumns
* @propertyOf ui.grid.exporter.api:GridOptions
* @description Columns that should not be exported. The selectionRowHeader is already automatically
* suppressed, but if you had a button column or some other "system" column that shouldn't be shown in the
* output then add it in this list. You should provide an array of column names.
* <br/>Defaults to: []
* <pre>
* gridOptions.exporterSuppressColumns = [ 'buttons' ];
* </pre>
*/
gridOptions.exporterSuppressColumns = gridOptions.exporterSuppressColumns ? gridOptions.exporterSuppressColumns : [];
/**
* @ngdoc object
* @name exporterCsvColumnSeparator
* @propertyOf ui.grid.exporter.api:GridOptions
* @description The character to use as column separator
* link
* <br/>Defaults to ','
*/
gridOptions.exporterCsvColumnSeparator = gridOptions.exporterCsvColumnSeparator ? gridOptions.exporterCsvColumnSeparator : ',';
/**
* @ngdoc object
* @name exporterCsvFilename
* @propertyOf ui.grid.exporter.api:GridOptions
* @description The default filename to use when saving the downloaded csv.
* This will only work in some browsers.
* <br/>Defaults to 'download.csv'
*/
gridOptions.exporterCsvFilename = gridOptions.exporterCsvFilename ? gridOptions.exporterCsvFilename : 'download.csv';
/**
* @ngdoc object
* @name exporterPdfFilename
* @propertyOf ui.grid.exporter.api:GridOptions
* @description The default filename to use when saving the downloaded pdf, only used in IE (other browsers open pdfs in a new window)
* <br/>Defaults to 'download.pdf'
*/
gridOptions.exporterPdfFilename = gridOptions.exporterPdfFilename ? gridOptions.exporterPdfFilename : 'download.pdf';
/**
* @ngdoc object
* @name exporterOlderExcelCompatibility
* @propertyOf ui.grid.exporter.api:GridOptions
* @description Some versions of excel don't like the utf-16 BOM on the front, and it comes
* through as  in the first column header. Setting this option to false will suppress this, at the
* expense of proper utf-16 handling in applications that do recognise the BOM
* <br/>Defaults to false
*/
gridOptions.exporterOlderExcelCompatibility = gridOptions.exporterOlderExcelCompatibility === true;
/**
* @ngdoc object
* @name exporterIsExcelCompatible
* @propertyOf ui.grid.exporter.api:GridOptions
* @description Separator header, used to set a custom column separator in a csv file, only works on MS Excel.
* Used it on other programs will make csv content display unproperly. Setting this option to false won't add this header.
* <br/>Defaults to false
*/
gridOptions.exporterIsExcelCompatible = gridOptions.exporterIsExcelCompatible === true;
/**
* @ngdoc object
* @name exporterMenuItemOrder
* @propertyOf ui.grid.exporter.api:GridOptions
* @description An option to determine the starting point for the menu items created by the exporter
* <br/>Defaults to 200
*/
gridOptions.exporterMenuItemOrder = gridOptions.exporterMenuItemOrder ? gridOptions.exporterMenuItemOrder : 200;
/**
* @ngdoc object
* @name exporterPdfDefaultStyle
* @propertyOf ui.grid.exporter.api:GridOptions
* @description The default style in pdfMake format
* <br/>Defaults to:
* <pre>
* {
* fontSize: 11
* }
* </pre>
*/
gridOptions.exporterPdfDefaultStyle = gridOptions.exporterPdfDefaultStyle ? gridOptions.exporterPdfDefaultStyle : { fontSize: 11 };
/**
* @ngdoc object
* @name exporterPdfTableStyle
* @propertyOf ui.grid.exporter.api:GridOptions
* @description The table style in pdfMake format
* <br/>Defaults to:
* <pre>
* {
* margin: [0, 5, 0, 15]
* }
* </pre>
*/
gridOptions.exporterPdfTableStyle = gridOptions.exporterPdfTableStyle ? gridOptions.exporterPdfTableStyle : { margin: [0, 5, 0, 15] };
/**
* @ngdoc object
* @name exporterPdfTableHeaderStyle
* @propertyOf ui.grid.exporter.api:GridOptions
* @description The tableHeader style in pdfMake format
* <br/>Defaults to:
* <pre>
* {
* bold: true,
* fontSize: 12,
* color: 'black'
* }
* </pre>
*/
gridOptions.exporterPdfTableHeaderStyle = gridOptions.exporterPdfTableHeaderStyle ? gridOptions.exporterPdfTableHeaderStyle : { bold: true, fontSize: 12, color: 'black' };
/**
* @ngdoc object
* @name exporterPdfHeader
* @propertyOf ui.grid.exporter.api:GridOptions
* @description The header section for pdf exports. Can be
* simple text:
* <pre>
* gridOptions.exporterPdfHeader = 'My Header';
* </pre>
* Can be a more complex object in pdfMake format:
* <pre>
* gridOptions.exporterPdfHeader = {
* columns: [
* 'Left part',
* { text: 'Right part', alignment: 'right' }
* ]
* };
* </pre>
* Or can be a function, allowing page numbers and the like
* <pre>
* gridOptions.exporterPdfHeader: function(currentPage, pageCount) { return currentPage.toString() + ' of ' + pageCount; };
* </pre>
*/
gridOptions.exporterPdfHeader = gridOptions.exporterPdfHeader ? gridOptions.exporterPdfHeader : null;
/**
* @ngdoc object
* @name exporterPdfFooter
* @propertyOf ui.grid.exporter.api:GridOptions
* @description The header section for pdf exports. Can be
* simple text:
* <pre>
* gridOptions.exporterPdfFooter = 'My Footer';
* </pre>
* Can be a more complex object in pdfMake format:
* <pre>
* gridOptions.exporterPdfFooter = {
* columns: [
* 'Left part',
* { text: 'Right part', alignment: 'right' }
* ]
* };
* </pre>
* Or can be a function, allowing page numbers and the like
* <pre>
* gridOptions.exporterPdfFooter: function(currentPage, pageCount) { return currentPage.toString() + ' of ' + pageCount; };
* </pre>
*/
gridOptions.exporterPdfFooter = gridOptions.exporterPdfFooter ? gridOptions.exporterPdfFooter : null;
/**
* @ngdoc object
* @name exporterPdfOrientation
* @propertyOf ui.grid.exporter.api:GridOptions
* @description The orientation, should be a valid pdfMake value,
* 'landscape' or 'portrait'
* <br/>Defaults to landscape
*/
gridOptions.exporterPdfOrientation = gridOptions.exporterPdfOrientation ? gridOptions.exporterPdfOrientation : 'landscape';
/**
* @ngdoc object
* @name exporterPdfPageSize
* @propertyOf ui.grid.exporter.api:GridOptions
* @description The orientation, should be a valid pdfMake
* paper size, usually 'A4' or 'LETTER'
* {@link https://github.com/bpampuch/pdfmake/blob/master/src/standardPageSizes.js pdfMake page sizes}
* <br/>Defaults to A4
*/
gridOptions.exporterPdfPageSize = gridOptions.exporterPdfPageSize ? gridOptions.exporterPdfPageSize : 'A4';
/**
* @ngdoc object
* @name exporterPdfMaxGridWidth
* @propertyOf ui.grid.exporter.api:GridOptions
* @description The maxium grid width - the current grid width
* will be scaled to match this, with any fixed width columns
* being adjusted accordingly.
* <br/>Defaults to 720 (for A4 landscape), use 670 for LETTER
*/
gridOptions.exporterPdfMaxGridWidth = gridOptions.exporterPdfMaxGridWidth ? gridOptions.exporterPdfMaxGridWidth : 720;
/**
* @ngdoc object
* @name exporterPdfTableLayout
* @propertyOf ui.grid.exporter.api:GridOptions
* @description A tableLayout in pdfMake format,
* controls gridlines and the like. We use the default
* layout usually.
* <br/>Defaults to null, which means no layout
*/
/**
* @ngdoc object
* @name exporterMenuAllData
* @porpertyOf ui.grid.exporter.api:GridOptions
* @description Add export all data as cvs/pdf menu items to the ui-grid grid menu, if it's present. Defaults to true.
*/
gridOptions.exporterMenuAllData = gridOptions.exporterMenuAllData !== undefined ? gridOptions.exporterMenuAllData : true;
/**
* @ngdoc object
* @name exporterMenuVisibleData
* @porpertyOf ui.grid.exporter.api:GridOptions
* @description Add export visible data as cvs/pdf menu items to the ui-grid grid menu, if it's present. Defaults to true.
*/
gridOptions.exporterMenuVisibleData = gridOptions.exporterMenuVisibleData !== undefined ? gridOptions.exporterMenuVisibleData : true;
/**
* @ngdoc object
* @name exporterMenuSelectedData
* @porpertyOf ui.grid.exporter.api:GridOptions
* @description Add export selected data as cvs/pdf menu items to the ui-grid grid menu, if it's present. Defaults to true.
*/
gridOptions.exporterMenuSelectedData = gridOptions.exporterMenuSelectedData !== undefined ? gridOptions.exporterMenuSelectedData : true;
/**
* @ngdoc object
* @name exporterMenuCsv
* @propertyOf ui.grid.exporter.api:GridOptions
* @description Add csv export menu items to the ui-grid grid menu, if it's present. Defaults to true.
*/
gridOptions.exporterMenuCsv = gridOptions.exporterMenuCsv !== undefined ? gridOptions.exporterMenuCsv : true;
/**
* @ngdoc object
* @name exporterMenuPdf
* @propertyOf ui.grid.exporter.api:GridOptions
* @description Add pdf export menu items to the ui-grid grid menu, if it's present. Defaults to true.
*/
gridOptions.exporterMenuPdf = gridOptions.exporterMenuPdf !== undefined ? gridOptions.exporterMenuPdf : true;
/**
* @ngdoc object
* @name exporterMenuExcel
* @propertyOf ui.grid.exporter.api:GridOptions
* @description Add excel export menu items to the ui-grid grid menu, if it's present. Defaults to true.
*/
gridOptions.exporterMenuExcel = gridOptions.exporterMenuExcel !== undefined ? gridOptions.exporterMenuExcel : true;
/**
* @ngdoc object
* @name exporterPdfCustomFormatter
* @propertyOf ui.grid.exporter.api:GridOptions
* @description A custom callback routine that changes the pdf document, adding any
* custom styling or content that is supported by pdfMake. Takes in the complete docDefinition, and
* must return an updated docDefinition ready for pdfMake.
* @example
* In this example we add a style to the style array, so that we can use it in our
* footer definition.
* <pre>
* gridOptions.exporterPdfCustomFormatter = function ( docDefinition ) {
* docDefinition.styles.footerStyle = { bold: true, fontSize: 10 };
* return docDefinition;
* }
*
* gridOptions.exporterPdfFooter = { text: 'My footer', style: 'footerStyle' }
* </pre>
*/
gridOptions.exporterPdfCustomFormatter = ( gridOptions.exporterPdfCustomFormatter && typeof( gridOptions.exporterPdfCustomFormatter ) === 'function' ) ? gridOptions.exporterPdfCustomFormatter : function ( docDef ) { return docDef; };
/**
* @ngdoc object
* @name exporterHeaderFilterUseName
* @propertyOf ui.grid.exporter.api:GridOptions
* @description Defaults to false, which leads to `displayName` being passed into the headerFilter.
* If set to true, then will pass `name` instead.
*
*
* @example
* <pre>
* gridOptions.exporterHeaderFilterUseName = true;
* </pre>
*/
gridOptions.exporterHeaderFilterUseName = gridOptions.exporterHeaderFilterUseName === true;
/**
* @ngdoc object
* @name exporterHeaderFilter
* @propertyOf ui.grid.exporter.api:GridOptions
* @description A function to apply to the header displayNames before exporting. Useful for internationalisation,
* for example if you were using angular-translate you'd set this to `$translate.instant`. Note that this
* call must be synchronous, it cannot be a call that returns a promise.
*
* Behaviour can be changed to pass in `name` instead of `displayName` through use of `exporterHeaderFilterUseName: true`.
*
* @example
* <pre>
* gridOptions.exporterHeaderFilter = function( displayName ){ return 'col: ' + name; };
* </pre>
* OR
* <pre>
* gridOptions.exporterHeaderFilter = $translate.instant;
* </pre>
*/
/**
* @ngdoc function
* @name exporterFieldCallback
* @propertyOf ui.grid.exporter.api:GridOptions
* @description A function to call for each field before exporting it. Allows
* massaging of raw data into a display format, for example if you have applied
* filters to convert codes into decodes, or you require
* a specific date format in the exported content.
*
* The method is called once for each field exported, and provides the grid, the
* gridCol and the GridRow for you to use as context in massaging the data.
*
* @param {Grid} grid provides the grid in case you have need of it
* @param {GridRow} row the row from which the data comes
* @param {GridCol} col the column from which the data comes
* @param {object} value the value for your massaging
* @returns {object} you must return the massaged value ready for exporting
*
* @example
* <pre>
* gridOptions.exporterFieldCallback = function ( grid, row, col, value ){
* if ( col.name === 'status' ){
* value = decodeStatus( value );
* }
* return value;
* }
* </pre>
*/
gridOptions.exporterFieldCallback = gridOptions.exporterFieldCallback ? gridOptions.exporterFieldCallback : function( grid, row, col, value ) { return value; };
/**
* @ngdoc function
* @name exporterFieldFormatCallback
* @propertyOf ui.grid.exporter.api:GridOptions
* @description A function to call for each field before exporting it. Allows
* general object to be return to modify the format of a cell in the case of
* excel exports
*
* The method is called once for each field exported, and provides the grid, the
* gridCol and the GridRow for you to use as context in massaging the data.
*
* @param {Grid} grid provides the grid in case you have need of it
* @param {GridRow} row the row from which the data comes
* @param {GridCol} col the column from which the data comes
* @param {object} value the value for your massaging
* @returns {object} you must return the massaged value ready for exporting
*
* @example
* <pre>
* gridOptions.exporterFieldCallback = function ( grid, row, col, value ){
* if ( col.name === 'status' ){
* value = decodeStatus( value );
* }
* return value;
* }
* </pre>
*/
gridOptions.exporterFieldFormatCallback = gridOptions.exporterFieldFormatCallback ? gridOptions.exporterFieldFormatCallback : function( grid, row, col, value ) { return null; };
/**
* @ngdoc object
* @name exporterFieldApplyFilters
* @propertyOf ui.grid.exporter.api:GridOptions
* @description Defaults to false, which leads to filters being evaluated on export *
*
* @example
* <pre>
* gridOptions.exporterFieldApplyFilters = true;
* </pre>
*/
gridOptions.exporterFieldApplyFilters = gridOptions.exporterFieldApplyFilters === true;
/**
* @ngdoc function
* @name exporterAllDataFn
* @propertyOf ui.grid.exporter.api:GridOptions
* @description This promise is needed when exporting all rows,
* and the data need to be provided by server side. Default is null.
* @returns {Promise} a promise to load all data from server
*
* @example
* <pre>
* gridOptions.exporterAllDataFn = function () {
* return $http.get('/data/100.json')
* }
* </pre>
*/
gridOptions.exporterAllDataFn = gridOptions.exporterAllDataFn ? gridOptions.exporterAllDataFn : null;
/**
* @ngdoc function
* @name exporterAllDataPromise
* @propertyOf ui.grid.exporter.api:GridOptions
* @description DEPRECATED - exporterAllDataFn used to be
* called this, but it wasn't a promise, it was a function that returned
* a promise. Deprecated, but supported for backward compatibility, use
* exporterAllDataFn instead.
* @returns {Promise} a promise to load all data from server
*
* @example
* <pre>
* gridOptions.exporterAllDataFn = function () {
* return $http.get('/data/100.json')
* }
* </pre>
*/
if ( gridOptions.exporterAllDataFn === null && gridOptions.exporterAllDataPromise ) {
gridOptions.exporterAllDataFn = gridOptions.exporterAllDataPromise;
}
},
/**
* @ngdoc function
* @name addToMenu
* @methodOf ui.grid.exporter.service:uiGridExporterService
* @description Adds export items to the grid menu,
* allowing the user to select export options
* @param {Grid} grid the grid from which data should be exported
*/
addToMenu: function ( grid ) {
grid.api.core.addToGridMenu( grid, [
{
title: i18nService.getSafeText('gridMenu.exporterAllAsCsv'),
action: function ($event) {
grid.api.exporter.csvExport( uiGridExporterConstants.ALL, uiGridExporterConstants.ALL );
},
shown: function() {
return grid.options.exporterMenuCsv && grid.options.exporterMenuAllData;
},
order: grid.options.exporterMenuItemOrder
},
{
title: i18nService.getSafeText('gridMenu.exporterVisibleAsCsv'),
action: function ($event) {
grid.api.exporter.csvExport( uiGridExporterConstants.VISIBLE, uiGridExporterConstants.VISIBLE );
},
shown: function() {
return grid.options.exporterMenuCsv && grid.options.exporterMenuVisibleData;
},
order: grid.options.exporterMenuItemOrder + 1
},
{
title: i18nService.getSafeText('gridMenu.exporterSelectedAsCsv'),
action: function ($event) {
grid.api.exporter.csvExport( uiGridExporterConstants.SELECTED, uiGridExporterConstants.VISIBLE );
},
shown: function() {
return grid.options.exporterMenuCsv && grid.options.exporterMenuSelectedData &&
( grid.api.selection && grid.api.selection.getSelectedRows().length > 0 );
},
order: grid.options.exporterMenuItemOrder + 2
},
{
title: i18nService.getSafeText('gridMenu.exporterAllAsPdf'),
action: function ($event) {
grid.api.exporter.pdfExport( uiGridExporterConstants.ALL, uiGridExporterConstants.ALL );
},
shown: function() {
return grid.options.exporterMenuPdf && grid.options.exporterMenuAllData;
},
order: grid.options.exporterMenuItemOrder + 3
},
{
title: i18nService.getSafeText('gridMenu.exporterVisibleAsPdf'),
action: function ($event) {
grid.api.exporter.pdfExport( uiGridExporterConstants.VISIBLE, uiGridExporterConstants.VISIBLE );
},
shown: function() {
return grid.options.exporterMenuPdf && grid.options.exporterMenuVisibleData;
},
order: grid.options.exporterMenuItemOrder + 4
},
{
title: i18nService.getSafeText('gridMenu.exporterSelectedAsPdf'),
action: function ($event) {
grid.api.exporter.pdfExport( uiGridExporterConstants.SELECTED, uiGridExporterConstants.VISIBLE );
},
shown: function() {
return grid.options.exporterMenuPdf && grid.options.exporterMenuSelectedData &&
( grid.api.selection && grid.api.selection.getSelectedRows().length > 0 );
},
order: grid.options.exporterMenuItemOrder + 5
},
{
title: i18nService.getSafeText('gridMenu.exporterAllAsExcel'),
action: function ($event) {
this.grid.api.exporter.excelExport( uiGridExporterConstants.ALL, uiGridExporterConstants.ALL );
},
shown: function() {
return this.grid.options.exporterMenuExcel && this.grid.options.exporterMenuAllData;
},
order: grid.options.exporterMenuItemOrder + 6
},
{
title: i18nService.getSafeText('gridMenu.exporterVisibleAsExcel'),
action: function ($event) {
this.grid.api.exporter.excelExport( uiGridExporterConstants.VISIBLE, uiGridExporterConstants.VISIBLE );
},
shown: function() {
return this.grid.options.exporterMenuExcel && this.grid.options.exporterMenuVisibleData;
},
order: grid.options.exporterMenuItemOrder + 7
},
{
title: i18nService.getSafeText('gridMenu.exporterSelectedAsExcel'),
action: function ($event) {
this.grid.api.exporter.excelExport( uiGridExporterConstants.SELECTED, uiGridExporterConstants.VISIBLE );
},
shown: function() {
return this.grid.options.exporterMenuExcel && this.grid.options.exporterMenuSelectedData &&
( this.grid.api.selection && this.grid.api.selection.getSelectedRows().length > 0 );
},
order: grid.options.exporterMenuItemOrder + 8
}
]);
},
/**
* @ngdoc function
* @name csvExport
* @methodOf ui.grid.exporter.service:uiGridExporterService
* @description Exports rows from the grid in csv format,
* the data exported is selected based on the provided options
* @param {Grid} grid the grid from which data should be exported
* @param {string} rowTypes which rows to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
* uiGridExporterConstants.SELECTED
* @param {string} colTypes which columns to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
* uiGridExporterConstants.SELECTED
*/
csvExport: function (grid, rowTypes, colTypes) {
var self = this;
this.loadAllDataIfNeeded(grid, rowTypes, colTypes).then(function() {
var exportColumnHeaders = grid.options.showHeader ? self.getColumnHeaders(grid, colTypes) : [];
var exportData = self.getData(grid, rowTypes, colTypes);
var csvContent = self.formatAsCsv(exportColumnHeaders, exportData, grid.options.exporterCsvColumnSeparator);
self.downloadFile (grid.options.exporterCsvFilename, csvContent, grid.options.exporterCsvColumnSeparator, grid.options.exporterOlderExcelCompatibility, grid.options.exporterIsExcelCompatible);
});
},
/**
* @ngdoc function
* @name loadAllDataIfNeeded
* @methodOf ui.grid.exporter.service:uiGridExporterService
* @description When using server side pagination, use exporterAllDataFn to
* load all data before continuing processing.
* When using client side pagination, return a resolved promise so processing
* continues immediately
* @param {Grid} grid the grid from which data should be exported
* @param {string} rowTypes which rows to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
* uiGridExporterConstants.SELECTED
* @param {string} colTypes which columns to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
* uiGridExporterConstants.SELECTED
*/
loadAllDataIfNeeded: function (grid, rowTypes, colTypes) {
if ( rowTypes === uiGridExporterConstants.ALL && grid.rows.length !== grid.options.totalItems && grid.options.exporterAllDataFn) {
return grid.options.exporterAllDataFn()
.then(function(allData) {
grid.modifyRows(allData);
});
} else {
var deferred = $q.defer();
deferred.resolve();
return deferred.promise;
}
},
/**
* @ngdoc property
* @propertyOf ui.grid.exporter.api:ColumnDef
* @name exporterSuppressExport
* @description Suppresses export for this column. Used by selection and expandable.
*/
/**
* @ngdoc function
* @name getColumnHeaders
* @methodOf ui.grid.exporter.service:uiGridExporterService
* @description Gets the column headers from the grid to use
* as a title row for the exported file, all headers have
* headerCellFilters applied as appropriate.
*
* Column headers are an array of objects, each object has
* name, displayName, width and align attributes. Only name is
* used for csv, all attributes are used for pdf.
*
* @param {Grid} grid the grid from which data should be exported
* @param {string} colTypes which columns to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
* uiGridExporterConstants.SELECTED
*/
getColumnHeaders: function (grid, colTypes) {
var headers = [];
var columns;
if ( colTypes === uiGridExporterConstants.ALL ){
columns = grid.columns;
} else {
var leftColumns = grid.renderContainers.left ? grid.renderContainers.left.visibleColumnCache.filter( function( column ){ return column.visible; } ) : [];
var bodyColumns = grid.renderContainers.body ? grid.renderContainers.body.visibleColumnCache.filter( function( column ){ return column.visible; } ) : [];
var rightColumns = grid.renderContainers.right ? grid.renderContainers.right.visibleColumnCache.filter( function( column ){ return column.visible; } ) : [];
columns = leftColumns.concat(bodyColumns,rightColumns);
}
columns.forEach( function( gridCol, index ) {
// $$hashKey check since when grouping and sorting programmatically this ends up in export. Filtering it out
if ( gridCol.colDef.exporterSuppressExport !== true && gridCol.field !== '$$hashKey' &&
grid.options.exporterSuppressColumns.indexOf( gridCol.name ) === -1 ){
var headerEntry = {
name: gridCol.field,
displayName: grid.options.exporterHeaderFilter ? ( grid.options.exporterHeaderFilterUseName ? grid.options.exporterHeaderFilter(gridCol.name) : grid.options.exporterHeaderFilter(gridCol.displayName) ) : gridCol.displayName,
width: gridCol.drawnWidth ? gridCol.drawnWidth : gridCol.width,
align: gridCol.colDef.align ? gridCol.colDef.align : (gridCol.colDef.type === 'number' ? 'right' : 'left')
};
headers.push(headerEntry);
}
});
return headers;
},
/**
* @ngdoc property
* @propertyOf ui.grid.exporter.api:ColumnDef
* @name exporterPdfAlign
* @description the alignment you'd like for this specific column when
* exported into a pdf. Can be 'left', 'right', 'center' or any other
* valid pdfMake alignment option.
*/
/**
* @ngdoc object
* @name ui.grid.exporter.api:GridRow
* @description GridRow settings for exporter
*/
/**
* @ngdoc object
* @name exporterEnableExporting
* @propertyOf ui.grid.exporter.api:GridRow
* @description If set to false, then don't export this row, notwithstanding visible or
* other settings
* <br/>Defaults to true
*/
/**
* @ngdoc function
* @name getRowsFromNode
* @methodOf ui.grid.exporter.service:uiGridExporterService
* @description Gets rows from a node. If the node is grouped it will
* recurse down into the children to get to the raw data element
* which is a row without children (a leaf).
* @param {Node} aNode the tree node on the grid
* @returns {Array} an array of leaf nodes
*/
getRowsFromNode: function(aNode) {
var rows = [];
for (var i = 0; i<aNode.children.length; i++) {
if (aNode.children[i].children && aNode.children[i].children.length === 0) {
rows.push(aNode.children[i]);
} else {
var nodeRows = this.getRowsFromNode(aNode.children[i]);
rows = rows.concat(nodeRows);
}
}
return rows;
},
/**
* @ngdoc function
* @name getDataSorted
* @methodOf ui.grid.exporter.service:uiGridExporterService
* @description Gets rows from a node. If the node is grouped it will
* recurse down into the children to get to the raw data element
* which is a row without children (a leaf). If the grid is not
* grouped this will return just the raw rows
* @param {Grid} grid the grid from which data should be exported
* @param {string} rowTypes which rows to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
* uiGridExporterConstants.SELECTED
* @param {string} colTypes which columns to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
* uiGridExporterConstants.SELECTED
* @param {boolean} applyCellFilters whether or not to get the display value or the raw value of the data
* @returns {Array} an array of leaf nodes
*/
getDataSorted: function (grid, rowTypes, colTypes, applyCellFilters) {
if (!grid.treeBase || grid.treeBase.numberLevels === 0) {
return grid.rows;
}
var rows = [];
for (var i = 0; i< grid.treeBase.tree.length; i++) {
var nodeRows = this.getRowsFromNode(grid.treeBase.tree[i]);
for (var j = 0; j<nodeRows.length; j++) {
rows.push(nodeRows[j].row);
}
}
return rows;
},
/**
* @ngdoc function
* @name getData
* @methodOf ui.grid.exporter.service:uiGridExporterService
* @description Gets data from the grid based on the provided options,
* all cells have cellFilters applied as appropriate. Any rows marked
* `exporterEnableExporting: false` will not be exported
* @param {Grid} grid the grid from which data should be exported
* @param {string} rowTypes which rows to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
* uiGridExporterConstants.SELECTED
* @param {string} colTypes which columns to export, valid values are
* uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
* uiGridExporterConstants.SELECTED
* @param {boolean} applyCellFilters whether or not to get the display value or the raw value of the data
*/
getData: function (grid, rowTypes, colTypes, applyCellFilters) {
var data = [];
var rows;
var columns;
switch ( rowTypes ) {
case uiGridExporterConstants.ALL:
rows = this.getDataSorted(grid, rowTypes, colTypes, applyCellFilters);
break;
case uiGridExporterConstants.VISIBLE:
rows = grid.getVisibleRows();
break;
case uiGridExporterConstants.SELECTED:
if ( grid.api.selection ){
rows = grid.api.selection.getSelectedGridRows();
} else {
gridUtil.logError('selection feature must be enabled to allow selected rows to be exported');
}
break;
}
if ( colTypes === uiGridExporterConstants.ALL ){
columns = grid.columns;
} else {
var leftColumns = grid.renderContainers.left ? grid.renderContainers.left.visibleColumnCache.filter( function( column ){ return column.visible; } ) : [];
var bodyColumns = grid.renderContainers.body ? grid.renderContainers.body.visibleColumnCache.filter( function( column ){ return column.visible; } ) : [];
var rightColumns = grid.renderContainers.right ? grid.renderContainers.right.visibleColumnCache.filter( function( column ){ return column.visible; } ) : [];
columns = leftColumns.concat(bodyColumns,rightColumns);
}
rows.forEach( function( row, index ) {
if (row.exporterEnableExporting !== false) {
var extractedRow = [];
columns.forEach( function( gridCol, index ) {
// $$hashKey check since when grouping and sorting programmatically this ends up in export. Filtering it out
if ( (gridCol.visible || colTypes === uiGridExporterConstants.ALL ) &&
gridCol.colDef.exporterSuppressExport !== true && gridCol.field !== '$$hashKey' &&
grid.options.exporterSuppressColumns.indexOf( gridCol.name ) === -1 ){
var cellValue = applyCellFilters ? grid.getCellDisplayValue( row, gridCol ) : grid.getCellValue( row, gridCol );
var extractedField = { value: grid.options.exporterFieldCallback( grid, row, gridCol, cellValue ) };
var extension = grid.options.exporterFieldFormatCallback( grid, row, gridCol, cellValue );
if (extension) {
Object.assign(extractedField, extension);
}
if ( gridCol.colDef.exporterPdfAlign ) {
extractedField.alignment = gridCol.colDef.exporterPdfAlign;
}
extractedRow.push(extractedField);
}
});
data.push(extractedRow);
}
});
return data;
},
/**
* @ngdoc function
* @name formatAsCsv
* @methodOf ui.grid.exporter.service:uiGridExporterService
* @description Formats the column headers and data as a CSV,
* and sends that data to the user
* @param {array} exportColumnHeaders an array of column headers,
* where each header is an object with name, width and maybe alignment
* @param {array} exportData an array of rows, where each row is