ol3接口大全
1.ol.Map类:(地图容器类)
实现: ol.Map(参数)
参数说明:1.1 target,说明地图所在的html元素、
如果没有指定,必须调用ol.Map类的setTarget()方法以便绘制地图;
1.2 layers,指定加载的图层。
如果未定义,则将呈现不包含图层的地图(图层是按提供的顺序呈现的,
如果想要矢量图层显示在瓦片图层顶部,则必须位于瓦片图层之后)。
1.3 view, 设置地图的显示视图。
如果在构建时未指定,则必须通过ol.Map()类的setView()方法指定,否则不会提取图层源。
常见方法说明: render():请求地图渲染(下一帧动画)。
getEventPixel(event):获取相对于浏览器窗口的地图像素位置。
event:(event)事件。
getView():获取地图视图。返回值为{ol.View}类。
addLayer(layer):将地图图层添加到地图容器中。
layer:(ol.layer.Base)地图图层。
removeLayer(layer):将图层从地图容器中移除。
layer:(ol.layer.Base)地图图层。
2.ol.Control类(地图控件基类)
常见方法说明:ol.control.defaults(opt_options):该方法表示地图默认包含的一组控件。除非另外配置,否则将返回一组默认的地图控件
默认控件: ol.control.Zoom(地图缩放控件)
ol.control.Rotate(地图旋转控件)
ol.control.Attribution(地图属性控件)以上返回值为{ol.Collection | [ol.control.control]}类
3.ol.Collection类(地图容器类,用于扩展JS数组,提供便捷操作)
实现:ol.Collection(opt_array), opt_array:(Array类型)数组
常见方法说明: extend(arr):该方法实现将要素添加到集合中
arr:(Array类型)将要添加进集合的数组。
例如代码中的[ol.control.MousePosition()]。
4.ol.control.ZoomToExtent类:(放大到设定区域地图控件类)
实现:new ol.control.ZoomToExtent(opt_options),
参数说明:(Object类型)可选项,设置该对象其他属性,以键值对的形式设置
extent:(ol.Extent | undefined)可选项,表示放大到范围的大小。
5.ol.layer.Tile(options):该类是一个瓦片图层类,用于显示瓦片资源。这些瓦片提供了预渲染,并且由特定分辨率的缩放级别组织的瓦片图片网格组成
实现:ol.layer.Tile(options)
参数说明:options:(object类型)可选项,设置该对象其他属性,以键值对的形式设置。
source:(ol.source.Tile)必填项。为图层设置来源、服务地址。
6.ol.source.OSM类,即openstreetmap瓦片图层资源
实现:ol.source.OSM(opt_options)
参数说明:opt_options:(object类型)可选项,设置该图层的配置选项,以键值对的形式设置。
6.1 cacheSize:(number|undefined)可选项,设置缓存大小。默认是2048。
6.2 crossOrigin:(null|string|undefined)可选项,设置加载瓦片的跨域属性。默认是匿名的。
6.3 maxZoom:(number|undefined)可选项,设置最大放大级别。默认是19。
6.4 opaque:(boolean|undefined)可选项,设置图层是否是不透明的。默认是true。
6.5 reprojectionErrorThreshold:(number|undefined)可选项,设置重投影允许的最大误差(以像素为单位)。
设置值越大,精度越低。默认是0.5。
6.6 tileLoadFunction:(ol.TileLoadFunctionType|undefined )可选项,设置通过给定的URL加载瓦片的功能。
默认是function(imageTile, src) {imageTile.getImage().src = src; };
6.7 url:(string|undefined)可选项,设置url模板。
默认为https://{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png。
6.8 wrapX:(boolean|undefined)可选项,设置是否在地图水平坐标轴上重复。默认是true。
7. ol.view类;地图显示视图类(地图初始化必备三要素)
实现: ol.View(opt_options)
参数说明:7.1 centerL:(ol.Coordinate|undefined)设置地图中心,以坐标形式。返回的是数组(经纬度)
7.2 zoom:(number|undefined)可选项,设置地图的显示级数。
7.3 minZoom:(number|undefined)可选项,设置地图最小缩放级别,
它与maxZoom(或minResolution)和zoomFactor一起使用.
如果同时给出maxResolution,maxResolution优先级高于minZoom。默认值为0。
7.4 rotation:(number|undefined)可选项,设置初始视图的旋转弧度(顺时针方向)
7.5 projection:(ol.ProjectionLike)可选项,地图的投影坐标系。默认为EPSG:3857,即墨卡托坐标系。
方法说明:setCenter(center): 设置地图视图的中心坐标
center:(ol.Coordinate | undefined)地图视图的中心坐标。
setZoom(zoom):设置地图视图的缩放级别。
zoom:(number)地图视图的缩放级别。
8. ol.layer.Vector类:用于显示在客户端渲染的矢量数据。
实现:ol.layer.Vector(opt_options)
参数说明:source:(string)必选项,设置矢量图层数据来源。
style:(ol.style.Style | Array-[ol.style.style] | ol.StyleFunction | undefined)图层样式,一个ol.style.Style或者一个 ol.style.Style数组,或者一个返回 ol.style.Style 的函数。
9. ol.source.Vector类:矢量要素来源。
实现: ol.source.Vector(参数)
参数说明:9.1 url:(string | ol.FeatureUrlFunction | undefined)可选项,矢量图层数据的url。(url和format 必须同时同时定于)
9.2 format:(ol.format.Feature | undefined)可选项,url属性设置后,XHR方式加载要素使用的数据格式。 默认是未定义的
9.3 attribution:(ol.AttributionLike | undefined)可选项,地图右下角的 logo 包含的内容。
9.4 features:(Array-[ol.feature] | ol.Collection-[ol.feature] | undefined)可选项,地理要素,从字符串读取的数据。
9.5 logo:(string | olx.LogoOptions | undefined)可选项,logo包含的内容。
9.6 strategy:(ol.LoadingStrategy | undefined)可选项,加载要素使用的策略,默认是直接一次性加载所有要素
9.7 wrapX:(boolean | undefined)可选项,是否在地图水平坐标轴上重复。默认是 true。
10。 ol.format.GeoJSON类:操作GeoJSON数据,包括各种读写方法。
实现: ol.format.GeoJSON(参数)
参数说明: defaultDataProjection:(ol.ProjectionLike)可选项,数据默认坐标系。默认是EPSG:4326,即为地理坐标系。
featureProjection:(ol.ProjectionLike)可选项,通过format解析的要素坐标系。
geometryName: (string | undefind) 创建要素时几何要素名。
11. ol.format.KML类:操作KML数据,包括各种读写方法。
实现:ol.format.KML( 参数)
参数说明: extractStyles:(boolean | undefined)可选项,是否提取KML样式。默认True
showPointNames:(boolean | undefined)可选项,是否显示地点标记名称。默认是true。
defaultStyle:(Array-[l.style.style] | undefined)可选项,默认样式。默认缺省样式为Google Earth。
writeStyles:(boolean | undefined)可选项,是否给KML写入样式 。默认是true。
以上是ol常见基础类及方法,后续将继续整理。