@cdmx/wappler_ag_grid 1.7.2 → 1.7.4

package/README.md

@@ -37,50 +37,51 @@ To use the "Custom" theme, copy "ag-theme-custom.css" to public/css/ag-theme-cus
 6. **Floating Filter**: Specifies if the column has a floating filter. (Default: true)
 7. **Exclude Hidden Fields**: Specifies if Hidden fields are to be excluded in CSV export. (Default: false)
 8. **CSV Export**: Specifies if Export to CSV is enabled. (Default: true)
-9. **Enable RTL**: Enabled Right to Left, used for Hebrew and Arabic. (Default: false)
-10. **Column Hover Highlight**: Specifies column hover highlighting. (Default: true)
-11. **Suppress Row Deselection**: Specifies if rows can be deselected. (Default: false)
-12. **Pagination**: Enables pagination. (Default: true)
-13. **Auto Pagination**: Enables automatic pagination. (Default: false)
-14. **Page Limit Selectors**: Allowed selectors for for page size. Set to false to hide the page size selector. (Default: [20,50,100] ).
-15. **Page Limit**: Number of rows to show per page. (Default: 20)
-16. **Row Selection**: Row Selection (single or multiple).
+9. **Exclude Fields CSV**: Specifies fields to be excluded in CSV export. (Default: null)
+10. **Enable RTL**: Enabled Right to Left, used for Hebrew and Arabic. (Default: false)
+11. **Column Hover Highlight**: Specifies column hover highlighting. (Default: true)
+12. **Suppress Row Deselection**: Specifies if rows can be deselected. (Default: false)
+13. **Pagination**: Enables pagination. (Default: true)
+14. **Auto Pagination**: Enables automatic pagination. (Default: false)
+15. **Page Limit Selectors**: Allowed selectors for for page size. Set to false to hide the page size selector. (Default: [20,50,100] ).
+16. **Page Limit**: Number of rows to show per page. (Default: 20)
+17. **Row Selection**: Row Selection (single or multiple).
    - "Single"
    - "Multiple" (Default)
-17. **Timezone**: Timezone for Date Fields. Select the appropriate timezone from the dropdown list. (Default: Local)
-18. **Date Format**: Date Format for displaying date values. (Default: "dd/MM/yyyy hh:mm A")
-19. **Filter Field ID**: Specifies the field ID of the search field when using grid quick filter. Applicable when using Quick Filter feature of AG Grid, called from Dynamic Events on change event on the field. (Default: search_field)
-20. **Loading Overlay**: This enables loading overlay. (Default: false)
-21. **Loading Overlay Duration**: This sets loading overlay duration in ms. (Default: 500)
-22. **Sticky Header and Horizontal Scrollbar**:  Optionally specify the header offset and topbar class.
+18. **Timezone**: Timezone for Date Fields. Select the appropriate timezone from the dropdown list. (Default: Local)
+19. **Date Format**: Date Format for displaying date values. (Default: "dd/MM/yyyy hh:mm A")
+20. **Filter Field ID**: Specifies the field ID of the search field when using grid quick filter. Applicable when using Quick Filter feature of AG Grid, called from Dynamic Events on change event on the field. (Default: search_field)
+21. **Loading Overlay**: This enables loading overlay. (Default: false)
+22. **Loading Overlay Duration**: This sets loading overlay duration in ms. (Default: 500)
+23. **Sticky Header and Horizontal Scrollbar**:  Optionally specify the header offset and topbar class.
    - Fixed Header: Enables sticky header. (Default: false)
    - Header Offset: Specifies offset from the top of the viewport area (Optional). (Default: 100)
    - Topbar Class: Specify class, e.g., "topbar", to measure the offset from (Optional). (Default: "topbar")
    - Topbar Offset: Specify topbar offset (Default: 80)
    - Fixed Horizontal Scroll: Enables Hovering horizontal scrollbar which stays at the bottom all the time. (Default: false)
    - Fixed Horizontal Scroll Width: Fixed horizontal scroll width percentage. (Default: 80%)
