Members
readonly dataSourceAdded : Event
当数据源被添加到集合时触发的事件。
事件处理程序会接收到被添加的数据源。
readonly dataSourceMoved : Event
当数据源在集合中的位置发生变化时触发的事件。
事件处理程序会接收到被移动的数据源、移动后的新索引以及移动前的旧索引。
readonly dataSourceRemoved : Event
当数据源从集合中移除时触发的事件。
事件处理程序会接收到被移除的数据源。
获取此集合中的数据源数量。
Methods
add(dataSource) → Promise.<DataSource>
将数据源添加到集合中。
| Name | Type | Description |
|---|---|---|
dataSource |
DataSource | Promise.<DataSource> | 要添加到集合中的数据源或数据源的 Promise。 当传递一个 Promise 时,数据源在 Promise 成功解析之前不会实际添加 到集合中。 |
Returns:
一旦数据源被添加到集合中,就会解析的 Promise。
检查集合中是否包含给定的数据源。
| Name | Type | Description |
|---|---|---|
dataSource |
DataSource | 要检查的数据源。 |
Returns:
如果集合中包含该数据源则返回 true;否则返回 false。
销毁此集合中所有数据源所占用的资源。显式地销毁此
对象允许确定性地释放 WebGL 资源,而不是依赖垃圾
收集器。一旦此对象被销毁,则不应使用;调用除
isDestroyed 以外的任何函数将导致 DeveloperError 异常。因此,
将返回值(undefined)赋值给对象,如示例所示。
Throws:
-
DeveloperError : 此对象已被销毁,即调用了 destroy()。
Example:
dataSourceCollection = dataSourceCollection && dataSourceCollection.destroy();
See:
从集合中按索引获取数据源。
| Name | Type | Description |
|---|---|---|
index |
number | 要检索的索引。 |
Returns:
在指定索引处的数据源。
getByName(name) → Array.<DataSource>
从集合中按名称获取数据源。
| Name | Type | Description |
|---|---|---|
name |
string | 要检索的名称。 |
Returns:
匹配提供名称的所有数据源的列表。
确定给定数据源在集合中的索引。
| Name | Type | Description |
|---|---|---|
dataSource |
DataSource | 要查找索引的数据源。 |
Returns:
数据源在集合中的索引,如果数据源不在集合中则返回 -1。
如果此对象已被销毁,则返回 true;否则返回 false。
如果此对象已被销毁,则不应使用;调用除
isDestroyed 以外的任何函数将导致 DeveloperError 异常。
Returns:
如果此对象已被销毁,则返回 true;否则返回 false。
将数据源在集合中向下移动一位。
| Name | Type | Description |
|---|---|---|
dataSource |
DataSource | 要移动的数据源。 |
Throws:
-
DeveloperError : 数据源不在此集合中。
-
DeveloperError : 此对象已被销毁,即调用了 destroy()。
将数据源移到底部集合。
| Name | Type | Description |
|---|---|---|
dataSource |
DataSource | 要移动的数据源。 |
Throws:
-
DeveloperError : 数据源不在此集合中。
-
DeveloperError : 此对象已被销毁,即调用了 destroy()。
将数据源在集合中向上移动一位。
| Name | Type | Description |
|---|---|---|
dataSource |
DataSource | 要移动的数据源。 |
Throws:
-
DeveloperError : 数据源不在此集合中。
-
DeveloperError : 此对象已被销毁,即调用了 destroy()。
将数据源提升到集合的顶部。
| Name | Type | Description |
|---|---|---|
dataSource |
DataSource | 要移动的数据源。 |
Throws:
-
DeveloperError : 数据源不在此集合中。
-
DeveloperError : 此对象已被销毁,即调用了 destroy()。
从此集合中移除数据源(如果存在)。
| Name | Type | Default | Description |
|---|---|---|---|
dataSource |
DataSource | 要移除的数据源。 | |
destroy |
boolean |
false
|
optional 是否在移除的数据源的同时销毁它。 |
Returns:
如果数据源在集合中并已被移除,则返回 true;
如果数据源不在集合中,则返回 false。
从此集合中移除所有数据源。
| Name | Type | Default | Description |
|---|---|---|---|
destroy |
boolean |
false
|
optional 是否在移除数据源的同时销毁它们。 |
