Class: VectorLayer

VectorLayer

矢量图层,一般用于承载地图上的覆盖物

new VectorLayer()

layer/VectorLayer.js, line 17

Classes

VectorLayer
VectorLayer

Methods

addFeature(feature)

layer/VectorLayer.js, line 36

给图层上添加要素

Name Type Description
feature Feature

单个要素

addFeatures(featureArr)

layer/VectorLayer.js, line 55

给图层上添加多个要素

Name Type Description
featureArr Array

要素数组

addToMap(map){layer}

layer/VectorLayer.js, line 179

将图层添加到指定的map上

Name Type Description
map Map

指定的map对象。

Returns:
Type Description
layer 当前的图层对象

clear()

layer/VectorLayer.js, line 77

清除图层上的要素

forEachFeature(callback){Feature|undefined}

layer/VectorLayer.js, line 106

遍历这个图层上所有要素,回调返回每一个要素。当回调返回truthy值以停止迭代。 此函数仅迭代具有已定义几何体的要素。

Name Type Description
callback function

使用图层上的每个要素调用。返回truthy值以停止迭代。

Returns:
Type Description
Feature | undefined 上次回调调用的返回值。

forEachFeatureInExtent(extent, callback){Feature|undefined}

layer/VectorLayer.js, line 117

遍历这个图层上指定边界内所有要素,回调返回每一个要素。当回调返回truthy值以停止迭代。

Name Type Description
extent Array.<extent>

指定边界内,[minx, miny, maxx, maxy]

callback function

使用边界内的每个要素调用。返回truthy值以停止迭代。

Returns:
Type Description
Feature | undefined 上次回调调用的返回值。

get(key){*}

layer/VectorLayer.js, line 321

获取图层中设置的键值对内容

Name Type Description
key String

key name

Returns:
Type Description
* key 对应的value

getAllFeatures(){Features}

layer/VectorLayer.js, line 86

获取图层上的所有资源要素

Returns:
Type Description
Features features

getClosestFeatureToCoordinate(coordinate, opt_filter){Feature}

layer/VectorLayer.js, line 129

获取该图层上最接近给定坐标的要素

Name Type Description
coordinate Array

坐标

opt_filter function

功能过滤器功能。过滤器函数将接收一个参数 feature,且该参数应返回布尔值。默认情况下,不进行过滤。

Returns:
Type Description
Feature 最接近的要素

getExtent(){Array}

layer/VectorLayer.js, line 289

获取图层渲染的边界范围

Returns:
Type Description
Array 图层渲染的边界范围

getFeatureById(){Feature}

layer/VectorLayer.js, line 95

通过要素id获取图层上的要素

Returns:
Type Description
Feature feature

getFeatures(pixel){Promise.<Array.<Feature>>}

layer/VectorLayer.js, line 169

获取视图中给定的像素与图层中相交的要素。 准确性不及Map#getFeaturesAtPixel()方法使用的算法。

Name Type Description
pixel Array.<pixel>

viewport上给定pixel

Returns:
Type Description
Promise.<Array.<Feature>> Promise that resolves with an array of features.

getFeaturesAtCoordinate(coordinate){Features}

layer/VectorLayer.js, line 148

获取该图层上指定坐标相交的所有要素

Name Type Description
coordinate Array

坐标

Returns:
Type Description
Features 图层上指定坐标相交的所有要素

getFeaturesExtent(){Array.<extent>}

layer/VectorLayer.js, line 138

获取该图层上所有要素的边界

Returns:
Type Description
Array.<extent> 所有要素的边界

getFeaturesInExtent(extent){Features}

layer/VectorLayer.js, line 158

获取该图层上指定边界内的所有要素

Name Type Description
extent Array.<extent>

指定边界内,[minx, miny, maxx, maxy]

Returns:
Type Description
Features 图层上指定边界内的所有要素

getMaxZoom(){number}

layer/VectorLayer.js, line 271

获取图层可见的最大视图缩放级别

