@revolist/revogrid 4.14.1 → 4.14.2

package/dist/collection/components/revoGrid/revo-grid.js

@@ -264,25 +264,29 @@ export class RevoGridComponent {
     }
     /**
      * Update column sorting
-     * @param column - full column details to update
-     * @param index - virtual column index
+     * @param column - column prop and cellCompare
      * @param order - order to apply
      * @param additive - if false will replace current order
+     *
+     * later passed to SortingPlugin
      */
-    async updateColumnSorting(column, index, order, additive) {
-        if (!this.columnProvider) {
-            throw new Error('Not connected');
-        }
-        return this.columnProvider.updateColumnSorting(column, index, order, additive);
+    async updateColumnSorting(column, order, additive) {
+        this.sortingconfigchanged.emit({
+            columns: [{
+                    prop: column.prop,
+                    order,
+                    cellCompare: column.cellCompare,
+                }],
+            additive,
+        });
     }
     /**
      * Clears column sorting
      */
     async clearSorting() {
-        if (!this.columnProvider) {
-            throw new Error('Not connected');
-        }
-        this.columnProvider.clearSorting();
+        this.sortingconfigchanged.emit({
+            columns: [],
+        });
     }
     /**
      * Receive all columns in data source
@@ -490,7 +494,10 @@ export class RevoGridComponent {
         const columns = this.columnProvider.setColumns(beforeApplyEvent.detail);
         this.aftercolumnsset.emit({
             columns,
-            order: this.columnProvider.order,
+            order: Object.entries(beforeApplyEvent.detail.sort).reduce((acc, [prop, column]) => {
+                acc[prop] = column.order;
+                return acc;
+            }, {}),
         });
     }
     disableVirtualXChanged(newVal = false, prevVal = false) {
@@ -1389,7 +1396,7 @@ export class RevoGridComponent {
                 "mutable": false,
                 "complexType": {
                     "original": "SortingConfig",
-                    "resolved": "undefined | { columns?: { prop: ColumnProp; order: Order; cellCompare?: CellCompareFunc | undefined; }[] | undefined; }",
+                    "resolved": "undefined | { columns?: { prop: ColumnProp; order: Order; cellCompare?: CellCompareFunc | undefined; }[] | undefined; additive?: boolean | undefined; }",
                     "references": {
                         "SortingConfig": {
                             "location": "import",
@@ -1402,7 +1409,7 @@ export class RevoGridComponent {
                 "optional": true,
                 "docs": {
                     "tags": [],
-                    "text": "Alternative way to set sorting.\n`{columns: [{prop: 'name', order: 'asc'}]}`"
+                    "text": "Alternative way to set sorting.\n`{columns: [{prop: 'name', order: 'asc'}]}`\nUse SortingPlugin to get current sorting state"
                 },
                 "getter": false,
                 "setter": false
@@ -1884,7 +1891,7 @@ export class RevoGridComponent {
                 "composed": true,
                 "docs": {
                     "tags": [],
-                    "text": "By `sorting.plugin.ts`\n<br>Triggered immediately after header click.\n<br>First in sorting event sequence. Ff this event stops no other event called.\n<br>Use `e.preventDefault()` to prevent sorting."
+                    "text": "By `SortingPlugin`\n<br>Triggered immediately after header click.\n<br>First in sorting event sequence. Ff this event stops no other event called.\n<br>Use `e.preventDefault()` to prevent sorting."
                 },
                 "complexType": {
                     "original": "{\n    column: ColumnRegular;\n    order: 'desc' | 'asc';\n    additive: boolean;\n  }",
@@ -1905,7 +1912,7 @@ export class RevoGridComponent {
                 "composed": true,
                 "docs": {
                     "tags": [],
-                    "text": "By `sorting.plugin.ts`\n<br>Same as `beforesorting` but triggered after `beforeanysource` (when source is changed).\n<br>Use `e.preventDefault()` to prevent sorting data change."
+                    "text": "By `SortingPlugin`\n<br>Same as `beforesorting` but triggered after `beforeanysource` (when source is changed).\n<br>Use `e.preventDefault()` to prevent sorting data change."
                 },
                 "complexType": {
                     "original": "{\n    type: DimensionRows;\n    sorting?: SortingOrder;\n  }",
@@ -1931,7 +1938,7 @@ export class RevoGridComponent {
                 "composed": true,
                 "docs": {
                     "tags": [],
-                    "text": "By `sorting.plugin.ts`\n<br> After `beforesorting`\n<br>Triggered after column data updated with new sorting order.\n<br>Use `e.preventDefault()` to prevent sorting data change."
+                    "text": "By `SortingPlugin`\n<br> After `beforesorting`\n<br>Triggered after column data updated with new sorting order.\n<br>Use `e.preventDefault()` to prevent sorting data change."
                 },
                 "complexType": {
                     "original": "{\n    column: ColumnRegular;\n    order: 'desc' | 'asc';\n    additive: boolean;\n  }",
@@ -2185,22 +2192,18 @@ export class RevoGridComponent {
                     "text": "Column updated"
                 },
                 "complexType": {
-                    "original": "{\n    columns: ColumnCollection;\n    order: Record<ColumnProp, 'asc' | 'desc' | undefined>;\n  }",
-                    "resolved": "{ columns: ColumnCollection; order: Record<ColumnProp, \"asc\" | \"desc\" | undefined>; }",
+                    "original": "{\n    columns: ColumnCollection;\n    order: SortingOrder;\n  }",
+                    "resolved": "{ columns: ColumnCollection; order: SortingOrder; }",
                     "references": {
                         "ColumnCollection": {
                             "location": "import",
                             "path": "../../utils/column.utils",
                             "id": "src/utils/column.utils.ts::ColumnCollection"
                         },
-                        "Record": {
-                            "location": "global",
-                            "id": "global::Record"
-                        },
-                        "ColumnProp": {
+                        "SortingOrder": {
                             "location": "import",
-                            "path": "@type",
-                            "id": "src/types/index.ts::ColumnProp"
+                            "path": "../../plugins",
+                            "id": "src/plugins/index.ts::SortingOrder"
                         }
                     }
                 }
@@ -2421,11 +2424,11 @@ export class RevoGridComponent {
                 "composed": true,
                 "docs": {
                     "tags": [],
-                    "text": "Emitted when the sorting configuration is changed"
+                    "text": "Emitted when the sorting configuration is changed\nSortingPlugin subsribed to this event"
                 },
                 "complexType": {
                     "original": "SortingConfig",
-                    "resolved": "{ columns?: { prop: ColumnProp; order: Order; cellCompare?: CellCompareFunc | undefined; }[] | undefined; }",
+                    "resolved": "{ columns?: { prop: ColumnProp; order: Order; cellCompare?: CellCompareFunc | undefined; }[] | undefined; additive?: boolean | undefined; }",
                     "references": {
                         "SortingConfig": {
                             "location": "import",
@@ -3010,15 +3013,11 @@ export class RevoGridComponent {
             },
             "updateColumnSorting": {
                 "complexType": {
-                    "signature": "(column: ColumnRegular, index: number, order: \"asc\" | \"desc\" | undefined, additive: boolean) => Promise<ColumnRegular>",
+                    "signature": "(column: Pick<ColumnRegular, \"prop\" | \"cellCompare\">, order: \"asc\" | \"desc\" | undefined, additive: boolean) => Promise<void>",
                     "parameters": [{
                             "name": "column",
-                            "type": "ColumnRegular",
-                            "docs": "- full column details to update"
-                        }, {
-                            "name": "index",
-                            "type": "number",
-                            "docs": "- virtual column index"
+                            "type": "{ prop: ColumnProp; cellCompare?: CellCompareFunc | undefined; }",
+                            "docs": "- column prop and cellCompare"
                         }, {
                             "name": "order",
                             "type": "\"asc\" | \"desc\" | undefined",
@@ -3026,35 +3025,36 @@ export class RevoGridComponent {
                         }, {
                             "name": "additive",
                             "type": "boolean",
-                            "docs": "- if false will replace current order"
+                            "docs": "- if false will replace current order\n\nlater passed to SortingPlugin"
                         }],
                     "references": {
                         "Promise": {
                             "location": "global",
                             "id": "global::Promise"
                         },
+                        "Pick": {
+                            "location": "global",
+                            "id": "global::Pick"
+                        },
                         "ColumnRegular": {
                             "location": "import",
                             "path": "@type",
                             "id": "src/types/index.ts::ColumnRegular"
                         }
                     },
-                    "return": "Promise<ColumnRegular>"
+                    "return": "Promise<void>"
                 },
                 "docs": {
                     "text": "Update column sorting",
                     "tags": [{
                             "name": "param",
-                            "text": "column - full column details to update"
-                        }, {
-                            "name": "param",
-                            "text": "index - virtual column index"
+                            "text": "column - column prop and cellCompare"
                         }, {
                             "name": "param",
                             "text": "order - order to apply"
                         }, {
                             "name": "param",
-                            "text": "additive - if false will replace current order"
+                            "text": "additive - if false will replace current order\n\nlater passed to SortingPlugin"
                         }]
                 }
             },