Class: MetaManager
Class: MetaManager
Loads model`s metadata (properties) from buckets and provides functions to manage elements properties.
Hierarchy
EventTarget
↳
MetaManager
Properties
guidToNums
• guidToNums: Map
<string
, number
>
Map for mapping elements GUIDs to numbers.
instanceId
• instanceId: string
Unique instance id.
isIdbInstanceIncorrect
• isIdbInstanceIncorrect: boolean
Is if the ID of this Meta Manager matches the one stored in the IndexedDb "meta" table.
isShared
• isShared: boolean
Fetch model data from shared endpoints.
linkId
• Optional
linkId: string
Shared link id.
metaTree
• metaTree: any
[]
Tree with metadata nodes structure.
modelIds
• modelIds: Set
<string
>
Loaded model GUIDs.
numsToGuids
• numsToGuids: Map
<number
, string
>
Map for mapping elements numbers to GUIDs.
useCache
• useCache: boolean
Use server cache for lazy element properties loading or not.
Methods
collect
▸ collect(elNums?
): any
[]
Collects tree nodes by element nums.
Parameters
Name | Type | Description |
---|---|---|
elNums? | number | number [] | Element number or array of element numbers. |
Returns
any
[]
collectEndNodes
▸ collectEndNodes(node
): any
[]
Collect all element nodes for any parent node in meta tree.
Parameters
Name | Type | Description |
---|---|---|
node | any | Any parent node. |
Returns
any
[]
destroy
▸ destroy(): void
Destroy MetaManager and delete all data from browser store.
Returns
void
getElementGuid
▸ getElementGuid(elNum
): string
Get element GUID by element geometry number and local number.
Parameters
Name | Type |
---|---|
elNum | number |
Returns
string
getElementMetaByGuid
▸ getElementMetaByGuid(guid
): Promise
<any
>
Get element metadata by GUID.
Parameters
Name | Type | Description |
---|---|---|
guid | string | element GUID. |
Returns
Promise
<any
>
getElementMetaByNumbers
▸ getElementMetaByNumbers(elNum
): Promise
<any
>
Get element metadata by element numbers.
Parameters
Name | Type | Description |
---|---|---|
elNum | number | Element number. |
Returns
Promise
<any
>
getElementNums
▸ getElementNums(guid
): number
Get element numbers by GUID.
Parameters
Name | Type | Description |
---|---|---|
guid | string | element GUID. |
Returns
number
getElementsMetasByGuids
▸ getElementsMetasByGuids(guids
): Promise
<any
[]>
Get full metadata for specified elements.
Parameters
Name | Type | Description |
---|---|---|
guids | string [] | Elements GUIDs. |
Returns
Promise
<any
[]>
load
▸ load(ids
, isShared?
, linkId?
): Promise
<void
>
Load metadata.
Parameters
Name | Type | Description |
---|---|---|
ids | { id : any ; name : string }[] | Model GUID or model GUIDs string with comma separator or GUIDs array. |
isShared? | boolean | - |
linkId? | string | - |
Returns
Promise
<void
>
setCacheServerPath
▸ setCacheServerPath(path?
): MetaManager
Set server path to REST point for cache data loading.
Parameters
Name | Type | Description |
---|---|---|
path? | string | path to server REST point. |
Returns
setServer
▸ setServer(server?
, cacheServer?
): MetaManager
Set server URI for data loading.
Parameters
Name | Type | Description |
---|---|---|
server? | string | server URI. |
cacheServer? | string | cache server URI |
Returns
setServerPath
▸ setServerPath(path?
): MetaManager
Set server path to REST point for data loading.
Parameters
Name | Type | Description |
---|---|---|
path? | string | path to server REST point. |
Returns
setToken
▸ setToken(token
): MetaManager
Set access token for manager`s requests.
Parameters
Name | Type | Description |
---|---|---|
token | string | access token. |
Returns
traverse
▸ traverse(onNodeCallback?
, elNums?
, startNode?
): any
[]
Traverse all nodes in meta tree and search element node with given geometry number and element number. If geometry or element number undefined then traverse will scan and call callback function for every element node.
Parameters
Name | Type | Description |
---|---|---|
onNodeCallback? | Function | Callback function for founded node. |
elNums? | number | number [] | Element numbers list or single number. |
startNode? | any | Start node for traversing children nodes. |
Returns
any
[]
Callbacks
onAllLoaded
▸ onAllLoaded(allLoadedCallback
): MetaManager
Set callback function for event when all models are loaded.
Parameters
Name | Type | Description |
---|---|---|
allLoadedCallback | Function | function with plain Function signature. |
Returns
onError
▸ onError(errorCallback
): MetaManager
Set a callback for an event when a model will not be loaded due to an error.
Parameters
Name | Type | Description |
---|---|---|
errorCallback | ErrorCallbackFunction | function with ErrorCallbackFunction signature. |
Returns
onLoaded
▸ onLoaded(loadedCallback
): MetaManager
Set callback function for event when each model is loaded.
Parameters
Name | Type | Description |
---|---|---|
loadedCallback | LoadedCallbackFunction | function with LoadedCallbackFunction signature. |