@skyux/data-manager 5.7.2 → 5.8.2

package/bundles/skyux-data-manager.umd.js

@@ -412,15 +412,28 @@
         return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
     }
 
+    /**
+     * Provides options for defining how data is displayed, such as which columns appear.
+     */
     var SkyDataViewState = /** @class */ (function () {
         function SkyDataViewState(data) {
+            /**
+             * The IDs of the columns able to be displayed for column-based views. This property is required when utilizing a grid-based view, a column picker, or both.
+             */
             this.columnIds = [];
+            /**
+             * The IDs of the columns displayed for column-based views.
+             */
             this.displayedColumnIds = [];
             this.viewId = data.viewId;
             this.columnIds = data.columnIds || [];
             this.displayedColumnIds = data.displayedColumnIds || [];
             this.additionalData = data.additionalData;
         }
+        /**
+         * Returns the `SkyDataViewStateOptions` for the current view.
+         * @returns The `SkyDataViewStateOptions`.
+         */
         SkyDataViewState.prototype.getViewStateOptions = function () {
             return {
                 viewId: this.viewId,
@@ -432,8 +445,14 @@
         return SkyDataViewState;
     }());
 
+    /**
+     * Provides options that control which data to display.
+     */
     var SkyDataManagerState = /** @class */ (function () {
         function SkyDataManagerState(data) {
+            /**
+             * The states of the individual views.
+             */
             this.views = [];
             var views = data.views && data.views.map(function (view) { return new SkyDataViewState(view); });
             this.activeSortOption = data.activeSortOption;
@@ -444,6 +463,10 @@
             this.searchText = data.searchText;
             this.views = views || [];
         }
+        /**
+         * Returns the `SkyDataManagerStateOptions` for the data manager.
+         * @returns The `SkyDataManagerStateOptions` for the data manager.
+         */
         SkyDataManagerState.prototype.getStateOptions = function () {
             var viewStates = this.views.map(function (view) {
                 return view.getViewStateOptions();
@@ -458,9 +481,20 @@
                 views: viewStates,
             };
         };
+        /**
+         * Returns the `SkyDataViewState` for the specified view.
+         * @param viewId The ID for the view.
+         * @returns The `SkyDataViewState` for the specified view.
+         */
         SkyDataManagerState.prototype.getViewStateById = function (viewId) {
             return this.views.find(function (view) { return view.viewId === viewId; });
         };
+        /**
+         * Adds a `SkyDataViewState` to a view or updates an existing view.
+         * @param viewId The ID for the view.
+         * @param view The `SkyDataViewState` option to add or update.
+         * @returns The state of the data manager for the specified view.
+         */
         SkyDataManagerState.prototype.addOrUpdateView = function (viewId, view) {
             var existingViewIndex = this.views.findIndex(function (v) { return v.viewId === viewId; });
             if (existingViewIndex !== -1) {
@@ -776,9 +810,19 @@
                 type: i0.Injectable
             }], ctorParameters: function () { return [{ type: i1__namespace.SkyUIConfigService }]; } });
 
+    /**
+     * These options specify the sorting strategy applied to columns when `columnPickerEnabled` is enabled.
+     */
     exports.SkyDataManagerColumnPickerSortStrategy = void 0;
     (function (SkyDataManagerColumnPickerSortStrategy) {
+        /**
+         * No sorting is applied to the columns.
+         */
         SkyDataManagerColumnPickerSortStrategy["None"] = "none";
+        /**
+         * If `sortEnabled` is set to `true`, then the selected columns are displayed before the unselected columns. Unselected columns are sorted alphabetically.
+         * If `sortEnabled` is set to `false`, then the columns are displayed in the order specified by `columnOptions`.
+         */
         SkyDataManagerColumnPickerSortStrategy["SelectedThenAlphabetical"] = "selectedThenAlphabetical";
     })(exports.SkyDataManagerColumnPickerSortStrategy || (exports.SkyDataManagerColumnPickerSortStrategy = {}));
 
@@ -876,6 +920,9 @@
                     }]
             }], ctorParameters: function () { return [{ type: i0__namespace.ChangeDetectorRef }, { type: SkyDataManagerService }]; } });
 
