Data JS API
DataJsAPI.API
Methods​
createScene​
â–¸ createScene(scene): Promise<{ error?: string ; success?: boolean }>
Create scene
Parameters​
| Name | Type | Description |
|---|---|---|
scene | SceneDefinition | SceneDefinition |
Returns​
Promise<{ error?: string ; success?: boolean }>
Remarks
Only administrator may reate a scene. Definition automatically saves to storage for future use.
Throws
Error in case of insufficient access rights.
deleteResource​
â–¸ deleteResource(id): Promise<boolean>
Delete the specified resource from cloud storage.
Parameters​
| Name | Type | Description |
|---|---|---|
id | string | The resource id (guid) |
Returns​
Promise<boolean>
A boolean promise indicating when the operation is complete succesfully/failed.
Remarks
Only administrator may delete a resource.
Throws
Error in case of insufficient access rights.
deleteScene​
â–¸ deleteScene(id): Promise<boolean>
Delete the specified scene from cloud storage.
Parameters​
| Name | Type | Description |
|---|---|---|
id | string | The scene id (guid) |
Returns​
Promise<boolean>
A boolean promise indicating when the operation is complete succesfully/failed.
Remarks
Only scene owners may delete a scene. The scene will be permanently lost and any references to it becomes invalid.
Throws
Error in case of insufficient access rights.
fetch​
â–¸ fetch(path, init?): Promise<Response>
Relative custom path request
Parameters​
| Name | Type |
|---|---|
path | string |
init? | RequestInit |
Returns​
Promise<Response>
getBookmarks​
â–¸ getBookmarks(id, options?): Promise<Bookmark[]>
Parameters​
| Name | Type |
|---|---|
id | string |
options? | Object |
options.group? | string |
options.personal? | boolean |
Returns​
Promise<Bookmark[]>
getGroupIds​
â–¸ getGroupIds(sceneId, id): Promise<number[]>
Parameters​
| Name | Type |
|---|---|
sceneId | string |
id | string |
Returns​
Promise<number[]>
getProcessProgress​
â–¸ getProcessProgress(id, position?, signal?): Promise<ProcessProgress>
Get process progress
Parameters​
| Name | Type | Description |
|---|---|---|
id | string | A process id |
position? | number | A position returned by previous process progress |
signal? | AbortSignal | - |
Returns​
Promise<ProcessProgress>
State of process ProcessProgress
getProcesses​
â–¸ getProcesses(): Promise<readonly ActiveProcess[]>
Get list of active processes.
Returns​
Promise<readonly ActiveProcess[]>
getResource​
â–¸ getResource(id): Promise<ResourcePreview>
Get preview of the specified resource from cloud storage.
Parameters​
| Name | Type | Description |
|---|---|---|
id | string | The scene id (guid) |
Returns​
Promise<ResourcePreview>
Returns ResourcePreview
Remarks
Only administrator may access resources.
Throws
Error in case of insufficient access rights.
getResources​
â–¸ getResources(): Promise<Resource[]>
Get list of available resources.
Returns​
Promise<Resource[]>
Remarks
The list contains only those resources available to the currently authenticated user. Only administrator could access to resources.
getSceneDefinition​
â–¸ getSceneDefinition(id): Promise<SceneDefinition>
Get saved scene definition using for createScene
Parameters​
| Name | Type |
|---|---|
id | string |
Returns​
Promise<SceneDefinition>
getScenes​
â–¸ getScenes(): Promise<readonly ScenePreview[]>
Get list of available scenes.
Returns​
Promise<readonly ScenePreview[]>
Remarks
The list contains only those scenes available to the currently authenticated user. For anonymous users, only public scenes are available.
getUserInformation​
â–¸ getUserInformation(): Promise<{ features: any ; name: string ; organization: string ; role: string }>
Get information about currently authenticated user
Returns​
Promise<{ features: any ; name: string ; organization: string ; role: string }>
getWKZones​
â–¸ getWKZones(): string[]
Returns​
string[]
latLon2tm​
â–¸ latLon2tm(coords, tmZone): vec3
Parameters​
| Name | Type |
|---|---|
coords | GeoLocation |
tmZone | string |
Returns​
vec3
loadScene​
â–¸ loadScene(id): Promise<SceneData | SceneLoadFail>
Parameters​
| Name | Type |
|---|---|
id | string |
Returns​
Promise<SceneData | SceneLoadFail>
putScene​
â–¸ putScene(scene): Promise<boolean>
Parameters​
| Name | Type |
|---|---|
scene | SceneData |
Returns​
Promise<boolean>
saveBookmarks​
â–¸ saveBookmarks(id, bookmarks, options?): Promise<boolean>
Parameters​
| Name | Type |
|---|---|
id | string |
bookmarks | Bookmark[] |
options? | Object |
options.group? | string |
options.personal? | boolean |
Returns​
Promise<boolean>
tm2LatLon​
â–¸ tm2LatLon(position, tmZone): GeoLocation
Parameters​
| Name | Type |
|---|---|
position | vec3 |
tmZone | string |
Returns​
GeoLocation
updateResource​
â–¸ updateResource(resource): Promise<boolean>
Update the specified resource in cloud storage.
Parameters​
| Name | Type | Description |
|---|---|---|
resource | Resource | The Resource |
Returns​
Promise<boolean>
A boolean promise indicating when the operation is complete succesfully/failed.
Remarks
Only administrator may update a resource.
Throws
Error in case of insufficient access rights.
uploadResource​
â–¸ uploadResource(file, progress, revisionOf?, path?, split?): Promise<{ error?: string ; processId?: string }>
Upload resource file
Parameters​
| Name | Type |
|---|---|
file | File |
progress | (progress: number) => void |
revisionOf? | string |
path? | string |
split? | boolean |
Returns​
Promise<{ error?: string ; processId?: string }>