Class: MetaManager
Class: MetaManager
Loads model`s metadata (properties) from buckets and provides functions to manage elements properties.
Extends
EventTarget
Properties
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?
optionallinkId:string
Shared link id.
metaTree
metaTree:
ModelNode[]
Tree with metadata nodes structure.
models
models:
Map<string,MetaModel>
Loaded model GUIDs.
propTools
propTools:
PropTools
Tools for batch fetching properties for list of elements or all elements.
useCache
useCache:
boolean
Deprecated
Cache is always on.
Methods
addAutoEventListener()
addAutoEventListener(
eventType,eventListener,signal):void
Add event listener with automatic dispose.
Parameters
eventType
event type.
eventListener
EventListenerOrEventListenerObject
event listener.
signal
AbortSignal
optional abort signal for manual aborting event listener.
Returns
void
addModelNodes()
addModelNodes(
versionIds):void
Add new model nodes in model tree.
Parameters
versionIds
object[]
model version GUIDS and names list.
Returns
void
clearAllNodes()
clearAllNodes():
void
Clear all nodes in model tree.
Returns
void
collect()
collect(
elNums?):any[]
Collects tree nodes by element nums.
Parameters
elNums?
Element number or array of element numbers.
number | number[]
Returns
any[]
collectEndNodes()
collectEndNodes(
node?):any[]
Collect all element nodes for any parent node in meta tree.
Parameters
node?
any
Any parent node.
Returns
any[]
destroy()
destroy():
void
Destroy MetaManager and delete all data from browser store.
Returns
void
fetchByModelVersionGuids()
fetchByModelVersionGuids(
versionIds):Promise<object[]>
Fetch meta trees by version GUIDs list. Meta tree will not be inserted into model node.
Parameters
versionIds
object[]
version GUIDs list.
Returns
Promise<object[]>
getCacheServer()
getCacheServer():
string
Get cache server URI for data loading.
Returns
string
getCacheServerPath()
getCacheServerPath():
string
Set server path to REST point for cache data loading.
Returns
string
getElementGuid()
getElementGuid(
elNum):string
Get element GUID by element geometry number and local number.
Parameters
elNum
number
element Number.
Returns
string
getElementMetaByGuid()
getElementMetaByGuid(
guid):Promise<any>
Get element metadata by GUID.
Parameters
guid
string
element GUID.
Returns
Promise<any>
getElementMetaByNumbers()
getElementMetaByNumbers(
elNum):Promise<any>
Get element metadata by element numbers.
Parameters
elNum
number
Element number.
Returns
Promise<any>
getElementNums()
getElementNums(
guid):number
Get element numbers by GUID.
Parameters
guid
string
element GUID.
Returns
number
getElementsMetasByGuids()
getElementsMetasByGuids(
guids,excludeModelRefs?):Promise<any[]>
Get full metadata for specified elements.
Parameters
guids
string[]
Elements GUIDs.
excludeModelRefs?
boolean
Returns
Promise<any[]>
getServerPath()
getServerPath():
string
Get server path to REST point for data loading.
Returns
string
getToken()
getToken():
string
Get access token for manager`s requests.
Returns
string
load()
load(
versionIds,isShared?,linkId?):Promise<void>
Load meta trees by version GUIDs list and create new model nodes.
Parameters
versionIds
object[]
version GUIDs list.
isShared?
boolean
meta trees are loaded by external link GUIDs or model version GUIDs.
linkId?
string
Returns
Promise<void>
loadByModelVersionGuids()
loadByModelVersionGuids(
versionIds):Promise<void>
Load meta trees by version GUIDS into existing model nodes.
Parameters
versionIds
object[]
version GUIDs list.
Returns
Promise<void>
setByModelVersionGuid()
setByModelVersionGuid(
versionId,status,progress,tree):void
Set meta tree to model node with specified version GUID.
Parameters
versionId
string
model version GUID.
status
new status for model node.
progress
number
new progress for model node.
tree
meta tree for inserting into model node.
Returns
void
setCacheServerPath()
setCacheServerPath(
path?):MetaManager
Set server path to REST point for cache data loading.
Parameters
path?
string
path to server REST point.
Returns
MetaManager
setElementDatas()
setElementDatas(
elementDatas):void
Set element datas map to MetaManager.
Parameters
elementDatas
Map<number, ElementData>
element datas map.
Returns
void
setServer()
setServer(
server?,cacheServer?):MetaManager
Set server URI for data loading.
Parameters
server?
string
server URI.
cacheServer?
string
cache server URI
Returns
MetaManager
setServerPath()
setServerPath(
path?):MetaManager
Set server path to REST point for data loading.
Parameters
path?
string
path to server REST point.
Returns
MetaManager
setToken()
setToken(
token):MetaManager
Set access token for manager`s requests.
Parameters
token
string
access token.
Returns
MetaManager
traverse()
traverse(
onNodeCallback?,elNums?,startNode?,isReversed?):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
onNodeCallback?
Function
Callback function for founded node.
elNums?
Element numbers list or single number.
number | number[]
startNode?
any
Start node for traversing children nodes.
isReversed?
boolean
If true then callback function will be called from inner to outer nodes.
Returns
any[]
Callbacks
onChanged()
onChanged(
changedCallback):MetaManager
Set callback function for event when models list are changed.
Parameters
changedCallback
Function
function with plain Function signature.
Returns
MetaManager
onError()
onError(
errorCallback):MetaManager
Set a callback for an event when a model will not be loaded due to an error.
Parameters
errorCallback
function with ErrorCallbackFunction signature.
Returns
MetaManager
onLoaded()
onLoaded(
loadedCallback):MetaManager
Set callback function for event when each model is loaded.
Parameters
loadedCallback
function with LoadedCallbackFunction signature.
Returns
MetaManager