+    /**
+     * Sets the state of the filters.
+     */
     var SkyDataManagerFilterModalContext = /** @class */ (function () {
         function SkyDataManagerFilterModalContext() {
         }

package/documentation.json

@@ -37,6 +37,9 @@
         "kind": 8,
         "kindString": "Enumeration",
         "flags": {},
+        "comment": {
+          "shortText": "These options specify the sorting strategy applied to columns when `columnPickerEnabled` is enabled."
+        },
         "children": [
           {
             "id": 235,
@@ -44,10 +47,13 @@
             "kind": 16,
             "kindString": "Enumeration member",
             "flags": {},
+            "comment": {
+              "shortText": "No sorting is applied to the columns."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-column-picker-sort-strategy.ts",
-                "line": 2,
+                "line": 8,
                 "character": 2
               }
             ],
@@ -59,10 +65,13 @@
             "kind": 16,
             "kindString": "Enumeration member",
             "flags": {},
+            "comment": {
+              "shortText": "If `sortEnabled` is set to `true`, then the selected columns are displayed before the unselected columns. Unselected columns are sorted alphabetically.\nIf `sortEnabled` is set to `false`, then the columns are displayed in the order specified by `columnOptions`."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-column-picker-sort-strategy.ts",
-                "line": 3,
+                "line": 13,
                 "character": 2
               }
             ],
@@ -82,7 +91,7 @@
         "sources": [
           {
             "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-column-picker-sort-strategy.ts",
-            "line": 1,
+            "line": 4,
             "character": 12
           }
         ]
@@ -93,6 +102,9 @@
         "kind": 128,
         "kindString": "Class",
         "flags": {},
+        "comment": {
+          "shortText": "Sets the state of the filters."
+        },
         "children": [
           {
             "id": 227,
@@ -102,10 +114,13 @@
             "flags": {
               "isPublic": true
             },
+            "comment": {
+              "shortText": "Sets the state of the filters."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/data-manager-filter-context.ts",
-                "line": 4,
+                "line": 10,
                 "character": 9
               }
             ],
@@ -135,7 +150,7 @@
         "sources": [
           {
             "fileName": "projects/data-manager/src/modules/data-manager/data-manager-filter-context.ts",
-            "line": 3,
+            "line": 6,
             "character": 13
           }
         ]
@@ -982,6 +997,9 @@
         "kind": 128,
         "kindString": "Class",
         "flags": {},
+        "comment": {
+          "shortText": "Provides options that control which data to display."
+        },
         "children": [
           {
             "id": 255,
@@ -992,7 +1010,7 @@
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-state.ts",
-                "line": 16,
+                "line": 42,
                 "character": 2
               }
             ],
@@ -1033,10 +1051,13 @@
             "flags": {
               "isPublic": true
             },
+            "comment": {
+              "shortText": "The selected SkyDataManagerSortOption to apply."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-state.ts",
-                "line": 8,
+                "line": 14,
                 "character": 9
               }
             ],
@@ -1054,10 +1075,13 @@
             "flags": {
               "isPublic": true
             },
+            "comment": {
+              "shortText": "An untyped property that tracks any state information that's relevant to a data\nmanager but that the existing properties do not cover."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-state.ts",
-                "line": 9,
+                "line": 19,
                 "character": 9
               }
             ],
@@ -1074,10 +1098,13 @@
             "flags": {
               "isPublic": true
             },
+            "comment": {
+              "shortText": "The state of the filters."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-state.ts",
-                "line": 10,
+                "line": 23,
                 "character": 9
               }
             ],
@@ -1095,10 +1122,13 @@
             "flags": {
               "isPublic": true
             },
