feat(query): add excludeFromQuery prop and use it for Row Selection

Author: Ghislain Beaulac

src/app/examples/grid-graphql.component.ts

@@ -67,6 +67,8 @@ export class GridGraphqlComponent implements OnInit {
       enableAutoResize: false,
       enableFiltering: true,
       enableCellNavigation: true,
+      enableCheckboxSelector: true,
+      enableRowSelection: true,
       enableTranslate: true,
       pagination: {
         pageSizes: [10, 15, 20, 25, 30, 40, 50, 75, 100],

src/app/examples/grid-odata.component.ts

@@ -55,8 +55,10 @@ export class GridOdataComponent implements OnInit {
         containerId: 'demo-container',
         sidePadding: 15
       },
-      enableFiltering: true,
       enableCellNavigation: true,
+      enableFiltering: true,
+      enableCheckboxSelector: true,
+      enableRowSelection: true,
       pagination: {
         pageSizes: [10, 15, 20, 25, 30, 40, 50, 75, 100],
         pageSize: defaultPageSize,

src/app/modules/angular-slickgrid/models/column.interface.ts

@@ -29,6 +29,9 @@ export interface Column {
   /** Default to false, do we want this column excluded from the export? */
   excludeFromExport?: boolean;
 
+  /** Defaults to false, do we want to exclude this field from the query (mostly a backend service query) */
+  excludeFromQuery?: boolean;
+
   /**
    * Export with a Custom Formatter, useful when we want to use a different Formatter for the export.
    * For example, we might have a boolean field with "Formatters.checkmark" but we would like see a translated value for (True/False).

src/app/modules/angular-slickgrid/services/controlAndPlugin.service.ts

@@ -503,6 +503,7 @@ export class ControlAndPluginService {
       this.checkboxSelectorPlugin = new Slick.CheckboxSelectColumn(options.checkboxSelector || {});
       const selectionColumn: Column = this.checkboxSelectorPlugin.getColumnDefinition();
       selectionColumn.excludeFromExport = true;
+      selectionColumn.excludeFromQuery = true;
       columnDefinitions.unshift(selectionColumn);
     }
   }

src/app/modules/angular-slickgrid/services/graphql.service.ts

@@ -58,7 +58,11 @@ export class GraphqlService implements BackendService {
     if (!this.options || !this.options.datasetName || (!this._columnDefinitions && !this.options.columnDefinitions)) {
       throw new Error('GraphQL Service requires "datasetName" & "columnDefinitions" properties for it to work');
     }
-    const columnDefinitions = this._columnDefinitions || this.options.columnDefinitions;
+
+    // get the column definitions and exclude some if they were tagged as excluded
+    let columnDefinitions = this._columnDefinitions || this.options.columnDefinitions;
+    columnDefinitions = columnDefinitions.filter((column: Column) => !column.excludeFromQuery);
+
     const queryQb = new QueryBuilder('query');
     const datasetQb = new QueryBuilder(this.options.datasetName);
     const pageInfoQb = new QueryBuilder('pageInfo');

src/app/modules/angular-slickgrid/services/grid-odata.service.ts

@@ -60,6 +60,8 @@ export class GridOdataService implements BackendService {
 
     if (grid && grid.getColumns && grid.getOptions) {
       this._columnDefinitions = grid.getColumns() || options.columnDefinitions;
+      this._columnDefinitions = this._columnDefinitions.filter((column: Column) => !column.excludeFromQuery);
+
       this._gridOptions = grid.getOptions();
     }
   }