tabulator-tables 5.4.3 → 5.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (253) hide show
  1. package/.babelrc.json +3 -3
  2. package/.editorconfig +6 -6
  3. package/.eslintignore +3 -3
  4. package/.eslintrc.js +28 -28
  5. package/.github/ISSUE_TEMPLATE/bug_report.md +58 -58
  6. package/.github/ISSUE_TEMPLATE/documentation.md +14 -14
  7. package/.github/ISSUE_TEMPLATE/feature_request.md +24 -24
  8. package/.github/ISSUE_TEMPLATE/question.md +12 -12
  9. package/.github/workflows/bad-files-check.yml +39 -39
  10. package/.github/workflows/lint-and-test.yml +30 -30
  11. package/CODE_OF_CONDUCT.md +46 -46
  12. package/CONTRIBUTING.md +22 -22
  13. package/LICENSE +20 -20
  14. package/README.md +76 -76
  15. package/bower.json +40 -40
  16. package/build/Bundler.js +185 -185
  17. package/build/rollup.js +6 -6
  18. package/dist/css/tabulator.css +0 -5
  19. package/dist/css/tabulator.css.map +1 -1
  20. package/dist/css/tabulator.min.css +1 -1
  21. package/dist/css/tabulator.min.css.map +1 -1
  22. package/dist/css/tabulator_bootstrap3.css +0 -5
  23. package/dist/css/tabulator_bootstrap3.css.map +1 -1
  24. package/dist/css/tabulator_bootstrap3.min.css +1 -1
  25. package/dist/css/tabulator_bootstrap3.min.css.map +1 -1
  26. package/dist/css/tabulator_bootstrap4.css +0 -5
  27. package/dist/css/tabulator_bootstrap4.css.map +1 -1
  28. package/dist/css/tabulator_bootstrap4.min.css +1 -1
  29. package/dist/css/tabulator_bootstrap4.min.css.map +1 -1
  30. package/dist/css/tabulator_bootstrap5.css +0 -5
  31. package/dist/css/tabulator_bootstrap5.css.map +1 -1
  32. package/dist/css/tabulator_bootstrap5.min.css +1 -1
  33. package/dist/css/tabulator_bootstrap5.min.css.map +1 -1
  34. package/dist/css/tabulator_bulma.css +0 -5
  35. package/dist/css/tabulator_bulma.css.map +1 -1
  36. package/dist/css/tabulator_bulma.min.css +1 -1
  37. package/dist/css/tabulator_bulma.min.css.map +1 -1
  38. package/dist/css/tabulator_materialize.css +0 -5
  39. package/dist/css/tabulator_materialize.css.map +1 -1
  40. package/dist/css/tabulator_materialize.min.css +1 -1
  41. package/dist/css/tabulator_materialize.min.css.map +1 -1
  42. package/dist/css/tabulator_midnight.css +0 -5
  43. package/dist/css/tabulator_midnight.css.map +1 -1
  44. package/dist/css/tabulator_midnight.min.css +1 -1
  45. package/dist/css/tabulator_midnight.min.css.map +1 -1
  46. package/dist/css/tabulator_modern.css +0 -5
  47. package/dist/css/tabulator_modern.css.map +1 -1
  48. package/dist/css/tabulator_modern.min.css +1 -1
  49. package/dist/css/tabulator_modern.min.css.map +1 -1
  50. package/dist/css/tabulator_semanticui.css +102 -107
  51. package/dist/css/tabulator_semanticui.css.map +1 -1
  52. package/dist/css/tabulator_semanticui.min.css +1 -1
  53. package/dist/css/tabulator_semanticui.min.css.map +1 -1
  54. package/dist/css/tabulator_simple.css +0 -5
  55. package/dist/css/tabulator_simple.css.map +1 -1
  56. package/dist/css/tabulator_simple.min.css +1 -1
  57. package/dist/css/tabulator_simple.min.css.map +1 -1
  58. package/dist/css/tabulator_site.css +0 -5
  59. package/dist/css/tabulator_site.css.map +1 -1
  60. package/dist/css/tabulator_site.min.css +1 -1
  61. package/dist/css/tabulator_site.min.css.map +1 -1
  62. package/dist/js/jquery_wrapper.js +55 -55
  63. package/dist/js/tabulator.js +25847 -25711
  64. package/dist/js/tabulator.js.map +1 -1
  65. package/dist/js/tabulator.min.js +2 -2
  66. package/dist/js/tabulator.min.js.map +1 -1
  67. package/dist/js/tabulator_esm.js +25926 -25790
  68. package/dist/js/tabulator_esm.js.map +1 -1
  69. package/dist/js/tabulator_esm.min.js +2 -2
  70. package/dist/js/tabulator_esm.min.js.map +1 -1
  71. package/package.json +65 -65
  72. package/src/js/builds/esm.js +14 -14
  73. package/src/js/builds/jquery_wrapper.js +55 -55
  74. package/src/js/core/ColumnManager.js +730 -730
  75. package/src/js/core/CoreFeature.js +138 -138
  76. package/src/js/core/FooterManager.js +101 -101
  77. package/src/js/core/Module.js +141 -141
  78. package/src/js/core/RowManager.js +1112 -1101
  79. package/src/js/core/Tabulator.js +895 -892
  80. package/src/js/core/TabulatorFull.js +10 -10
  81. package/src/js/core/cell/Cell.js +295 -295
  82. package/src/js/core/cell/CellComponent.js +76 -76
  83. package/src/js/core/column/Column.js +949 -949
  84. package/src/js/core/column/ColumnComponent.js +152 -152
  85. package/src/js/core/column/defaults/options.js +17 -17
  86. package/src/js/core/defaults/options.js +65 -65
  87. package/src/js/core/modules/core.js +2 -2
  88. package/src/js/core/modules/optional.js +34 -34
  89. package/src/js/core/rendering/Renderer.js +203 -203
  90. package/src/js/core/rendering/renderers/BasicHorizontal.js +19 -19
  91. package/src/js/core/rendering/renderers/BasicVertical.js +79 -78
  92. package/src/js/core/rendering/renderers/VirtualDomHorizontal.js +577 -577
  93. package/src/js/core/rendering/renderers/VirtualDomVertical.js +579 -579
  94. package/src/js/core/row/PseudoRow.js +44 -44
  95. package/src/js/core/row/Row.js +457 -457
  96. package/src/js/core/row/RowComponent.js +93 -93
  97. package/src/js/core/tools/Alert.js +61 -61
  98. package/src/js/core/tools/ComponentFunctionBinder.js +32 -32
  99. package/src/js/core/tools/DataLoader.js +119 -119
  100. package/src/js/core/tools/DeprecationAdvisor.js +46 -46
  101. package/src/js/core/tools/ExternalEventBus.js +104 -104
  102. package/src/js/core/tools/Helpers.js +46 -46
  103. package/src/js/core/tools/InteractionMonitor.js +321 -321
  104. package/src/js/core/tools/InternalEventBus.js +161 -161
  105. package/src/js/core/tools/ModuleBinder.js +104 -104
  106. package/src/js/core/tools/OptionsList.js +44 -40
  107. package/src/js/core/tools/Popup.js +304 -304
  108. package/src/js/core/tools/TableRegistry.js +61 -61
  109. package/src/js/modules/Accessor/Accessor.js +115 -115
  110. package/src/js/modules/Ajax/Ajax.js +143 -143
  111. package/src/js/modules/Ajax/defaults/config.js +2 -2
  112. package/src/js/modules/Ajax/defaults/contentTypeFormatters.js +44 -44
  113. package/src/js/modules/Ajax/defaults/loaderPromise.js +86 -86
  114. package/src/js/modules/Ajax/defaults/urlGenerator.js +43 -43
  115. package/src/js/modules/Clipboard/Clipboard.js +279 -279
  116. package/src/js/modules/Clipboard/defaults/pasteActions.js +10 -10
  117. package/src/js/modules/Clipboard/defaults/pasteParsers.js +74 -74
  118. package/src/js/modules/ColumnCalcs/CalcComponent.js +47 -47
  119. package/src/js/modules/ColumnCalcs/ColumnCalcs.js +581 -568
  120. package/src/js/modules/ColumnCalcs/defaults/calculations.js +85 -85
  121. package/src/js/modules/Comms/Comms.js +51 -51
  122. package/src/js/modules/DataTree/DataTree.js +603 -603
  123. package/src/js/modules/Download/Download.js +148 -148
  124. package/src/js/modules/Download/defaults/downloaders/csv.js +61 -61
  125. package/src/js/modules/Download/defaults/downloaders/html.js +4 -4
  126. package/src/js/modules/Download/defaults/downloaders/json.js +33 -33
  127. package/src/js/modules/Download/defaults/downloaders/jsonLines.js +31 -31
  128. package/src/js/modules/Download/defaults/downloaders/pdf.js +111 -111
  129. package/src/js/modules/Download/defaults/downloaders/xlsx.js +98 -98
  130. package/src/js/modules/Download/defaults/downloaders.js +14 -14
  131. package/src/js/modules/Edit/Edit.js +735 -736
  132. package/src/js/modules/Edit/List.js +1037 -1033
  133. package/src/js/modules/Edit/defaults/editors/autocomplete.js +11 -11
  134. package/src/js/modules/Edit/defaults/editors/date.js +138 -110
  135. package/src/js/modules/Edit/defaults/editors/datetime.js +125 -97
  136. package/src/js/modules/Edit/defaults/editors/input.js +76 -74
  137. package/src/js/modules/Edit/defaults/editors/list.js +6 -6
  138. package/src/js/modules/Edit/defaults/editors/number.js +109 -107
  139. package/src/js/modules/Edit/defaults/editors/progress.js +126 -126
  140. package/src/js/modules/Edit/defaults/editors/range.js +80 -78
  141. package/src/js/modules/Edit/defaults/editors/select.js +9 -9
  142. package/src/js/modules/Edit/defaults/editors/star.js +145 -145
  143. package/src/js/modules/Edit/defaults/editors/textarea.js +122 -120
  144. package/src/js/modules/Edit/defaults/editors/tickCross.js +94 -96
  145. package/src/js/modules/Edit/defaults/editors/time.js +126 -98
  146. package/src/js/modules/Edit/defaults/editors.js +28 -28
  147. package/src/js/modules/Edit/inputMask.js +73 -73
  148. package/src/js/modules/Export/Export.js +623 -623
  149. package/src/js/modules/Export/ExportColumn.js +10 -10
  150. package/src/js/modules/Export/ExportRow.js +9 -9
  151. package/src/js/modules/Filter/Filter.js +892 -892
  152. package/src/js/modules/Filter/defaults/filters.js +107 -107
  153. package/src/js/modules/Format/Format.js +212 -212
  154. package/src/js/modules/Format/defaults/formatters/buttonCross.js +2 -2
  155. package/src/js/modules/Format/defaults/formatters/buttonTick.js +2 -2
  156. package/src/js/modules/Format/defaults/formatters/color.js +3 -3
  157. package/src/js/modules/Format/defaults/formatters/datetime.js +36 -36
  158. package/src/js/modules/Format/defaults/formatters/datetimediff.js +40 -40
  159. package/src/js/modules/Format/defaults/formatters/handle.js +3 -3
  160. package/src/js/modules/Format/defaults/formatters/html.js +2 -2
  161. package/src/js/modules/Format/defaults/formatters/image.js +39 -39
  162. package/src/js/modules/Format/defaults/formatters/link.js +77 -77
  163. package/src/js/modules/Format/defaults/formatters/lookup.js +9 -9
  164. package/src/js/modules/Format/defaults/formatters/money.js +36 -36
  165. package/src/js/modules/Format/defaults/formatters/plaintext.js +2 -2
  166. package/src/js/modules/Format/defaults/formatters/progress.js +132 -132
  167. package/src/js/modules/Format/defaults/formatters/responsiveCollapse.js +43 -43
  168. package/src/js/modules/Format/defaults/formatters/rowSelection.js +59 -59
  169. package/src/js/modules/Format/defaults/formatters/rownum.js +9 -9
  170. package/src/js/modules/Format/defaults/formatters/star.js +37 -37
  171. package/src/js/modules/Format/defaults/formatters/textarea.js +3 -3
  172. package/src/js/modules/Format/defaults/formatters/tickCross.js +21 -21
  173. package/src/js/modules/Format/defaults/formatters/traffic.js +46 -46
  174. package/src/js/modules/Format/defaults/formatters.js +42 -42
  175. package/src/js/modules/FrozenColumns/FrozenColumns.js +299 -299
  176. package/src/js/modules/FrozenRows/FrozenRows.js +169 -159
  177. package/src/js/modules/GroupRows/Group.js +597 -598
  178. package/src/js/modules/GroupRows/GroupComponent.js +66 -66
  179. package/src/js/modules/GroupRows/GroupRows.js +639 -639
  180. package/src/js/modules/History/History.js +171 -171
  181. package/src/js/modules/History/defaults/redoers.js +24 -24
  182. package/src/js/modules/History/defaults/undoers.js +24 -24
  183. package/src/js/modules/HtmlTableImport/HtmlTableImport.js +181 -181
  184. package/src/js/modules/Import/Import.js +193 -193
  185. package/src/js/modules/Import/defaults/importers/array.js +4 -4
  186. package/src/js/modules/Import/defaults/importers/csv.js +62 -62
  187. package/src/js/modules/Import/defaults/importers/json.js +7 -7
  188. package/src/js/modules/Import/defaults/importers.js +8 -8
  189. package/src/js/modules/Interaction/Interaction.js +325 -325
  190. package/src/js/modules/Keybindings/Keybindings.js +172 -172
  191. package/src/js/modules/Keybindings/defaults/actions.js +118 -118
  192. package/src/js/modules/Keybindings/defaults/bindings.js +12 -12
  193. package/src/js/modules/Layout/Layout.js +49 -49
  194. package/src/js/modules/Layout/defaults/modes/fitColumns.js +171 -171
  195. package/src/js/modules/Layout/defaults/modes/fitData.js +9 -9
  196. package/src/js/modules/Layout/defaults/modes/fitDataGeneral.js +9 -9
  197. package/src/js/modules/Layout/defaults/modes/fitDataStretch.js +39 -39
  198. package/src/js/modules/Layout/defaults/modes.js +11 -11
  199. package/src/js/modules/Localize/Localize.js +185 -185
  200. package/src/js/modules/Localize/defaults/langs.js +36 -36
  201. package/src/js/modules/Menu/Menu.js +302 -302
  202. package/src/js/modules/MoveColumns/MoveColumns.js +299 -299
  203. package/src/js/modules/MoveRows/MoveRows.js +635 -635
  204. package/src/js/modules/Mutator/Mutator.js +161 -161
  205. package/src/js/modules/Page/Page.js +881 -881
  206. package/src/js/modules/Page/defaults/pageCounters/pages.js +32 -32
  207. package/src/js/modules/Page/defaults/pageCounters/rows.js +39 -39
  208. package/src/js/modules/Page/defaults/pageCounters.js +7 -7
  209. package/src/js/modules/Persistence/Persistence.js +458 -458
  210. package/src/js/modules/Persistence/defaults/readers.js +29 -29
  211. package/src/js/modules/Persistence/defaults/writers.js +12 -12
  212. package/src/js/modules/Popup/Popup.js +231 -231
  213. package/src/js/modules/Print/Print.js +137 -137
  214. package/src/js/modules/ReactiveData/ReactiveData.js +408 -408
  215. package/src/js/modules/ResizeColumns/ResizeColumns.js +309 -309
  216. package/src/js/modules/ResizeRows/ResizeRows.js +111 -111
  217. package/src/js/modules/ResizeTable/ResizeTable.js +159 -159
  218. package/src/js/modules/ResponsiveLayout/ResponsiveLayout.js +345 -345
  219. package/src/js/modules/SelectRow/SelectRow.js +446 -444
  220. package/src/js/modules/Sort/Sort.js +470 -470
  221. package/src/js/modules/Sort/defaults/sorters/alphanum.js +43 -43
  222. package/src/js/modules/Sort/defaults/sorters/array.js +53 -53
  223. package/src/js/modules/Sort/defaults/sorters/boolean.js +6 -6
  224. package/src/js/modules/Sort/defaults/sorters/date.js +9 -9
  225. package/src/js/modules/Sort/defaults/sorters/datetime.js +43 -43
  226. package/src/js/modules/Sort/defaults/sorters/exists.js +6 -6
  227. package/src/js/modules/Sort/defaults/sorters/number.js +39 -39
  228. package/src/js/modules/Sort/defaults/sorters/string.js +33 -33
  229. package/src/js/modules/Sort/defaults/sorters/time.js +9 -9
  230. package/src/js/modules/Sort/defaults/sorters.js +20 -20
  231. package/src/js/modules/Tooltip/Tooltip.js +130 -130
  232. package/src/js/modules/Validate/Validate.js +305 -305
  233. package/src/js/modules/Validate/defaults/validators.js +138 -138
  234. package/src/scss/tabulator.scss +1464 -1467
  235. package/src/scss/themes/bootstrap/functions4.scss +118 -118
  236. package/src/scss/themes/bootstrap/functions5.scss +302 -302
  237. package/src/scss/themes/bootstrap/tabulator_bootstrap3.scss +284 -284
  238. package/src/scss/themes/bootstrap/tabulator_bootstrap4.scss +544 -544
  239. package/src/scss/themes/bootstrap/tabulator_bootstrap5.scss +574 -574
  240. package/src/scss/themes/bootstrap/variables3.scss +870 -870
  241. package/src/scss/themes/bootstrap/variables4.scss +930 -930
  242. package/src/scss/themes/bootstrap/variables5.scss +1641 -1641
  243. package/src/scss/themes/bulma/tabulator_bulma.scss +252 -252
  244. package/src/scss/themes/bulma/variables.scss +197 -197
  245. package/src/scss/themes/materialize/tabulator_materialize.scss +265 -265
  246. package/src/scss/themes/materialize/variables.scss +70 -70
  247. package/src/scss/themes/semanticui/tabulator_semanticui.scss +561 -561
  248. package/src/scss/themes/semanticui/variables.scss +839 -839
  249. package/src/scss/themes/semanticui/variables_table.scss +247 -247
  250. package/src/scss/themes/tabulator_midnight.scss +158 -158
  251. package/src/scss/themes/tabulator_modern.scss +231 -231
  252. package/src/scss/themes/tabulator_simple.scss +102 -102
  253. package/src/scss/themes/tabulator_site.scss +189 -189
