@globalpayments/vega 2.24.0 → 2.25.0

package/dist/collection/components/vega-table/vega-table.js

@@ -32,6 +32,9 @@ import { ImmutableMap } from '../../helpers/immutable/immutable-map';
 import { VegaTableRenderModeController } from './slimmers/controllers/vega-table-render-mode-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaTableRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-table/runtime-metrics-payload-definition';
+/**
+ * @version 1.3.0
+ */
 export class VegaTable {
   constructor() {
     this.globalSlimmers = {};
@@ -100,13 +103,17 @@ export class VegaTable {
     this.isSelectedAll = false;
     /**
      * Defines the columns of the table.
+     *
+     * @version 1.3.0
      */
     this.columns = [];
     /**
      * Contains the data records to be rendered and
      *    displayed within the table.
+     *
+     * @version 1.3.0
      */
-    // eslint-disable-next-line @stencil/strict-mutable
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.dataSource = [];
     /**
      * Defines the behavior and options related to
@@ -114,8 +121,10 @@ export class VegaTable {
      *
      * It allows users to select one or more rows in
      *    the table for further actions or processing.
+     *
+     * @version 1.3.0
      */
-    // eslint-disable-next-line @stencil/strict-mutable
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.rowSelection = null;
     /**
      * Specifies whether rows in the table can be expanded
@@ -123,58 +132,82 @@ export class VegaTable {
      */
     /**
      * Indicates whether the row is expandable.
+     *
+     * @version 1.3.0
      */
     this.rowExpandable = false;
     /**
      * Specifies whether rows in the table can be clicked.
      *    If enabled, a `vegaRowClick` event will be
      *    dispatched when a row is clicked.
+     *
+     * @version 1.3.0
      */
     this.rowClickable = false;
     /**
      * Specifies whether dividers should be displayed
      *    between rows in the table.
+     *
+     * @version 1.3.0
      */
     this.rowDivider = false;
     /**
      * Specifies whether dividers should be displayed
      *    between columns in the table.
+     *
+     * @version 1.3.0
      */
     this.columnDivider = false;
     /**
      * Specifies whether alternate colors should be applied
      *    to the rows of the table.
+     *
+     * @version 1.3.0
      */
     this.striped = true;
     /**
      * Specifies the negative space within the table's cells.
+     *
+     * @version 1.3.0
      */
     this.density = 'default';
     /**
      * Controls the amount of horizontal padding applied to the table.
+     *
+     * @version 1.3.0
      */
     this.paddingX = ['8px', '8px'];
     /**
      * Specifies whether the table header should be displayed.
+     *
+     * @version 1.3.0
      */
     this.showHeader = true;
     /**
      * Specifies the pagination configuration.
+     *
+     * @version 1.5.0
      */
     this.pagination = null;
     /**
      * Provides a customized message or description that is
      *    shown when the table's data source is empty.
+     *
+     * @version 1.7.0
      */
     this.emptyDescription = 'There is no data to display';
     /**
      * Defines a unique key for each row in the table.
+     *
+     * @version 1.9.2
      */
     this.rowKey = 'key';
     /**
      * Defines the column sorting options
      * Has optional property type: single | multiple
      * If not specified, it defaults to multiple column sorting
+     *
+     * @version 2.22.0
      */
     this.sortConfig = { type: 'multiple' };
   }
@@ -237,6 +270,7 @@ export class VegaTable {
    *    revealing additional content.
    *
    * @param rowKey
+   * @version 1.3.0
    */
   async openExpandRow(rowKey) {
     methodPlaceholder(rowKey);
@@ -245,12 +279,15 @@ export class VegaTable {
    * Invoke this method to close the expanded row with the specified `rowKey`.
    *
    * @param rowKey
+   * @version 1.3.0
    */
   async closeExpandRow(rowKey) {
     methodPlaceholder(rowKey);
   }
   /**
    * Invoke this method to close all expanded rows.
+   *
+   * @version 1.3.0
    */
   async closeAllExpandRow() {
     methodPlaceholder();
@@ -261,6 +298,7 @@ export class VegaTable {
    *    collapsed and collapsing it if it is currently expanded.
    *
    * @param rowKey
+   * @version 1.3.0
    */
   async toggleExpandRow(rowKey) {
     methodPlaceholder(rowKey);
@@ -268,6 +306,8 @@ export class VegaTable {
   /**
    * Invoke this method to clear the selected row keys,
    *    removing any current selection.
+   *
+   * @version 1.3.0
    */
   async clearSelection() {
     methodPlaceholder();
@@ -276,6 +316,8 @@ export class VegaTable {
    * Invoke this method to retrieve the selected row keys,
    *    provided an array or list of the keys representing
    *    the currently selected rows.
+   *
+   * @version 1.3.0
    */
   async getSelection() {
     return methodPlaceholder();
@@ -286,6 +328,7 @@ export class VegaTable {
    *    the desired selected rows.
    *
    * @param {string[]} keys - Row keys to be set as selected.
+   * @version 1.3.0
    */
   async setSelection(keys) {
     methodPlaceholder(keys);
@@ -295,6 +338,8 @@ export class VegaTable {
    *    with the specified `rowKey`.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   async startRowEditMode(rowKey) {
     methodPlaceholder(rowKey);
@@ -304,6 +349,8 @@ export class VegaTable {
    *    with the specified `rowKey`.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   async stopRowEditMode(rowKey) {
     methodPlaceholder(rowKey);
@@ -314,6 +361,8 @@ export class VegaTable {
    *    in the editing state.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   async stopAllRowEditMode() {
     methodPlaceholder();
@@ -326,6 +375,8 @@ export class VegaTable {
    * @param rowKey The row's unique key.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   async getRowData(rowKey) {
     return methodPlaceholder(rowKey);
@@ -336,6 +387,8 @@ export class VegaTable {
    *    associated with each row.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   async getRowsData() {
     return methodPlaceholder();
@@ -350,6 +403,8 @@ export class VegaTable {
    * @param optional rowKey
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   async getFormRef(rowKey) {
     return methodPlaceholder(rowKey);
@@ -361,6 +416,8 @@ export class VegaTable {
    * @returns {Promise<string>} the rowKey of the new row
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   async addNewRow(record = {}) {
     return methodPlaceholder(record);
@@ -373,6 +430,8 @@ export class VegaTable {
    * This action will not affect the editing mode of other rows.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   async saveEditRow(rowKey) {
     return methodPlaceholder(rowKey);
@@ -383,6 +442,8 @@ export class VegaTable {
    *    all rows in the table.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   async saveAllEditRows() {
     methodPlaceholder();
@@ -392,6 +453,8 @@ export class VegaTable {
    *    in the editing mode in the table.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   async getEditingRowsKey() {
     return methodPlaceholder();
@@ -403,6 +466,8 @@ export class VegaTable {
    * @param rowKey The rowKey of the row to remove.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   async removeRow(rowKey) {
     methodPlaceholder(rowKey);
@@ -436,7 +501,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Defines the columns of the table."
       },
       "defaultValue": "[]"
@@ -457,7 +525,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Contains the data records to be rendered and\n   displayed within the table."
       },
       "defaultValue": "[]"
@@ -478,7 +549,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Defines the behavior and options related to\n   row selection in the table.\n\nIt allows users to select one or more rows in\n   the table for further actions or processing."
       },
       "defaultValue": "null"
@@ -494,7 +568,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Indicates whether the row is expandable."
       },
       "attribute": "row-expandable",
@@ -512,7 +589,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies whether rows in the table can be clicked.\n   If enabled, a `vegaRowClick` event will be\n   dispatched when a row is clicked."
       },
       "attribute": "row-clickable",
@@ -530,7 +610,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies whether dividers should be displayed\n   between rows in the table."
       },
       "attribute": "row-divider",
@@ -548,7 +631,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies whether dividers should be displayed\n   between columns in the table."
       },
       "attribute": "column-divider",
@@ -566,7 +652,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies whether alternate colors should be applied\n   to the rows of the table."
       },
       "attribute": "striped",
@@ -593,7 +682,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the negative space within the table's cells."
       },
       "attribute": "density",
@@ -611,7 +703,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Controls the amount of horizontal padding applied to the table."
       },
       "defaultValue": "['8px', '8px']"
@@ -627,7 +722,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies whether the table header should be displayed."
       },
       "attribute": "show-header",
@@ -650,7 +748,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.5.0"
+          }],
         "text": "Specifies the pagination configuration."
       },
       "defaultValue": "null"
@@ -666,7 +767,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.7.0"
+          }],
         "text": "Provides a customized message or description that is\n   shown when the table's data source is empty."
       },
       "attribute": "empty-description",
@@ -684,7 +788,10 @@ export class VegaTable {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.9.2"
+          }],
         "text": "Defines a unique key for each row in the table."
       },
       "attribute": "row-key",
@@ -707,7 +814,10 @@ export class VegaTable {
       "required": false,
       "optional": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.29.0"
+          }],
         "text": "Customizes the behavior and appearance of the\n   scrollable container that wraps the table."
       }
     },
@@ -727,7 +837,10 @@ export class VegaTable {
       "required": false,
       "optional": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.22.0"
+          }],
         "text": "Defines the column sorting options\nHas optional property type: single | multiple\nIf not specified, it defaults to multiple column sorting"
       },
       "defaultValue": "{ type: 'multiple' }"
@@ -753,7 +866,10 @@ export class VegaTable {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "An event emitter notifying changes in the table data."
       },
       "complexType": {
@@ -776,6 +892,9 @@ export class VegaTable {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying changes in the table data."
       },
@@ -796,7 +915,10 @@ export class VegaTable {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "An event emitter notifying the click event of a row\n   in the table."
       },
       "complexType": {
@@ -819,6 +941,9 @@ export class VegaTable {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the click event of a row\n   in the table."
       },
@@ -839,7 +964,10 @@ export class VegaTable {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.24.0"
+          }],
         "text": "An event emitter notifying the expanded event of a row\n   in the table."
       },
       "complexType": {
@@ -862,6 +990,9 @@ export class VegaTable {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.24.0"
           }],
         "text": "An event emitter notifying the expanded event of a row\n   in the table."
       },
@@ -882,7 +1013,10 @@ export class VegaTable {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.18.0"
+          }],
         "text": "An event emitter notifying when the row selection changes."
       },
       "complexType": {
@@ -905,6 +1039,9 @@ export class VegaTable {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying when the selection state of all rows changes."
       },
@@ -925,7 +1062,10 @@ export class VegaTable {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.18.0"
+          }],
         "text": "An event emitter notifying changes in the selection of checkboxes,\n   particularly the \"Select All\" checkbox in the table header."
       },
       "complexType": {
@@ -948,6 +1088,9 @@ export class VegaTable {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying changes in the selection of checkboxes,\n   particularly the \"Select All\" checkbox in the table header."
       },
@@ -968,7 +1111,10 @@ export class VegaTable {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.23.0"
+          }],
         "text": "An event emitter notifying before the selected change when select/deselect one row"
       },
       "complexType": {
@@ -991,6 +1137,9 @@ export class VegaTable {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.23.0"
           }],
         "text": "An event emitter notifying before the selected change when select/deselect one row"
       },
@@ -1011,7 +1160,10 @@ export class VegaTable {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.23.0"
+          }],
         "text": "An event emitter notifying before the selected change when select/deselect all rows"
       },
       "complexType": {
@@ -1034,6 +1186,9 @@ export class VegaTable {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.23.0"
           }],
         "text": "An event emitter notifying before the selected change when select/deselect all rows"
       },
@@ -1071,6 +1226,9 @@ export class VegaTable {
         "tags": [{
             "name": "param",
             "text": "rowKey"
+          }, {
+            "name": "version",
+            "text": "1.3.0"
           }]
       }
     },
@@ -1096,6 +1254,9 @@ export class VegaTable {
         "tags": [{
             "name": "param",
             "text": "rowKey"
+          }, {
+            "name": "version",
+            "text": "1.3.0"
           }]
       }
     },
