OpenLayers API接口文档.docx

1、OpenLayers API接口文档OpenLayers API 由于OpenLayers是采用JavaScript实现的，不存在包的概念，但是它可以通过命名空间来实现类似包的功能。另外，JavaScript不存在继承的概念，也不存在私有、公有、保护等概念，OpenLayers中所谓的继承其实就是将基类中的所有属性和方法复制到子类中去。OpenLayers的命名空间如下：一、OpenLayers命名空间：如上图所示，OpenLayers是整个webgis系统的最外层命名空间，所有的地理信息系统相关web程序都在此命名空间下，在此命名空间下又创建了其他的命名空间来管理相关功能的类。在这个命名空间

2、下定义了一些基础类和基类来构建整个框架。1、class OpenLayers.MapMap类将div DOM元素实例化的对象为地图容器，可以向地图容器中添加图层和控件。构造函数构造函数描述Map（ string divId, Object options）创建地图容器对象。string divId：页面的div元素ID，Object options：地图容器的相关属性。属性属性类型描述eventsOpenLayers.Events地图上能响应的事件集合layersOpenLayers.Layer地图上的图层集合方法方法返回值描述getTileSize()OpenLayers.Size返回瓦片尺

3、寸 addLayer(Layer layer)none向地图容器中添加层,Layer：OpenLayers.LayeraddLayers(Layer )none向地图容器中批量增加层，Layer：OpenLayers.LayerremoveLayer( Layer layer, Boolean setNewBaseLayer)none移除层。Layer:OpenLayers.Layer,删除的层。如果setNewBaseLayer为true从新设置新的baseLayer，默认为truesetBaseLayer(Layer layer)none设置新的baseLayer,隐藏原来的baseLay

4、er,Layer:OpenLayers.LayeraddControl(Control c)none向地图容器中添加控件,Control:OpenLayers.ControlremoveControl(Control c)none从地图容器中移除控件,Control:OpenLayers.ControladdPopup( Popup pp, Boolean closeOther)none新增弹出窗口。参数：pp为弹出窗口, closeOther为是否排它即移除其它弹出窗口 。Popup:OpenLayers.Popup.removePopup(Popup pp)none移除弹出窗口,Popup

5、:OpenLayers.PopupgetZoom()int获取地图当前缩放级别panTo(LonLat ll)none地图中心按指定的方式平滑到新的坐标, LonLat:OpenLayers.LonLatsetCenter( LonLat ll, Int zoom, Boolean drag, Boolean zoomChange)none重新设置地图中心，缩放比列。LonLat ll：设置地图中心的经纬度,LonLat:OpenLayers.LonLatInt zoom：缩放级别Boolean drag：是否触发movestart/end事件Boolean zoomChange：是否触发zo

6、omchange事件getProjection（）string返回投影对象代码，3.0版本将改成返回投影对象getNumZoomLevels()Int返回baseLayer的缩放级别数zoomTo(int zoom)none改变地图的缩放级别zoomIn（）none放大一个级别zoomOut（）none缩小一个级别zoomToScale（float scale）None缩放到给定的尺寸getLonLatFromViewPortPx(Pixel p)OpenLayers.LonLat视口坐标转换地图坐标,Pixel:OpenLayers.PixelgetViewPortPxFromLonLat(

7、LonLat ll)OpenLayers.Pixel地图坐标转换成视口坐标,LonLat:OpenLayers.LonLatgetLonLatFromPixel(Pixel p)OpenLayers.LonLat像素点转经纬度,Pixel:OpenLayers.PixelgetPixelFromLonLat(LonLat ll)OpenLayers.Pixel经纬度转像素点,LonLat:OpenLayers.LonLatgetViewPortPxFromLayerPx(Pixel p)OpenLayers.Pixel层中的坐标转视口坐标,Pixel:OpenLayers.PixelgetLa

