OpenLayers API接口文档Word文件下载.docx
《OpenLayers API接口文档Word文件下载.docx》由会员分享，可在线阅读，更多相关《OpenLayers API接口文档Word文件下载.docx（35页珍藏版）》请在冰豆网上搜索。
addLayers（Layer[]）
向地图容器中批量增加层，Layer：
removeLayer（
Layerlayer,
BooleansetNewBaseLayer
移除层。
Layer:
OpenLayers.Layer,删除的层。
如果setNewBaseLayer为true从新设置新的baseLayer，默认为true
setBaseLayer（Layerlayer）
设置新的baseLayer,隐藏原来的baseLayer,Layer:
addControl（Controlc）
向地图容器中添加控件,Control:
OpenLayers.Control
removeControl（Controlc）
从地图容器中移除控件,Control:
addPopup（
Popuppp,
BooleancloseOther
新增弹出窗口。
参数：
pp为弹出窗口,closeOther为是否排它即移除其它弹出窗口。
Popup:
OpenLayers.Popup.
removePopup（Popuppp）
移除弹出窗口,Popup:
OpenLayers.Popup
getZoom（）
int
获取地图当前缩放级别
panTo（LonLatll）
地图中心按指定的方式平滑到新的坐标,LonLat:
OpenLayers.LonLat
setCenter（
LonLatll,
Intzoom,
Booleandrag,
BooleanzoomChange
重新设置地图中心，缩放比列。
LonLatll：
设置地图中心的经纬度,LonLat:
Intzoom：
缩放级别
Booleandrag：
是否触发movestart/end事件
BooleanzoomChange：
是否触发zoomchange事件
getProjection（）
string
返回投影对象代码，3.0版本将改成返回投影对象
getNumZoomLevels（）
Int
返回baseLayer的缩放级别数
zoomTo（intzoom）
改变地图的缩放级别
zoomIn（）
放大一个级别
zoomOut（）
缩小一个级别
zoomToScale（floatscale）
None
缩放到给定的尺寸
getLonLatFromViewPortPx（Pixelp）
视口坐标转换地图坐标,Pixel:
OpenLayers.Pixel
getViewPortPxFromLonLat（LonLatll）
地图坐标转换成视口坐标,LonLat:
getLonLatFromPixel（Pixelp）
像素点转经纬度,Pixel:
getPixelFromLonLat（LonLatll）
经纬度转像素点,LonLat:
getViewPortPxFromLayerPx（Pixelp）
层中的坐标转视口坐标,Pixel:
getLayerPxFromViewPortPx（Pixelp）
视口坐标转层坐标,Pixel:
getLonLatFromLayerPx（Pixelp）
层坐标转经纬度,Pixel:
getLayerPxFromLonLat（LonLatll）
经纬度转层坐标
2、classOpenLayers.Map2
基于OpenLayers.Map封装，将自有地图图层和常用控件都已经加载在地图当中，用户无需关心地图数据源等问题，简化了用户的地图调用。
实例化该类后即可创建一个可查看和使用的地图对象，其方法和属性与OpenLayers.Map一致，见OpenLayers.Map类。
2、classOpenLayers.Marker
OpenLayers命名空间下的Marker类可以被实例化为marker对象，用于标注地图上的位置，marker对象是由LonLat对象和Icon对象组合而成的。
markers一般被添加到一个叫做OpenLayers.Layer.Markers的特殊图层中。
需要注意的是，如果你在一个marker中使用了一个icon，也就是说，你不能在其他的marker中在使用它——一旦你使用了这个icon，你应该clone（）这个icon然后在另外的marker中使用这个icon。
Marker（
Iconicon,
LonLatll
创建一个Marker点。
Iconicon:
点的图标,Icon:
OpenLayers.Icon
点的位置,LonLat:
OpenLayers.LonLat.
如果不设置icon将给出一个默认的图标。
3、classOpenLayers.Popup
Popup类实例化一个弹出窗口，通常被添加到地图容器中。
Popup（
stringid,
Sizesize,
StringcontentHTML,
BooleancloseBox,
FunctioncloseBoxCallback
创建一个弹出窗口。
Stringid:
为该窗口创建一个唯一的标识符，
LonLatll:
该窗口在地图上的位置，LonLat：
Sizesize:
窗口的大小,
StringcontentHTML:
窗口中的HTML文本信息，
BooleancloseBox:
是否显示关闭按钮，
FunctioncloseBoxCallback:
点击关闭按钮时调用的回调函数
setOpacity（floatopacity）
设置该窗口的透明度，0.0到1.0之间
setSize（Sizesize）
设置窗口大小，Size:
setBackgroundColor（Colorcolor）
设置窗口背景颜色
setContentHTML（stringcontent）
设置窗口显示内容
4、classOpenLayers.Icon
Icon为图标类，图标指定用来在地图上显示Marker的图像。
Icon（
URLimg,
Pixeloffset,
FunctioncalculateOffset
创建OpenLayers.Icon对象。
URLimg:
图标的图片地址，
Sizesize：
图标大小，Size:
Pixeloffset：
图片地位的参考点，
FunctioncalculateOffset：
提供一个函数用于计算参考点
5、classOpenLayers.Format
各种format类的基类，它的子类实现reading/writing方法。
initialize（options）
构造函数，把参数付给对象的属性。
options
Object
传给构造函数的一系列参数
externalProjection
OpenLayers.Projection
internalProjection
read（stringdata）
Dependsonsubclass
读取一个字符串，根据不同的子类返回不同的类型
write（objectobj）
传入一个对象返回关于找个对象的字符串
6、OpenLayers.Request
OpenLayers.Request命名空间下包含两个常用的AJAX方法，通过这两个方法可以方便的实现XMLHttpRequests功能。
OpenLayers.Request.GET（{
url:
urlString,
callback:
funDeal
}）
该方法发送一个HTTPGET请求。
整个GET方法的参数为一个对象，urlString为请求的地址和参数，funDeal为回调函数，用于处理返回的数据。
OpenLayers.Request.POST（{
funDeal,
data:
data
该方法发送一个HTTPPOST请求。
整个POST方法的参数为一个对象，urlString为接收数据的地址，funDeal为回调函数用于处理返回的数据；
data为发送到服务器端的数据。
7、classOpenLayers.Feature
Feature是几何信息和属性的结合体，在OpenLayers.Feauter中主要是包括一个标记和经纬度。
initialize（
layer,
lonlat,
data
layer:
添加feature的层，
lonlat:
定位该feature的经纬度，
data：
其他参数
layer
添加该feature的图层
lonlat
OpenLayers.Lonlat
定位该feature的经纬度
Objec
存放其他数据的对象
marker
OpenLayers.Marker
标记该feature的marker
popup
装载该feature信息的弹出信息窗口
onScreen（）
Boolean
该feature当前是否在屏幕的可视区域内
createMarker（）
为对象创建一个marker
destroyMarker（）
销毁该对象创建的marker
createPopup（）
为对象创建一个信息窗口
destroyPopup（）
销毁该对象创建的信息窗口
二、BaseType命名空间:
在BaseTypes命名空间下定义了一些基本类型的类，如LonLat、Size等。
1、classOpenLayers.LonLat
LonLat是以经度和纬度表示的地理坐标点。
注意：
进行地图投影时通常将经度与地图的x坐标联系起来，将纬度与y坐标联系起来。
LonLat（floatlon,floatlat）
创建OpenLayers.LonLat对象，经度lon在-180度和+180度之间，而纬度lat将在-90度到+90度之间周而复始。
lon
Number:
float
地图上的经度（X轴坐标）
lat
地图上的纬度（Y轴坐标）
toShortString（）
返回包含lon和lat坐标的字符串，先lon坐标后lat坐标，用逗号分隔。
clone（）
返回一个与当前经纬度对象有相同经纬度的新经纬度对象
add（floatlon,floatlat）
改变现有地图的位置，returnnewOpenLayers.LonLat（this.lon+lon,this.lat+lat）;
equals（OpenLayers.LonLatll）
boolean
当前经纬度对象与经纬度对象ll比较，相同返回true否则返回false
2、classOpenLayers.Pixel
Pixel是以像素坐标表示的地图上的一点。
在地图坐标系统中，x坐标向右增大，y坐标向下增大。
Pixel（intx,inty）
创建OpenLayers.Pixel对象，x、y取地图可见范围内的有效像素点距离。
x
地图上的x轴坐标，向右增大。
y
地图上的y轴坐标，向下增大。
返回一个与当前像素坐标对象有相同值的像素坐标对象
equals（OpenLayers.Pixelpix）
当前像素坐标对象与像素坐标对象ll比较，相同返回true否则返回false
3、classOpenLayers.Size
Size是地图矩形区域的大小（以像素表示）。
大小对象有两个参数：
width和height。
宽度是点的x坐标的差值，高度是y坐标的差值。
Size（intwidth,intheight）
创建OpenLayers.Size对象。
w
地图矩形区域的宽
h
地图矩形区域的高
复制一个当前size对象
equals（OpenLayers.Sizesize）
当且仅当其他大小都完全相同时，则返回true。
三、Control命名空间：
OpenLayers命名空间下面定义了Control基类，Control命名空间下面的所有类都继承于Control基类。
每个具体的控件类实现地图的一项具体操作。
控件影响地图的显示和行为，它允许拖动和放大缩小地图以控制地图的比例尺，默认的控件是被添加到地图上的，尽管如此，也可以通过传递可选参数将其加入到地图外部的DIV中。
1、classBM.Control.TMeasureDistance
TMeasureDistance为测距控件，它实现OpenLayers.Control接口，因此可用OpenLayers.map.addControl（）方法添加到地图中。
可能会增加控件定位的参数或方法
TMeasureDistance（）
创建MeasureDistance对象。
getDistance（）
返回测量的长度,当距离为100000米下时单位为米（m），否则为千米（km）
activate（）
激活测量长度控件
interdict（）
禁止测量长度控件
事件
参数
measure
传出一个事件参数e
在控件处于激活状态下，当单击鼠标时触发
2、classBM.Control.TMeasurePolygon
TMeasurePolygon为测面积控件，它实现OpenLayers.Control接口，因此可用OpenLayers.Map.addControl（）方法添加到地图中。
TMeasurePolygon（）
创建TMeasurePolygon对象。
getArea（）
返回测量的面积,当面积为100000平方米下时单位为平方米（㎡），否则为千米（k㎡）
激活测面积控件
禁止测面积控件
3、classBM.Control.TPanZoomBar
PanZoomBar为缩放移动控件，继承于OpenLayers中的PanZoomBar，主要工作为修改样式，使图标跟以前GZGIS中对应的控件一样，增加设置最大级别和最小级别的功能,它实现了OpenLayers.Control接口，因此可用OpenLayers.Map.addControl（）方法添加到地图中。
TPanZoomBar（）
创建PanZoomBar控件对象。
4、classBM.Control.TOverviewMap
OverviewMap为缩略图控件（鹰眼控件），可继承于OpenLayers中的OverviewMap，主要工作为修改样式，由于OpenLayers.OverviewMap实现了OpenLayers.Control接口，因此可用OpenLayers.Map.addControl（）方法添加到地图中。
OverviewMap（）
创建OverviewMap控件对象。
size
缩略图控件的像素大小。
Array（OpenLayers.Layer）
各层的缩略图控件列表，如果不设置，则只显示首层的地图缩略图
5、classBM.Control.TNavigation
TNavigation为导航控件，该控件将分类导航,一个导航控件中包含一到多个TNavPage实例。
该控件实现了OpenLayers.Control接口，可由OpenLayers.Map.addControl（）方法加载到地图中。
TNavigation（TNavPage[]）
根据分类页实例数组创建TNavigation控件对象。
setPosition（Pixelp）
设置控件显示位置,Pixel:
show（）
显示该控件
hide（）
隐藏该控件
switchType（stringTNavPage_id）
根据导航分类页id切换导航类别：
比如“政府类”，“酒店类”
AddNavPage（TNavPage[]）
添加分类页数组到导航控件里
6、classBM.Control.TGoto
TGoto为定位控件，根据用户输入的经纬度定位地图。
//调用事例
//1、不设置标题
//map.addControl（newBM.Control.TGoTo（））;
//2、设置标题
//vargotoControl=newBM.Control.TGoTo（）;
//gotoControl.setTitle（"
标题"
）;
//map.addControl（gotoControl）;
TGoto（）
创建TGotoControl对象。
setTitle（stringstr）
给定位窗口设置标题，默认为"
请输入经纬度：
"
7、classBM.Control.TDivTree
TDivTree为复选框树行控件，被添加到DOM元素中，无需实现OpenLayers.Control接口，与地图无关。
TDivTree（stringtreeData）
构造函数，通过str创建一个复选框树对象。
StringtreeData：
包含了生成一棵树的相关数据信息。
init（functionfun）
将回调函数传给这个棵树，使树能根据回调函数能产生不同的响应效果。
fun（node），回调函数会传入一个当前复选框被点击的对象。
getAllNodes（）
TTreeNode[]
根据树的前序遍历获取整棵树的节点数组，包括根
8、classBM.Control.TTree
TTree为复选框树的数据结构，可以获得数组形式的所有节点和树形式的所有节点，可以获得包含自己的树对象。
升级会员 