+            "comment": {
+              "shortText": "Indicates whether to display only the selected rows or objects. The multiselect toolbar\nuses this property."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-state.ts",
-                "line": 11,
+                "line": 28,
                 "character": 9
               }
             ],
@@ -1115,10 +1145,13 @@
             "flags": {
               "isPublic": true
             },
+            "comment": {
+              "shortText": "The search text to apply."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-state.ts",
-                "line": 12,
+                "line": 32,
                 "character": 9
               }
             ],
@@ -1135,10 +1168,13 @@
             "flags": {
               "isPublic": true
             },
+            "comment": {
+              "shortText": "The currently selected rows or objects."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-state.ts",
-                "line": 13,
+                "line": 36,
                 "character": 9
               }
             ],
@@ -1158,10 +1194,13 @@
             "flags": {
               "isPublic": true
             },
+            "comment": {
+              "shortText": "The states of the individual views."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-state.ts",
-                "line": 14,
+                "line": 40,
                 "character": 9
               }
             ],
@@ -1186,7 +1225,7 @@
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-state.ts",
-                "line": 49,
+                "line": 90,
                 "character": 9
               }
             ],
@@ -1197,6 +1236,10 @@
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
+                "comment": {
+                  "shortText": "Adds a `SkyDataViewState` to a view or updates an existing view.",
+                  "returns": "The state of the data manager for the specified view.\n"
+                },
                 "parameters": [
                   {
                     "id": 272,
@@ -1204,6 +1247,9 @@
                     "kind": 32768,
                     "kindString": "Parameter",
                     "flags": {},
+                    "comment": {
+                      "shortText": "The ID for the view."
+                    },
                     "type": {
                       "type": "intrinsic",
                       "name": "string"
@@ -1215,6 +1261,9 @@
                     "kind": 32768,
                     "kindString": "Parameter",
                     "flags": {},
+                    "comment": {
+                      "shortText": "The `SkyDataViewState` option to add or update."
+                    },
                     "type": {
                       "type": "reference",
                       "id": 306,
@@ -1241,7 +1290,7 @@
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-state.ts",
-                "line": 29,
+                "line": 59,
                 "character": 9
               }
             ],
@@ -1252,6 +1301,10 @@
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
+                "comment": {
+                  "shortText": "Returns the `SkyDataManagerStateOptions` for the data manager.",
+                  "returns": "The `SkyDataManagerStateOptions` for the data manager.\n"
+                },
                 "type": {
                   "type": "reference",
                   "id": 274,
@@ -1271,7 +1324,7 @@
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-state.ts",
-                "line": 45,
+                "line": 80,
                 "character": 9
               }
             ],
@@ -1282,6 +1335,10 @@
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
+                "comment": {
+                  "shortText": "Returns the `SkyDataViewState` for the specified view.",
+                  "returns": "The `SkyDataViewState` for the specified view.\n"
+                },
                 "parameters": [
                   {
                     "id": 269,
@@ -1289,6 +1346,9 @@
                     "kind": 32768,
                     "kindString": "Parameter",
                     "flags": {},
+                    "comment": {
+                      "shortText": "The ID for the view."
+                    },
                     "type": {
                       "type": "intrinsic",
                       "name": "string"
@@ -1338,7 +1398,7 @@
         "sources": [
           {
             "fileName": "projects/data-manager/src/modules/data-manager/models/data-manager-state.ts",
-            "line": 7,
+            "line": 10,
             "character": 13
           }
         ]
@@ -1349,6 +1409,9 @@
         "kind": 128,
         "kindString": "Class",
         "flags": {},
+        "comment": {
+          "shortText": "Provides options for defining how data is displayed, such as which columns appear."
+        },
         "children": [
           {
             "id": 307,
@@ -1359,7 +1422,7 @@
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-view-state.ts",
-                "line": 9,
+                "line": 25,
                 "character": 2
               }
             ],
@@ -1400,10 +1463,13 @@
             "flags": {
               "isPublic": true
             },
+            "comment": {
+              "shortText": "An untyped property that tracks any view-specific state information\nthat is relevant to a data manager but that existing properties do not cover."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-view-state.ts",
-                "line": 7,
+                "line": 23,
                 "character": 9
               }
             ],
@@ -1420,10 +1486,13 @@
             "flags": {
               "isPublic": true
             },
+            "comment": {
+              "shortText": "The IDs of the columns able to be displayed for column-based views. This property is required when utilizing a grid-based view, a column picker, or both."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-view-state.ts",
-                "line": 4,
+                "line": 10,
                 "character": 9
               }
             ],
@@ -1444,10 +1513,13 @@
             "flags": {
               "isPublic": true
             },
+            "comment": {
+              "shortText": "The IDs of the columns displayed for column-based views."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-view-state.ts",
-                "line": 5,
+                "line": 14,
                 "character": 9
               }
             ],
@@ -1468,10 +1540,13 @@
             "flags": {
               "isPublic": true
             },
+            "comment": {
+              "shortText": "The ID of this view."
+            },
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-view-state.ts",
-                "line": 6,
+                "line": 18,
                 "character": 9
               }
             ],