Returns:
Type Description
number 图层可见的最大视图缩放级别

getMinZoom(){number}

layer/VectorLayer.js, line 253

获取图层的最小视图缩放级别

Returns:
Type Description
number minZoom 图层的最小视图缩放级别

getOpacity(){number}

layer/VectorLayer.js, line 217

获取图层的透明度

Returns:
Type Description
number opacity 图层的透明度

getVisible(){Boolean}

layer/VectorLayer.js, line 199

获取图层的可见度

Returns:
Type Description
Boolean visibale图层是否可见。

getZIndex(){number}

layer/VectorLayer.js, line 235

获取图层的zIndex

Returns:
Type Description
number 图层的zIndex

on(type, listener)

layer/VectorLayer.js, line 341

监听图层属性的改变

Name Type Description
type String

监听的类型,比如:change:extentchange:maxZoomchange:visible等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html#on

listener function

回调函数

once(type, listener)

layer/VectorLayer.js, line 363

监听一次图层属性的改变

Name Type Description
type String

监听的类型,比如:change:extentchange:maxZoomchange:visible等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html#on

listener function

回调函数

removeFeature(feature)

layer/VectorLayer.js, line 46

从图层上移出要素

Name Type Description
feature Feature

单个要素

removeFeatures(featureArr)

layer/VectorLayer.js, line 65

从图层上移出多个要素

Name Type Description
featureArr Array

要素数组

set(key, value)

layer/VectorLayer.js, line 311

给图层的value属性中添加键值对,用于给图层绑定一些要用到的数据

Name Type Description
key String

key name

value *

value

setExtent(extent)

layer/VectorLayer.js, line 280

设置图层渲染的边界范围。该图层不会在此范围之外渲染。

Name Type Description
extent Array

图层渲染的边界范围,[minx, miny, maxx, maxy]

setMap(map)

layer/VectorLayer.js, line 301

设置要在地图上其他图层之上渲染的图层。地图将不会在其图层集合中管理此图层, 并且其中的回调 Map#forEachLayerAtPixel()将null作为图层接收。 这对于临时层很有用。要从地图上删除非托管图层,请使用#setMap(null)。 要将图层添加到地图并由地图管理,请使用Map#addLayer().

Name Type Description
map Array

要渲染图层的地图对象

setMaxZoom(maxZoom)

layer/VectorLayer.js, line 262

设置图层可见的最大视图缩放级别

Name Type Description
maxZoom number

图层可见的最大视图缩放级别

setMinZoom(minZoom)

layer/VectorLayer.js, line 244

设置图层的最小视图缩放级别(不包括),在该级别之上,该层将可见。

Name Type Description
minZoom number

图层的最小视图缩放级别

setOpacity(opacity)

layer/VectorLayer.js, line 208

设置图层的透明度

Name Type Description
opacity number

图层的透明度

setVisible(visibale)

layer/VectorLayer.js, line 189

设置图层的可见度

Name Type Description
visibale Boolean

图层是否可见。

setZIndex(zIndex)

layer/VectorLayer.js, line 226

设置图层的zIndex

Name Type Description
zIndex number

图层的zIndex

un(type, listener)

layer/VectorLayer.js, line 352

取消监听图层属性的改变

Name Type Description
type String

监听的类型,比如:change:extentchange:maxZoomchange:visible等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html#on

listener function

回调函数

unset(key)

layer/VectorLayer.js, line 330

移出图层指定属性

Name Type Description
key String

key name

VectorLayer VectorLayer

矢量图层,一般用于承载地图上的覆盖物

new VectorLayer(options)

layer/VectorLayer.js, line 17

构造一个图像图层对象

Name Type Description
options LayerOptions

图层可选属性

Name Type Default Description
className string 'ol-layer' optional

设置layer元素的CSS类名称。

opacity number 1 optional

不透明度(0,1)。

visible boolean true optional

图层是否可见。

extent Array optional

图层渲染的边界范围。该图层不会在此范围之外渲染。

zIndex number optional

