API Reference > presentation-common > Core > getInstancesCount

getInstancesCount Function

Get total number of instances included in the supplied key set. The count is calculated by adding all of the following:

  • keys.instanceKeysCount
  • number of keys.nodeKeys which are ECInstance keys
  • for every grouping node key in keys.nodeKeys, number of grouped instances

E.g. if keys contains one instance key, one ECInstance node key and one grouping node key which groups 3 instances, the result is 5.

getInstancesCount(keys: Readonly<KeySet>): number

Parameter Type Description
keys Readonly<KeySet>  

Returns - number

Defined in

Last Updated: 11 June, 2024