Members
readonly dataSourceAdded : Event
将数据源添加到集合时引发的事件。事件处理程序被传递给添加的数据源。
readonly dataSourceMoved : Event
当数据源在集合中更改位置时引发的事件。事件处理程序会传递被移动的数据源、移动后的新索引以及移动前的旧索引。
readonly dataSourceRemoved : Event
从集合中删除数据源时引发的事件。事件处理程序将传递已删除的数据源。
获取此集合中数据源的数量。
Methods
add (dataSource) → Promise.< DataSource >
将数据源添加到集合中。
Name | Type | Description |
---|---|---|
dataSource
|
DataSource | Promise.< DataSource > | 要添加到集合中的数据源或对数据源的承诺。当传递一个 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:
get (index) → DataSource
从集合中按索引获取数据源。
Name | Type | Description |
---|---|---|
index
|
Number | 要检索的索引。 |
Returns:
指定索引处的数据源。
getByName (name) → Array.< DataSource >
从集合中按名称获取数据源。
Name | Type | Description |
---|---|---|
name
|
String | 要检索的名称。 |
Returns:
与提供的名称匹配的所有数据源的列表。
确定集合中给定数据源的索引。
Name | Type | Description |
---|---|---|
dataSource
|
DataSource | 查找索引的数据源。 |
Returns:
集合中数据源的索引,如果集合中不存在数据源,则为 -1。
如果此对象被销毁,则返回 true;否则为假。如果该对象被销毁,则不应使用;调用
isDestroyed
以外的任何函数都会导致
DeveloperError
异常。
Returns:
如果此对象被销毁,则为 true;否则为假。
将数据源在集合中降低一个位置。
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
|
可选 是否除了删除数据源之外还销毁它。 |
Returns:
如果数据源在集合中并被删除,则为 true;如果数据源不在集合中,则为 false。
从此集合中删除所有数据源。
Name | Type | Default | Description |
---|---|---|---|
destroy
|
Boolean |
false
|
可选 是否除了删除数据源之外还销毁它们。 |