-
-
Notifications
You must be signed in to change notification settings - Fork 117
/
grid-clientside.component.ts
292 lines (268 loc) · 12 KB
/
grid-clientside.component.ts
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
import { Component, OnInit } from '@angular/core';
import { HttpClient } from '@angular/common/http';
import { ExcelExportService } from '@slickgrid-universal/excel-export';
import { TranslateService } from '@ngx-translate/core';
import {
AngularGridInstance,
Column,
FieldType,
Filters,
Formatters,
GridOption,
GridStateChange,
Metrics,
type MultipleSelectOption,
OperatorType,
type VanillaCalendarOption,
} from './../modules/angular-slickgrid';
import { CustomInputFilter } from './custom-inputFilter';
function randomBetween(min: number, max: number) {
return Math.floor(Math.random() * (max - min + 1) + min);
}
const NB_ITEMS = 1500;
const URL_SAMPLE_COLLECTION_DATA = 'assets/data/collection_500_numbers.json';
@Component({
templateUrl: './grid-clientside.component.html'
})
export class GridClientSideComponent implements OnInit {
title = 'Example 4: Client Side Sort/Filter';
subTitle = `
Sort/Filter on client side only using SlickGrid DataView (<a href="https://ghiscoding.gitbook.io/angular-slickgrid/column-functionalities/sorting" target="_blank">Wiki docs</a>)
<br/>
<ul class="small">
<li>Support multi-sort (by default), hold "Shift" key and click on the next column to sort.</li>
<li>All column types support the following operators: (>, >=, <, <=, <>, !=, =, ==, *)</li>
<ul>
<li>Example: >100 ... >=2001-01-01 ... >02/28/17</li>
<li><b>Note:</b> For filters to work properly (default is string), make sure to provide a FieldType (type is against the dataset, not the Formatter)</li>
</ul>
<li>Date Filters</li>
<ul>
<li>
FieldType of dateUtc/date (from dataset) can use an extra option of "filterSearchType" to let user filter more easily.
For example, in the "UTC Date" field below, you can type ">02/28/2017", also when dealing with UTC you have to take the time difference in consideration.
</li>
</ul>
<li>On String filters, (*) can be used as startsWith (Hello* => matches "Hello Word") ... endsWith (*Doe => matches: "John Doe")</li>
<li>Custom Filter are now possible, "Description" column below, is a customized InputFilter with different placeholder. See <a href="https://ghiscoding.gitbook.io/angular-slickgrid/column-functionalities/custom-filter" target="_blank">Wiki - Custom Filter</a>
<li>MultipleSelect & SingeSelect Filters can use a regular "collection" or "collectionAsync" to load it asynchronously</li>
</ul>
`;
angularGrid!: AngularGridInstance;
columnDefinitions: Column[] = [];
gridOptions!: GridOption;
dataset!: any[];
metrics!: Metrics;
constructor(private http: HttpClient, private translate: TranslateService) { }
ngOnInit(): void {
this.columnDefinitions = [
{
id: 'title', name: 'Title', field: 'title', sortable: true, minWidth: 55,
type: FieldType.string, filterable: true, filter: { model: Filters.compoundInputText }
},
{
id: 'description', name: 'Description', field: 'description', filterable: true, sortable: true, minWidth: 80,
type: FieldType.string,
filter: {
model: CustomInputFilter, // create a new instance to make each Filter independent from each other
enableTrimWhiteSpace: true // or use global "enableFilterTrimWhiteSpace" to trim on all Filters
}
},
{
id: 'duration', name: 'Duration (days)', field: 'duration', sortable: true, type: FieldType.number, exportCsvForceToKeepAsString: true,
minWidth: 55,
filterable: true,
filter: {
collectionAsync: this.http.get<{ option: string; value: string; }[]>(URL_SAMPLE_COLLECTION_DATA),
// collectionFilterBy & collectionSortBy accept a single or multiple options
// we can exclude certains values 365 & 360 from the dropdown filter
collectionFilterBy: [{
property: 'value',
operator: OperatorType.notEqual,
value: 360
}, {
property: 'value',
operator: OperatorType.notEqual,
value: 365
}],
collectionSortBy: {
property: 'value',
sortDesc: true,
fieldType: FieldType.number
},
customStructure: {
value: 'value',
label: 'label',
optionLabel: 'value', // if selected text is too long, we can use option labels instead
labelSuffix: 'text',
},
collectionOptions: {
separatorBetweenTextLabels: ' ',
filterResultAfterEachPass: 'chain' // options are "merge" or "chain" (defaults to "chain")
},
model: Filters.multipleSelect,
// we could add certain option(s) to the "multiple-select" plugin
filterOptions: {
maxHeight: 250,
width: 175,
// if we want to display shorter text as the selected text (on the select filter itself, parent element)
// we can use "useSelectOptionLabel" or "useSelectOptionLabelToHtml" the latter will parse html
useSelectOptionLabelToHtml: true
} as MultipleSelectOption
}
},
{
id: 'complete', name: '% Complete', field: 'percentComplete', formatter: Formatters.percentCompleteBar, minWidth: 70, type: FieldType.number, sortable: true,
filterable: true, filter: { model: Filters.compoundInputNumber }
},
{
id: 'start', name: 'Start', field: 'start', formatter: Formatters.dateIso, sortable: true, minWidth: 75,
type: FieldType.date, filterable: true, filter: { model: Filters.compoundDate }
},
{
id: 'usDateShort', name: 'US Date Short', field: 'usDateShort', sortable: true, minWidth: 70, width: 70,
type: FieldType.dateUsShort, exportWithFormatter: true, filterable: true, filter: { model: Filters.compoundDate }
},
{
id: 'utcDate', name: 'UTC Date', field: 'utcDate', formatter: Formatters.dateTimeIsoAmPm, sortable: true, minWidth: 115,
type: FieldType.dateUtc, exportWithFormatter: true, outputType: FieldType.dateTimeIsoAmPm, filterable: true,
filter: {
model: Filters.compoundDate,
// override any of the date picker options through "filterOptions"
filterOptions: { range: { date: 'today' } } as VanillaCalendarOption
}
},
{
id: 'effort-driven', name: 'Effort Driven', field: 'effortDriven.isEffort', minWidth: 85, maxWidth: 85,
type: FieldType.boolean,
sortable: true,
exportCustomFormatter: Formatters.complexObject,
// to pass multiple formatters, use the params property
// also these formatters are executed in sequence, so if you want the checkmark to work correctly, it has to be the last formatter defined
formatter: Formatters.multiple,
params: { formatters: [Formatters.complexObject, Formatters.checkmarkMaterial] },
// when the "field" string includes the dot "." notation, the library will consider this to be a complex object and Filter accordingly
filterable: true,
filter: {
// We can also add HTML text to be rendered (any bad script will be sanitized) but we have to opt-in, else it will be sanitized
// enableRenderHtml: true,
// collection: [{ value: '', label: '' }, { value: true, label: 'True', labelPrefix: `<i class="mdi mdi-check"></i> ` }, { value: false, label: 'False' }],
collection: [{ isEffort: '', label: '' }, { isEffort: true, label: 'True' }, { isEffort: false, label: 'False' }],
customStructure: {
value: 'isEffort',
label: 'label'
},
model: Filters.singleSelect,
// we could add certain option(s) to the "multiple-select" plugin
filterOptions: { autoAdjustDropHeight: true } as MultipleSelectOption,
}
}
];
this.gridOptions = {
autoResize: {
container: '#demo-container',
rightPadding: 10
},
enableExcelExport: true,
enableExcelCopyBuffer: true,
enableFiltering: true,
// enableFilterTrimWhiteSpace: true,
i18n: this.translate,
showCustomFooter: true, // display some metrics in the bottom custom footer
// use columnDef searchTerms OR use presets as shown below
presets: {
filters: [
{ columnId: 'duration', searchTerms: [10, 98] },
// { columnId: 'complete', searchTerms: ['5'], operator: '>' },
{ columnId: 'usDateShort', operator: '<', searchTerms: ['4/20/25'] },
// { columnId: 'effort-driven', searchTerms: [true] },
],
sorters: [
{ columnId: 'duration', direction: 'DESC' },
{ columnId: 'complete', direction: 'ASC' }
],
},
externalResources: [new ExcelExportService()],
};
// mock a dataset
this.dataset = this.mockData(NB_ITEMS);
}
angularGridReady(angularGrid: AngularGridInstance) {
this.angularGrid = angularGrid;
}
mockData(itemCount: number, startingIndex = 0): any[] {
// mock a dataset
const tempDataset = [];
for (let i = startingIndex; i < (startingIndex + itemCount); i++) {
const randomDuration = Math.round(Math.random() * 100);
const randomYear = randomBetween(2000, 2035);
const randomYearShort = randomBetween(10, 35);
const randomMonth = randomBetween(1, 12);
const randomMonthStr = (randomMonth < 10) ? `0${randomMonth}` : randomMonth;
const randomDay = randomBetween(10, 28);
const randomPercent = randomBetween(0, 100);
const randomHour = randomBetween(10, 23);
const randomTime = randomBetween(10, 59);
const randomMilliseconds = `${randomBetween(1, 9)}${randomBetween(10, 99)}`;
const randomIsEffort = (i % 3 === 0);
tempDataset.push({
id: i,
title: 'Task ' + i,
description: (i % 5) ? 'desc ' + i : null, // also add some random to test NULL field
duration: randomDuration,
percentComplete: randomPercent,
percentCompleteNumber: randomPercent,
start: (i % 4) ? null : new Date(randomYear, randomMonth, randomDay), // provide a Date format
usDateShort: `${randomMonth}/${randomDay}/${randomYearShort}`, // provide a date US Short in the dataset
utcDate: `${randomYear}-${randomMonthStr}-${randomDay}T${randomHour}:${randomTime}:${randomTime}.${randomMilliseconds}Z`,
effortDriven: {
isEffort: randomIsEffort,
label: randomIsEffort ? 'Effort' : 'NoEffort',
}
});
}
return tempDataset;
}
/** Dispatched event of a Grid State Changed event */
gridStateChanged(gridState: GridStateChange) {
console.log('Client sample, Grid State changed:: ', gridState.change);
}
/** Save current Filters, Sorters in LocaleStorage or DB */
saveCurrentGridState() {
console.log('Client sample, last Grid State:: ', this.angularGrid.gridStateService.getCurrentGridState());
}
setFiltersDynamically() {
// we can Set Filters Dynamically (or different filters) afterward through the FilterService
this.angularGrid.filterService.updateFilters([
{ columnId: 'duration', searchTerms: [2, 25, 48, 50] },
{ columnId: 'complete', searchTerms: [95], operator: '<' },
{ columnId: 'effort-driven', searchTerms: [true] },
{ columnId: 'start', operator: '>=', searchTerms: ['2001-02-28'] },
]);
}
setSortingDynamically() {
this.angularGrid.sortService.updateSorting([
// orders matter, whichever is first in array will be the first sorted column
{ columnId: 'duration', direction: 'ASC' },
{ columnId: 'start', direction: 'DESC' },
]);
}
refreshMetrics(e: Event, args: any) {
if (args && args.current >= 0) {
window.setTimeout(() => {
this.metrics = {
startTime: new Date(),
endTime: new Date(),
itemCount: args && args.current || 0,
totalItemCount: this.dataset.length || 0
};
});
}
}
scrollGridBottom() {
this.angularGrid.slickGrid.navigateBottom();
}
scrollGridTop() {
this.angularGrid.slickGrid.navigateTop();
}
}