# MapGIS Client for JavaScript API

Common Cesium-Plugin MapboxGL-Plugin Leaflet-Plugin OpenLayers-Plugin Video-Plugin
API文档

#### # new FluidSourceCollection(fluid)

流体源集合对象（该对象会在Fluid内部进行实例化，不需要额外手动实例化）

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`fluid` | Fluid | 流体源集合所属的流体对象

返回值:

返回根据参数实例化的流体源集合对象

类型: Object

### 成员变量

类型: Number

#### # readonly length

集合中流体源的数量

### 方法

#### # add(fluidSource)

添加流体源对象，创建点流体源对象（PointFluidSource）或全域流体源对象（VolumeFluidSource），创建方法可以查看上述文档 在创建Fluid对象时，FluidSourceCollection对象会在其内部自动实例化，可以通过fluid.fluidSources获取

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`fluidSource` | PointFluidSource | VolumeFluidSource | 需要添加的流体源对象

返回值:

添加成功的流体源对象

类型: PointFluidSource | VolumeFluidSource

##### 示例

    // 以添加一个点流体源为例，首先实例化一个点流体源对象
    const pointFluidSource = new PointFluidSource({
      position: Cesium.Cartesian3.fromDegrees(113, 30),
      radius: 50,
      flow: 20,
    })
    // 将点流体源添加到流体模拟对象的流体源集合中
    fluid.fluidSources.add(pointFluidSource)

#### # contains(fluidSource)

返回流体源集合中是否包含指定的流体源对象

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`fluidSource` | PointFluidSource | VolumeFluidSource | 需要查找的流体源对象

返回值:

当流体源集合中包含fluidSource时返回true，否则返回false

类型: Boolean

#### # get(index)

返回流体源集合中指定下标的流体源对象

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`index` | Number | 需要查找的流体源对象在集合中的下标

返回值:

在流体源集合中下标index所对应的流体源对象

类型: PointFluidSource | VolumeFluidSource

#### # remove(fluidSource)

删除流体源对象（目前支持PointFluidSource和VolumeFluidSource）

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`fluidSource` | PointFluidSource | VolumeFluidSource | 需要删除的流体源对象

返回值:

如果删除成功返回true，如果要删除的流体源对象未定义或不在集合中则返回false

类型: Boolean

#### # removeAll()

删除集合中的所有流体源对象

构造函数
成员变量
方法
事件