@revolist/revogrid 4.15.2 → 4.15.3

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

@@ -50,47 +50,158 @@ import { PluginService } from "./plugin.service";
 */
 export class RevoGridComponent {
     constructor() {
-        this.extraElements = [];
-        this.pluginService = new PluginService();
-        this.viewport = null;
-        this.isInited = false;
-        this.rowHeaders = undefined;
+        /**
+         * Defines how many rows/columns should be rendered outside visible area.
+         */
         this.frameSize = 1;
+        /**
+         * Indicates default rgRow size.
+         * By default 0, means theme package size will be applied
+         *
+         * Alternatively you can use `rowSize` to reset viewport
+         */
         this.rowSize = 0;
+        /** Indicates default column size. */
         this.colSize = 100;
+        /** When true, user can range selection. */
         this.range = false;
+        /** When true, grid in read only mode. */
         this.readonly = false;
+        /** When true, columns are resizable. */
         this.resize = false;
+        /** When true cell focus appear. */
         this.canFocus = true;
+        /** When true enable clipboard. */
         this.useClipboard = true;
+        /**
+         * Columns - defines an array of grid columns.
+         * Can be column or grouped column.
+         */
         this.columns = [];
+        /**
+         * Source - defines main data source.
+         * Can be an Object or 2 dimensional array([][]);
+         * Keys/indexes referenced from columns Prop.
+         */
         this.source = [];
+        /** Pinned top Source: {[T in ColumnProp]: any} - defines pinned top rows data source. */
         this.pinnedTopSource = [];
+        /** Pinned bottom Source: {[T in ColumnProp]: any} - defines pinned bottom rows data source. */
         this.pinnedBottomSource = [];
+        /** Custom row properies to be applied. See `RowDefinition` for more info. */
         this.rowDefinitions = [];
+        /** Custom editors register. */
         this.editors = {};
+        /**
+         * Apply changes in editor when closed except 'Escape' cases.
+         * If custom editor in use method getValue required.
+         * Check interfaces.d.ts `EditorBase` for more info.
+         */
         this.applyOnClose = false;
+        /**
+         * Custom grid plugins. Can be added or removed at runtime.
+         * Every plugin should be inherited from BasePlugin class.
+         *
+         * For more details check [Plugin guide](https://rv-grid.com/guide/plugin/)
+         */
         this.plugins = [];
+        /**
+         * Column Types Format.
+         * Every type represent multiple column properties.
+         * Types will be merged but can be replaced with column properties.
+         * Types were made as separate objects to be reusable per multiple columns.
+         */
         this.columnTypes = {};
+        /** Theme name. */
         this.theme = 'default';
+        /**
+         * Row class property mapping.
+         * Map custom classes to rows from row object data.
+         * Define this property in rgRow object and this will be mapped as rgRow class.
+         */
         this.rowClass = '';
+        /**
+         * Autosize config.
+         * Enables columns autoSize.
+         * For more details check `autoSizeColumn` plugin.
+         * By default disabled, hence operation is not performance efficient.
+         * `true` to enable with default params (double header separator click for autosize).
+         * Or define config. See `AutoSizeColumnConfig` for more details.
+         */
         this.autoSizeColumn = false;
+        /**
+         * Enables filter plugin.
+         * Can be boolean.
+         * Or can be filter collection See `FilterCollection` for more info.
+         */
         this.filter = false;
-        this.sorting = undefined;
-        this.focusTemplate = undefined;
+        /**
+         * Enable column move plugin.
+         */
         this.canMoveColumns = false;
+        /**
+         * Trimmed rows.
+         * Functionality which allows to hide rows from main data set.
+         * `trimmedRows` are physical `rgRow` indexes to hide.
+         */
         this.trimmedRows = {};
+        /**
+         * Enable export plugin.
+         */
         this.exporting = false;
-        this.grouping = undefined;
+        /**
+         * Stretch strategy for columns by `StretchColumn` plugin.
+         * For example if there are more space on the right last column size would be increased.
+         */
         this.stretch = false;
+        /**
+         * Additional data to be passed to plugins, renders or editors.
+         * For example if you need to pass Vue component instance.
+         */
         this.additionalData = {};
+        /**
+         * Disable lazy rendering mode for the `X axis`.
+         * Use when not many columns present and you don't need rerenader cells during scroll.
+         * Can be used for initial rendering performance improvement.
+         */
         this.disableVirtualX = false;
+        /**
+         * Disable lazy rendering mode for the `Y axis`.
+         * Use when not many rows present and you don't need rerenader cells during scroll.
+         * Can be used for initial rendering performance improvement.
+         */
         this.disableVirtualY = false;
+        /**
+         * Please only hide the attribution if you are subscribed to Pro version
+         */
         this.hideAttribution = false;
+        /**
+         * Prevent rendering until job is done.
+         * Can be used for initial rendering performance improvement.
+         * When several plugins require initial rendering this will prevent double initial rendering.
+         */
         this.jobsBeforeRender = [];
+        /**
+         * Register new virtual node inside of grid.
+         * Used for additional items creation such as plugin elements.
+         * Should be set before grid render inside of plugins.
+         * Can return VNode result of h() function or a function that returns VNode.
+         * Function can be used for performance improvement and additional renders.
+         */
         this.registerVNode = [];
+        /**
+         * Enable accessibility. If disabled, the grid will not be accessible.
+         * @default true
+         */
         this.accessible = true;
+        /**
+         * Disable native drag&drop plugin.
+         */
         this.canDrag = true;
+        this.extraElements = [];
+        this.pluginService = new PluginService();
+        this.viewport = null;
+        this.isInited = false;
     }
     // #endregion
     // #region Methods
@@ -895,6 +1006,7 @@ export class RevoGridComponent {
         return {
             "rowHeaders": {
                 "type": "boolean",
+                "attribute": "row-headers",
                 "mutable": false,
                 "complexType": {
                     "original": "RowHeaders | boolean",
@@ -915,11 +1027,11 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "row-headers",
                 "reflect": false
             },
             "frameSize": {
                 "type": "number",
+                "attribute": "frame-size",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -934,12 +1046,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "frame-size",
                 "reflect": false,
                 "defaultValue": "1"
             },
             "rowSize": {
                 "type": "number",
+                "attribute": "row-size",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -954,12 +1066,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "row-size",
                 "reflect": false,
                 "defaultValue": "0"
             },
             "colSize": {
                 "type": "number",
+                "attribute": "col-size",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -974,12 +1086,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "col-size",
                 "reflect": false,
                 "defaultValue": "100"
             },
             "range": {
                 "type": "boolean",
+                "attribute": "range",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -994,12 +1106,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "range",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "readonly": {
                 "type": "boolean",
+                "attribute": "readonly",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1014,12 +1126,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "readonly",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "resize": {
                 "type": "boolean",
+                "attribute": "resize",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1034,12 +1146,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "resize",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "canFocus": {
                 "type": "boolean",
+                "attribute": "can-focus",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1054,12 +1166,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "can-focus",
                 "reflect": false,
                 "defaultValue": "true"
             },
             "useClipboard": {
                 "type": "boolean",
+                "attribute": "use-clipboard",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1074,12 +1186,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "use-clipboard",
                 "reflect": false,
                 "defaultValue": "true"
             },
             "columns": {
                 "type": "unknown",
+                "attribute": "columns",
                 "mutable": false,
                 "complexType": {
                     "original": "(ColumnRegular | ColumnGrouping)[]",
@@ -1109,6 +1221,7 @@ export class RevoGridComponent {
             },
             "source": {
                 "type": "unknown",
+                "attribute": "source",
                 "mutable": false,
                 "complexType": {
                     "original": "DataType[]",
@@ -1133,6 +1246,7 @@ export class RevoGridComponent {
             },
             "pinnedTopSource": {
                 "type": "unknown",
+                "attribute": "pinned-top-source",
                 "mutable": false,
                 "complexType": {
                     "original": "DataType[]",
@@ -1157,6 +1271,7 @@ export class RevoGridComponent {
             },
             "pinnedBottomSource": {
                 "type": "unknown",
+                "attribute": "pinned-bottom-source",
                 "mutable": false,
                 "complexType": {
                     "original": "DataType[]",
@@ -1181,6 +1296,7 @@ export class RevoGridComponent {
             },
             "rowDefinitions": {
                 "type": "unknown",
+                "attribute": "row-definitions",
                 "mutable": false,
                 "complexType": {
                     "original": "RowDefinition[]",
@@ -1205,6 +1321,7 @@ export class RevoGridComponent {
             },
             "editors": {
                 "type": "unknown",
+                "attribute": "editors",
                 "mutable": false,
                 "complexType": {
                     "original": "Editors",
@@ -1229,6 +1346,7 @@ export class RevoGridComponent {
             },
             "applyOnClose": {
                 "type": "boolean",
+                "attribute": "apply-on-close",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1243,12 +1361,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "apply-on-close",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "plugins": {
                 "type": "unknown",
+                "attribute": "plugins",
                 "mutable": false,
                 "complexType": {
                     "original": "GridPlugin[]",
@@ -1273,6 +1391,7 @@ export class RevoGridComponent {
             },
             "columnTypes": {
                 "type": "unknown",
+                "attribute": "column-types",
                 "mutable": false,
                 "complexType": {
                     "original": "{ [name: string]: ColumnType }",
@@ -1297,6 +1416,7 @@ export class RevoGridComponent {
             },
             "theme": {
                 "type": "string",
+                "attribute": "theme",
                 "mutable": true,
                 "complexType": {
                     "original": "Theme",
@@ -1317,12 +1437,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "theme",
                 "reflect": true,
                 "defaultValue": "'default'"
             },
             "rowClass": {
                 "type": "string",
+                "attribute": "row-class",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -1337,12 +1457,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "row-class",
                 "reflect": true,
                 "defaultValue": "''"
             },
             "autoSizeColumn": {
                 "type": "boolean",
+                "attribute": "auto-size-column",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean | AutoSizeColumnConfig",
@@ -1363,12 +1483,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "auto-size-column",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "filter": {
                 "type": "boolean",
+                "attribute": "filter",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean | ColumnFilterConfig",
@@ -1389,12 +1509,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "filter",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "sorting": {
                 "type": "unknown",
+                "attribute": "sorting",
                 "mutable": false,
                 "complexType": {
                     "original": "SortingConfig",
@@ -1418,6 +1538,7 @@ export class RevoGridComponent {
             },
             "focusTemplate": {
                 "type": "unknown",
+                "attribute": "focus-template",
                 "mutable": false,
                 "complexType": {
                     "original": "FocusTemplateFunc",
@@ -1441,6 +1562,7 @@ export class RevoGridComponent {
             },
             "canMoveColumns": {
                 "type": "boolean",
+                "attribute": "can-move-columns",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1455,12 +1577,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "can-move-columns",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "trimmedRows": {
                 "type": "unknown",
+                "attribute": "trimmed-rows",
                 "mutable": false,
                 "complexType": {
                     "original": "Record<number, boolean>",
@@ -1484,6 +1606,7 @@ export class RevoGridComponent {
             },
             "exporting": {
                 "type": "boolean",
+                "attribute": "exporting",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1498,12 +1621,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "exporting",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "grouping": {
                 "type": "unknown",
+                "attribute": "grouping",
                 "mutable": false,
                 "complexType": {
                     "original": "GroupingOptions",
@@ -1527,6 +1650,7 @@ export class RevoGridComponent {
             },
             "stretch": {
                 "type": "any",
+                "attribute": "stretch",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean | string",
@@ -1541,12 +1665,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "stretch",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "additionalData": {
                 "type": "unknown",
+                "attribute": "additional-data",
                 "mutable": false,
                 "complexType": {
                     "original": "AdditionalData",
@@ -1571,6 +1695,7 @@ export class RevoGridComponent {
             },
             "disableVirtualX": {
                 "type": "boolean",
+                "attribute": "disable-virtual-x",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1585,12 +1710,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "disable-virtual-x",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "disableVirtualY": {
                 "type": "boolean",
+                "attribute": "disable-virtual-y",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1605,12 +1730,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "disable-virtual-y",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "hideAttribution": {
                 "type": "boolean",
+                "attribute": "hide-attribution",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1625,12 +1750,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "hide-attribution",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "jobsBeforeRender": {
                 "type": "unknown",
+                "attribute": "jobs-before-render",
                 "mutable": false,
                 "complexType": {
                     "original": "Promise<any>[]",
@@ -1654,6 +1779,7 @@ export class RevoGridComponent {
             },
             "registerVNode": {
                 "type": "unknown",
+                "attribute": "register-v-node",
                 "mutable": false,
                 "complexType": {
                     "original": "(\n    | VNode\n    | ((c: ExtraNodeFuncConfig) => VNode)\n  )[]",
@@ -1683,6 +1809,7 @@ export class RevoGridComponent {
             },
             "accessible": {
                 "type": "boolean",
+                "attribute": "accessible",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1700,12 +1827,12 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "accessible",
                 "reflect": false,
                 "defaultValue": "true"
             },
             "canDrag": {
                 "type": "boolean",
+                "attribute": "can-drag",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1720,7 +1847,6 @@ export class RevoGridComponent {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "can-drag",
                 "reflect": false,
                 "defaultValue": "true"
             }