Entity
实例的可观察集合,其中每个实体都有唯一的 id。
Name | Type | Description |
---|---|---|
owner
|
DataSource | CompositeEntityCollection | 可选 创建此集合的数据源(或复合实体集合)。 |
Members
readonly collectionChanged : Event .< EntityCollection.CollectionChangedEventCallback >
获取在集合中添加或删除实体时触发的事件。生成的事件是
EntityCollection.CollectionChangedEventCallback
。
获取此集合的全局唯一标识符。
readonly owner : DataSource | CompositeEntityCollection
获取此实体集合的所有者,即。创建它的数据源或复合实体集合。
获取是否应显示此实体集合。当为 true 时,每个实体仅在其自己的 show 属性也为 true 时才会显示。
readonly values : Array.< Entity >
获取集合中 Entity 实例的数组。不应直接修改此数组。
Methods
add (entity) → Entity
将实体添加到集合中。
Name | Type | Description |
---|---|---|
entity
|
Entity | Entity.ConstructorOptions | 要添加的实体。 |
Returns:
添加的实体。
Throws:
-
DeveloperError : 一个实体
此集合中已存在。
computeAvailability () → TimeInterval
计算集合中实体的最大可用性。如果集合包含无限可用数据和非无限数据的混合,它将仅返回与非无限数据有关的区间。如果所有数据都是无限的,则将返回无限区间。
Returns:
集合中实体的可用性。
如果提供的实体在此集合中,则返回 true,否则返回 false。
Name | Type | Description |
---|---|---|
entity
|
Entity | 实体。 |
Returns:
如果提供的实体在此集合中,则为 true,否则为 false。
getById (id) → Entity |undefined
获取具有指定 id 的实体。
Name | Type | Description |
---|---|---|
id
|
String | 要检索的实体的 ID。 |
Returns:
具有提供的 id 的实体,如果集合中不存在该 id,则为 undefined。
getOrCreateEntity (id) → Entity
获取具有指定 id 的实体或创建它并将其添加到集合中(如果它不存在)。
Name | Type | Description |
---|---|---|
id
|
String | 要检索或创建的实体的 ID。 |
Returns:
新的或现有的对象。
从集合中移除一个实体。
Name | Type | Description |
---|---|---|
entity
|
Entity | 要移除的实体。 |
Returns:
如果该项目已被删除,则为 true,如果集合中不存在该项目,则为 false。
从集合中移除所有实体。
从集合中删除具有提供的 id 的实体。
Name | Type | Description |
---|---|---|
id
|
String | 要删除的实体的 ID。 |
Returns:
如果该项目已被删除,则为 true,如果集合中不存在具有提供的 id 的项目,则为 false。
添加或删除项目时立即恢复引发
EntityCollection#collectionChanged
事件。在事件挂起期间所做的任何修改都将在调用此函数时作为单个事件触发。此函数是引用计数的,只要有对
EntityCollection#resumeEvents
的相应调用,就可以安全地多次调用该函数。
Throws:
-
DeveloperError :不能在suspendEvents 之前调用resumeEvents。
防止引发
EntityCollection#collectionChanged
事件,直到对
EntityCollection#resumeEvents
进行相应的调用,此时将引发涵盖所有暂停操作的单个事件。这允许有效地添加和删除许多项目。只要有对
EntityCollection#resumeEvents
的相应调用,就可以安全地多次调用此函数。
Type Definitions
EntityCollection#collectionChanged
生成的事件的签名。
Name | Type | Description |
---|---|---|
collection
|
EntityCollection | 触发事件的集合。 |
added
|
Array.< Entity > |
已添加到集合中的
Entity
实例数组。
|
removed
|
Array.< Entity > |
已从集合中删除的
Entity
实例数组。
|
changed
|
Array.< Entity > |
已修改的
Entity
实例数组。
|