@@ -1,471 +1,471 @@
1
- import Module from '../../core/Module.js';
2
-
3
- import defaultSorters from './defaults/sorters.js';
4
-
5
- class Sort extends Module{
6
-
7
- constructor(table){
8
- super(table);
9
-
10
- this.sortList = []; //holder current sort
11
- this.changed = false; //has the sort changed since last render
12
-
13
- this.registerTableOption("sortMode", "local"); //local or remote sorting
14
-
15
- this.registerTableOption("initialSort", false); //initial sorting criteria
16
- this.registerTableOption("columnHeaderSortMulti", true); //multiple or single column sorting
17
- this.registerTableOption("sortOrderReverse", false); //reverse internal sort ordering
18
- this.registerTableOption("headerSortElement", "<div class='tabulator-arrow'></div>"); //header sort element
19
- this.registerTableOption("headerSortClickElement", "header"); //element which triggers sort when clicked
20
-
21
- this.registerColumnOption("sorter");
22
- this.registerColumnOption("sorterParams");
23
-
24
- this.registerColumnOption("headerSort", true);
25
- this.registerColumnOption("headerSortStartingDir");
26
- this.registerColumnOption("headerSortTristate");
27
-
28
- }
29
-
30
- initialize(){
31
- this.subscribe("column-layout", this.initializeColumn.bind(this));
32
- this.subscribe("table-built", this.tableBuilt.bind(this));
33
- this.registerDataHandler(this.sort.bind(this), 20);
34
-
35
- this.registerTableFunction("setSort", this.userSetSort.bind(this));
36
- this.registerTableFunction("getSorters", this.getSort.bind(this));
37
- this.registerTableFunction("clearSort", this.clearSort.bind(this));
38
-
39
- if(this.table.options.sortMode === "remote"){
40
- this.subscribe("data-params", this.remoteSortParams.bind(this));
41
- }
42
- }
43
-
44
- tableBuilt(){
45
- if(this.table.options.initialSort){
46
- this.setSort(this.table.options.initialSort);
47
- }
48
- }
49
-
50
- remoteSortParams(data, config, silent, params){
51
- var sorters = this.getSort();
52
-
53
- sorters.forEach((item) => {
54
- delete item.column;
55
- });
56
-
57
- params.sort = sorters;
58
-
59
- return params;
60
- }
61
-
62
-
63
- ///////////////////////////////////
64
- ///////// Table Functions /////////
65
- ///////////////////////////////////
66
-
67
- userSetSort(sortList, dir){
68
- this.setSort(sortList, dir);
69
- // this.table.rowManager.sorterRefresh();
70
- this.refreshSort();
71
- }
72
-
73
- clearSort(){
74
- this.clear();
75
- // this.table.rowManager.sorterRefresh();
76
- this.refreshSort();
77
- }
78
-
79
-
80
- ///////////////////////////////////
81
- ///////// Internal Logic //////////
82
- ///////////////////////////////////
83
-
84
- //initialize column header for sorting
85
- initializeColumn(column){
86
- var sorter = false,
87
- colEl,
88
- arrowEl;
89
-
90
- switch(typeof column.definition.sorter){
91
- case "string":
92
- if(Sort.sorters[column.definition.sorter]){
93
- sorter = Sort.sorters[column.definition.sorter];
94
- }else{
95
- console.warn("Sort Error - No such sorter found: ", column.definition.sorter);
96
- }
97
- break;
98
-
99
- case "function":
100
- sorter = column.definition.sorter;
101
- break;
102
- }
103
-
104
- column.modules.sort = {
105
- sorter:sorter, dir:"none",
106
- params:column.definition.sorterParams || {},
107
- startingDir:column.definition.headerSortStartingDir || "asc",
108
- tristate: column.definition.headerSortTristate,
109
- };
110
-
111
- if(column.definition.headerSort !== false){
112
-
113
- colEl = column.getElement();
114
-
115
- colEl.classList.add("tabulator-sortable");
116
-
117
- arrowEl = document.createElement("div");
118
- arrowEl.classList.add("tabulator-col-sorter");
119
-
120
- switch(this.table.options.headerSortClickElement){
121
- case "icon":
122
- arrowEl.classList.add("tabulator-col-sorter-element");
123
- break;
124
- case "header":
125
- colEl.classList.add("tabulator-col-sorter-element");
126
- break;
127
- default:
128
- colEl.classList.add("tabulator-col-sorter-element");
129
- break;
130
- }
131
-
132
- switch(this.table.options.headerSortElement){
133
- case "function":
134
- //do nothing
135
- break;
136
-
137
- case "object":
138
- arrowEl.appendChild(this.table.options.headerSortElement);
139
- break;
140
-
141
- default:
142
- arrowEl.innerHTML = this.table.options.headerSortElement;
143
- }
144
-
145
- //create sorter arrow
146
- column.titleHolderElement.appendChild(arrowEl);
147
-
148
- column.modules.sort.element = arrowEl;
149
-
150
- this.setColumnHeaderSortIcon(column, "none");
151
-
152
- //sort on click
153
- (this.table.options.headerSortClickElement === "icon" ? arrowEl : colEl).addEventListener("click", (e) => {
154
- var dir = "",
155
- sorters=[],
156
- match = false;
157
-
158
- if(column.modules.sort){
159
- if(column.modules.sort.tristate){
160
- if(column.modules.sort.dir == "none"){
161
- dir = column.modules.sort.startingDir;
162
- }else{
163
- if(column.modules.sort.dir == column.modules.sort.startingDir){
164
- dir = column.modules.sort.dir == "asc" ? "desc" : "asc";
165
- }else{
166
- dir = "none";
167
- }
168
- }
169
- }else{
170
- switch(column.modules.sort.dir){
171
- case "asc":
172
- dir = "desc";
173
- break;
174
-
175
- case "desc":
176
- dir = "asc";
177
- break;
178
-
179
- default:
180
- dir = column.modules.sort.startingDir;
181
- }
182
- }
183
-
184
- if (this.table.options.columnHeaderSortMulti && (e.shiftKey || e.ctrlKey)) {
185
- sorters = this.getSort();
186
-
187
- match = sorters.findIndex((sorter) => {
188
- return sorter.field === column.getField();
189
- });
190
-
191
- if(match > -1){
192
- sorters[match].dir = dir;
193
-
194
- match = sorters.splice(match, 1)[0];
195
- if(dir != "none"){
196
- sorters.push(match);
197
- }
198
- }else{
199
- if(dir != "none"){
200
- sorters.push({column:column, dir:dir});
201
- }
202
- }
203
-
204
- //add to existing sort
205
- this.setSort(sorters);
206
- }else{
207
- if(dir == "none"){
208
- this.clear();
209
- }else{
210
- //sort by column only
211
- this.setSort(column, dir);
212
- }
213
-
214
- }
215
-
216
- // this.table.rowManager.sorterRefresh(!this.sortList.length);
217
- this.refreshSort();
218
- }
219
- });
220
- }
221
- }
222
-
223
- refreshSort(){
224
- if(this.table.options.sortMode === "remote"){
225
- this.reloadData(null, false, false);
226
- }else{
227
- this.refreshData(true);
228
- }
229
-
230
- //TODO - Persist left position of row manager
231
- // left = this.scrollLeft;
232
- // this.scrollHorizontal(left);
233
- }
234
-
235
- //check if the sorters have changed since last use
236
- hasChanged(){
237
- var changed = this.changed;
238
- this.changed = false;
239
- return changed;
240
- }
241
-
242
- //return current sorters
243
- getSort(){
244
- var self = this,
245
- sorters = [];
246
-
247
- self.sortList.forEach(function(item){
248
- if(item.column){
249
- sorters.push({column:item.column.getComponent(), field:item.column.getField(), dir:item.dir});
250
- }
251
- });
252
-
253
- return sorters;
254
- }
255
-
256
- //change sort list and trigger sort
257
- setSort(sortList, dir){
258
- var self = this,
259
- newSortList = [];
260
-
261
- if(!Array.isArray(sortList)){
262
- sortList = [{column: sortList, dir:dir}];
263
- }
264
-
265
- sortList.forEach(function(item){
266
- var column;
267
-
268
- column = self.table.columnManager.findColumn(item.column);
269
-
270
- if(column){
271
- item.column = column;
272
- newSortList.push(item);
273
- self.changed = true;
274
- }else{
275
- console.warn("Sort Warning - Sort field does not exist and is being ignored: ", item.column);
276
- }
277
-
278
- });
279
-
280
- self.sortList = newSortList;
281
-
282
- this.dispatch("sort-changed");
283
- }
284
-
285
- //clear sorters
286
- clear(){
287
- this.setSort([]);
288
- }
289
-
290
- //find appropriate sorter for column
291
- findSorter(column){
292
- var row = this.table.rowManager.activeRows[0],
293
- sorter = "string",
294
- field, value;
295
-
296
- if(row){
297
- row = row.getData();
298
- field = column.getField();
299
-
300
- if(field){
301
-
302
- value = column.getFieldValue(row);
303
-
304
- switch(typeof value){
305
- case "undefined":
306
- sorter = "string";
307
- break;
308
-
309
- case "boolean":
310
- sorter = "boolean";
311
- break;
312
-
313
- default:
314
- if(!isNaN(value) && value !== ""){
315
- sorter = "number";
316
- }else{
317
- if(value.match(/((^[0-9]+[a-z]+)|(^[a-z]+[0-9]+))+$/i)){
318
- sorter = "alphanum";
319
- }
320
- }
321
- break;
322
- }
323
- }
324
- }
325
-
326
- return Sort.sorters[sorter];
327
- }
328
-
329
- //work through sort list sorting data
330
- sort(data){
331
- var self = this,
332
- sortList = this.table.options.sortOrderReverse ? self.sortList.slice().reverse() : self.sortList,
333
- sortListActual = [],
334
- rowComponents = [];
335
-
336
- if(this.subscribedExternal("dataSorting")){
337
- this.dispatchExternal("dataSorting", self.getSort());
338
- }
339
-
340
- self.clearColumnHeaders();
341
-
342
- if(this.table.options.sortMode !== "remote"){
343
-
344
- //build list of valid sorters and trigger column specific callbacks before sort begins
345
- sortList.forEach(function(item, i){
346
- var sortObj;
347
-
348
- if(item.column){
349
- sortObj = item.column.modules.sort;
350
-
351
- if(sortObj){
352
-
353
- //if no sorter has been defined, take a guess
354
- if(!sortObj.sorter){
355
- sortObj.sorter = self.findSorter(item.column);
356
- }
357
-
358
- item.params = typeof sortObj.params === "function" ? sortObj.params(item.column.getComponent(), item.dir) : sortObj.params;
359
-
360
- sortListActual.push(item);
361
- }
362
-
363
- self.setColumnHeader(item.column, item.dir);
364
- }
365
- });
366
-
367
- //sort data
368
- if (sortListActual.length) {
369
- self._sortItems(data, sortListActual);
370
- }
371
-
372
- }else{
373
- sortList.forEach(function(item, i){
374
- self.setColumnHeader(item.column, item.dir);
375
- });
376
- }
377
-
378
- if(this.subscribedExternal("dataSorted")){
379
- data.forEach((row) => {
380
- rowComponents.push(row.getComponent());
381
- });
382
-
383
- this.dispatchExternal("dataSorted", self.getSort(), rowComponents);
384
- }
385
-
386
- return data;
387
- }
388
-
389
- //clear sort arrows on columns
390
- clearColumnHeaders(){
391
- this.table.columnManager.getRealColumns().forEach((column) => {
392
- if(column.modules.sort){
393
- column.modules.sort.dir = "none";
394
- column.getElement().setAttribute("aria-sort", "none");
395
- this.setColumnHeaderSortIcon(column, "none");
396
- }
397
- });
398
- }
399
-
400
- //set the column header sort direction
401
- setColumnHeader(column, dir){
402
- column.modules.sort.dir = dir;
403
- column.getElement().setAttribute("aria-sort", dir === "asc" ? "ascending" : "descending");
404
- this.setColumnHeaderSortIcon(column, dir);
405
- }
406
-
407
- setColumnHeaderSortIcon(column, dir){
408
- var sortEl = column.modules.sort.element,
409
- arrowEl;
410
-
411
- if(column.definition.headerSort && typeof this.table.options.headerSortElement === "function"){
412
- while(sortEl.firstChild) sortEl.removeChild(sortEl.firstChild);
413
-
414
- arrowEl = this.table.options.headerSortElement.call(this.table, column.getComponent(), dir);
415
-
416
- if(typeof arrowEl === "object"){
417
- sortEl.appendChild(arrowEl);
418
- }else{
419
- sortEl.innerHTML = arrowEl;
420
- }
421
- }
422
- }
423
-
424
- //sort each item in sort list
425
- _sortItems(data, sortList){
426
- var sorterCount = sortList.length - 1;
427
-
428
- data.sort((a, b) => {
429
- var result;
430
-
431
- for(var i = sorterCount; i>= 0; i--){
432
- let sortItem = sortList[i];
433
-
434
- result = this._sortRow(a, b, sortItem.column, sortItem.dir, sortItem.params);
435
-
436
- if(result !== 0){
437
- break;
438
- }
439
- }
440
-
441
- return result;
442
- });
443
- }
444
-
445
- //process individual rows for a sort function on active data
446
- _sortRow(a, b, column, dir, params){
447
- var el1Comp, el2Comp;
448
-
449
- //switch elements depending on search direction
450
- var el1 = dir == "asc" ? a : b;
451
- var el2 = dir == "asc" ? b : a;
452
-
453
- a = column.getFieldValue(el1.getData());
454
- b = column.getFieldValue(el2.getData());
455
-
456
- a = typeof a !== "undefined" ? a : "";
457
- b = typeof b !== "undefined" ? b : "";
458
-
459
- el1Comp = el1.getComponent();
460
- el2Comp = el2.getComponent();
461
-
462
- return column.modules.sort.sorter.call(this, a, b, el1Comp, el2Comp, column.getComponent(), dir, params);
463
- }
464
- }
465
-
466
- Sort.moduleName = "sort";
467
-
468
- //load defaults
469
- Sort.sorters = defaultSorters;
470
-
1
+ import Module from '../../core/Module.js';
2
+
3
+ import defaultSorters from './defaults/sorters.js';
4
+
5
+ class Sort extends Module{
6
+
7
+ constructor(table){
8
+ super(table);
9
+
10
+ this.sortList = []; //holder current sort
11
+ this.changed = false; //has the sort changed since last render
12
+
13
+ this.registerTableOption("sortMode", "local"); //local or remote sorting
14
+
15
+ this.registerTableOption("initialSort", false); //initial sorting criteria
16
+ this.registerTableOption("columnHeaderSortMulti", true); //multiple or single column sorting
17
+ this.registerTableOption("sortOrderReverse", false); //reverse internal sort ordering
18
+ this.registerTableOption("headerSortElement", "<div class='tabulator-arrow'></div>"); //header sort element
19
+ this.registerTableOption("headerSortClickElement", "header"); //element which triggers sort when clicked
20
+
21
+ this.registerColumnOption("sorter");
22
+ this.registerColumnOption("sorterParams");
23
+
24
+ this.registerColumnOption("headerSort", true);
25
+ this.registerColumnOption("headerSortStartingDir");
26
+ this.registerColumnOption("headerSortTristate");
27
+
28
+ }
29
+
30
+ initialize(){
31
+ this.subscribe("column-layout", this.initializeColumn.bind(this));
32
+ this.subscribe("table-built", this.tableBuilt.bind(this));
33
+ this.registerDataHandler(this.sort.bind(this), 20);
34
+
35
+ this.registerTableFunction("setSort", this.userSetSort.bind(this));
36
+ this.registerTableFunction("getSorters", this.getSort.bind(this));
37
+ this.registerTableFunction("clearSort", this.clearSort.bind(this));
38
+
39
+ if(this.table.options.sortMode === "remote"){
40
+ this.subscribe("data-params", this.remoteSortParams.bind(this));
41
+ }
42
+ }
43
+
44
+ tableBuilt(){
45
+ if(this.table.options.initialSort){
46
+ this.setSort(this.table.options.initialSort);
47
+ }
48
+ }
49
+
50
+ remoteSortParams(data, config, silent, params){
51
+ var sorters = this.getSort();
52
+
53
+ sorters.forEach((item) => {
54
+ delete item.column;
55
+ });
56
+
57
+ params.sort = sorters;
58
+
59
+ return params;
60
+ }
61
+
62
+
63
+ ///////////////////////////////////
64
+ ///////// Table Functions /////////
65
+ ///////////////////////////////////
66
+
67
+ userSetSort(sortList, dir){
68
+ this.setSort(sortList, dir);
69
+ // this.table.rowManager.sorterRefresh();
70
+ this.refreshSort();
71
+ }
72
+
73
+ clearSort(){
74
+ this.clear();
75
+ // this.table.rowManager.sorterRefresh();
76
+ this.refreshSort();
77
+ }
78
+
79
+
80
+ ///////////////////////////////////
81
+ ///////// Internal Logic //////////
82
+ ///////////////////////////////////
83
+
84
+ //initialize column header for sorting
85
+ initializeColumn(column){
86
+ var sorter = false,
87
+ colEl,
88
+ arrowEl;
89
+
90
+ switch(typeof column.definition.sorter){
91
+ case "string":
92
+ if(Sort.sorters[column.definition.sorter]){
93
+ sorter = Sort.sorters[column.definition.sorter];
94
+ }else{
95
+ console.warn("Sort Error - No such sorter found: ", column.definition.sorter);
96
+ }
97
+ break;
98
+
99
+ case "function":
100
+ sorter = column.definition.sorter;
101
+ break;
102
+ }
103
+
104
+ column.modules.sort = {
105
+ sorter:sorter, dir:"none",
106
+ params:column.definition.sorterParams || {},
107
+ startingDir:column.definition.headerSortStartingDir || "asc",
108
+ tristate: column.definition.headerSortTristate,
109
+ };
110
+
111
+ if(column.definition.headerSort !== false){
112
+
113
+ colEl = column.getElement();
114
+
115
+ colEl.classList.add("tabulator-sortable");
116
+
117
+ arrowEl = document.createElement("div");
118
+ arrowEl.classList.add("tabulator-col-sorter");
119
+
120
+ switch(this.table.options.headerSortClickElement){
121
+ case "icon":
122
+ arrowEl.classList.add("tabulator-col-sorter-element");
123
+ break;
124
+ case "header":
125
+ colEl.classList.add("tabulator-col-sorter-element");
126
+ break;
127
+ default:
128
+ colEl.classList.add("tabulator-col-sorter-element");
129
+ break;
130
+ }
131
+
132
+ switch(this.table.options.headerSortElement){
133
+ case "function":
134
+ //do nothing
135
+ break;
136
+
137
+ case "object":
138
+ arrowEl.appendChild(this.table.options.headerSortElement);
139
+ break;
140
+
141
+ default:
142
+ arrowEl.innerHTML = this.table.options.headerSortElement;
143
+ }
144
+
145
+ //create sorter arrow
146
+ column.titleHolderElement.appendChild(arrowEl);
147
+
148
+ column.modules.sort.element = arrowEl;
149
+
150
+ this.setColumnHeaderSortIcon(column, "none");
151
+
152
+ //sort on click
153
+ (this.table.options.headerSortClickElement === "icon" ? arrowEl : colEl).addEventListener("click", (e) => {
154
+ var dir = "",
155
+ sorters=[],
156
+ match = false;
157
+
158
+ if(column.modules.sort){
159
+ if(column.modules.sort.tristate){
160
+ if(column.modules.sort.dir == "none"){
161
+ dir = column.modules.sort.startingDir;
162
+ }else{
163
+ if(column.modules.sort.dir == column.modules.sort.startingDir){
164
+ dir = column.modules.sort.dir == "asc" ? "desc" : "asc";
165
+ }else{
166
+ dir = "none";
167
+ }
168
+ }
169
+ }else{
170
+ switch(column.modules.sort.dir){
171
+ case "asc":
172
+ dir = "desc";
173
+ break;
174
+
175
+ case "desc":
176
+ dir = "asc";
177
+ break;
178
+
179
+ default:
180
+ dir = column.modules.sort.startingDir;
181
+ }
182
+ }
183
+
184
+ if (this.table.options.columnHeaderSortMulti && (e.shiftKey || e.ctrlKey)) {
185
+ sorters = this.getSort();
186
+
187
+ match = sorters.findIndex((sorter) => {
188
+ return sorter.field === column.getField();
189
+ });
190
+
191
+ if(match > -1){
192
+ sorters[match].dir = dir;
193
+
194
+ match = sorters.splice(match, 1)[0];
195
+ if(dir != "none"){
196
+ sorters.push(match);
197
+ }
198
+ }else{
199
+ if(dir != "none"){
200
+ sorters.push({column:column, dir:dir});
201
+ }
202
+ }
203
+
204
+ //add to existing sort
205
+ this.setSort(sorters);
206
+ }else{
207
+ if(dir == "none"){
208
+ this.clear();
209
+ }else{
210
+ //sort by column only
211
+ this.setSort(column, dir);
212
+ }
213
+
214
+ }
215
+
216
+ // this.table.rowManager.sorterRefresh(!this.sortList.length);
217
+ this.refreshSort();
218
+ }
219
+ });
220
+ }
221
+ }
222
+
223
+ refreshSort(){
224
+ if(this.table.options.sortMode === "remote"){
225
+ this.reloadData(null, false, false);
226
+ }else{
227
+ this.refreshData(true);
228
+ }
229
+
230
+ //TODO - Persist left position of row manager
231
+ // left = this.scrollLeft;
232
+ // this.scrollHorizontal(left);
233
+ }
234
+
235
+ //check if the sorters have changed since last use
236
+ hasChanged(){
237
+ var changed = this.changed;
238
+ this.changed = false;
239
+ return changed;
240
+ }
241
+
242
+ //return current sorters
243
+ getSort(){
244
+ var self = this,
245
+ sorters = [];
246
+
247
+ self.sortList.forEach(function(item){
248
+ if(item.column){
249
+ sorters.push({column:item.column.getComponent(), field:item.column.getField(), dir:item.dir});
250
+ }
251
+ });
252
+
253
+ return sorters;
254
+ }
255
+
256
+ //change sort list and trigger sort
257
+ setSort(sortList, dir){
258
+ var self = this,
259
+ newSortList = [];
260
+
261
+ if(!Array.isArray(sortList)){
262
+ sortList = [{column: sortList, dir:dir}];
263
+ }
264
+
265
+ sortList.forEach(function(item){
266
+ var column;
267
+
268
+ column = self.table.columnManager.findColumn(item.column);
269
+
270
+ if(column){
271
+ item.column = column;
272
+ newSortList.push(item);
273
+ self.changed = true;
274
+ }else{
275
+ console.warn("Sort Warning - Sort field does not exist and is being ignored: ", item.column);
276
+ }
277
+
278
+ });
279
+
280
+ self.sortList = newSortList;
281
+
282
+ this.dispatch("sort-changed");
283
+ }
284
+
285
+ //clear sorters
286
+ clear(){
287
+ this.setSort([]);
288
+ }
289
+
290
+ //find appropriate sorter for column
291
+ findSorter(column){
292
+ var row = this.table.rowManager.activeRows[0],
293
+ sorter = "string",
294
+ field, value;
295
+
296
+ if(row){
297
+ row = row.getData();
298
+ field = column.getField();
299
+
300
+ if(field){
301
+
302
+ value = column.getFieldValue(row);
303
+
304
+ switch(typeof value){
305
+ case "undefined":
306
+ sorter = "string";
307
+ break;
308
+
309
+ case "boolean":
310
+ sorter = "boolean";
311
+ break;
312
+
313
+ default:
314
+ if(!isNaN(value) && value !== ""){
315
+ sorter = "number";
316
+ }else{
317
+ if(value.match(/((^[0-9]+[a-z]+)|(^[a-z]+[0-9]+))+$/i)){
318
+ sorter = "alphanum";
319
+ }
320
+ }
321
+ break;
322
+ }
323
+ }
324
+ }
325
+
326
+ return Sort.sorters[sorter];
327
+ }
328
+
329
+ //work through sort list sorting data
330
+ sort(data){
331
+ var self = this,
332
+ sortList = this.table.options.sortOrderReverse ? self.sortList.slice().reverse() : self.sortList,
333
+ sortListActual = [],
334
+ rowComponents = [];
335
+
336
+ if(this.subscribedExternal("dataSorting")){
337
+ this.dispatchExternal("dataSorting", self.getSort());
338
+ }
339
+
340
+ self.clearColumnHeaders();
341
+
342
+ if(this.table.options.sortMode !== "remote"){
343
+
344
+ //build list of valid sorters and trigger column specific callbacks before sort begins
345
+ sortList.forEach(function(item, i){
346
+ var sortObj;
347
+
348
+ if(item.column){
349
+ sortObj = item.column.modules.sort;
350
+
351
+ if(sortObj){
352
+
353
+ //if no sorter has been defined, take a guess
354
+ if(!sortObj.sorter){
355
+ sortObj.sorter = self.findSorter(item.column);
356
+ }
357
+
358
+ item.params = typeof sortObj.params === "function" ? sortObj.params(item.column.getComponent(), item.dir) : sortObj.params;
359
+
360
+ sortListActual.push(item);
361
+ }
362
+
363
+ self.setColumnHeader(item.column, item.dir);
364
+ }
365
+ });
366
+
367
+ //sort data
368
+ if (sortListActual.length) {
369
+ self._sortItems(data, sortListActual);
370
+ }
371
+
372
+ }else{
373
+ sortList.forEach(function(item, i){
374
+ self.setColumnHeader(item.column, item.dir);
375
+ });
376
+ }
377
+
378
+ if(this.subscribedExternal("dataSorted")){
379
+ data.forEach((row) => {
380
+ rowComponents.push(row.getComponent());
381
+ });
382
+
383
+ this.dispatchExternal("dataSorted", self.getSort(), rowComponents);
384
+ }
385
+
386
+ return data;
387
+ }
388
+
389
+ //clear sort arrows on columns
390
+ clearColumnHeaders(){
391
+ this.table.columnManager.getRealColumns().forEach((column) => {
392
+ if(column.modules.sort){
393
+ column.modules.sort.dir = "none";
394
+ column.getElement().setAttribute("aria-sort", "none");
395
+ this.setColumnHeaderSortIcon(column, "none");
396
+ }
397
+ });
398
+ }
399
+
400
+ //set the column header sort direction
401
+ setColumnHeader(column, dir){
402
+ column.modules.sort.dir = dir;
403
+ column.getElement().setAttribute("aria-sort", dir === "asc" ? "ascending" : "descending");
404
+ this.setColumnHeaderSortIcon(column, dir);
405
+ }
406
+
407
+ setColumnHeaderSortIcon(column, dir){
408
+ var sortEl = column.modules.sort.element,
409
+ arrowEl;
410
+
411
+ if(column.definition.headerSort && typeof this.table.options.headerSortElement === "function"){
412
+ while(sortEl.firstChild) sortEl.removeChild(sortEl.firstChild);
413
+
414
+ arrowEl = this.table.options.headerSortElement.call(this.table, column.getComponent(), dir);
415
+
416
+ if(typeof arrowEl === "object"){
417
+ sortEl.appendChild(arrowEl);
418
+ }else{
419
+ sortEl.innerHTML = arrowEl;
420
+ }
421
+ }
422
+ }
423
+
424
+ //sort each item in sort list
425
+ _sortItems(data, sortList){
426
+ var sorterCount = sortList.length - 1;
427
+
428
+ data.sort((a, b) => {
429
+ var result;
430
+
431
+ for(var i = sorterCount; i>= 0; i--){
432
+ let sortItem = sortList[i];
433
+
434
+ result = this._sortRow(a, b, sortItem.column, sortItem.dir, sortItem.params);
435
+
436
+ if(result !== 0){
437
+ break;
438
+ }
439
+ }
440
+
441
+ return result;
442
+ });
443
+ }
444
+
445
+ //process individual rows for a sort function on active data
446
+ _sortRow(a, b, column, dir, params){
447
+ var el1Comp, el2Comp;
448
+
449
+ //switch elements depending on search direction
450
+ var el1 = dir == "asc" ? a : b;
451
+ var el2 = dir == "asc" ? b : a;
452
+
453
+ a = column.getFieldValue(el1.getData());
454
+ b = column.getFieldValue(el2.getData());
455
+
456
+ a = typeof a !== "undefined" ? a : "";
457
+ b = typeof b !== "undefined" ? b : "";
458
+
459
+ el1Comp = el1.getComponent();
460
+ el2Comp = el2.getComponent();
461
+
462
+ return column.modules.sort.sorter.call(this, a, b, el1Comp, el2Comp, column.getComponent(), dir, params);
463
+ }
464
+ }
465
+
466
+ Sort.moduleName = "sort";
467
+
468
+ //load defaults
469
+ Sort.sorters = defaultSorters;
470
+
471
471
  export default Sort;