@skyux/data-manager 5.8.1 → 5.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bundles/skyux-data-manager.umd.js +47 -0
- package/documentation.json +106 -27
- package/esm2015/lib/modules/data-manager/data-manager-filter-context.js +3 -0
- package/esm2015/lib/modules/data-manager/data-manager-filter-context.js.map +1 -1
- package/esm2015/lib/modules/data-manager/models/data-manager-column-picker-sort-strategy.js +10 -0
- package/esm2015/lib/modules/data-manager/models/data-manager-column-picker-sort-strategy.js.map +1 -1
- package/esm2015/lib/modules/data-manager/models/data-manager-state-options.js.map +1 -1
- package/esm2015/lib/modules/data-manager/models/data-manager-state.js +21 -0
- package/esm2015/lib/modules/data-manager/models/data-manager-state.js.map +1 -1
- package/esm2015/lib/modules/data-manager/models/data-view-state-options.js.map +1 -1
- package/esm2015/lib/modules/data-manager/models/data-view-state.js +13 -0
- package/esm2015/lib/modules/data-manager/models/data-view-state.js.map +1 -1
- package/fesm2015/skyux-data-manager.js +47 -0
- package/fesm2015/skyux-data-manager.js.map +1 -1
- package/lib/modules/data-manager/data-manager-filter-context.d.ts +6 -0
- package/lib/modules/data-manager/models/data-manager-column-picker-sort-strategy.d.ts +10 -0
- package/lib/modules/data-manager/models/data-manager-state-options.d.ts +3 -3
- package/lib/modules/data-manager/models/data-manager-state.d.ts +41 -0
- package/lib/modules/data-manager/models/data-view-state-options.d.ts +2 -2
- package/lib/modules/data-manager/models/data-view-state.d.ts +20 -0
- package/package.json +9 -9
@@ -2,16 +2,57 @@ import { SkyDataManagerFilterData } from './data-manager-filter-data';
|
|
2
2
|
import { SkyDataManagerSortOption } from './data-manager-sort-option';
|
3
3
|
import { SkyDataManagerStateOptions } from './data-manager-state-options';
|
4
4
|
import { SkyDataViewState } from './data-view-state';
|
5
|
+
/**
|
6
|
+
* Provides options that control which data to display.
|
7
|
+
*/
|
5
8
|
export declare class SkyDataManagerState {
|
9
|
+
/**
|
10
|
+
* The selected SkyDataManagerSortOption to apply.
|
11
|
+
*/
|
6
12
|
activeSortOption: SkyDataManagerSortOption;
|
13
|
+
/**
|
14
|
+
* An untyped property that tracks any state information that's relevant to a data
|
15
|
+
* manager but that the existing properties do not cover.
|
16
|
+
*/
|
7
17
|
additionalData: any;
|
18
|
+
/**
|
19
|
+
* The state of the filters.
|
20
|
+
*/
|
8
21
|
filterData: SkyDataManagerFilterData;
|
22
|
+
/**
|
23
|
+
* Indicates whether to display only the selected rows or objects. The multiselect toolbar
|
24
|
+
* uses this property.
|
25
|
+
*/
|
9
26
|
onlyShowSelected: boolean;
|
27
|
+
/**
|
28
|
+
* The search text to apply.
|
29
|
+
*/
|
10
30
|
searchText: string;
|
31
|
+
/**
|
32
|
+
* The currently selected rows or objects.
|
33
|
+
*/
|
11
34
|
selectedIds: string[];
|
35
|
+
/**
|
36
|
+
* The states of the individual views.
|
37
|
+
*/
|
12
38
|
views: SkyDataViewState[];
|
13
39
|
constructor(data: SkyDataManagerStateOptions);
|
40
|
+
/**
|
41
|
+
* Returns the `SkyDataManagerStateOptions` for the data manager.
|
42
|
+
* @returns The `SkyDataManagerStateOptions` for the data manager.
|
43
|
+
*/
|
14
44
|
getStateOptions(): SkyDataManagerStateOptions;
|
45
|
+
/**
|
46
|
+
* Returns the `SkyDataViewState` for the specified view.
|
47
|
+
* @param viewId The ID for the view.
|
48
|
+
* @returns The `SkyDataViewState` for the specified view.
|
49
|
+
*/
|
15
50
|
getViewStateById(viewId: string): SkyDataViewState;
|
51
|
+
/**
|
52
|
+
* Adds a `SkyDataViewState` to a view or updates an existing view.
|
53
|
+
* @param viewId The ID for the view.
|
54
|
+
* @param view The `SkyDataViewState` option to add or update.
|
55
|
+
* @returns The state of the data manager for the specified view.
|
56
|
+
*/
|
16
57
|
addOrUpdateView(viewId: string, view: SkyDataViewState): SkyDataManagerState;
|
17
58
|
}
|
@@ -12,8 +12,8 @@ export interface SkyDataViewStateOptions {
|
|
12
12
|
*/
|
13
13
|
displayedColumnIds?: string[];
|
14
14
|
/**
|
15
|
-
* An untyped property that
|
16
|
-
* relevant to a data manager that existing properties do not cover.
|
15
|
+
* An untyped property that tracks any view-specific state information
|
16
|
+
* that is relevant to a data manager but that existing properties do not cover.
|
17
17
|
*/
|
18
18
|
additionalData?: any;
|
19
19
|
}
|
@@ -1,9 +1,29 @@
|
|
1
1
|
import { SkyDataViewStateOptions } from './data-view-state-options';
|
2
|
+
/**
|
3
|
+
* Provides options for defining how data is displayed, such as which columns appear.
|
4
|
+
*/
|
2
5
|
export declare class SkyDataViewState {
|
6
|
+
/**
|
7
|
+
* 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.
|
8
|
+
*/
|
3
9
|
columnIds: string[];
|
10
|
+
/**
|
11
|
+
* The IDs of the columns displayed for column-based views.
|
12
|
+
*/
|
4
13
|
displayedColumnIds: string[];
|
14
|
+
/**
|
15
|
+
* The ID of this view.
|
16
|
+
*/
|
5
17
|
viewId: string;
|
18
|
+
/**
|
19
|
+
* An untyped property that tracks any view-specific state information
|
20
|
+
* that is relevant to a data manager but that existing properties do not cover.
|
21
|
+
*/
|
6
22
|
additionalData: any;
|
7
23
|
constructor(data: SkyDataViewStateOptions);
|
24
|
+
/**
|
25
|
+
* Returns the `SkyDataViewStateOptions` for the current view.
|
26
|
+
* @returns The `SkyDataViewStateOptions`.
|
27
|
+
*/
|
8
28
|
getViewStateOptions(): SkyDataViewStateOptions;
|
9
29
|
}
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@skyux/data-manager",
|
3
|
-
"version": "5.8.
|
3
|
+
"version": "5.8.2",
|
4
4
|
"author": "Blackbaud, Inc.",
|
5
5
|
"keywords": [
|
6
6
|
"blackbaud",
|
@@ -19,14 +19,14 @@
|
|
19
19
|
"@angular/common": "^12.2.16",
|
20
20
|
"@angular/core": "^12.2.16",
|
21
21
|
"@angular/forms": "^12.2.16",
|
22
|
-
"@skyux/core": "5.8.
|
23
|
-
"@skyux/forms": "5.8.
|
24
|
-
"@skyux/i18n": "5.8.
|
25
|
-
"@skyux/indicators": "5.8.
|
26
|
-
"@skyux/layout": "5.8.
|
27
|
-
"@skyux/lists": "5.8.
|
28
|
-
"@skyux/lookup": "5.8.
|
29
|
-
"@skyux/modals": "5.8.
|
22
|
+
"@skyux/core": "5.8.2",
|
23
|
+
"@skyux/forms": "5.8.2",
|
24
|
+
"@skyux/i18n": "5.8.2",
|
25
|
+
"@skyux/indicators": "5.8.2",
|
26
|
+
"@skyux/layout": "5.8.2",
|
27
|
+
"@skyux/lists": "5.8.2",
|
28
|
+
"@skyux/lookup": "5.8.2",
|
29
|
+
"@skyux/modals": "5.8.2"
|
30
30
|
},
|
31
31
|
"dependencies": {
|
32
32
|
"tslib": "^2.3.1"
|