图层渲染的Z索引。在渲染时,将首先按Z索引然后按位置对图层进行排序。 当zIndexundefined时,zIndex将被设置为0加入到图层集合中; 而在使用图层的setMap()方法时,zIndexInfinity

minZoom number optional

最小视图缩放级别(不包括),在该级别之上,该层将可见。

maxZoom number optional

该图层可见的最大视图缩放级别(包括该级别)。

map Map optional

将图层设置为地图上的叠加层。地图将不会在其图层集合中管理此图层, 也就是当调用Map#getLayers()方法时,图层集合里不会出现该图层。并且该图层将呈现在顶部。 这对于临时层很有用。在地图上添加图层并由地图管理图层的标准方法是使用Map#addLayer()方法。

Classes

VectorLayer
VectorLayer

Methods

addFeature(feature)

layer/VectorLayer.js, line 36

给图层上添加要素

Name Type Description
feature Feature

单个要素

addFeatures(featureArr)

layer/VectorLayer.js, line 55

给图层上添加多个要素

Name Type Description
featureArr Array

要素数组

addToMap(map){layer}

layer/VectorLayer.js, line 179

将图层添加到指定的map上

Name Type Description
map Map

指定的map对象。

Returns:
Type Description
layer 当前的图层对象

clear()

layer/VectorLayer.js, line 77

清除图层上的要素

forEachFeature(callback){Feature|undefined}

layer/VectorLayer.js, line 106

遍历这个图层上所有要素,回调返回每一个要素。当回调返回truthy值以停止迭代。 此函数仅迭代具有已定义几何体的要素。

Name Type Description
callback function

使用图层上的每个要素调用。返回truthy值以停止迭代。

Returns:
Type Description
Feature | undefined 上次回调调用的返回值。

forEachFeatureInExtent(extent, callback){Feature|undefined}

layer/VectorLayer.js, line 117

遍历这个图层上指定边界内所有要素,回调返回每一个要素。当回调返回truthy值以停止迭代。

Name Type Description
extent Array.<extent>

指定边界内,[minx, miny, maxx, maxy]

callback function

使用边界内的每个要素调用。返回truthy值以停止迭代。

Returns:
Type Description
Feature | undefined 上次回调调用的返回值。

get(key){*}

layer/VectorLayer.js, line 321

获取图层中设置的键值对内容

Name Type Description
key String

key name

Returns:
Type Description
* key 对应的value

getAllFeatures(){Features}

layer/VectorLayer.js, line 86

获取图层上的所有资源要素

Returns:
Type Description
Features features

getClosestFeatureToCoordinate(coordinate, opt_filter){Feature}

layer/VectorLayer.js, line 129

获取该图层上最接近给定坐标的要素

Name Type Description
coordinate Array

坐标

opt_filter function

功能过滤器功能。过滤器函数将接收一个参数 feature,且该参数应返回布尔值。默认情况下,不进行过滤。

Returns:
Type Description
Feature 最接近的要素

getExtent(){Array}

layer/VectorLayer.js, line 289

获取图层渲染的边界范围

Returns:
Type Description
Array 图层渲染的边界范围

getFeatureById(){Feature}

layer/VectorLayer.js, line 95

通过要素id获取图层上的要素

Returns:
Type Description
Feature feature

getFeatures(pixel){Promise.<Array.<Feature>>}

layer/VectorLayer.js, line 169

获取视图中给定的像素与图层中相交的要素。 准确性不及Map#getFeaturesAtPixel()方法使用的算法。

Name Type Description
pixel Array.<pixel>

viewport上给定pixel

Returns:
Type Description
Promise.<Array.<Feature>> Promise that resolves with an array of features.

getFeaturesAtCoordinate(coordinate){Features}

layer/VectorLayer.js, line 148

获取该图层上指定坐标相交的所有要素

Name Type Description
coordinate Array

坐标

Returns:
Type Description
Features 图层上指定坐标相交的所有要素

getFeaturesExtent(){Array.<extent>}

layer/VectorLayer.js, line 138

