IWorkspaceLogicalModelService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Service for querying and changing the logical data model of a workspace.
export interface IWorkspaceLogicalModelService
Methods
Method | Description |
|---|---|
(ALPHA) Returns information about date datasets in the workspace. | |
(ALPHA) Returns the logical data model of the workspace in the declarative form. | |
(ALPHA) Replaces the logical data model and the analytical objects of the workspace in one request. | |
(ALPHA) Replaces the logical data model of the workspace. |
Method details
IWorkspaceLogicalModelService.getDatasets()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns information about date datasets in the workspace.
getDatasets(includeParents: boolean): Promise<IDateDataset[]>;
Parameters
Parameter | Type | Description |
|---|---|---|
includeParents | boolean | true if parents should be included/ |
Returns
Promise<IDateDataset[]>
IWorkspaceLogicalModelService.getDeclarativeModel()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns the logical data model of the workspace in the declarative form.
getDeclarativeModel(options?: IDeclarativeLogicalModelOptions): Promise<IDeclarativeLogicalModel>;
Parameters
Parameter | Type | Description |
|---|---|---|
options | (Optional) options of the read |
Returns
Promise<IDeclarativeLogicalModel>
IWorkspaceLogicalModelService.setDeclarativeLayout()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Replaces the logical data model and the analytical objects of the workspace in one request.
setDeclarativeLayout(layout: IDeclarativeWorkspaceLayout): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
layout | the logical data model and the analytical objects |
Returns
Promise<void>
Remarks
Use this to provision a workspace from a layout that the backend exported, for example demo content.
IWorkspaceLogicalModelService.setDeclarativeModel()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Replaces the logical data model of the workspace.
setDeclarativeModel(model: IDeclarativeLogicalModel): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
model | the new logical data model |
Returns
Promise<void>