OpenLayers3

Openlayer3.13.1的几个API的部分翻译

说明

1、需求：显示地图，同时，在地图上显示标记，并且在点击标记后显示可定制弹窗
2、本API基于版本：3.13.1
3、本API说明针对以上需求提炼出相关API，全部引文请参考OpenLayers3 API

ol.Map类

Map是OpenLayers的核心部件。一个地图若要被渲染的话，一个view，一个或多个的layer还有一个目标容器是必须的。

1、new ol.Map(options)

构造方法，关于option的说明，这里只说用到的，具体参见这里。

2、getEventPixel(event)

返回浏览器事件发生时，相对于viewport的地图的像素位置。

返回值:
像素。

3、forEachFeatureAtPixel(pixel, callback, opt_this, opt_layerFilter, opt_this2)

探测在viewport上被像素截断的feature,并且对每一个被截断的feature执行回掉函数。在探测中被包含的Layer能够通过opt_layerFilter进行设置。

注：在后续版本中(如4.6.5)，函数定义变为forEachFeatureAtPixel(pixel, callback, opt_options)，实测这个版本的定义在3.13.1版本中也可使用。
返回值:
回掉函数的返回值，比如，最后一次回掉的返回值，或者第一次返回的真值。

4、addOverlay(overlay)

将给予的overlay添加到map上

5、on(type, listener, opt_this)

监听某一个确切事件。

返回值:
监听器的唯一ID

6、addLayer(layer)

将给予的layer添加到map的顶层。如果你想添加在栈中其他地方的layer，使用getLayers()和在ol.Collection中的可用方法。

7、getView()

获取与map相关联的view。一个view管理着像center、resolution的属性。
返回值:
控制这个map的view

ol.View类

一个ol.View对象代表地图上的一个简单2D视图
这是一个随着地图的中心、分辨率、旋转而做出对应行动的对象。

1、new ol.View(opt_options)

构造方法，关于opt_options的说明，这里只说用到的，具体参见这里。

2、fit(geometry, size, opt_options)

根据给定的地图大小和边界来拟合给定的几何图形或范围。 大小是盒子的像素尺寸以适合程度。 在大多数情况下，你会希望使用地图大小，即map.getSize（），站在地图的角度来考虑。

ol.Overlay类

Overlay是一个能在地图上显示并且依附在地图上单一位置的元素。像ol.control.Control,Overlay是可见的小组件。不像Controls，它们不固定在屏幕上的某一个位置，但是它们与地理的坐标系进行绑定，所以平移地图时将移动Overlay而不是一个Control。

例子：

var popup = new ol.Overlay({
  element: document.getElementById('popup')
});
popup.setPosition(coordinate);
map.addOverlay(popup);

1、new ol.Overlay(options)

构造方法，关于options的说明（只列举用到的，其他更具体的设置，参看这里）

2、setPosition(position)

这是overlay的位置。如果位置是undefined，overlay被隐藏。

ol.source.Vector类

为矢量层的feature提供一个源(容器)。通过这个源(容器)提供的矢量feature是适合编辑的。参阅ol.source.VectorTile中为渲染优化的矢量数据。

1、new ol.source.Vector(opt_options)

构造方法，关于opt_option的说明，请参阅这里

2、addFeature(feature)

为源(容器)中添加单一的feature。如果你想一次性添加多个feature，调用source.addFeatures()代替。

ol.Feature类

它是一个矢量对象，是一个地理的feature，拥有几何形状和其他属性特征，类似矢量feature中的GeoJSON。
Feature能够使用setStyle独立地设置样式；否则它们使用它们矢量层的样式。
注意在feature对象中的属性会被设置成ol.Object属性，所以它们是可见的，并且有get/set访问方法。

通常，一个feature有一个单一的geometry属性。你能使用setGeometry属性设置geometry并且使用getGeometry来获得它。使用属性在一个feature中存储超过一个的grometry是可能的。但是在默认情况下，geometry使用属性名为geometry的值进行渲染。如果你想使用其他geometry属性进行渲染，使用setGeometryName方法来改变与这个feature对象所绑定的geometry。比如：