@@ -1112,7 +1273,10 @@ export class VegaTable {
       },
       "docs": {
         "text": "Invoke this method to close all expanded rows.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }]
       }
     },
     "toggleExpandRow": {
@@ -1137,6 +1301,9 @@ export class VegaTable {
         "tags": [{
             "name": "param",
             "text": "rowKey"
+          }, {
+            "name": "version",
+            "text": "1.3.0"
           }]
       }
     },
@@ -1153,7 +1320,10 @@ export class VegaTable {
       },
       "docs": {
         "text": "Invoke this method to clear the selected row keys,\n   removing any current selection.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }]
       }
     },
     "getSelection": {
@@ -1169,7 +1339,10 @@ export class VegaTable {
       },
       "docs": {
         "text": "Invoke this method to retrieve the selected row keys,\n   provided an array or list of the keys representing\n   the currently selected rows.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }]
       }
     },
     "setSelection": {
@@ -1194,6 +1367,9 @@ export class VegaTable {
         "tags": [{
             "name": "param",
             "text": "keys - Row keys to be set as selected."
+          }, {
+            "name": "version",
+            "text": "1.3.0"
           }]
       }
     },
@@ -1216,6 +1392,9 @@ export class VegaTable {
         "tags": [{
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
+          }, {
+            "name": "version",
+            "text": "1.19.0"
           }]
       }
     },
