-
Notifications
You must be signed in to change notification settings - Fork 0
/
RockGrid.js
288 lines (244 loc) · 8.11 KB
/
RockGrid.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
/**
* RockGrid class
*/
function RockGrid() {
// object holding all individual gridItems
this.gridItems = {};
// object holding plugins
this.plugins = {};
// object holding renderers
this.renderers = {};
// object holding formatters
// https://www.ag-grid.com/javascript-grid-value-getters/#value-formatter
this.formatters = {};
// object holding colDefs
this.colDefs = {};
// manually defined global options
// these options are set for all grids
this.gridOptions = {
enableFilter: true,
enableSorting: true,
enableColResize: true,
floatingFilter: true,
}
// object holding all filters
this.filters = {}
// are we in the backend?
this.backend = false;
if(typeof ProcessWire !== 'undefined') this.backend = true;
};
/* ######################### helper methods ######################### */
/**
* debounce function execution
* useful for handling filter inputs
* see https://davidwalsh.name/javascript-debounce-function
*/
RockGrid.prototype.debounce = function(func, wait, immediate) {
var wait = wait || 500; // 500ms default
var timeout;
return function() {
var context = this, args = arguments;
var later = function() {
timeout = null;
if (!immediate) func.apply(context, args);
};
var callNow = immediate && !timeout;
clearTimeout(timeout);
timeout = setTimeout(later, wait);
if (callNow) func.apply(context, args);
};
};
/**
* get a new empty column object
*/
RockGrid.prototype.getDefaultColumn = function(options) {
options = options || {};
var def = {
headerName: options.headerName ? RockGrid.hoverSpan(options.headerName) : '',
field: options.field || null,
minWidth: 100,
// this keeps the filter when data is refreshed by ajax
filterParams: {newRowsAction: 'keep'},
// don't show filter icon on floating filters by default
// see https://www.ag-grid.com/javascript-grid-filtering/#floating-filters
floatingFilterComponentParams: {suppressFilterButton:true},
// assign the custom smart filter by default
filter: RockGrid.filters.smart,
floatingFilterComponent: RockGrid.filters.smartFloating,
};
// add all settings
for(var prop in options) {
if(prop == 'headerName') continue;
if(prop == 'field') continue;
def[prop] = options[prop];
}
return def;
}
/**
* add a new grid to the object
*/
RockGrid.prototype.getGrid = function(grid) {
if(typeof grid == typeof undefined) {
console.warn('grid must be defined');
return;
}
// check if grid is a params object
try {
grid = grid.node.gridOptionsWrapper.environment.eGridDiv.id;
}
catch(err) { // nothing
}
// if a dom element was passed we look for the griditem and take the id as grid
if(typeof grid !== 'string') {
// if the grid parameter is the wrapper element we return the grid instantly
if(grid.classList.contains('RockGridItem')) {
grid = grid.id.replace('RockGridItem_','');
}
else if(grid.classList.contains('RockGridWrapper')) {
grid = grid.querySelector('.RockGridItem');
grid = grid.id.replace('RockGridItem_','');
}
else {
var closest = function(el, selector) {
var matchesFn;
// find vendor prefix
['matches','webkitMatchesSelector','mozMatchesSelector','msMatchesSelector','oMatchesSelector'].some(function(fn) {
if (typeof document.body[fn] == 'function') {
matchesFn = fn;
return true;
}
return false;
})
var parent;
// traverse parents
while (el) {
parent = el.parentElement;
if (parent && parent[matchesFn](selector)) {
return parent;
}
el = parent;
}
return null;
}
grid = closest(grid, '.RockGridWrapper').querySelector('.RockGridItem');
grid = grid.id.replace('RockGridItem_','');
}
}
grid = grid.replace('RockGridItem_','');
return RockGrid.gridItems[grid];
}
/**
* initialise the griditem
*/
RockGrid.prototype.init = function(settings) {
var grid = settings.grid;
var dataColumns = settings.dataColumns;
var data = settings.data;
var js = settings.js;
if(!dataColumns.length) {
// data columns where not set by php
// we set the data columns from the data source
var object = data[0];
for (var property in object) {
if (object.hasOwnProperty(property)) {
dataColumns.push(property);
}
}
}
// create the gridItem
this.gridItems[grid] = new RockGridItem({}, dataColumns);
this.gridItems[grid].id = grid;
this.gridItems[grid].data = data;
// get the grid's dom element
var el = document.querySelector('#RockGridItem_' + grid);
// event listener to get data either from AJAX or from the config object
el.addEventListener('RockGridItemAfterInit', function(event) {
var grid = RockGrid.getGrid(event.target);
var api = grid.gridOptions.api;
if(grid.data == 'ajax') {
grid.getAjaxData();
}
else {
// set data from the grid's data property
// if the data was set via the gridOptions take this data
if(grid.data && grid.gridOptions.rowData) {
console.error('Define either grid.data OR gridOptions.rowData, not both!');
}
api.setRowData(grid.gridOptions.rowData || grid.data);
}
});
// populate custom javascript variables (eg for translations)
this.gridItems[grid].js = js;
// setup pagination page size
var opt = this.gridItems[grid].gridOptions;
opt.pagination = true;
if(js.settings.height > 0) {
opt.paginationPageSize = null;
opt.paginationAutoPageSize = true;
}
else {
opt.domLayout = 'autoHeight';
opt.paginationPageSize = js.settings.initPageSize;
}
// set language translation object
opt.localeText = RockGrid.localeText;
// create grid and fire events
el.dispatchEvent(new Event('RockGridItemBeforeInit', {bubbles:true}));
new agGrid.Grid(el, this.gridItems[grid].gridOptions);
el.dispatchEvent(new Event('RockGridItemLoadPlugins', {bubbles:true}));
el.dispatchEvent(new Event('RockGridItemAfterInit', {bubbles:true}));
// remove .init dom element
var initDiv = document.querySelector('#RockGridWrapper_' + grid + ' .init');
if(initDiv) initDiv.parentNode.removeChild(initDiv);
}
/* ######################### helper functions ######################### */
/**
* replace tags by value of current row
*/
RockGrid.prototype.replaceTags = function(str, params) {
var result = str.match(/{(.*?)}/g);
if(!result) return str;
// replace tags
var notfound = false;
result.map(function(val) {
var field = val.replace(/{|}/g,'');
str = str.replace(val, params.data[field]);
if(params.data[field] == null) notfound = true;
});
// don't show icon if a tag's value was null
if(notfound) return false;
return str;
}
/**
* wrap a span with hover info around the current string
*/
RockGrid.prototype.hoverSpan = function(str, hovertext, icon) {
if(!hovertext) {
hovertext = str;
icon = false;
}
if(icon === false) icon = '';
else {
if(typeof icon === 'string') icon = '<i class="fa fa-' + icon + '"></i>';
else icon = '<i class="fa fa-comment-o"></i>';
}
return '<span title="' + hovertext + '">' + str + ' ' + icon + '</span>';
}
/**
* round a number to given number of digits
*/
RockGrid.prototype.toFixed = function(number, digits) {
digits = digits || 2;
return number.toFixed(digits)*1;
}
/**
* strip html tags
*/
RockGrid.prototype.stripTags = function(str) {
var tmp = document.createElement("DIV");
tmp.innerHTML = str;
return tmp.textContent || tmp.innerText || "";
}
// assign global rockgrid variable
var RockGrid = new RockGrid();
document.dispatchEvent(new Event('RockGridReady'));