@vizzly/services 0.9.0-dev-2d979a445fd606b68765ccef941c2029627f665c → 0.9.0
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.
|
@@ -3,12 +3,8 @@ import { Cell } from './CellServices';
|
|
|
3
3
|
import * as ViewServices from './ViewServices';
|
|
4
4
|
/**
|
|
5
5
|
* Represents a Library class.
|
|
6
|
-
* @param components
|
|
6
|
+
* @param components An optional array of Component instances to initialize the library.
|
|
7
7
|
*/
|
|
8
|
-
declare type LibrayView = {
|
|
9
|
-
component: ViewServices.View;
|
|
10
|
-
uniqueViewId: string;
|
|
11
|
-
};
|
|
12
8
|
export declare class Library {
|
|
13
9
|
/**
|
|
14
10
|
* An array of Cell instances representing the cells in the library.
|
|
@@ -17,28 +13,24 @@ export declare class Library {
|
|
|
17
13
|
/**
|
|
18
14
|
* Creates a new instance of a Library.
|
|
19
15
|
* @param attributes An optional object containing the attributes of the library.
|
|
20
|
-
* @param components The `component` instance to be added to the library. `uniqueViewId` of the component, should always be the same and not auto-generated.
|
|
21
16
|
*/
|
|
22
17
|
constructor(attributes?: {
|
|
23
|
-
components?:
|
|
18
|
+
components?: ViewServices.View[];
|
|
24
19
|
});
|
|
25
20
|
/**
|
|
26
21
|
* Adds a cell to the library at a specified position or appends it at the end if no position is specified.
|
|
27
22
|
* @param component The Component instance to be added to the library.
|
|
28
|
-
* @param uniqueViewId The unique view id of the component, should always be the same and not auto-generated.
|
|
29
23
|
* @param attributes An optional object containing the attributes of the cell.
|
|
30
|
-
* @example library.addComponent(Vizzly.AreaChart
|
|
31
|
-
* @example library.addComponent(Vizzly.AreaChart,
|
|
24
|
+
* @example library.addComponent(Vizzly.AreaChart);
|
|
25
|
+
* @example library.addComponent(Vizzly.AreaChart, { position: 0 });
|
|
32
26
|
*/
|
|
33
|
-
addComponent(component: ViewServices.View,
|
|
27
|
+
addComponent(component: ViewServices.View, attributes?: {
|
|
34
28
|
position?: number;
|
|
35
29
|
localFilters?: AdditionalFilter[];
|
|
36
30
|
}): void;
|
|
37
31
|
/**
|
|
38
32
|
* Adds an array of cells to the library.
|
|
39
|
-
* @param components
|
|
33
|
+
* @param components An array of Component instances.
|
|
40
34
|
*/
|
|
41
|
-
addComponents(components:
|
|
35
|
+
addComponents(components: ViewServices.View[]): void;
|
|
42
36
|
}
|
|
43
|
-
export declare const mergeInViewId: (component: ViewServices.View, uniqueViewId: string) => ViewServices.View;
|
|
44
|
-
export {};
|
|
@@ -26,5 +26,4 @@ export declare const updateLibraryWithProtectedComponents: (dashboards: Dashboar
|
|
|
26
26
|
export declare function resetToParentDashboard(dashboard: Dashboard, dashboards: Dashboard[], parentDashboardId: string): Dashboard;
|
|
27
27
|
export declare const buildProgrammaticDashboard: (programaticDashboards: Partial<SaveableDashboardDefinition>[], dataSets: DataSet[]) => Dashboard[];
|
|
28
28
|
export declare function updateWithProgrammaticDashboard(allDashboards: Dashboard[], programmaticDashboards: Dashboard[]): Dashboard[];
|
|
29
|
-
export declare const addUniqueLibraryComponents: (programmaticLibrary: ComponentType[], dashboardLibrary: ComponentType[]) => ComponentType[];
|
|
30
29
|
export declare const checkAndReturnProgrammaticDashboardId: (dashboards: Dashboard[]) => string | undefined;
|
package/package.json
CHANGED