@skyux/data-manager 5.8.1 → 5.8.4

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() {
         }
@@ -1148,7 +1195,6 @@
             this.dataManagerService = dataManagerService;
             this.instance = instance;
             this.libResources = libResources;
-            this.title = 'Choose columns to show in the list';
             this.viewConfig = {
                 id: 'columnPicker',
                 name: 'Column Picker',