获取该图层上所有要素的边界

Returns:
Type Description
Array.<extent> 所有要素的边界

getFeaturesInExtent(extent){Features}

layer/VectorLayer.js, line 158

获取该图层上指定边界内的所有要素

Name Type Description
extent Array.<extent>

指定边界内,[minx, miny, maxx, maxy]

Returns:
Type Description
Features 图层上指定边界内的所有要素

getMaxZoom(){number}

layer/VectorLayer.js, line 271

获取图层可见的最大视图缩放级别

Returns:
Type Description
number 图层可见的最大视图缩放级别

getMinZoom(){number}

layer/VectorLayer.js, line 253

获取图层的最小视图缩放级别

Returns:
Type Description
number minZoom 图层的最小视图缩放级别

getOpacity(){number}

layer/VectorLayer.js, line 217

获取图层的透明度

Returns:
Type Description
number opacity 图层的透明度

getVisible(){Boolean}

layer/VectorLayer.js, line 199

获取图层的可见度

Returns:
Type Description
Boolean visibale图层是否可见。

getZIndex(){number}

layer/VectorLayer.js, line 235

获取图层的zIndex

Returns:
Type Description
number 图层的zIndex

on(type, listener)

layer/VectorLayer.js, line 341

监听图层属性的改变

Name Type Description
type String

监听的类型,比如:change:extentchange:maxZoomchange:visible等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html#on

listener function

回调函数

once(type, listener)

layer/VectorLayer.js, line 363

监听一次图层属性的改变

Name Type Description
type String

监听的类型,比如:change:extentchange:maxZoomchange:visible等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html#on

listener function

回调函数

removeFeature(feature)

layer/VectorLayer.js, line 46

从图层上移出要素

Name Type Description
feature Feature

单个要素

removeFeatures(featureArr)

layer/VectorLayer.js, line 65

从图层上移出多个要素

Name Type Description
featureArr Array

要素数组

set(key, value)

layer/VectorLayer.js, line 311

给图层的value属性中添加键值对,用于给图层绑定一些要用到的数据

Name Type Description
key String

key name

value *

value

setExtent(extent)

layer/VectorLayer.js, line 280

设置图层渲染的边界范围。该图层不会在此范围之外渲染。

Name Type Description
extent Array

图层渲染的边界范围,[minx, miny, maxx, maxy]

setMap(map)

layer/VectorLayer.js, line 301

设置要在地图上其他图层之上渲染的图层。地图将不会在其图层集合中管理此图层, 并且其中的回调 Map#forEachLayerAtPixel()将null作为图层接收。 这对于临时层很有用。要从地图上删除非托管图层,请使用#setMap(null)。 要将图层添加到地图并由地图管理,请使用Map#addLayer().

Name Type Description
map Array

要渲染图层的地图对象

setMaxZoom(maxZoom)

layer/VectorLayer.js, line 262

设置图层可见的最大视图缩放级别

Name Type Description
maxZoom number

图层可见的最大视图缩放级别

setMinZoom(minZoom)

layer/VectorLayer.js, line 244

设置图层的最小视图缩放级别(不包括),在该级别之上,该层将可见。

Name Type Description
minZoom number

图层的最小视图缩放级别

setOpacity(opacity)

layer/VectorLayer.js, line 208

设置图层的透明度

Name Type Description
opacity number

图层的透明度

setVisible(visibale)

layer/VectorLayer.js, line 189

设置图层的可见度

Name Type Description
visibale Boolean

图层是否可见。

setZIndex(zIndex)

layer/VectorLayer.js, line 226

设置图层的zIndex

Name Type Description
zIndex number

图层的zIndex

un(type, listener)

layer/VectorLayer.js, line 352

取消监听图层属性的改变

Name Type Description
type String

监听的类型,比如:change:extentchange:maxZoomchange:visible等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html#on

listener function

回调函数

unset(key)

layer/VectorLayer.js, line 330

移出图层指定属性

Name Type Description
key String

key name