-23. **Row Height**: Height of each row in pixels. (Default: Auto)
-24. **Header Height**: Height of the header row in pixels. (Default: Auto)
-25. **Wrap Header Text**: This will cause long headers to wrap. (Default: true)
-26. **Auto Header Height**: The header height is automatically set based on the content of the header. (Default: true)
-27. **Auto Height**: The height is automatically set based on the content of the cells. (Default: false)
-28. **Wrap Text**: This will cause long texts to wrap in the cells. (Default: false)
-29. **Center Align (V)**: Specifies if the cell data should be vertically centered. (Default: false)
-30. **Suppress Row Click Selection**: Disables row selection on row click. (Default: false)
-31. **Suppress Menu Hide**: Prevents hiding the column menu. (Default: false)
-32. **Suppress Movable Columns**: Disables moving columns. (Default: false)
-33. **Enable Cell Expressions**: Enables expressions in cell values. (Default: false)
-34. **Animate Rows**: Enables row animation on data changes. (Default: false)
-35. **Suppress Aggregation Function in Header**: Hides the aggregation function in column headers. (Default: false)
-36. **Suppress Clipboard Paste**: Disables pasting data from the clipboard. (Default: false)
-37. **Suppress Scroll on New Data**: Prevents scrolling to newly added data. (Default: false)
-38. **Suppress Property Names Check**: Disables checking for duplicate property names. (Default: false)
-39. **Hide ID Field**: Hides the ID Field in the Grid. (Default: false)
-40. **Numeric Column Align**: Align numeric columns to the right. (Default: false)
-41. **Row Click Events**: Enables row click events. This can be used in Dynamic events => Grid Events => Row Clicked. (Default: false)
-42. **Row Double Click Events**: Enables row double click events. This can be used in Dynamic events => Grid Events => Row Double Clicked. (Default: false)
-43. **Enable Row Selection**: Enables row selection. This can be used in Dynamic events => Grid Events => Checkbox Checked || Checkbox Unchecked. (Default: false)
-44. **Enable Row Status Toggle**: Enables row status toggle events. This can be used in Dynamic events => Grid Events => Checkbox Checked || Checkbox Unchecked. (Default: false)
+24. **Row Height**: Height of each row in pixels. (Default: Auto)
+25. **Header Height**: Height of the header row in pixels. (Default: Auto)
+26. **Wrap Header Text**: This will cause long headers to wrap. (Default: true)
+27. **Auto Header Height**: The header height is automatically set based on the content of the header. (Default: true)
+28. **Auto Height**: The height is automatically set based on the content of the cells. (Default: false)
+29. **Wrap Text**: This will cause long texts to wrap in the cells. (Default: false)
+30. **Center Align (V)**: Specifies if the cell data should be vertically centered. (Default: false)
+31. **Suppress Row Click Selection**: Disables row selection on row click. (Default: false)
+32. **Suppress Menu Hide**: Prevents hiding the column menu. (Default: false)
+33. **Suppress Movable Columns**: Disables moving columns. (Default: false)
+34. **Enable Cell Expressions**: Enables expressions in cell values. (Default: false)
+35. **Animate Rows**: Enables row animation on data changes. (Default: false)
+36. **Suppress Aggregation Function in Header**: Hides the aggregation function in column headers. (Default: false)
+37. **Suppress Clipboard Paste**: Disables pasting data from the clipboard. (Default: false)
+38. **Suppress Scroll on New Data**: Prevents scrolling to newly added data. (Default: false)
+39. **Suppress Property Names Check**: Disables checking for duplicate property names. (Default: false)
+40. **Hide ID Field**: Hides the ID Field in the Grid. (Default: false)
+41. **Numeric Column Align**: Align numeric columns to the right. (Default: false)
+42. **Row Click Events**: Enables row click events. This can be used in Dynamic events => Grid Events => Row Clicked. (Default: false)
+43. **Row Double Click Events**: Enables row double click events. This can be used in Dynamic events => Grid Events => Row Double Clicked. (Default: false)
+44. **Enable Row Selection**: Enables row selection. This can be used in Dynamic events => Grid Events => Checkbox Checked || Checkbox Unchecked. (Default: false)
+45. **Enable Row Status Toggle**: Enables row status toggle events. This can be used in Dynamic events => Grid Events => Checkbox Checked || Checkbox Unchecked. (Default: false)
 
 # Data Type Overrides
 
@@ -300,7 +301,7 @@ Configuration includes:
 
 ---
 
