Перейти к основному содержанию

Class: MetaManager

Около 2 мин

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

NameTypeDescription
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

NameTypeDescription
nodeanyAny 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

NameType
elNumnumber

Returns

string


getElementMetaByGuid

getElementMetaByGuid(guid): Promise<any>

Get element metadata by GUID.

Parameters

NameTypeDescription
guidstringelement GUID.

Returns

Promise<any>


getElementMetaByNumbers

getElementMetaByNumbers(elNum): Promise<any>

Get element metadata by element numbers.

Parameters

NameTypeDescription
elNumnumberElement number.

Returns

Promise<any>


getElementNums

getElementNums(guid): number

Get element numbers by GUID.

Parameters

NameTypeDescription
guidstringelement GUID.

Returns

number


getElementsMetasByGuids

getElementsMetasByGuids(guids): Promise<any[]>

Get full metadata for specified elements.

Parameters

NameTypeDescription
guidsstring[]Elements GUIDs.

Returns

Promise<any[]>


load

load(ids, isShared?, linkId?): Promise<void>

Load metadata.

Parameters

NameTypeDescription
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

NameTypeDescription
path?stringpath to server REST point.

Returns

MetaManager


setServer

setServer(server?, cacheServer?): MetaManager

Set server URI for data loading.

Parameters

NameTypeDescription
server?stringserver URI.
cacheServer?stringcache server URI

Returns

MetaManager


setServerPath

setServerPath(path?): MetaManager

Set server path to REST point for data loading.

Parameters

NameTypeDescription
path?stringpath to server REST point.

Returns

MetaManager


setToken

setToken(token): MetaManager

Set access token for manager`s requests.

Parameters

NameTypeDescription
tokenstringaccess token.

Returns

MetaManager


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

NameTypeDescription
onNodeCallback?FunctionCallback function for founded node.
elNums?number | number[]Element numbers list or single number.
startNode?anyStart node for traversing children nodes.

Returns

any[]

Callbacks

onAllLoaded

onAllLoaded(allLoadedCallback): MetaManager

Set callback function for event when all models are loaded.

Parameters

NameTypeDescription
allLoadedCallbackFunctionfunction 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

NameTypeDescription
errorCallbackErrorCallbackFunctionfunction with ErrorCallbackFunction signature.

Returns

MetaManager


onLoaded

onLoaded(loadedCallback): MetaManager

Set callback function for event when each model is loaded.

Parameters

NameTypeDescription
loadedCallbackLoadedCallbackFunctionfunction with LoadedCallbackFunction signature.

Returns

MetaManager