@@ -1238,6 +1417,9 @@ export class VegaTable {
         "tags": [{
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
+          }, {
+            "name": "version",
+            "text": "1.19.0"
           }]
       }
     },
@@ -1257,6 +1439,9 @@ export class VegaTable {
         "tags": [{
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
+          }, {
+            "name": "version",
+            "text": "1.19.0"
           }]
       }
     },
@@ -1289,6 +1474,9 @@ export class VegaTable {
           }, {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
+          }, {
+            "name": "version",
+            "text": "1.19.0"
           }]
       }
     },
@@ -1312,6 +1500,9 @@ export class VegaTable {
         "tags": [{
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
+          }, {
+            "name": "version",
+            "text": "1.19.0"
           }]
       }
     },
@@ -1340,6 +1531,9 @@ export class VegaTable {
           }, {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
+          }, {
+            "name": "version",
+            "text": "1.19.0"
           }]
       }
     },
@@ -1375,6 +1569,9 @@ export class VegaTable {
           }, {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
+          }, {
+            "name": "version",
+            "text": "1.19.0"
           }]
       }
     },
@@ -1397,6 +1594,9 @@ export class VegaTable {
         "tags": [{
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
+          }, {
+            "name": "version",
+            "text": "1.19.0"
           }]
       }
     },
@@ -1416,6 +1616,9 @@ export class VegaTable {
         "tags": [{
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
+          }, {
+            "name": "version",
+            "text": "1.19.0"
           }]
       }
     },
@@ -1435,6 +1638,9 @@ export class VegaTable {
         "tags": [{
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
+          }, {
+            "name": "version",
+            "text": "1.19.0"
           }]
       }
     },
@@ -1463,6 +1669,9 @@ export class VegaTable {
           }, {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
+          }, {
+            "name": "version",
+            "text": "1.19.0"
           }]
       }
     }