geosolution~GeosolutionLayer(options)

地理解决方案图层。承载地理解决方案包内所有数学模型的绘制。

Summary

Methods:
addMathModel

添加数学模型到地理解决方案图层

destroy

销毁图层。

getAllMathModels

获取地理解决方案图层上的所有数学模型

getLayerZIndex

返回图层的zIndex值。

getMap

获取当前图层所在的地图。

getMathModelById

根据数学模型的唯一标识符获取数学模型对象

getModelsByClassName

根据数学模型的类名(ClassName)属性获取对应的数学模型数组

getName

获取图层名称。

getOpacity

获取图层透明度。

getVisibility

获取图层的可见性。

offMap

解除图层与地图的关联,即从图层去掉与地图对象有关的信息,同时在地图对象去掉与该图层有关的信息。关联解除后,图层依然存在,但与地图不再有关系。
如果图层本身并未加载到地图上,那么该方法没有任何效果。

redraw

图层重绘,当模型数据发生更新时,手动调用

removeAllMathModels

移除地理解决方案图层的所有数学模型对象

removeMathModelById

根据数学模型的唯一标识符移除地理解决方案图层上的数学模型对象

setLayerZIndex

设置图层在图层容器中的顺序。

setName

设置图层名称。

setOpacity

设置图层透明度。0表示完全透明,1表示完全不透明。

setVisibility

设置图层的可见性。仅设置该图层是否可见,而图层本身依然存在。

Constructor

new GeosolutionLayer(options)

地理解决方案图层的构造函数。

Parameters:
Name Type Description
options Object

Methods

addMathModel(mathModel)

添加数学模型到地理解决方案图层

Parameters:
Name Type Description
mathModel module:geosolution/math~MathModel

数学模型对象

destroy()

销毁图层。

getAllMathModels() → {Array.<module:geosolution/math~MathModel>}

获取地理解决方案图层上的所有数学模型

Returns:
Array.<module:geosolution/math~MathModel> -

数学模型数组

getLayerZIndex() → {Number}

返回图层的zIndex值。

Returns:
Number -

图层的zIndex

getMap() → {module:Map}

获取当前图层所在的地图。

Returns:
module:Map -

图层所属的地图对象

getMathModelById(id) → {module:geosolution/math~MathModel}

根据数学模型的唯一标识符获取数学模型对象

Parameters:
Name Type Description
id String

添加到地理解决方案图层上数学模型对象的唯一标识符

Returns:
module:geosolution/math~MathModel -

具体的数学模型对象

getModelsByClassName(className) → {Array.<module:geosolution/math~MathModel>}

根据数学模型的类名(ClassName)属性获取对应的数学模型数组

Parameters:
Name Type Description
className String

数学模型的类名

Returns:
Array.<module:geosolution/math~MathModel> -

数学模型数组

getName() → {String}

获取图层名称。

Returns:
String -

图层名称

getOpacity() → {Number}

获取图层透明度。

Returns:
Number -

透明度

getVisibility() → {Boolean}

获取图层的可见性。

Returns:
Boolean -

true表示可见,false表示不可见。

offMap()

解除图层与地图的关联,即从图层去掉与地图对象有关的信息,同时在地图对象去掉与该图层有关的信息。关联解除后,图层依然存在,但与地图不再有关系。
如果图层本身并未加载到地图上,那么该方法没有任何效果。

redraw()

图层重绘,当模型数据发生更新时,手动调用

removeAllMathModels()

移除地理解决方案图层的所有数学模型对象

removeMathModelById(id)

根据数学模型的唯一标识符移除地理解决方案图层上的数学模型对象

Parameters:
Name Type Description
id String

添加到地理解决方案图层上的数学模型对象的唯一标识符

setLayerZIndex(zIndex)

设置图层在图层容器中的顺序。

Parameters:
Name Type Description
zIndex Number

图层的zIndex,值越大,图层越靠近上方。但是该值改变不了图层容器的上下顺序。

setName(name)

设置图层名称。

Parameters:
Name Type Description
name String

图层名称

Throws:
Error -

当name不是String类型时抛出异常。

setOpacity(opacity)

设置图层透明度。0表示完全透明,1表示完全不透明。

Parameters:
Name Type Default Description
opacity Number 1

图层透明度,介于0-1之间。

Throws:
TypeError -

当图层的透明度值不是一个0-1之间的数字时,抛出异常。

setVisibility(visible)

设置图层的可见性。仅设置该图层是否可见,而图层本身依然存在。

Parameters:
Name Type Default Description
visible Boolean true

是否可见,默认为true,可见。

Throws:
TypeError -

当参数不是布尔类型时,抛出异常。