8、yerPxFromViewPortPx(Pixel p)OpenLayers.Pixel视口坐标转层坐标,Pixel:OpenLayers.PixelgetLonLatFromLayerPx(Pixel p)OpenLayers.LonLat层坐标转经纬度,Pixel:OpenLayers.PixelgetLayerPxFromLonLat(LonLat ll)OpenLayers.Pixel经纬度转层坐标2、class OpenLayers.Map2基于OpenLayers.Map封装，将自有地图图层和常用控件都已经加载在地图当中，用户无需关心地图数据源等问题，简化了用户的地图调用。实例化该

9、类后即可创建一个可查看和使用的地图对象，其方法和属性与OpenLayers.Map一致，见OpenLayers.Map类。2、class OpenLayers.MarkerOpenLayers命名空间下的Marker类可以被实例化为marker对象，用于标注地图上的位置，marker对象是由LonLat对象和Icon对象组合而成的。markers一般被添加到一个叫做OpenLayers.Layer.Markers的特殊图层中。需要注意的是，如果你在一个marker中使用了一个icon，也就是说，你不能在其他的marker中在使用它一旦你使用了这个icon，你应该clone()这个icon然后在

10、另外的marker中使用这个icon。构造函数构造函数描述Marker( Icon icon, LonLat ll)创建一个Marker点。Icon icon:点的图标,Icon:OpenLayers.IconLonLat ll：点的位置,LonLat:OpenLayers.LonLat.如果不设置icon将给出一个默认的图标。3、class OpenLayers.PopupPopup类实例化一个弹出窗口，通常被添加到地图容器中。构造函数构造函数描述Popup( string id, LonLat ll, Size size, String contentHTML, Boolean close

11、Box, Function closeBoxCallback)创建一个弹出窗口。String id:为该窗口创建一个唯一的标识符，LonLat ll:该窗口在地图上的位置，LonLat：OpenLayers.LonLatSize size:窗口的大小,String contentHTML:窗口中的HTML文本信息，Boolean closeBox:是否显示关闭按钮，Function closeBoxCallback:点击关闭按钮时调用的回调函数方法方法返回值描述setOpacity(float opacity)none设置该窗口的透明度，0.0到1.0之间setSize(Size size)n

12、one设置窗口大小，Size:OpenLayers.SizesetBackgroundColor(Color color)none设置窗口背景颜色setContentHTML(string content)none设置窗口显示内容4、class OpenLayers.IconIcon为图标类，图标指定用来在地图上显示 Marker 的图像。构造函数构造函数描述Icon（ URL img, Size size, Pixel offset, Function calculateOffset）创建OpenLayers.Icon对象。URL img:图标的图片地址，Size size：图标大小，Siz

13、e:OpenLayers.SizePixel offset：图片地位的参考点，Function calculateOffset：提供一个函数用于计算参考点5、class OpenLayers.Format各种format类的基类，它的子类实现reading/writing方法。构造函数构造函数描述initialize(options)构造函数，把参数付给对象的属性。属性属性类型描述optionsObject传给构造函数的一系列参数externalProjectionOpenLayers.ProjectioninternalProjectionOpenLayers.Projection方法方法返

14、回值描述read(string data)Depends on subclass读取一个字符串，根据不同的子类返回不同的类型write(object obj)string传入一个对象返回关于找个对象的字符串6、OpenLayers.RequestOpenLayers.Request命名空间下包含两个常用的AJAX方法，通过这两个方法可以方便的实现XMLHttpRequests功能。方法方法返回值描述OpenLayers.Request.GET( url:urlString, callback:funDeal)none该方法发送一个HTTP GET请求。整个GET方法的参数为一个对象，urlSt

15、ring为请求的地址和参数，funDeal为回调函数，用于处理返回的数据。OpenLayers.Request.POST( url:urlString, callback:funDeal, data:data)none该方法发送一个HTTP POST请求。整个POST方法的参数为一个对象，urlString为接收数据的地址，funDeal为回调函数用于处理返回的数据；data为发送到服务器端的数据。7、class OpenLayers.FeatureFeature是几何信息和属性的结合体，在OpenLayers.Feauter中主要是包括一个标记和经纬度。构造函数构造函数描述initializ