@@ -1491,7 +1566,7 @@
             "sources": [
               {
                 "fileName": "projects/data-manager/src/modules/data-manager/models/data-view-state.ts",
-                "line": 16,
+                "line": 36,
                 "character": 9
               }
             ],
@@ -1502,6 +1577,10 @@
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
+                "comment": {
+                  "shortText": "Returns the `SkyDataViewStateOptions` for the current view.",
+                  "returns": "The `SkyDataViewStateOptions`.\n"
+                },
                 "type": {
                   "type": "reference",
                   "id": 316,
@@ -1540,7 +1619,7 @@
         "sources": [
           {
             "fileName": "projects/data-manager/src/modules/data-manager/models/data-view-state.ts",
-            "line": 3,
+            "line": 6,
             "character": 13
           }
         ]
@@ -3887,7 +3966,7 @@
               "isOptional": true
             },
             "comment": {
-              "shortText": "An untyped property that can track any state information relevant to a data\nmanager that the existing properties do not cover."
+              "shortText": "An untyped property that tracks any state information that's relevant to a data\nmanager but that the existing properties do not cover."
             },
             "sources": [
               {
@@ -3910,7 +3989,7 @@
               "isOptional": true
             },
             "comment": {
-              "shortText": "The state of filters."
+              "shortText": "The state of the filters."
             },
             "sources": [
               {
@@ -4285,7 +4364,7 @@
               "isOptional": true
             },
             "comment": {
-              "shortText": "Inidicates whether to display the filter button for this view."
+              "shortText": "Indicates whether to display the filter button for this view."
             },
             "sources": [
               {
@@ -4625,7 +4704,7 @@
               "isOptional": true
             },
             "comment": {
-              "shortText": "An untyped property that can track any view-specific state information\nrelevant to a data manager that existing properties do not cover."
+              "shortText": "An untyped property that tracks any view-specific state information\nthat is relevant to a data manager but that existing properties do not cover."
             },
             "sources": [
               {
@@ -4808,7 +4887,7 @@
     {
       "fileName": "data-manager-demo.module.ts",
       "filePath": "/projects/data-manager/documentation/code-examples/data-manager/basic/data-manager-demo.module.ts",
-      "rawContents": "import { CommonModule } from '@angular/common';\nimport { NgModule } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { SkyDataManagerModule } from '@skyux/data-manager';\nimport { SkyCheckboxModule } from '@skyux/forms';\nimport { SkyCardModule, SkyToolbarModule } from '@skyux/layout';\nimport { SkyRepeaterModule } from '@skyux/lists';\nimport { SkyModalModule } from '@skyux/modals';\n\nimport { DataManagerFiltersModalDemoComponent } from './data-filter-modal.component';\nimport { DataManagerDemoComponent } from './data-manager-demo.component';\nimport { DataViewCardsDemoComponent } from './data-view-cards.component';\nimport { DataViewRepeaterDemoComponent } from './data-view-repeater.component';\n\n@NgModule({\n  declarations: [\n    DataManagerDemoComponent,\n    DataManagerFiltersModalDemoComponent,\n    DataViewCardsDemoComponent,\n    DataViewRepeaterDemoComponent,\n  ],\n  imports: [\n    CommonModule,\n    FormsModule,\n    SkyCardModule,\n    SkyCheckboxModule,\n    SkyDataManagerModule,\n    SkyModalModule,\n    SkyRepeaterModule,\n    SkyToolbarModule,\n  ],\n  exports: [DataManagerDemoComponent],\n})\nexport class DataManagerDemoModule {}\n"
+      "rawContents": "import { CommonModule } from '@angular/common';\nimport { NgModule } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { SkyDataManagerModule } from '@skyux/data-manager';\nimport { SkyCheckboxModule } from '@skyux/forms';\nimport { SkyCardModule, SkyToolbarModule } from '@skyux/layout';\nimport { SkyRepeaterModule } from '@skyux/lists';\nimport { SkyModalModule } from '@skyux/modals';\n\nimport { DataManagerFiltersModalDemoComponent } from './data-filter-modal.component';\nimport { DataManagerDemoComponent } from './data-manager-demo.component';\nimport { DataViewCardsDemoComponent } from './data-view-cards.component';\nimport { DataViewRepeaterDemoComponent } from './data-view-repeater.component';\n\n@NgModule({\n  declarations: [\n    DataManagerDemoComponent,\n    DataManagerFiltersModalDemoComponent,\n    DataViewCardsDemoComponent,\n    DataViewRepeaterDemoComponent,\n  ],\n  imports: [\n    CommonModule,\n    FormsModule,\n    SkyCardModule,\n    SkyCheckboxModule,\n    SkyDataManagerModule,\n    SkyModalModule,\n    SkyRepeaterModule,\n    SkyToolbarModule,\n  ],\n  exports: [DataManagerDemoComponent],\n  entryComponents: [\n    DataManagerDemoComponent,\n    DataManagerFiltersModalDemoComponent,\n  ],\n})\nexport class DataManagerDemoModule {}\n"
     },
     {
       "fileName": "data-view-cards.component.html",

package/esm2015/lib/modules/data-manager/data-manager-filter-context.js

@@ -1,3 +1,6 @@
+/**
+ * Sets the state of the filters.
+ */
 export class SkyDataManagerFilterModalContext {
 }
 //# sourceMappingURL=data-manager-filter-context.js.map

package/esm2015/lib/modules/data-manager/data-manager-filter-context.js.map

@@ -1 +1 @@
-{"version":3,"file":"data-manager-filter-context.js","sourceRoot":"","sources":["../../../../../../../../libs/components/data-manager/src/lib/modules/data-manager/data-manager-filter-context.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,gCAAgC;CAE5C","sourcesContent":["import { SkyDataManagerFilterData } from './models/data-manager-filter-data';\n\nexport class SkyDataManagerFilterModalContext {\n  public filterData: SkyDataManagerFilterData;\n}\n"]}
+{"version":3,"file":"data-manager-filter-context.js","sourceRoot":"","sources":["../../../../../../../../libs/components/data-manager/src/lib/modules/data-manager/data-manager-filter-context.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,gCAAgC;CAK5C","sourcesContent":["import { SkyDataManagerFilterData } from './models/data-manager-filter-data';\n\n/**\n * Sets the state of the filters.\n */\nexport class SkyDataManagerFilterModalContext {\n  /**\n   * Sets the state of the filters.\n   */\n  public filterData: SkyDataManagerFilterData;\n}\n"]}

package/esm2015/lib/modules/data-manager/models/data-manager-column-picker-sort-strategy.js

@@ -1,6 +1,16 @@
+/**
+ * These options specify the sorting strategy applied to columns when `columnPickerEnabled` is enabled.
+ */
 export var SkyDataManagerColumnPickerSortStrategy;
 (function (SkyDataManagerColumnPickerSortStrategy) {
+    /**
+     * No sorting is applied to the columns.
+     */
     SkyDataManagerColumnPickerSortStrategy["None"] = "none";
+    /**
+     * If `sortEnabled` is set to `true`, then the selected columns are displayed before the unselected columns. Unselected columns are sorted alphabetically.
+     * If `sortEnabled` is set to `false`, then the columns are displayed in the order specified by `columnOptions`.
+     */
     SkyDataManagerColumnPickerSortStrategy["SelectedThenAlphabetical"] = "selectedThenAlphabetical";
 })(SkyDataManagerColumnPickerSortStrategy || (SkyDataManagerColumnPickerSortStrategy = {}));
 //# sourceMappingURL=data-manager-column-picker-sort-strategy.js.map

package/esm2015/lib/modules/data-manager/models/data-manager-column-picker-sort-strategy.js.map

@@ -1 +1 @@
-{"version":3,"file":"data-manager-column-picker-sort-strategy.js","sourceRoot":"","sources":["../../../../../../../../../libs/components/data-manager/src/lib/modules/data-manager/models/data-manager-column-picker-sort-strategy.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,sCAGX;AAHD,WAAY,sCAAsC;IAChD,uDAAa,CAAA;IACb,+FAAqD,CAAA;AACvD,CAAC,EAHW,sCAAsC,KAAtC,sCAAsC,QAGjD","sourcesContent":["export enum SkyDataManagerColumnPickerSortStrategy {\n  None = 'none',\n  SelectedThenAlphabetical = 'selectedThenAlphabetical',\n}\n"]}
+{"version":3,"file":"data-manager-column-picker-sort-strategy.js","sourceRoot":"","sources":["../../../../../../../../../libs/components/data-manager/src/lib/modules/data-manager/models/data-manager-column-picker-sort-strategy.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,sCAUX;AAVD,WAAY,sCAAsC;IAChD;;OAEG;IACH,uDAAa,CAAA;IACb;;;OAGG;IACH,+FAAqD,CAAA;AACvD,CAAC,EAVW,sCAAsC,KAAtC,sCAAsC,QAUjD","sourcesContent":["/**\n * These options specify the sorting strategy applied to columns when `columnPickerEnabled` is enabled.\n */\nexport enum SkyDataManagerColumnPickerSortStrategy {\n  /**\n   * No sorting is applied to the columns.\n   */\n  None = 'none',\n  /**\n   * If `sortEnabled` is set to `true`, then the selected columns are displayed before the unselected columns. Unselected columns are sorted alphabetically.\n   * If `sortEnabled` is set to `false`, then the columns are displayed in the order specified by `columnOptions`.\n   */\n  SelectedThenAlphabetical = 'selectedThenAlphabetical',\n}\n"]}

package/esm2015/lib/modules/data-manager/models/data-manager-state-options.js.map

@@ -1 +1 @@
-{"version":3,"file":"data-manager-state-options.js","sourceRoot":"","sources":["../../../../../../../../../libs/components/data-manager/src/lib/modules/data-manager/models/data-manager-state-options.ts"],"names":[],"mappings":"","sourcesContent":["import { SkyDataManagerFilterData } from './data-manager-filter-data';\nimport { SkyDataManagerSortOption } from './data-manager-sort-option';\nimport { SkyDataViewStateOptions } from './data-view-state-options';\n\nexport interface SkyDataManagerStateOptions {\n  /**\n   * The selected SkyDataManagerSortOption to apply.\n   */\n  activeSortOption?: SkyDataManagerSortOption;\n  /**\n   * An untyped property that can track any state information relevant to a data\n   * manager that the existing properties do not cover.\n   */\n  additionalData?: any;\n  /**\n   * The state of filters.\n   */\n  filterData?: SkyDataManagerFilterData;\n  /**\n   * Indicates whether to display only the selected rows or objects. The multiselect toolbar\n   * uses this property.\n   */\n  onlyShowSelected?: boolean;\n  /**\n   * The search text to apply.\n   */\n  searchText?: string;\n  /**\n   * The currently selected rows or objects.\n   */\n  selectedIds?: string[];\n  /**\n   * The states of the individual views.\n   */\n  views?: SkyDataViewStateOptions[];\n}\n"]}
+{"version":3,"file":"data-manager-state-options.js","sourceRoot":"","sources":["../../../../../../../../../libs/components/data-manager/src/lib/modules/data-manager/models/data-manager-state-options.ts"],"names":[],"mappings":"","sourcesContent":["import { SkyDataManagerFilterData } from './data-manager-filter-data';\nimport { SkyDataManagerSortOption } from './data-manager-sort-option';\nimport { SkyDataViewStateOptions } from './data-view-state-options';\n\nexport interface SkyDataManagerStateOptions {\n  /**\n   * The selected SkyDataManagerSortOption to apply.\n   */\n  activeSortOption?: SkyDataManagerSortOption;\n  /**\n   * An untyped property that tracks any state information that's relevant to a data\n   * manager but that the existing properties do not cover.\n   */\n  additionalData?: any;\n  /**\n   * The state of the filters.\n   */\n  filterData?: SkyDataManagerFilterData;\n  /**\n   * Indicates whether to display only the selected rows or objects. The multiselect toolbar\n   * uses this property.\n   */\n  onlyShowSelected?: boolean;\n  /**\n   * The search text to apply.\n   */\n  searchText?: string;\n  /**\n   * The currently selected rows or objects.\n   */\n  selectedIds?: string[];\n  /**\n   * The states of the individual views.\n   */\n  views?: SkyDataViewStateOptions[];\n}\n"]}

package/esm2015/lib/modules/data-manager/models/data-manager-state.js

@@ -1,6 +1,12 @@
 import { SkyDataViewState } from './data-view-state';
+/**
+ * Provides options that control which data to display.
+ */
 export class SkyDataManagerState {
     constructor(data) {
+        /**
+         * The states of the individual views.
+         */
         this.views = [];
         const views = data.views && data.views.map((view) => new SkyDataViewState(view));
         this.activeSortOption = data.activeSortOption;
@@ -11,6 +17,10 @@ export class SkyDataManagerState {
         this.searchText = data.searchText;
         this.views = views || [];
     }
+    /**
+     * Returns the `SkyDataManagerStateOptions` for the data manager.
+     * @returns The `SkyDataManagerStateOptions` for the data manager.
+     */
     getStateOptions() {
         const viewStates = this.views.map((view) => {
             return view.getViewStateOptions();
@@ -25,9 +35,20 @@ export class SkyDataManagerState {
             views: viewStates,
         };
     }
+    /**
+     * Returns the `SkyDataViewState` for the specified view.
+     * @param viewId The ID for the view.
+     * @returns The `SkyDataViewState` for the specified view.
+     */
     getViewStateById(viewId) {
         return this.views.find((view) => view.viewId === viewId);
     }
+    /**
+     * Adds a `SkyDataViewState` to a view or updates an existing view.
+     * @param viewId The ID for the view.
+     * @param view The `SkyDataViewState` option to add or update.
+     * @returns The state of the data manager for the specified view.
+     */
     addOrUpdateView(viewId, view) {
         const existingViewIndex = this.views.findIndex((v) => v.viewId === viewId);
         if (existingViewIndex !== -1) {