-# Set Filters
+# Set Filters and Sort Orders
 
 The "Set Filters" feature allows you to enable the setting of filters for columns in a user interface. This feature allows to preset filters when the grid is rendered.
 
@@ -313,6 +314,13 @@ Toggle to enable or disable the feature. When enabled, users can set filters for
   - **Filter Type**: The type of filter to apply, options available are: "Starts With," "Less Than," "Date From," "Greater Than," "Equals," and "Contains."
   - **Filter Value**: The Value/Filter to be applied.
 
+### Set Sort Orders
+Toggle to enable or disable the feature. When enabled, users can set sort orders for columns. (Default: false)
+
+  **Custom Sort Orders**: A grid that allows you to define custom sort orders.
+  - **Field**: The column name to sort.
+  - **Sort Order**: Select Ascending or Descending Order for the Field."
+
 ---
 
 # Configure Actions Column

package/app_connect/components.hjson

@@ -176,22 +176,6 @@
               "defaultValue": true,
               "help": "Specifies if the column has a floating filter"
             },
-            {
-              "name": "exportExcludeHidden",
-              "attribute": "dmx-bind:export_exclude_hidden_fields",
-              "title": "Exclude Hidden Fields",
-              "type": "boolean",
-              "defaultValue": false,
-              "help": "Specifies if Hidden fields are to be excluded in CSV export."
-            },
-            {
-              "name": "exportToCSV",
-              "attribute": "dmx-bind:export_to_csv",
-              "title": "CSV Export",
-              "type": "boolean",
-              "defaultValue": true,
-              "help": "Specifies if Export to CSV to be enabled"
-            },
             {
               "name": "enableRtl",
               "attribute": "dmx-bind:enable_rtl",
@@ -232,6 +216,29 @@
               "defaultValue": false,
               "help": "Built-in pagination size as per page size."
             },
+            {
+              "name": "exportToCSV",
+              "attribute": "dmx-bind:export_to_csv",
+              "title": "CSV Export",
+              "type": "boolean",
+              "defaultValue": true,
+              "help": "Specifies if Export to CSV to be enabled"
+            },
+            {
+              "name": "exportExcludeHidden",
+              "attribute": "dmx-bind:export_exclude_hidden_fields",
+              "title": "Exclude Hidden Fields",
+              "type": "boolean",
+              "defaultValue": false,
+              "help": "Specifies if Hidden fields are to be excluded in CSV export."
+            },
+            {
+              "name": "exportExcludeFields",
+              "attribute": "export_exclude_fields",
+              "title": "Exclude Fields CSV",
+              "type": "text",
+              "help": "Specifies fields to be excluded in CSV export (comma-seperated)."
+            },
             {
               "name": "paginationPageSizeSelector",
               "attribute": "dmx-bind:pagination_page_size_selector",
@@ -1625,7 +1632,7 @@
           ]
         },
         {
-          "group": "📒 Set Filters",
+          "group": "📒 Set Filters and Sort Orders",
           "variables": [
             {
               "name": "setFilters",
@@ -1690,6 +1697,57 @@
                   }
                 }
               ]
+            },
+            {
+              "name": "setSortOrders",
+              "title": "Set Sort Orders",
+              "attributeStartsWith": "dmx-bind",
+              "attribute": "set_sort_order",
+              "type": "boolean",
+              "defaultValue": false,
+              "display": "fieldset",
+              "show": ["listCustomSortOrder"],
+              "noChangeOnHide": true,
+              "groupEnabler": true,
+              "help": "Allows setting sort orders for columns",
+              "children": [
+                {
+                  "name": "listCustomSortOrder",
+                  "attribute": "dmx-bind:csort",
+                  "title": "Custom Sort Order",
+                  "type": "grid",
+                  "jsonFormat": true,
+                  "dataBindings": true,
+                  "encloseBT": true,
+                  "jsonBT": true,
+                  "initDisplay": "none",
+                  "columns": [
+                    {
+                      "field": "field",
+                      "caption": "Field",
+                      "editable": {
+                        "type": "text"
+                      }
+                    },
+                    {
+                      "field": "sort",
+                      "caption": "Sort Order",
+                      "editable": {
+                        "type": "list",
+                        "items": [
+                          {"id": "asc", "text": "Ascending"},
+                          {"id": "desc", "text": "Descending"}
+                        ]
+                      }
+                      "help": "Sort Order for the fields."
+                    }
+                  ],
+                  "newRecord": {
+                    "field": "",
+                    "sort": "asc"
+                  }
+                }
+              ]
             }
           ]
         },