16、e( layer, lonlat, data)构造函数，把参数付给对象的属性。layer:添加feature的层，lonlat:定位该feature的经纬度，data：其他参数属性属性类型描述layerOpenLayers.Layer添加该feature的图层lonlatOpenLayers.Lonlat定位该feature的经纬度dataObjec存放其他数据的对象markerOpenLayers.Marker标记该feature的markerpopupOpenLayers.Popup装载该feature信息的弹出信息窗口方法方法返回值描述onScreen ()Boolean该feature

17、当前是否在屏幕的可视区域内createMarker()OpenLayers.Marker为对象创建一个markerdestroyMarker（）None销毁该对象创建的markercreatePopup ()OpenLayers.Popup为对象创建一个信息窗口destroyPopup（）None销毁该对象创建的信息窗口二、BaseType命名空间:在BaseTypes命名空间下定义了一些基本类型的类，如LonLat、Size等。1、class OpenLayers.LonLatLonLat是以经度和纬度表示的地理坐标点。注意：进行地图投影时通常将经度与地图的 x 坐标联系起来，将纬度与 y

18、坐标联系起来。构造函数构造函数描述LonLat（float lon , float lat）创建OpenLayers.LonLat对象，经度lon在 -180 度和 +180 度之间，而纬度lat将在 -90 度到 +90 度之间周而复始。属性属性类型描述lonNumber:float地图上的经度（X轴坐标）latNumber:float地图上的纬度（Y轴坐标）方法方法返回值描述toShortString()string返回包含lon和lat坐标的字符串，先lon坐标后lat坐标，用逗号分隔。clone()OpenLayers.LonLat返回一个与当前经纬度对象有相同经纬度的新经纬度对象ad

19、d(float lon,float lat)OpenLayers.LonLat改变现有地图的位置，return new OpenLayers.LonLat(this.lon + lon, this.lat + lat);equals(OpenLayers.LonLat ll)boolean当前经纬度对象与经纬度对象ll比较，相同返回true否则返回false2、class OpenLayers.PixelPixel是以像素坐标表示的地图上的一点。在地图坐标系统中，x坐标向右增大，y坐标向下增大。构造函数构造函数描述Pixel（int x , int y）创建OpenLayers.Pixel对象

20、，x、y取地图可见范围内的有效像素点距离。属性属性类型描述xNumber:int地图上的x轴坐标，向右增大。yNumber:int地图上的y轴坐标，向下增大。方法方法返回值描述clone()OpenLayers.Pixel返回一个与当前像素坐标对象有相同值的像素坐标对象equals(OpenLayers.Pixel pix)boolean当前像素坐标对象与像素坐标对象ll比较，相同返回true否则返回false3、class OpenLayers.SizeSize是地图矩形区域的大小（以像素表示）。大小对象有两个参数：width 和 height。宽度是点的 x 坐标的差值，高度是 y 坐标的

21、差值。构造函数构造函数描述Size（int width , int height）创建OpenLayers.Size对象。属性属性类型描述wNumber:int地图矩形区域的宽hNumber:int地图矩形区域的高方法方法返回值描述clone()OpenLayers.Size复制一个当前size对象equals(OpenLayers.Size size)boolean当且仅当其他大小都完全相同时，则返回 true。三、Control命名空间：OpenLayers命名空间下面定义了Control基类，Control命名空间下面的所有类都继承于Control基类。每个具体的控件类实现地图的一项具体

22、操作。控件影响地图的显示和行为，它允许拖动和放大缩小地图以控制地图的比例尺，默认的控件是被添加到地图上的，尽管如此，也可以通过传递可选参数将其加入到地图外部的DIV中。1、class BM.Control.TMeasureDistanceTMeasureDistance为测距控件，它实现OpenLayers.Control接口，因此可用OpenLayers.map.addControl()方法添加到地图中。可能会增加控件定位的参数或方法构造函数构造函数描述TMeasureDistance（）创建MeasureDistance对象。方法方法返回值描述getDistance ()Number:fl

