OpenLayers API接口文档

OpenLayers API

由于OpenLayers是采用JavaScript实现的，不存在包的概念，但是它可以通过命名空间来实现类似包的功能。另外，JavaScript不存在继承的概念，也不存在私有、公有、保护等概念，OpenLayers中所谓的继承其实就是将基类中的所有属性和方法复制到子类中去。OpenLayers的命名空间如下：

一、OpenLayers命名空间：

如上图所示，OpenLayers是整个webgis系统的最外层命名空间，所有的地理信息系统相关web程序都在此命名空间下，在此命名空间下又创建了其他的命名空间来管理相关功能的类。在这个命名空间下定义了一些基础类和基类来构建整个框架。

1、class OpenLayers.Map

Map类将div DOM元素实例化的对象为地图容器，可以向地图容器中添加图层和控件。

属性

2、class OpenLayers.Map2

基于OpenLayers.Map封装，将自有地图图层和常用控件都已经加载在地图当中，用户无需关心地图数据源等问题，简化了用户的地图调用。实例化该类后即可创建一个可查看和使用的地图对象，其方法和属性与OpenLayers.Map一致，见OpenLayers.Map类。

2、class OpenLayers.Marker

OpenLayers命名空间下的Marker类可以被实例化为marker对象，用于标注地图上的位置，marker对象是由LonLat 对象和Icon对象组合而成的。markers一般被添加到一个叫做yer.Markers的特殊图层中。

需要注意的是，如果你在一个marker中使用了一个icon，也就是说，你不能在其他的marker中在使用它——一旦你使用了这个icon，你应该clone()这个icon然后在另外的marker中使用这个icon。

3、class OpenLayers.Popup

Popup类实例化一个弹出窗口，通常被添加到地图容器中。

构造函数

4、class OpenLayers.Icon

Icon为图标类，图标指定用来在地图上显示Marker 的图像。

5、class OpenLayers.Format

各种format类的基类，它的子类实现reading/writing方法。构造函数

属性

方法

6、OpenLayers.Request

OpenLayers.Request命名空间下包含两个常用的AJAX方法，通过这两个方法可以方便的实现XMLHttpRequests功能。方法

7、class OpenLayers.Feature

Feature是几何信息和属性的结合体，在OpenLayers.Feauter中主要是包括一个标记和经纬度。

方法

方法返回值描述

onScreen () Boolean 该feature当前是否在屏幕的可视区域内

createMarker()OpenLayers.Marker 为对象创建一个marker

destroyMarker（）None 销毁该对象创建的marker

createPopup ()OpenLayers.Popup 为对象创建一个信息窗口

destroyPopup（）None 销毁该对象创建的信息窗口

二、BaseType命名空间:

在BaseTypes命名空间下定义了一些基本类型的类，如LonLat、Size等。

1、class OpenLayers.LonLat

LonLat是以经度和纬度表示的地理坐标点。

注意：进行地图投影时通常将经度与地图的x 坐标联系起来，将纬度与y 坐标联系起来。

构造函数

构造函数描述

LonLat（float lon , float lat）创建OpenLayers.LonLat对象，经度lon在-180 度和+180 度之间，而纬度lat将在-90 度到+90 度之间周而复始。

属性类型描述

lon Number:float 地图上的经度（X轴坐标）

lat Number:float 地图上的纬度（Y轴坐标）

方法返回值描述

toShortString() string 返回包含lon和lat坐标的字符串，先lon坐标后lat坐标，用逗号分隔。clone() OpenLayers.LonLat 返回一个与当前经纬度对象有相同经纬度的新经纬度对象

2、class OpenLayers.Pixel

Pixel是以像素坐标表示的地图上的一点。在地图坐标系统中，x坐标向右增大，y坐标向下增大。

属性

方法

3、class OpenLayers.Size

Size是地图矩形区域的大小（以像素表示）。大小对象有两个参数：width 和height。宽度是点的x 坐标的差值，高度是y 坐标的差值。

构造函数

属性

方法

三、Control命名空间：

OpenLayers命名空间下面定义了Control基类，Control命名空间下面的所有类都继承于Control基类。每个具体的控件类实现地图的一项具体操作。控件影响地图的显示和行为，它允许拖动和放大缩小地图以控制地图的比例尺，默认的控件是被添加到地图上的，尽管如此，也可以通过传递可选参数将其加入到地图外部的DIV中。

1、class BM.Control.TMeasureDistance

TMeasureDistance为测距控件，它实现OpenLayers.Control接口，因此可用OpenLayers.map.addControl()方法添加到地图中。可能会增加控件定位的参数或方法

构造函数描述

TMeasureDistance（）创建MeasureDistance对象。

方法返回值描述

getDistance () Number:float 返回测量的长度,当距离为100000米下时单位为米（m），否则为千

米（km）

activate() none 激活测量长度控件