package/dmx-ag-grid.js

@@ -27,6 +27,7 @@ dmx.Component('ag-grid', {
     cwidths: { type: Object, default: {} },
     ctypes: { type: Array, default: [] },
     cfilters: { type: Array, default: [] },
+    csort: { type: Array, default: [] },
     cstatic_select_editors: { type: Object, default: {} },
     cdynamic_select_editors: { type: Object, default: {} },
     cselect_placeholder: { type: String, default: "-" },
@@ -82,6 +83,7 @@ dmx.Component('ag-grid', {
     column_hover_highlight: { type: Boolean, default: true },
     quick_filter_field: { type: String, default: 'search_field' },
     export_exclude_hidden_fields: { type: Boolean, default: false },
+    export_exclude_fields: { type: String, default: null },
     export_to_csv: { type: Boolean, default: true },
     export_csv_filename: { type: String, default: 'export.csv' },
     fixed_header: { type: Boolean, default: false },
@@ -856,17 +858,17 @@ dmx.Component('ag-grid', {
 
         if ((displayDataChanges.length > 0) && displayDataChanges.some(change => change.field === params.colDef.field)) {
           const placeholderMap = Object.fromEntries(
-            Object.entries(params.data).map(([field, fieldValue]) => [`%${field}%`, fieldValue])
+              Object.entries(params.data).map(([field, fieldValue]) => [`%${field}%`, fieldValue !== null ? fieldValue : ''])
           );
           return displayDataChanges.reduce((cellData, change) => {
-            if (change.field === params.colDef.field) {
-              const placeholders = Object.keys(placeholderMap).join('|');
-              const regex = new RegExp(placeholders, 'g');
-              cellData = change.data.replace(regex, match => placeholderMap[match]);
-            }
-            return cellData;
+              if (change.field === params.colDef.field) {
+                  const placeholders = Object.keys(placeholderMap).join('|');
+                  const regex = new RegExp(placeholders + '|%[^%]+%', 'g');
+                  cellData = change.data.replace(regex, match => placeholderMap[match] || '');
+              }
+              return cellData;
           }, value);
-        }
+      }      
 
         // Check if there's a matching change in dataChanges
         const matchingChange = dataChanges.find(change => change.field === key && change.value === String(value));
@@ -1460,6 +1462,19 @@ dmx.Component('ag-grid', {
       },
       onGridReady: (params) => {
         const columnApi = params.columnApi.api;
+        if (options.csort && options.csort.length > 0) {
+          let sortModel = options.csort.map(function(sortItem, index) {
+              return {
+                  colId: sortItem.field,
+                  sort: sortItem.sort,
+                  sortIndex: index
+              };
+          });
+          columnApi.applyColumnState({
+              state: sortModel,
+              defaultState: { sort: null }
+          });
+        }
         hideColumn = (fieldToHide) => {
           columnApi.setColumnsVisible([fieldToHide], false);
         }
@@ -1781,6 +1796,7 @@ dmx.Component('ag-grid', {
     //CSV Export Function
     exportGridData = () => {
       const excludedColumnIds = ['checkboxColumn', 'actionsColumn']; 
+      const exportExcludeFieldsArray = options.export_exclude_fields ? options.export_exclude_fields.split(',') : [];
       // Extracting fields and colIds from columnDefs
       let fieldsAndColIds;
       if (options.group_config) {
@@ -1811,7 +1827,8 @@ dmx.Component('ag-grid', {
       }
       const fieldsToExport = fieldsAndColIds.filter((column) => {
         return !excludedColumnIds.includes(column.colId) &&
-               (!options.export_exclude_hidden_fields || !column.hide);
+               (!options.export_exclude_hidden_fields || !column.hide) &&
+               !exportExcludeFieldsArray.includes(column.field);
       }).map((column) => column.field);
       
       const params = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cdmx/wappler_ag_grid",
-    "version": "1.7.2",
+    "version": "1.7.4",
     "type": "module",
     "description": "App Connect module for AG Grid Table Generation.",
     "license": "MIT",