23、oat返回测量的长度,当距离为100000米下时单位为米（m），否则为千米（km）activate()none激活测量长度控件interdict()none禁止测量长度控件事件事件参数描述measure传出一个事件参数e 在控件处于激活状态下，当单击鼠标时触发2、class BM.Control.TMeasurePolygonTMeasurePolygon为测面积控件，它实现OpenLayers.Control接口，因此可用OpenLayers.Map.addControl()方法添加到地图中。可能会增加控件定位的参数或方法构造函数构造函数描述TMeasurePolygon（）创建TMeasu

24、rePolygon对象。方法方法返回值描述getArea()Number:float返回测量的面积,当面积为100000平方米下时单位为平方米（），否则为千米（k）activate()none激活测面积控件interdict()none禁止测面积控件事件事件参数描述measure传出一个事件参数e 在控件处于激活状态下，当单击鼠标时触发3、class BM.Control.TPanZoomBarPanZoomBar为缩放移动控件，继承于OpenLayers中的PanZoomBar，主要工作为修改样式，使图标跟以前GZGIS中对应的控件一样，增加设置最大级别和最小级别的功能,它实现了OpenLa

25、yers.Control接口，因此可用OpenLayers.Map.addControl()方法添加到地图中。构造函数构造函数描述TPanZoomBar（）创建PanZoomBar控件对象。4、class BM.Control.TOverviewMapOverviewMap为缩略图控件（鹰眼控件），可继承于OpenLayers中的OverviewMap，主要工作为修改样式，由于OpenLayers.OverviewMap实现了OpenLayers.Control接口，因此可用OpenLayers.Map.addControl()方法添加到地图中。构造函数构造函数描述OverviewMap（）创

26、建OverviewMap控件对象。属性属性类型描述sizeOpenLayers.Size缩略图控件的像素大小。layersArray(OpenLayers.Layer)各层的缩略图控件列表，如果不设置，则只显示首层的地图缩略图5、class BM.Control.TNavigationTNavigation为导航控件，该控件将分类导航,一个导航控件中包含一到多个TNavPage实例。该控件实现了OpenLayers.Control接口，可由OpenLayers.Map.addControl()方法加载到地图中。构造函数构造函数描述TNavigation（TNavPage ）根据分类页实例数组创

27、建TNavigation控件对象。方法方法返回值描述setPosition(Pixel p)none设置控件显示位置,Pixel:OpenLayers.Pixelshow()none显示该控件hide()none隐藏该控件switchType(string TNavPage_id)none根据导航分类页id切换导航类别：比如“政府类”，“酒店类”AddNavPage (TNavPage )none添加分类页数组到导航控件里6、class BM.Control.TGotoTGoto为定位控件，根据用户输入的经纬度定位地图。/调用事例 /1、不设置标题 /map.addControl(new BM

28、.Control.TGoTo(); /2、设置标题 /var gotoControl = new BM.Control.TGoTo(); /gotoControl.setTitle(标题); /map.addControl(gotoControl);构造函数构造函数描述TGoto()创建TGotoControl对象。方法方法返回值描述setTitle（string str）none给定位窗口设置标题，默认为请输入经纬度：7、class BM.Control.TDivTreeTDivTree为复选框树行控件，被添加到DOM元素中，无需实现OpenLayers.Control接口，与地图无关。构造

29、函数构造函数描述TDivTree(string treeData)构造函数，通过str创建一个复选框树对象 。String treeData：包含了生成一棵树的相关数据信息。方法方法返回值描述init(function fun)none将回调函数传给这个棵树，使树能根据回调函数能产生不同的响应效果。fun（node），回调函数会传入一个当前复选框被点击的对象。getAllNodes()TTreeNode 根据树的前序遍历获取整棵树的节点数组，包括根8、class BM.Control.TTreeTTree为复选框树的数据结构，可以获得数组形式的所有节点和树形式的所有节点，可以获得包含自己的树对象。