var feature = new ol.Feature({
  geometry: new ol.geom.Polygon(polyCoords),
  labelPoint: new ol.geom.Point(labelCoords),
  name: 'My Polygon'
});
// 获得多边形geometry
var poly = feature.getGeometry();
// 使用labelPoint的坐标系将这个feature以点进行渲染
feature.setGeometryName('labelPoint');
// 获得点的geometry
var point = feature.getGeometry();

1、new ol.Feature(opt_geometryOrProperties)

构造方法

ol.geom.Point类

Point geometry

继承关系：

1、new ol.geom.Point(coordinates, opt_layout)

构造方法

ol.style.Style类

渲染矢量feature的样式容器。任何通过set*()方法对样式或其子样式进行的改变，直到这个feature或layer重新渲染时才会起效。

1、new ol.style.Style(opt_options)

构造方法，关于opt_option的说明，这里只说用到的，具体参见这里。这个opt_option就是样式设置的选项。

ol.style.Icon类

为矢量feature设置图标样式

继承关系：

1、new ol.style.Icon(opt_options)

构造方法，关于opt_option的说明，这里只说用到的，具体参见这里。这个opt_options就是样式设置的选项。

ol.layer.Vector类

矢量数据在客户端渲染。注意任何在option中设置都会被设置为layer对象上的ol.object属性；举个例子，在option中设置title: 'My Title'，意味着title是可见的，并且拥有get/set方法。

1、new ol.layer.Vector(opt_options)

构造方法，关于opt_option的说明，这里只说用到的，具体参见这里。这个opt_options就是样式设置的选项。

ol.layer.Tile类

对以特定分辨率的缩放级别，组织网格中预渲染的图层源。注意任何设置在option中的属性将会在layer对象中被设置成ol.Object属性。举个例子，在option中设置title: 'My Title'，意味着title是可见的，并且拥有get/set方法。

1、new ol.layer.Tile(opt_options)

构造方法，关于opt_option的说明，这里只说用到的，具体参见这里。这个opt_options就是样式设置的选项。

ol.source.TileWMS类

从WMS服务获取瓦片数据图层源。

继承关系：

1、new ol.source.TileWMS(opt_options)

构造方法，关于opt_option的说明，这里只说用到的，具体参见这里。这个opt_options就是样式设置的选项。

ol.tilegrid.TileGrid类

它是对访问瓦片图片服务的数据源设置网格模式的基类。

1、new ol.tilegrid.TileGrid(options)

构造方法，关于option的说明，这里只说用到的，具体参见这里。

ol.proj.Projection类

投影坐标系定义类。其中一个是为应用程序支持的每个投影创建的，并在ol.proj名字空间中。你可以在应用程序中使用这些，但是不是必须的，因为API参数和选项使用的是ol.proj.ProjectionLike。这意味着简单的字符串代码就足够了。
你可以使用ol.project来获得一个具体的投影坐标系对象。
这个库包含了ESPG:4326和ESPG:3587的定义，同时，包含以下别名：
EPSG:4326: CRS:84, urn:ogc:def:crs:EPSG:6.6:4326, urn:ogc:def:crs:OGC:1.3:CRS84, urn:ogc:def:crs:OGC:2:84, http://www.opengis.net/gml/srs/epsg.xml#4326, urn:x-ogc:def:crs:EPSG:4326
EPSG:3857: EPSG:102100, EPSG:102113, EPSG:900913, urn:ogc:def:crs:EPSG:6.18:3:3857, http://www.opengis.net/gml/srs/epsg.xml#3857
如果你使用的是proj4j，别名可以使用proj.defs()进行添加，查看文档。为proj4设置一个可选的名字空间，使用ol.proj.setProj4。

1、new ol.proj.Projection(options)

构造方法，关于option的说明，这里只说用到的，具体参见这里。

ol.source.WMTS类

从WMTS服务器获取瓦片数据的层

1、new ol.source.WMTS(options)

构造方法，关于option的说明，这里只说用到的，具体参见这里。

ol.tilegrid.WMTS类

为访问WMTS 瓦片图像服务设置网格模式

new ol.tilegrid.WMTS(options)

构造方法，关于option的说明，这里只说用到的，具体参见这里。