2 * Collection of grid related classses and interfaces.
4 import {TemplateRef, EventEmitter, QueryList} from '@angular/core';
5 import {Observable, Subscription, empty} from 'rxjs';
6 import {IdlService, IdlObject} from '@eg/core/idl.service';
7 import {OrgService} from '@eg/core/org.service';
8 import {ServerStoreService} from '@eg/core/server-store.service';
9 import {FormatService} from '@eg/core/format.service';
10 import {Pager} from '@eg/share/util/pager';
11 import {GridFilterControlComponent} from './grid-filter-control.component';
13 const MAX_ALL_ROW_COUNT = 10000;
15 export class GridColumn {
25 // IDL class of the object which contains this field.
26 // Not to be confused with the class of a linked object.
30 datePlusTime: boolean;
32 timezoneContextOrg: number;
33 cellTemplate: TemplateRef<any>;
34 dateOnlyIntervalField: string;
38 isDragTarget: boolean;
40 isFilterable: boolean;
42 isMultiSortable: boolean;
43 disableTooltip: boolean;
44 asyncSupportsEmptyTermClick: boolean;
45 comparator: (valueA: any, valueB: any) => number;
48 // True if the column was automatically generated.
53 filterOperator: string;
54 filterInputDisabled: boolean;
55 filterIncludeOrgAncestors: boolean;
56 filterIncludeOrgDescendants: boolean;
58 flesher: (obj: any, col: GridColumn, item: any) => any;
60 getCellContext(row: any) {
64 userContext: this.cellContext
73 this.isFiltered = false;
74 this.filterValue = undefined;
75 this.filterOperator = '=';
76 this.filterInputDisabled = false;
77 this.filterIncludeOrgAncestors = false;
78 this.filterIncludeOrgDescendants = false;
82 const col = new GridColumn();
86 col.label = this.label;
88 col.required = this.required;
89 col.hidden = this.hidden;
90 col.asyncSupportsEmptyTermClick = this.asyncSupportsEmptyTermClick;
91 col.isIndex = this.isIndex;
92 col.cellTemplate = this.cellTemplate;
93 col.cellContext = this.cellContext;
94 col.disableTooltip = this.disableTooltip;
95 col.isSortable = this.isSortable;
96 col.isFilterable = this.isFilterable;
97 col.isMultiSortable = this.isMultiSortable;
98 col.datatype = this.datatype;
99 col.datePlusTime = this.datePlusTime;
100 col.ternaryBool = this.ternaryBool;
101 col.timezoneContextOrg = this.timezoneContextOrg;
102 col.idlClass = this.idlClass;
103 col.isAuto = this.isAuto;
110 export class GridColumnSet {
111 columns: GridColumn[];
113 indexColumn: GridColumn;
115 isFilterable: boolean;
116 isMultiSortable: boolean;
117 stockVisible: string[];
119 defaultHiddenFields: string[];
120 defaultVisibleFields: string[];
122 constructor(idl: IdlService, idlClass?: string) {
125 this.stockVisible = [];
126 this.idlClass = idlClass;
129 add(col: GridColumn) {
131 if (col.path && col.path.match(/\*$/)) {
132 return this.generateWildcardColumns(col);
135 this.applyColumnDefaults(col);
137 if (!this.insertColumn(col)) {
138 // Column was rejected as a duplicate.
142 if (col.isIndex) { this.indexColumn = col; }
144 // track which fields are visible on page load.
146 this.stockVisible.push(col.name);
149 this.applyColumnSortability(col);
150 this.applyColumnFilterability(col);
153 generateWildcardColumns(col: GridColumn) {
155 const dotpath = col.path.replace(/\.?\*$/, '');
156 let classObj, idlField;
159 classObj = this.idl.classes[col.idlClass];
161 classObj = this.idl.classes[this.idlClass];
164 if (!classObj) { return; }
166 const pathParts = dotpath.split(/\./);
169 // find the IDL class definition for the last element in the
170 // path before the .*
171 // An empty pathParts means expand the root class
172 pathParts.forEach((part, pathIdx) => {
174 idlField = classObj.field_map[part];
176 // unless we're at the end of the list, this field should
177 // link to another class.
178 if (idlField && idlField['class'] && (
179 idlField.datatype === 'link' || idlField.datatype === 'org_unit')) {
180 classObj = this.idl.classes[idlField['class']];
183 if (pathIdx < (pathParts.length - 1)) {
184 // we ran out of classes to hop through before
185 // we ran out of path components
186 console.warn('Grid: invalid IDL path: ' + dotpath);
193 'Grid: wildcard path does not resolve to an object:' + dotpath);
197 classObj.fields.forEach(field => {
199 // Only show wildcard fields where we have data to show
200 // Virtual and un-fleshed links will not have any data.
202 field.datatype === 'link' || field.datatype === 'org_unit') {
206 const newCol = col.clone();
207 newCol.isAuto = true;
208 newCol.path = dotpath ? dotpath + '.' + field.name : field.name;
209 newCol.label = dotpath ? classObj.label + ': ' + field.label : field.label;
210 newCol.datatype = field.datatype;
212 // Avoid including the class label prefix in the main grid
213 // header display so it doesn't take up so much horizontal space.
214 newCol.headerLabel = field.label;
220 // Returns true if the new column was inserted, false otherwise.
221 // Declared columns take precedence over auto-generated columns
222 // when collisions occur.
223 // Declared columns are inserted in front of auto columns.
224 insertColumn(col: GridColumn): boolean {
227 if (this.getColByName(col.name) || this.getColByPath(col.path)) {
228 // New auto-generated column conflicts with existing
232 // No collisions. Add to the end of the list
233 this.columns.push(col);
238 // Adding a declared column.
241 for (let idx = 0; idx < this.columns.length; idx++) {
242 const testCol = this.columns[idx];
243 if (testCol.name === col.name) { // match found
244 if (testCol.isAuto) {
245 // new column takes precedence, remove the existing column.
246 this.columns.splice(idx, 1);
249 // New column does not take precedence. Avoid
256 // Delcared columns are inserted just before the first auto-column
257 for (let idx = 0; idx < this.columns.length; idx++) {
258 const testCol = this.columns[idx];
259 if (testCol.isAuto) {
261 this.columns.unshift(col);
263 this.columns.splice(idx, 0, col);
269 // No insertion point found. Toss the new column on the end.
270 this.columns.push(col);
274 getColByName(name: string): GridColumn {
275 return this.columns.filter(c => c.name === name)[0];
278 getColByPath(path: string): GridColumn {
280 return this.columns.filter(c => c.path === path)[0];
284 idlInfoFromDotpath(dotpath: string): any {
285 if (!dotpath || !this.idlClass) { return null; }
290 let nextIdlClass = this.idl.classes[this.idlClass];
292 const pathParts = dotpath.split(/\./);
294 for (let i = 0; i < pathParts.length; i++) {
296 const part = pathParts[i];
297 idlParent = idlField;
298 idlClass = nextIdlClass;
299 idlField = idlClass.field_map[part];
301 if (!idlField) { return null; } // invalid IDL path
303 if (i === pathParts.length - 1) {
304 // No more links to process.
308 if (idlField['class'] && (
309 idlField.datatype === 'link' ||
310 idlField.datatype === 'org_unit')) {
311 // The link class on the current field refers to the
312 // class of the link destination, not the current field.
313 // Mark it for processing during the next iteration.
314 nextIdlClass = this.idl.classes[idlField['class']];
319 idlParent: idlParent,
327 this.columns.forEach(col => {
331 col.visible = this.stockVisible.includes(col.name);
335 applyColumnDefaults(col: GridColumn) {
337 if (!col.idlFieldDef) {
338 const idlInfo = this.idlInfoFromDotpath(col.path || col.name);
340 col.idlFieldDef = idlInfo.idlField;
341 col.idlClass = idlInfo.idlClass.name;
343 col.datatype = col.idlFieldDef.datatype;
346 col.label = col.idlFieldDef.label || col.idlFieldDef.name;
351 if (!col.name) { col.name = col.path; }
352 if (!col.flex) { col.flex = 2; }
353 if (!col.align) { col.align = 'left'; }
354 if (!col.label) { col.label = col.name; }
355 if (!col.datatype) { col.datatype = 'text'; }
356 if (!col.isAuto) { col.headerLabel = col.label; }
358 col.visible = !col.hidden;
361 applyColumnSortability(col: GridColumn) {
362 // column sortability defaults to the sortability of the column set.
363 if (col.isSortable === undefined && this.isSortable) {
364 col.isSortable = true;
367 if (col.isMultiSortable === undefined && this.isMultiSortable) {
368 col.isMultiSortable = true;
371 if (col.isMultiSortable) {
372 col.isSortable = true;
375 applyColumnFilterability(col: GridColumn) {
376 // column filterability defaults to the afilterability of the column set.
377 if (col.isFilterable === undefined && this.isFilterable) {
378 col.isFilterable = true;
382 displayColumns(): GridColumn[] {
383 return this.columns.filter(c => c.visible);
386 // Sorted visible columns followed by sorted non-visible columns.
387 // Note we don't sort this.columns directly as it would impact
388 // grid column display ordering.
389 sortForColPicker(): GridColumn[] {
390 const visible = this.columns.filter(c => c.visible);
391 const invisible = this.columns.filter(c => !c.visible);
393 visible.sort((a, b) => a.label < b.label ? -1 : 1);
394 invisible.sort((a, b) => a.label < b.label ? -1 : 1);
396 return visible.concat(invisible);
399 requiredColumns(): GridColumn[] {
400 const visible = this.displayColumns();
401 return visible.concat(
402 this.columns.filter(c => c.required && !c.visible));
405 insertBefore(source: GridColumn, target: GridColumn) {
408 this.columns.forEach((col, idx) => {
409 if (col.name === target.name) { targetIdx = idx; }});
411 this.columns.forEach((col, idx) => {
412 if (col.name === source.name) { sourceIdx = idx; }});
414 if (sourceIdx >= 0) {
415 this.columns.splice(sourceIdx, 1);
418 this.columns.splice(targetIdx, 0, source);
421 // Move visible columns to the front of the list.
422 moveVisibleToFront() {
423 const newCols = this.displayColumns();
424 this.columns.forEach(col => {
425 if (!col.visible) { newCols.push(col); }});
426 this.columns = newCols;
429 moveColumn(col: GridColumn, diff: number) {
430 let srcIdx, targetIdx;
432 this.columns.forEach((c, i) => {
433 if (c.name === col.name) { srcIdx = i; }
436 targetIdx = srcIdx + diff;
439 } else if (targetIdx >= this.columns.length) {
440 // Target index follows the last visible column.
442 this.columns.forEach((c, idx) => {
443 if (c.visible) { lastVisible = idx; }
446 // When moving a column (down) causes one or more
447 // visible columns to shuffle forward, our column
448 // moves into the slot of the last visible column.
449 // Otherwise, put it into the slot directly following
450 // the last visible column.
451 targetIdx = srcIdx <= lastVisible ? lastVisible : lastVisible + 1;
454 // Splice column out of old position, insert at new position.
455 this.columns.splice(srcIdx, 1);
456 this.columns.splice(targetIdx, 0, col);
459 compileSaveObject(): GridColumnPersistConf[] {
460 // only store information about visible columns.
461 // scrunch the data down to just the needed info.
462 return this.displayColumns().map(col => {
463 const c: GridColumnPersistConf = {name : col.name};
464 if (col.align !== 'left') { c.align = col.align; }
465 if (col.flex !== 2) { c.flex = Number(col.flex); }
466 if (Number(col.sort)) { c.sort = Number(col.sort); }
471 applyColumnSettings(conf: GridColumnPersistConf[]) {
473 if (!conf || conf.length === 0) {
474 // No configuration is available, but we have a list of
475 // fields to show or hide by default
477 if (this.defaultVisibleFields) {
478 this.columns.forEach(col => {
479 if (this.defaultVisibleFields.includes(col.name)) {
486 } else if (this.defaultHiddenFields) {
487 this.defaultHiddenFields.forEach(name => {
488 const col = this.getColByName(name);
500 conf.forEach(colConf => {
501 const col = this.getColByName(colConf.name);
502 if (!col) { return; } // no such column in this grid.
505 if (colConf.align) { col.align = colConf.align; }
506 if (colConf.flex) { col.flex = Number(colConf.flex); }
507 if (colConf.sort) { col.sort = Number(colConf.sort); }
509 // Add to new columns array, avoid dupes.
510 if (newCols.filter(c => c.name === col.name).length === 0) {
515 // columns which are not expressed within the saved
516 // configuration are marked as non-visible and
517 // appended to the end of the new list of columns.
518 this.columns.forEach(c => {
519 if (conf.filter(cf => cf.name === c.name).length === 0) {
525 this.columns = newCols;
529 // Maps colunm names to functions which return plain text values for
530 // each mapped column on a given row. This is primarily useful for
531 // generating print-friendly content for grid cells rendered via
534 // USAGE NOTE: Since a cellTemplate can be passed arbitrary context
535 // but a GridCellTextGenerator only gets the row object,
536 // if it's important to include content that's not available
537 // by default in the row object, you may want to stick
538 // it in the row object as an additional attribute.
540 export interface GridCellTextGenerator {
541 [columnName: string]: (row: any) => string;
544 export class GridRowSelector {
545 indexes: {[string: string]: boolean};
547 // Track these so we can emit the selectionChange event
548 // only when the selection actually changes.
549 previousSelection: string[] = [];
551 // Emits the selected indexes on selection change
552 selectionChange: EventEmitter<string[]> = new EventEmitter<string[]>();
558 // Returns true if all of the requested indexes exist in the selector.
559 contains(index: string | string[]): boolean {
560 const indexes = [].concat(index);
561 for (let i = 0; i < indexes.length; i++) { // early exit
562 if (!this.indexes[indexes[i]]) {
570 const keys = this.selected();
572 if (keys.length === this.previousSelection.length &&
573 this.contains(this.previousSelection)) {
574 return; // No change has occurred
577 this.previousSelection = keys;
578 this.selectionChange.emit(keys);
581 select(index: string | string[]) {
582 const indexes = [].concat(index);
583 indexes.forEach(i => this.indexes[i] = true);
587 deselect(index: string | string[]) {
588 const indexes = [].concat(index);
589 indexes.forEach(i => delete this.indexes[i]);
593 toggle(index: string) {
594 if (this.indexes[index]) {
595 this.deselect(index);
601 selected(): string[] {
602 return Object.keys(this.indexes);
606 return this.selected().length === 0;
615 export interface GridRowFlairEntry {
616 icon: string; // name of material icon
617 title?: string; // tooltip string
620 export class GridColumnPersistConf {
627 export class GridPersistConf {
630 columns: GridColumnPersistConf[];
631 hideToolbarActions: string[];
634 export class GridContext {
639 isFilterable: boolean;
640 initialFilterValues: {[field: string]: string};
641 stickyGridHeader: boolean;
642 isMultiSortable: boolean;
643 useLocalSort: boolean;
645 disableMultiSelect: boolean;
646 disableSelect: boolean;
647 dataSource: GridDataSource;
648 columnSet: GridColumnSet;
649 autoGeneratedColumnOrder: string;
650 rowSelector: GridRowSelector;
651 toolbarLabel: string;
652 toolbarButtons: GridToolbarButton[];
653 toolbarCheckboxes: GridToolbarCheckbox[];
654 toolbarActions: GridToolbarAction[];
655 lastSelectedIndex: any;
656 pageChanges: Subscription;
657 rowFlairIsEnabled: boolean;
658 rowFlairCallback: (row: any) => GridRowFlairEntry;
659 rowClassCallback: (row: any) => string;
660 cellClassCallback: (row: any, col: GridColumn) => string;
661 defaultVisibleFields: string[];
662 defaultHiddenFields: string[];
663 ignoredFields: string[];
664 overflowCells: boolean;
665 disablePaging: boolean;
666 showDeclaredFieldsOnly: boolean;
667 cellTextGenerator: GridCellTextGenerator;
668 reloadOnColumnChange: boolean;
670 // Allow calling code to know when the select-all-rows-in-page
671 // action has occurred.
672 selectRowsInPageEmitter: EventEmitter<void>;
674 filterControls: QueryList<GridFilterControlComponent>;
676 // Services injected by our grid component
679 store: ServerStoreService;
680 format: FormatService;
685 store: ServerStoreService,
686 format: FormatService) {
691 this.format = format;
692 this.pager = new Pager();
693 this.rowSelector = new GridRowSelector();
694 this.toolbarButtons = [];
695 this.toolbarCheckboxes = [];
696 this.toolbarActions = [];
700 this.selectRowsInPageEmitter = new EventEmitter<void>();
701 this.columnSet = new GridColumnSet(this.idl, this.idlClass);
702 this.columnSet.isSortable = this.isSortable === true;
703 this.columnSet.isFilterable = this.isFilterable === true;
704 this.columnSet.isMultiSortable = this.isMultiSortable === true;
705 this.columnSet.defaultHiddenFields = this.defaultHiddenFields;
706 this.columnSet.defaultVisibleFields = this.defaultVisibleFields;
707 if (!this.pager.limit) {
708 this.pager.limit = this.disablePaging ? MAX_ALL_ROW_COUNT : 10;
710 this.generateColumns();
713 // Load initial settings and data.
715 this.applyGridConfig()
716 .then(ok => this.dataSource.requestPage(this.pager))
717 .then(ok => this.listenToPager());
724 applyGridConfig(): Promise<void> {
725 return this.getGridConfig(this.persistKey)
729 columns = conf.columns;
730 if (conf.limit && !this.disablePaging) {
731 this.pager.limit = conf.limit;
733 this.applyToolbarActionVisibility(conf.hideToolbarActions);
736 // This is called regardless of the presence of saved
737 // settings so defaults can be applied.
738 this.columnSet.applyColumnSettings(columns);
742 applyToolbarActionVisibility(hidden: string[]) {
743 if (!hidden || hidden.length === 0) { return; }
746 this.toolbarActions.forEach(action => {
747 if (action.isGroup) {
749 } else if (!action.isSeparator) {
750 action.hidden = hidden.includes(action.label);
754 // If all actions in a group are hidden, hide the group as well.
755 // Note the group may be marked as hidden in the configuration,
756 // but the addition of new entries within a group should cause
757 // it to be visible again.
758 groups.forEach(group => {
759 const visible = this.toolbarActions
760 .filter(action => action.group === group.label && !action.hidden);
761 group.hidden = visible.length === 0;
766 // Give the UI time to settle before reloading grid data.
767 // This can help when data retrieval depends on a value
768 // getting modified by an angular digest cycle.
771 this.dataSource.reset();
772 this.dataSource.requestPage(this.pager);
776 reloadWithoutPagerReset() {
778 this.dataSource.reset();
779 this.dataSource.requestPage(this.pager);
783 // Sort the existing data source instead of requesting sorted
784 // data from the client. Reset pager to page 1. As with reload(),
785 // give the client a chance to setting before redisplaying.
789 this.sortLocalData();
790 this.dataSource.requestPage(this.pager);
794 // Subscribe or unsubscribe to page-change events from the pager.
796 if (this.pageChanges) { return; }
797 this.pageChanges = this.pager.onChange$.subscribe(
798 val => this.dataSource.requestPage(this.pager));
802 if (!this.pageChanges) { return; }
803 this.pageChanges.unsubscribe();
804 this.pageChanges = null;
807 // Sort data in the data source array
810 const sortDefs = this.dataSource.sort.map(sort => {
811 const column = this.columnSet.getColByName(sort.name);
819 if (!def.col.comparator) {
820 switch (def.col.datatype) {
824 def.col.comparator = (a, b) => {
827 if (a < b) { return -1; }
828 if (a > b) { return 1; }
833 def.col.comparator = (a, b) => {
834 if (a < b) { return -1; }
835 if (a > b) { return 1; }
844 this.dataSource.data.sort((rowA, rowB) => {
846 for (let idx = 0; idx < sortDefs.length; idx++) {
847 const sortDef = sortDefs[idx];
849 const valueA = this.getRowColumnValue(rowA, sortDef.col);
850 const valueB = this.getRowColumnValue(rowB, sortDef.col);
852 if (valueA === '' && valueB === '') { continue; }
853 if (valueA === '' && valueB !== '') { return 1; }
854 if (valueA !== '' && valueB === '') { return -1; }
856 const diff = sortDef.col.comparator(valueA, valueB);
857 if (diff === 0) { continue; }
859 return sortDef.dir === 'DESC' ? -diff : diff;
862 return 0; // No differences found.
866 getRowIndex(row: any): any {
867 const col = this.columnSet.indexColumn;
869 throw new Error('grid index column required');
871 return this.getRowColumnValue(row, col);
874 // Returns position in the data source array of the row with
875 // the provided index.
876 getRowPosition(index: any): number {
877 // for-loop for early exit
878 for (let idx = 0; idx < this.dataSource.data.length; idx++) {
879 const row = this.dataSource.data[idx];
880 if (row !== undefined && index === this.getRowIndex(row)) {
886 // Return the row with the provided index.
887 getRowByIndex(index: any): any {
888 for (let idx = 0; idx < this.dataSource.data.length; idx++) {
889 const row = this.dataSource.data[idx];
890 if (row !== undefined && index === this.getRowIndex(row)) {
896 // Returns all selected rows, regardless of whether they are
897 // currently visible in the grid display.
898 // De-selects previously selected rows which are no longer
899 // present in the grid.
900 getSelectedRows(): any[] {
904 this.rowSelector.selected().forEach(index => {
905 const row = this.getRowByIndex(index);
913 this.rowSelector.deselect(deleted);
917 rowIsSelected(row: any): boolean {
918 const index = this.getRowIndex(row);
919 return this.rowSelector.selected().filter(
924 getRowColumnBareValue(row: any, col: GridColumn): any {
925 if (col.name in row) {
926 return this.getObjectFieldValue(row, col.name);
927 } else if (col.path) {
928 return this.nestedItemFieldValue(row, col);
932 getRowColumnValue(row: any, col: GridColumn): any {
933 const val = this.getRowColumnBareValue(row, col);
935 if (col.datatype === 'bool') {
936 // Avoid string-ifying bools so we can use an <eg-bool/>
937 // in the grid template.
942 const intField = col.dateOnlyIntervalField;
945 this.columnSet.columns.filter(c => c.path === intField)[0];
947 interval = this.getRowColumnBareValue(row, intCol);
951 return this.format.transform({
953 idlClass: col.idlClass,
954 idlField: col.idlFieldDef ? col.idlFieldDef.name : col.name,
955 datatype: col.datatype,
956 datePlusTime: Boolean(col.datePlusTime),
957 timezoneContextOrg: Number(col.timezoneContextOrg),
958 dateOnlyInterval: interval
962 getObjectFieldValue(obj: any, name: string): any {
963 if (typeof obj[name] === 'function') {
970 nestedItemFieldValue(obj: any, col: GridColumn): string {
974 const original = obj;
975 const steps = col.path.split('.');
977 for (let i = 0; i < steps.length; i++) {
978 const step = steps[i];
980 if (obj === null || obj === undefined || typeof obj !== 'object') {
981 // We have run out of data to step through before
982 // reaching the end of the path. Conclude fleshing via
983 // callback if provided then exit.
984 if (col.flesher && obj !== undefined) {
985 return col.flesher(obj, col, original);
990 const class_ = obj.classname;
991 if (class_ && (idlClassDef = this.idl.classes[class_])) {
992 idlField = idlClassDef.field_map[step];
995 obj = this.getObjectFieldValue(obj, step);
998 // We found a nested IDL object which may or may not have
999 // been configured as a top-level column. Flesh the column
1000 // metadata with our newly found IDL info.
1002 if (!col.datatype) {
1003 col.datatype = idlField.datatype;
1005 if (!col.idlFieldDef) {
1006 idlField = col.idlFieldDef;
1008 if (!col.idlClass) {
1009 col.idlClass = idlClassDef.name;
1012 col.label = idlField.label || idlField.name;
1020 getColumnTextContent(row: any, col: GridColumn): string {
1021 if (this.columnHasTextGenerator(col)) {
1022 const str = this.cellTextGenerator[col.name](row);
1023 return (str === null || str === undefined) ? '' : str;
1025 if (col.cellTemplate) {
1026 return ''; // avoid 'undefined' values
1028 return this.getRowColumnValue(row, col);
1033 selectOneRow(index: any) {
1034 this.rowSelector.clear();
1035 this.rowSelector.select(index);
1036 this.lastSelectedIndex = index;
1039 selectMultipleRows(indexes: any[]) {
1040 this.rowSelector.clear();
1041 this.rowSelector.select(indexes);
1042 this.lastSelectedIndex = indexes[indexes.length - 1];
1045 // selects or deselects an item, without affecting the others.
1046 // returns true if the item is selected; false if de-selected.
1047 toggleSelectOneRow(index: any) {
1048 if (this.rowSelector.contains(index)) {
1049 this.rowSelector.deselect(index);
1053 this.rowSelector.select(index);
1054 this.lastSelectedIndex = index;
1058 selectRowByPos(pos: number) {
1059 const row = this.dataSource.data[pos];
1061 this.selectOneRow(this.getRowIndex(row));
1065 selectPreviousRow() {
1066 if (!this.lastSelectedIndex) { return; }
1067 const pos = this.getRowPosition(this.lastSelectedIndex);
1068 if (pos === this.pager.offset) {
1069 this.toPrevPage().then(ok => this.selectLastRow(), err => {});
1071 this.selectRowByPos(pos - 1);
1076 if (!this.lastSelectedIndex) { return; }
1077 const pos = this.getRowPosition(this.lastSelectedIndex);
1078 if (pos === (this.pager.offset + this.pager.limit - 1)) {
1079 this.toNextPage().then(ok => this.selectFirstRow(), err => {});
1081 this.selectRowByPos(pos + 1);
1086 // Select the previous row in addition to any currently selected row.
1087 // However, if the previous row is already selected, assume the user
1088 // has reversed direction and now wants to de-select the last selected row.
1089 selectMultiRowsPrevious() {
1090 if (!this.lastSelectedIndex) { return; }
1091 const pos = this.getRowPosition(this.lastSelectedIndex);
1092 const selectedIndexes = this.rowSelector.selected();
1094 const promise = // load the previous page of data if needed
1095 (pos === this.pager.offset) ? this.toPrevPage() : Promise.resolve();
1099 const row = this.dataSource.data[pos - 1];
1100 const newIndex = this.getRowIndex(row);
1101 if (selectedIndexes.filter(i => i === newIndex).length > 0) {
1102 // Prev row is already selected. User is reversing direction.
1103 this.rowSelector.deselect(this.lastSelectedIndex);
1104 this.lastSelectedIndex = newIndex;
1106 this.selectMultipleRows(selectedIndexes.concat(newIndex));
1113 // Select all rows between the previously selected row and
1114 // the provided row, including the provided row.
1115 // This is additive only -- rows are never de-selected.
1116 selectRowRange(index: any) {
1118 if (!this.lastSelectedIndex) {
1119 this.selectOneRow(index);
1123 const next = this.getRowPosition(index);
1124 const prev = this.getRowPosition(this.lastSelectedIndex);
1125 const start = Math.min(prev, next);
1126 const end = Math.max(prev, next);
1128 for (let idx = start; idx <= end; idx++) {
1129 const row = this.dataSource.data[idx];
1131 this.rowSelector.select(this.getRowIndex(row));
1135 this.lastSelectedIndex = index;
1139 // Select the next row in addition to any currently selected row.
1140 // However, if the next row is already selected, assume the user
1141 // has reversed direction and wants to de-select the last selected row.
1142 selectMultiRowsNext() {
1143 if (!this.lastSelectedIndex) { return; }
1144 const pos = this.getRowPosition(this.lastSelectedIndex);
1145 const selectedIndexes = this.rowSelector.selected();
1147 const promise = // load the next page of data if needed
1148 (pos === (this.pager.offset + this.pager.limit - 1)) ?
1149 this.toNextPage() : Promise.resolve();
1153 const row = this.dataSource.data[pos + 1];
1154 const newIndex = this.getRowIndex(row);
1155 if (selectedIndexes.filter(i => i === newIndex).length > 0) {
1156 // Next row is already selected. User is reversing direction.
1157 this.rowSelector.deselect(this.lastSelectedIndex);
1158 this.lastSelectedIndex = newIndex;
1160 this.selectMultipleRows(selectedIndexes.concat(newIndex));
1167 getFirstRowInPage(): any {
1168 return this.dataSource.data[this.pager.offset];
1171 getLastRowInPage(): any {
1172 return this.dataSource.data[this.pager.offset + this.pager.limit - 1];
1176 this.selectOneRow(this.getRowIndex(this.getFirstRowInPage()));
1180 this.selectOneRow(this.getRowIndex(this.getLastRowInPage()));
1183 selectRowsInPage() {
1184 const rows = this.dataSource.getPageOfRows(this.pager);
1185 const indexes = rows.map(r => this.getRowIndex(r));
1186 this.rowSelector.select(indexes);
1187 this.selectRowsInPageEmitter.emit();
1190 toPrevPage(): Promise<any> {
1191 if (this.pager.isFirstPage()) {
1192 return Promise.reject('on first');
1194 // temp ignore pager events since we're calling requestPage manually.
1196 this.pager.decrement();
1197 this.listenToPager();
1198 return this.dataSource.requestPage(this.pager);
1201 toNextPage(): Promise<any> {
1202 if (this.pager.isLastPage()) {
1203 return Promise.reject('on last');
1205 // temp ignore pager events since we're calling requestPage manually.
1207 this.pager.increment();
1208 this.listenToPager();
1209 return this.dataSource.requestPage(this.pager);
1212 getAllRows(): Promise<any> {
1213 const pager = new Pager();
1215 pager.limit = MAX_ALL_ROW_COUNT;
1216 return this.dataSource.requestPage(pager);
1219 // Returns a key/value pair object of visible column data as text.
1220 getRowAsFlatText(row: any): any {
1222 this.columnSet.displayColumns().forEach(col => {
1224 this.getColumnTextContent(row, col);
1229 getAllRowsAsText(): Observable<any> {
1230 return Observable.create(observer => {
1231 this.getAllRows().then(ok => {
1232 this.dataSource.data.forEach(row => {
1233 observer.next(this.getRowAsFlatText(row));
1235 observer.complete();
1240 removeFilters(): void {
1241 this.dataSource.filters = {};
1242 this.columnSet.displayColumns().forEach(col => { col.removeFilter(); });
1243 this.filterControls.forEach(ctl => ctl.reset());
1246 filtersSet(): boolean {
1247 return Object.keys(this.dataSource.filters).length > 0;
1250 gridToCsv(): Promise<string> {
1253 const columns = this.columnSet.displayColumns();
1256 columns.forEach(col => {
1257 csvStr += this.valueToCsv(col.label),
1261 csvStr = csvStr.replace(/,$/, '\n');
1263 return new Promise(resolve => {
1264 this.getAllRowsAsText().subscribe(
1266 columns.forEach(col => {
1267 csvStr += this.valueToCsv(row[col.name]);
1270 csvStr = csvStr.replace(/,$/, '\n');
1273 () => resolve(csvStr)
1279 // prepares a string for inclusion within a CSV document
1280 // by escaping commas and quotes and removing newlines.
1281 valueToCsv(str: string): string {
1283 if (!str) { return ''; }
1284 str = str.replace(/\n/g, '');
1285 if (str.match(/\,/) || str.match(/"/)) {
1286 str = str.replace(/"/g, '""');
1287 str = '"' + str + '"';
1293 if (!this.columnSet.idlClass) { return; }
1295 const pkeyField = this.idl.classes[this.columnSet.idlClass].pkey;
1296 const specifiedColumnOrder = this.autoGeneratedColumnOrder ?
1297 this.autoGeneratedColumnOrder.split(/,/) : [];
1299 // generate columns for all non-virtual fields on the IDL class
1300 const fields = this.idl.classes[this.columnSet.idlClass].fields
1301 .filter(field => !field.virtual);
1303 const sortedFields = this.autoGeneratedColumnOrder ?
1304 this.idl.sortIdlFields(fields, this.autoGeneratedColumnOrder.split(/,/)) :
1307 sortedFields.forEach(field => {
1308 if (!this.ignoredFields.filter(ignored => ignored === field.name).length) {
1309 const col = new GridColumn();
1310 col.name = field.name;
1311 col.label = field.label || field.name;
1312 col.idlFieldDef = field;
1313 col.idlClass = this.columnSet.idlClass;
1314 col.datatype = field.datatype;
1315 col.isIndex = (field.name === pkeyField);
1317 col.headerLabel = col.label;
1319 if (this.showDeclaredFieldsOnly) {
1323 col.filterValue = this?.initialFilterValues?.[field.name];
1325 this.columnSet.add(col);
1330 saveGridConfig(): Promise<any> {
1331 if (!this.persistKey) {
1332 throw new Error('Grid persistKey required to save columns');
1334 const conf = new GridPersistConf();
1336 conf.limit = this.pager.limit;
1337 conf.columns = this.columnSet.compileSaveObject();
1339 // Avoid persisting group visibility since that may change
1340 // with the addition of new columns. Always calculate that
1342 conf.hideToolbarActions = this.toolbarActions
1343 .filter(action => !action.isGroup && action.hidden)
1344 .map(action => action.label);
1346 return this.store.setItem('eg.grid.' + this.persistKey, conf);
1349 // TODO: saveGridConfigAsOrgSetting(...)
1351 getGridConfig(persistKey: string): Promise<GridPersistConf> {
1352 if (!persistKey) { return Promise.resolve(null); }
1353 return this.store.getItem('eg.grid.' + persistKey);
1356 columnHasTextGenerator(col: GridColumn): boolean {
1357 return this.cellTextGenerator && col.name in this.cellTextGenerator;
1362 // Actions apply to specific rows
1363 export class GridToolbarAction {
1365 onClick: EventEmitter<any []>;
1366 action: (rows: any[]) => any; // DEPRECATED
1369 isGroup: boolean; // used for group placeholder entries
1370 isSeparator: boolean;
1371 disableOnRows: (rows: any[]) => boolean;
1375 // Buttons are global actions
1376 export class GridToolbarButton {
1378 onClick: EventEmitter<any []>;
1379 action: () => any; // DEPRECATED
1384 export class GridToolbarCheckbox {
1387 onChange: EventEmitter<boolean>;
1390 export interface GridColumnSort {
1395 export class GridDataSource {
1398 sort: GridColumnSort[];
1400 allRowsRetrieved: boolean;
1401 requestingData: boolean;
1402 retrievalError: boolean;
1403 getRows: (pager: Pager, sort: GridColumnSort[]) => Observable<any>;
1413 this.allRowsRetrieved = false;
1416 // called from the template -- no data fetching
1417 getPageOfRows(pager: Pager): any[] {
1419 return this.data.slice(
1420 pager.offset, pager.limit + pager.offset
1421 ).filter(row => row !== undefined);
1426 // called on initial component load and user action (e.g. paging, sorting).
1427 requestPage(pager: Pager): Promise<any> {
1430 this.getPageOfRows(pager).length === pager.limit
1431 // already have all data
1432 || this.allRowsRetrieved
1433 // have no way to get more data.
1436 return Promise.resolve();
1439 // If we have to call out for data, set inFetch
1440 this.requestingData = true;
1441 this.retrievalError = false;
1443 return new Promise((resolve, reject) => {
1444 let idx = pager.offset;
1445 return this.getRows(pager, this.sort).subscribe(
1447 this.data[idx++] = row;
1448 // not updating this.requestingData, as having
1449 // retrieved one row doesn't mean we're done
1450 this.retrievalError = false;
1453 console.error(`grid getRows() error ${err}`);
1454 this.requestingData = false;
1455 this.retrievalError = true;
1459 this.checkAllRetrieved(pager, idx);
1460 this.requestingData = false;
1461 this.retrievalError = false;
1468 // See if the last getRows() call resulted in the final set of data.
1469 checkAllRetrieved(pager: Pager, idx: number) {
1470 if (this.allRowsRetrieved) { return; }
1472 if (idx === 0 || idx < (pager.limit + pager.offset)) {
1473 // last query returned nothing or less than one page.
1474 // confirm we have all of the preceding pages.
1475 if (!this.data.includes(undefined)) {
1476 this.allRowsRetrieved = true;
1477 pager.resultCount = this.data.length;