Entity
实例的可观察集合,其中每个实体都有唯一的 ID。
Name | Type | Description |
---|---|---|
owner |
DataSource | CompositeEntityCollection | optional 创建此集合的数据源(或复合实体集合)。 |
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
计算集合中实体的最大可用性。
如果集合包含无限可用数据和非无限数据的混合,
它将仅返回与非无限数据相关的间隔。 如果所有
data 是无限的,则返回无限间隔。
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(如果项已删除),则为 false(如果集合中不存在具有提供的 ID 的项)。
立即恢复引发
EntityCollection#collectionChanged
事件
添加或删除项时。 在活动暂停期间所做的任何修改
将作为单个事件触发。
此函数是引用计数的,只要存在
是对 EntityCollection#resumeEvents
的相应调用。
Throws:
-
DeveloperError : resumeEvents can not be called before suspendEvents.
防止引发
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 实例的数组。 |