@easydata/crud 1.4.6 → 1.4.7

package/dist/bundles/easydata.crud.js

@@ -4492,7 +4492,9 @@ var easy_grid_spreadArrays = (undefined && undefined.__spreadArrays) || function
 
 var DEFAULT_ROW_HEIGHT = 36;
 var DEFAULT_ROW_COUNT = 15;
+/** Represents a grid widget with columns rows, paging, custom rendering and more */
 var easy_grid_EasyGrid = /** @class */ (function () {
+    /** Creates and initializes all internal properties of the grid object */
     function EasyGrid(options) {
         this.cssPrefix = "keg";
         this.pagination = { page: 1, pageSize: 30, total: 0 };
@@ -4634,6 +4636,7 @@ var easy_grid_EasyGrid = /** @class */ (function () {
             this.slot = slot;
         }
     };
+    /** Initializes grid widget according to the options passed in the parameter */
     EasyGrid.prototype.init = function (options) {
         var _this = this;
         if (options.onInit) {
@@ -4697,6 +4700,10 @@ var easy_grid_EasyGrid = /** @class */ (function () {
         this.refresh();
         this.fireEvent('init');
     };
+    /** Fires a grid event. You can pass either an event type
+     * (like 'init', 'rowClick', 'pageChanged', etc )
+     * or a ready-to-use grid event object
+     * */
     EasyGrid.prototype.fireEvent = function (event) {
         if (typeof event === "string") {
             this.eventEmitter.fire(event);
@@ -4705,20 +4712,26 @@ var easy_grid_EasyGrid = /** @class */ (function () {
             this.eventEmitter.fire(event.type, event);
         }
     };
+    /** Allows to set the data (represented by a EasyDataTable object)
+     *  or to replace the existing one associated with the grid */
     EasyGrid.prototype.setData = function (data) {
         this.dataTable = data;
         this.clear();
         this.refresh();
     };
+    /** Returns the EasyDataTable object associated with the grid via `setData()` call */
     EasyGrid.prototype.getData = function () {
         return this.dataTable;
     };
+    /** Gets the list of grid columns */
     EasyGrid.prototype.getColumns = function () {
         return this.columns;
     };
+    /** This function is called when the grid is destroyed */
     EasyGrid.prototype.destroy = function () {
         this.slot.innerHTML = "";
     };
+    /** Clears the current DOM object and re-renders everything from the scratch */
     EasyGrid.prototype.refresh = function () {
         this.clearDOM();
         this.render();
@@ -4726,10 +4739,12 @@ var easy_grid_EasyGrid = /** @class */ (function () {
     EasyGrid.prototype.clearDOM = function () {
         this.slot.innerHTML = '';
     };
+    /** Clears all DOM object in the grid and return it to its initial state */
     EasyGrid.prototype.clear = function () {
         this.pagination.page = 1;
         this.clearDOM();
     };
+    /** Renders the grid */
     EasyGrid.prototype.render = function () {
         var _this = this;
         if (!this.hasData() && !this.options.showPlusButton)
@@ -5284,6 +5299,7 @@ var easy_grid_EasyGrid = /** @class */ (function () {
         }
         return cellElement;
     };
+    /** Sets current grid pages (if paging is used) */
     EasyGrid.prototype.setPage = function (page) {
         this.pagination.page = page;
         this.fireEvent({ type: "pageChanged", page: page });
@@ -5530,9 +5546,11 @@ var easy_grid_EasyGrid = /** @class */ (function () {
             return rows[index];
         return null;
     };
+    /** Makes the grid focused for keyboard events */
     EasyGrid.prototype.focus = function () {
         this.bodyViewportDiv.focus();
     };
+    /** Resizes columns according to the data they represent */
     EasyGrid.prototype.resizeColumns = function () {
         if (this.options.columnWidths.autoResize === AutoResizeColumns.Never)
             return;