静态方法
静态方法 | 返回值 | 说明 |
---|
addDomListener(instance:Object, eventName:string, handler:Function) | EventListener | 注册Dom事件。删除该事件的监听器时调用removeListener,将返回的eventListener作为参数 |
addDomListenerOnce(instance:Object, eventName:string, handler:Function) | EventListener | 类似于event.addDomListener ,但处理程序在处理完第一个事件后将自己移除。 |
addListener(instance:Object, eventName:string, handler:Function) | EventListener | 注册对象事件。删除该事件的监听器时调用removeListener,将返回的eventListener作为参数 |
addListenerOnce(instance:Object, eventName:string, handler:Function) | EventListener | 类似于event.addListener ,但处理程序会在处理完第一个事件后将自己移除。 |
clearListeners(instance:Object, eventName:string) | none | 对于指定实例,删除其指定事件的所有侦听器。 |
removeListener(listener:EventListener) | none | 删除由上述event.addDomListener 和event.addListener 传回的指定侦听器。 |
trigger(instance:Object, eventName:string, var_args:*) | none | 触发指定事件。eventName 后的所有参数都以参数的形式传递到侦听器。 |
EventListener 对象规范
此类是不透明的。它没有方法和构造函数。此类的实例从 addListener()
、addDomListener()
返回,并最终传递回removeListener()
。
MapsEvent 对象规范
此对象由地图和叠加层上的各种鼠标事件返回,包含如下所示的所有字段。
属性
属性 | 类型 | 说明 |
---|
latLng | LatLng | 发生事件时在光标下方显示的纬度/经度。 |
pixel | Point | 发生事件时在光标下方显示的像素坐标。 |
type | string | 发生事件时的事件类型。 |
target | Object | 发生事件时的目标对象。 |
Map 类
用来实例化一个地图,此类扩展了 MVCObject.
构造函数
构造函数 | 说明 |
---|
Map(mapDiv:Node, opts?:MapOptions ) | 在指定的 HTML 容器中创建新的地图,该容器通常是一个 DIV 元素。 |
方法
方法 | 返回值 | 说明 |
---|
fitBounds(bounds:LatLngBounds) | none | 设置地图,使其与指定的范围相符。 |
getBounds() | LatLngBounds | 返回当前地图区域的纬度/经度范围。如果还未启动地图(即 mapType 仍为 Null),或者没有设置中心和缩放,则结果为 Null。可以通过侦听 bounds_changed ,检查并确保其值不为 Null。 |
getCenter() | LatLng | 返回地图当前中心点地理坐标。 |
getZoom() | number | 返回地图缩放级别。 |
getContainer() | Node | 返回当前地图所在的 HTML 容器。 |
getMapTypeId() | MapTypeId | 返回当前地图类型ID。 |
getProjection() | Projection | 传回当前地图的投影对象。如果还未启动地图(即 mapType 仍为 Null),则结果为 Null。侦听 projection_changed 并确保其值不为 Null。 |
panBy(x:number, y:number) | none | 将地图中心移动一段指定的距离(以像素为单位)。 |
zoomBy(deltaZoom:number) | none | 将地图平滑缩放到当前的级别加上指定的数值后的级别。 |
panTo(latLng:LatLng) | none | 将地图中心更改为指定的 LatLng 。 |
zoomTo(zoom:number) | none | 将地图平滑缩放到指定的级别。 |
flyTo(latLng:LatLng,zoom:number) | none | 将地图中心点以飞跃的形式移动并缩放到放指定的级别和坐标。 |
setCenter(latLng:LatLng) | none | 设置地图中心点坐标。 |
setZoom(zoom:number) | none | 设置地图缩放级别。 |
setMapTypeId(mapTypeId:MapTypeId) | none | 更换地图类型ID。 |
setOptions(options:MapOptions) | none | 设置地图参数。 |
属性
属性 | 类型 | 说明 |
---|
mapTypes | MapTypeRegistry | 按字符串 ID 划分的 MapType 实例的注册表。 |
controls | Array.<MVCArray.< Node> > | 在地图上添加自定义控件。添加一个div元素到ControlPosition对应的MVCArray中。 例如:map.controls[soso.maps.ControlPosition.LEFT_TOP].push(div) |
事件
事件 | 参数 | 说明 |
---|
bounds_changed | none | 当可视区域范围更改时会触发此事件。 |
center_changed | none | 当地图中心属性更改时会触发此事件。 |
click | MapsEvent | 当用户点击地图(但不是点击标记或信息窗口)时会触发此事件。 |
dblclick | MapsEvent | 当用户双击地图时会触发此事件。请注意,触发此事件前还会触发点击事件。 |
drag | MapsEvent | 当用户拖动地图时会反复触发此事件。 |
dragend | MapsEvent | 当用户停止拖动地图时会触发此事件。 |
dragstart | MapsEvent | 当用户开始拖动地图时会触发此事件。 |
idle | none | 如果地图在平移或缩放之后变为闲置状态,则会触发此事件。 |
maptypeid_changed | none | 当 mapTypeId 属性更改时会触发此事件。 |
mousemove | MapsEvent | 只要用户的鼠标在地图容器上移动,就会触发此事件。 |
mouseout | MapsEvent | 当用户的鼠标从地图容器上退出时会触发此事件。 |
mouseover | MapsEvent | 当用户的鼠标进入地图容器时会触发此事件。 |
projection_changed | none | 当投影更改时会触发此事件。 |
resize | none | 当地图容器更改大小时,触发此事件。 |
rightclick | MapsEvent | 在地图容器中触发 DOM contextmenu 事件时会触发此事件。 |
zoom_changed | none | 当地图缩放属性更改时会触发此事件。 |
MapOptions 对象规范
属性
属性 | 类型 | 说明 |
---|
backgroundColor | string | 用作地图 div 的背景颜色。当用户进行平移时,如果尚未载入图块,则显示此颜色。仅在地图初始化时,才能设置此选项。 |
boundary | LatLngBounds | boundary规定了地图的边界,即地图不可在boundary范围之外操作。 |
center | LatLng | 初始的地图中心。 |
zoom | number | 初始的地图缩放级别。 |
disableDoubleClickZoom | boolean | 启用/停用在双击鼠标左键时时放大地图。默认情况下处于启用状态。 |
draggable | boolean | 如果为 false ,则禁止拖动地图。默认情况下启用拖动。 |
draggableCursor | string | 地图的默认鼠标指针样式。 |
draggingCursor | string | 拖动地图时的鼠标指针样式。 |
keyboardShortcuts | boolean | 如果为 false ,则禁止通过键盘控制地图。默认情况下启用键盘快捷键。 |
noClear | boolean | 如果为 true ,在初始化地图时不会清除地图容器内的内容。 |
scrollwheel | boolean | 如果为 false ,则停用通过滚轮缩放地图的功能。默认情况下启用滚轮功能。 |
mapTypeControl | boolean | 地图类型控件的初始启用/停用状态。 |
mapTypeControlOptions | MapTypeControlOptions | 地图类型控件的初始化选项。 |
navigationControl | boolean | 平移缩放控件的初始启用/停用状态。(该属性即将废弃,开发者请使用panControl和zoomControl) |
navigationControlOptions | NavigationControlOptions | 平移缩放控件的初始化选项。(该属性即将废弃,开发者请使用panControl和zoomControl) |
scaleControl | boolean | 比例尺控件的初始启用/停用状态。 |
scaleControlOptions | scaleControlOptions | 比例尺控件的初始化选项。 |
panControl | boolean | 平移控件的初始启用/停用状态。 |
panControlOptions | panControlOptions | 平移控件的初始化选项。 |
zoomControl | boolean | 缩放控件的初始启用/停用状态。 |
zoomControlOptions | zoomControlOptions | 缩放控件的初始化选项。 |
MapTypeId 类
常见 MapTypes 的标识符。
常数
常数 | 说明 |
---|
ROADMAP | 该地图类型显示普通的街道地图。 |
SATELLITE | 该地图类型显示卫星图像。 |
HYBRID | 该地图类型显示卫星图像上的主要街道透明层。 |
MapPanes 对象规范
此对象包含渲染叠加层的 DOM 元素。下面列出了这些元素,底部为“窗格 0”,顶部为“窗格 6”。
属性
属性 | 类型 | 说明 |
---|
floatPane | Node | 此窗格包含信息窗口。它位于所有地图叠加层之上。(窗格 6)。 |
overlayMouseTarget | Node | 此窗格包含透明元素,可接收针对标记的 DOM 鼠标事件。该窗格在 floatShadow 之上,这样便可点击信息窗口阴影中的标记。(窗格 5)。 |
floatShadow | Node | 此窗格包含信息窗口阴影。该窗格在overlayImage 之上,这样标记便可位于信息窗口的阴影中。(窗格 4)。 |
overlayImage | Node | 此窗格包含标记前景图像。(窗格 3)。 |
overlayShadow | Node | 此窗格包含标记阴影。(窗格 2)。 |
overlayLayer | Node | 此窗格包含折线、多边形、地面叠加层和图块图层叠加层。(窗格 1)。 |
mapPane | Node | 此窗格是最下面的窗格,位于图块之上。(窗格 0)。 |
MapCanvasProjection 对象规范
方法
方法 | 返回值 | 说明 |
---|
fromContainerPixelToLatLng(pixel:Point ) | LatLng | 根据地图容器中的像素坐标计算地理坐标。 |
fromLatLngToContainerPixel(latLng:LatLng ) | Point | 计算地图外部容器的 DOM 元素中指定地理位置的像素坐标。 |
fromDivPixelToLatLng(pixel:Point ) | LatLng | 根据存放可拖动地图的 div 中的像素坐标计算地理坐标。 |
fromLatLngToDivPixel(latLng:LatLng ) | Point | 计算存放可拖动地图的 DOM 元素中指定地理位置的像素坐标。 |
MapType 对象规范
表示一种地图类型,您可以通过实例化此类自定义地图类型。
属性
属性 | 类型 | 说明 |
---|
layers | Array.<TileLayer> | 此 MapType 所拥有的瓦片图层。必选。 |
alt | string | 当此 MapType 的按钮悬停在 MapTypeControl 中时显示的备选文本。可选。 |
maxZoom | number | 显示此 MapType 时地图的最大缩放级别。对于基本 MapType,为必填项。而对于叠加层 MapType,则将其忽略。 |
minZoom | number | 显示此 MapType 时地图的最小缩放级别。可选;默认值为 0。 |
name | string | 要在 MapTypeControl 中显示的名称。可选。 |
projection | Projection | 用于渲染此 MapType 的投影。可选;默认值为 Mercator。 |
radius | number | 地图的行星半径(以米为单位)。可选;默认为地球的赤道半径(6378137 米)。 |
tileSize | Size | 每个图块的尺寸。必填。 |
Projection 对象规范
方法
方法 | 返回值 | 说明 |
---|
fromLatLngToPoint(latLng:LatLng,zoom:number) | Point | 从 LatLng 圆柱转换为 Point 平面。此接口指定一个函数,该函数实现从指定 LatLng 值到地图投影上的世界地图坐标的转换。SOSO Maps API 在需要在屏幕上绘制位置时调用此方法。Projection 对象必须实现此方法。 |
fromPointToLatLng(pixel:Point, zoom:number) | LatLng | 此接口指定一个函数,该函数实现从地图投影上的世界地图坐标到 LatLng 值的转换。SOSO Maps API 在需要将屏幕上的操作转换为地图上的位置时调用此方法。Projection 对象必须实现此方法。 |
MapTypeRegistry 类
此类扩展了 MVCObject.
构造函数
构造函数 | 说明 |
---|
MapTypeRegistry() | MapTypeRegistry 拥有一组可用于地图以帮助它实现用途的自定义地图类型。例如,API 将在提供控件中的可用地图类型列表时参考此注册表。 |
方法
方法 | 返回值 | 说明 |
---|
set(id:string, mapType:MapType) | none | 设置注册表以将传递的字符串标识符与传递的 MapType 相关联。 |
ImageMapType 类
此类实现了MapType接口,可用来渲染图像瓦片。该类扩展了 MVCObject。
构造函数
ImageMapTypeOptions 对象规范
属性
属性 | 类型 | 说明 |
---|
alt | string | 当此 MapType 的按钮悬停在MapTypeControl 中时显示的备选文本。可选。 |
getTileUrl | Function(Point,number):string | 通过传入的瓦片坐标(x,y)以及zoom级别返回瓦片的URL(string类型)。该方法形式如下:Function(Point,number):string |
minZoom | number | 指定用于显示图层的最小缩放级别。 |
maxZoom | number | 指定用于显示图层的最大缩放级别。 |
name | string | 图层名称。要在 MapTypeControl 中显示的名称。可选。 |
tileSize | Size | 瓦片尺寸。 |
Panorama 类
此类扩展了 MVCObject.
构造函数
构造函数 | 说明 |
---|
Panorama(container:Node, opts?:PanoramaOptions ) | 在指定的 HTML 容器中创建街景,该容器通常是一个 DIV 元素。 |
方法
方法 | 返回值 | 说明 |
---|
getPano() | string | 获取当前场景的id。 |
setPano(pano:string) | none | 设置场景。pano是要设置的场景的id。 |
getPov() | PanoPov | 获取全景查看器的视角。 |
setPov(pov:PanoPov) | none | 设置全景查看器的视角。 |
getZoom() | number | 获取当前场景的缩放级别。 |
setZoom(zoom:number) | none | 设置缩放级别,没有动画。5>zoom>0 |
getVisible() | boolean | 获取街景查看器的显示状态(显示/隐藏)。 |
setVisible(visible:boolean) | none | 设置街景查看器的显示状态。 |
getPosition() | LatLng | 获取当前场景点的经纬度信息。 |
事件
事件 | 参数 | 说明 |
---|
pano_changed | none | 场景发生改变时会触发此事件。 |
pov_changed | none | 俯仰角发生改变时会触发此事件。 |
zoom_changed | none | 街景显示器的放大级别发生改变时会触发此事件。 |
visible_changed | none | 显示/隐藏状态发生变化时会触发此事件。 |
position_changed | none | 场景发生改变时会触发此事件。 |
error | none | 场景发生点加载失败的时候触发此事件。 |
loaded | none | flash加载成功的时候触发此事件。 |
PanoramaOptions 对象规范
属性
属性 | 类型 | 说明 |
---|
pano | string | 场景点的唯一标识 |
pov | PanoPov | 修改场景的俯仰角。 |
zoom | number | 放大级别,值大于1小于4。 |
visible | boolean | 街景的显示/隐藏状态。 |
scrollwheel | boolean | 滚轮是否触发zoom改变的启用/停用状态。 |
disableCompass | boolean | 罗盘显示/隐藏状态。 |
disableMove | boolean | 移动箭头显示/隐藏状态。 |
disableFullScreen | boolean | FLASH全屏控件显示/隐藏状态。 |
PanoPov 对象规范
属性
属性 | 类型 | 说明 |
---|
heading | number | 查看器视线与正北方的水平夹角, 以度为单位。 |
pitch | number | 查看器视线与地面的夹角, 以度为单位 |
PanoramaLayer 类
PanoramaLayer是一个渲染层,它显示来自于Panorama的图像数据。
构造函数
构造函数 | 说明 |
---|
PanoramaLayer() | 显示来自于Panorama的数据的图层。 |
方法
方法 | 返回值 | 说明 |
---|
setMap(map:Map) | None | 设置街景路网图层所属的地图容器。 |
PanoramaLabel 类
此类扩展了 MVCObject.
构造函数
方法
方法 | 返回值 | 说明 |
---|
setPanorama(panorama:Panorama) | none | 设置label要显示的街景对象。 |
getPanorama(panorama:Panorama) | none | 获得Label显示的街景对象。 |
setPosition(position:LatLng) | none | 设置Label所在的位置。 |
getPosition() | LatLng | 获取Label所在的位置坐标。 |
setContent(content:string) | none | 设置Label的内容信息。 |
getContent() | string | 返回Label的内容信息。 |
setVisible(visible:boolean) | none | 设置Label的可见性。 |
getVisible() | boolean | 返回Label的可见性。 |
setAltitude(altitude:float) | none | 设置Label距离地面的高度。 |
getAltitude() | boolean | 获得Label距离地面的高度。 |
事件
事件 | 参数 | 说明 |
---|
click | Object | 点击Label后触发此事件。 |
mouseover | Object | 当鼠标进入Label时触发此事件。 |
mouseout | Object | 当鼠标移出Label时触发此事件。 |
PanoramaLabelOptions 对象规范
属性
属性 | 类型 | 说明 |
---|
panorama | Panorama | 场景对象 |
visible | boolean | 待显示Label的可见性。如果为 true,则显示标记。 |
position | LatLng | 标注所在位置。必填。 |
content | content:string | 要在Label中显示的内容。该内容只可以是string 元素。 |
altitude | altitude:float | label距离地面的高度,单位m。 |
PanoramaService 类
街景检索类。用于通过经纬度吸附街景场景点以及判断给定Bounds是否包含全景点。
构造函数
构造函数 | 说明 |
---|
PanoramaService() | 街景检索类构造函数。 |
方法
方法 | 返回值 | 说明 |
---|
checkBounds(bounds:LatLngBounds, callback:Function) | undefined | 判断指定范围内是否包含全景。callback为回调函数,参数为布尔值,true表示指定bounds存在街景,false表示指定bounds不存在街景 |
getPano(position:LatLng, radius:Number, callback:Function) | undefined | 在指定位置和半径范围内查找最近的全景, 通过回调返回全景的Id和其所在位置, 若未找到则返回null ,callback为回调函数, function(location:PanoramaLocation),吸附失败,回调函数参数为null |
PanoramaLocation 对象规范
场景点所在位置信息。
属性
属性 | 类型 | 说明 |
---|
svid | string | 场景id |
latlng | LatLng | 场景的经纬度 |
description | string | 场景的描述,场景所在路名等 |
Point 类
构造函数
构造函数 | 说明 |
---|
Point(x:number, y:number) | 二维平面上的点。 |
方法
方法 | 返回值 | 说明 |
---|
equals(other:Point) | boolean | 比较两个点是否相等。 |
getX() | number | 传回该点的 x 坐标。 |
getY() | number | 传回该点的 y 坐标。 |
toString() | string | 转换为字符串表示。 |
clone() | Point | 创建并返回一份 Point 的拷贝。 |
distanceTo(other:Point) | number | 计算两个点之间的距离。 |
Size 类
构造函数
构造函数 | 说明 |
---|
Size(width:number, height:number, widthUnit?:string, heightUnit?:string) | 以指定的宽度和高度创建一个矩形区域。 |
方法
方法 | 返回值 | 说明 |
---|
equals(other:Size) | boolean | 比较两个矩形区域是否相等。 |
getWidth() | number | 传回该矩形区域的 width 宽度。 |
getHeight() | number | 传回该矩形区域的 heihgt 高度 。 |
toString() | string | 转换为字符串表示。 |
clone() | Size | 创建并返回一份Size的拷贝。 |
Color类
Color
是描述一个颜色及透明度的类。注意,您不能修改 Color
的属性。如果您想要改变一个其他颜色,则必须创建一个新的Color
实例。
构造函数
构造函数 | 说明 |
---|
Color(red:number, green:number, blue:number, alpha?:number) | 返回一个Color实例。red,green,blue三个色值的取值范围是0-255的整数,请注意色值的顺序。 alpha代表透明度,取值范围是0-1,默认为1 |
方法
方法 | 返回值 | 说明 |
---|
toRGB() | string | 返回格式:rgb(r,g,b),如:rgb(255,255,255) |
toRGBA() | string | 返回格式: rgba(r,g,b,a),如:rgba(255,255,255,1) |
toHex() | string | 返回格式: #FFFFFF |
静态方法
方法 | 返回值 | 说明 |
---|
fromHex(hex:string,alpha:number) | none | 通过#FFFFFF或者#FFF生成Color实例,alpha取值范围为0-1 |
LatLng 类
LatLng
是以纬度和经度表示的地理坐标点。 请注意,尽管进行地图投影时通常将经度与地图的 x 坐标相关联,将纬度与 y 坐标相关联,但总是先写入纬度坐标,再写入经度坐标。
另请注意,您不能修改 LatLng
的坐标。如果您想要计算另一个点,则必须创建一个新点。
构造函数
构造函数 | 说明 |
---|
LatLng(lat:number, lng:number) | 请注意纬度和经度的顺序。lat是纬度值,lon是经度值。 |
方法
方法 | 返回值 | 说明 |
---|
equals(other:LatLng) | boolean | 比较两个经纬度坐标是否相等。 |
getLat() | number | 返回纬度值(以度为单位)。 |
getLng() | number | 返回经度值(以度为单位)。 |
toString() | string | 转换为字符串表示。 如:“39,116” |
clone() | LatLng | 复制一份 LatLng 实例。 |
distanceTo(other:LatLng) | number | 计算两个经纬度之间的距离,单位为米。 |
LatLngBounds 类
地理坐标范围类,表示矩形地理坐标对象,采用西南、东北坐标表示。
构造函数
构造函数 | 说明 |
---|
LatLngBounds(LatLngBounds(sw?:LatLng, ne?:LatLng)) | 基于矩形的西南角和东北角处的坐标点构造矩形。 |
方法
ALIGN 对象规范
用来设置对齐样式的对象。(该对象即将废弃,开发者请使用ControlPosition)
属性
属性 | 类型 | 说明 |
---|
TOP_LEFT | Const | 相对左上角对齐。 |
TOP | Const | 相对上方中间位置对齐。 |
TOP_RIGHT | Const | 相对右上角对齐。 |
LEFT | Const | 相对左方中间位置对齐。 |
CENTER | Const | 相对中心点对齐。 |
RIGHT | Const | 相对右方中间位置对齐。 |
BOTTOM_LEFT | Const | 相对左下角对齐。 |
BOTTOM | Const | 相对下方中间位置对齐。 |
BOTTOM_RIGHT | Const | 相对右下角对齐。 |
Marker 类
点标注类。
构造函数
方法
方法 | 返回值 | 说明 |
---|
getMap() | Map | 返回标注所在的map对象。 |
getVisible() | boolean | 获取标注当前是否可见。 |
getPosition() | LatLng | 获取标注所在的位置坐标。 |
getIcon() | MarkerImage | 获取当前标注的icon属性。 |
getShadow() | MarkerImage | 获取当前标注shadow属性。 |
getShape() | MarkerShape | 获取当前标注的shape属性。 |
getCursor() | string | 获取标注中的鼠标样式。 |
getTitle() | string | 获取标注的标题。 |
getZIndex() | number | 获取标注的zIndex值。 |
getAnimation() | MarkerAnimation | 获取标注动画效果对应值。 |
getClickable() | boolean | 获取标注是否可点。 |
getDraggable() | boolean | 获取标注是否可拖拽。 |
getFlat() | boolean | 获取标注是否带阴影。如果标注无阴影,则值为true。 |
getDecoration() | MarkerDecoration | 获取标注装饰类。 |
setMap(map:Map) | none | 设置标注所在的map对象。 |
setVisible(visible:boolean) | none | 设置标注的可见性。 |
setPosition(position:LatLng) | none | 设置标注所在的位置。 |
setIcon(icon:MarkerImage) | none | 设置标注的前景图标。 |
setShadow(shadow:MarkerImage) | none | 设置标注的阴影图像。 |
setShape(shape:MarkerShape) | none | 设置标注的可感应区域图像。 |
setCursor(cursor:string) | none | 设置标注的鼠标样式。 |
setTitle(title:string) | none | 设置标注的名称。 |
setZIndex(zIndex:number) | none | 设置标注的zIndex值。 |
setAnimation(animation:MarkerAnimation) | none | 设置标注的动画效果。 |
setClickable(clickable:boolean) | none | 设置标注是否可点击。 |
setDraggable(draggable:boolean) | none | 设置标注是否可拖拽。 |
setFlat(flat:boolean) | none | 设置标注是否带阴影。设置为true,则标注无阴影。 |
setDecoration(decoration:MarkerDecoration) | none | 设置标注装饰类。 |
事件
事件 | 参数 | 说明 |
---|
position_changed | none | 当标注位置属性更改时会触发此事件。 |
shadow_changed | none | 当标注的阴影更改时会触发此事件。 |
shape_changed | none | 当标注可感应区域图像更改时会触发此事件。 |
cursor_changed | none | 当标注鼠标样式更改时会触发此事件。 |
animation_changed | none | 当标注动画效果更改时会触发此事件。 |
clickable_changed | none | 当标注可点性更改时会触发此事件。 |
draggable_changed | none | 当标注可拖拽性更改时会触发此事件。 |
visible_changed | none | 当标注可见性更改时会触发此事件。 |
flat_changed | none | 当标注阴影是否可见更改时会触发此事件。 |
zindex_changed | none | 当标注ZIndex值更改时会触发此事件。 |
click | MapsEvent | 点击标注图标后会触发此事件。 |
dragstart | MapsEvent | 当用户开始拖动标注时会触发此事件。 |
dragging | MapsEvent | 当用户正在拖动标注时会触发此事件。 |
title_changed | MapsEvent | 当标注名称属性更改时会触发此事件。 |
dragend | MapsEvent | 当用户停止拖动标注时会触发此事件。 |
mouseover | MapsEvent | 当鼠标进入标注图标区域时会触发此事件。 |
mosueout | MapsEvent | 当鼠标离开标注图标区域时会触发此事件。 |
mosuedown | MapsEvent | 对标注图标触发 DOM mousedown 事件时会触发此事件。 |
mouseup | MapsEvent | 对标注触发 DOM mouseup 事件时会触发此事件。 |
dblclick | MapsEvent | 当双击标注图标时会触发此事件。 |
rightclick | MapsEvent | 右键点击标注时会触发此事件。 |
MarkerOptions 对象规范
属性
属性 | 类型 | 说明 |
---|
map | Map | 待显示标记的地图。 |
visible | boolean | 待显示标记的可见性。如果为 true,则显示标记。 |
position | LatLng | 标注所在位置。必填。 |
icon | MarkerImage | 标注所用的图标对象。 |
shadow | MarkerImage | 标注所用的阴影图标。 |
shape | MarkerShape | 用于拖动/点击的图像地图区域定义。 |
cursor | string | 标注所用的鼠标样式。 |
title | string | 鼠标移到标注上的显示内容。 |
zIndex | number | 标注的ZIndex值。 |
clickable | boolean | 标注是否可点击。 |
draggable | boolean | 标注是否可拖拽。 |
flat | flat | 标注阴影是否可见。 |
animation | MarkerAnimation | 标注动画效果。 |
decoration | MarkerDecoration | 标注装饰类。 |
MarkerImage 类
自定义Marker图标样式类。
构造函数 | 说明 |
---|
MarkerImage(url:string, size:Size, origin:Point, anchor:Point, scaledSize:Size, shadowAngle:number) | 定义一张用作标注图标或者阴影的图像。“origin”和“size”用于选择拼合图像的图块,“anchor”用于重写锚点默认所处的底部中间位置。图像的锚点是系统在跟踪图像位置时引用的像素。默认情况下,锚点设置为图像的底部中间位置 (width/2, height)。因此,当标注放置在指定的 LatLng 上时,定义为锚点的像素就定位于指定的 LatLng 上。要缩放图像,无论该图像是否为拼合图像,都请将 scaledSize 的值设置为整个图像的大小,并用换算值设置大小、原点和锚点。shadowAngle用于定义阴影与Y轴正半轴的夹角。MarkerImage 在构造完成后就无法更改。 |
MarkerShape 类
自定义Marker可点区域类。
构造函数 | 说明 |
---|
MarkerShape() | 此属性的格式取决于 type 的值,并且遵循 http://www.w3.org/tr/REC-html40/struct/objects.html#adef-coords 上的 w3 AREA coords 规范。coord 是一个整数数组,其中的整数指定形状相对于目标图像左上角的像素位置。坐标取决于下面所示的 type 值: circ 或 circle:coord 是 [x1,y1,r],其中 x1,y2 是圆心的坐标,而 r 是圆的半径。 poly 或 polygon:coord 是 [x1,y1,x2,y2...xn,yn],其中每个 x,y 对包含多边形的一个顶点的坐标。 rect 或 rectangle:coord 是 [x1,y1,x2,y2],其中 x1,y1 是矩形的左上角的坐标,而 x2,y2 是矩形的右下角的坐标。 |
MarkerAnimation 对象规范
marker对象的动画类型。
属性
属性 | 类型 | 说明 |
---|
BOUNCE | Const | 反复弹跳 |
DROP | Const | 从天而降 |
UP | Const | 升起 |
DOWN | Const | 落下 |
InfoWindow 类
此类表示地图上的信息窗口。
构造函数
构造函数 | 说明 |
---|
InfoWindow(opts?:InfoWindowOptions ) | 创建带有指定选项的信息窗口。信息窗口可以放置在地图的特定位置,也可以位于标记上方,具体取决于选项中指定的内容。除非停用自动平移,否则,信息窗口会在打开后平移地图,以便让窗体显示完整。信息窗口构建完成后,您需要调用 open 函数,才能在地图上显示该窗口。用户可以点击信息窗口上的关闭按钮将其从地图中关闭,也可以调用 close() 函数实现关闭窗体。 |
方法
方法 | 返回值 | 说明 |
---|
close() | none | 关闭此信息窗口 |
getMap() | Map | 返回信息窗口所在的map对象。 |
getContent() | string|Node | 获取信息窗口显示区的内容。 |
getPosition() | LatLng|Marker | 获取信息窗口当前的坐标位置。 |
getZIndex() | number | 获取信息窗口的ZIndex值。 |
open() | none | 在指定的地图上打开这个信息窗口,如果autopan 为false 则在打开的过程中不进行平移。 |
setMap(map:Map) | none | 设置信息窗口所在的map对象。 |
setContent(content:string|Node) | none | 设置信息窗口显示区的内容。信息窗的内容区根据显示的内容大小自动调整适合的大小。如需固定宽高,可以再传入的节点中设置固定的宽高样式,并开启轮动条,来达到定宽定高的效果。 |
setPosition(position:LatLng|Marker) | none | 设置信息窗口的位置,支持LatLng和Marker两种参数。 |
setZIndex(zIndex:number) | none | 设置信息窗口的zIndex值。 |
setOptions(options:InfoWindowOptions) | none | 设置信息窗口的初始化参数。 |
事件
事件 | 参数 | 说明 |
---|
closeclick | none | 点击关闭按钮时会触发此事件。 |
content_changed | none | 内容属性更改时会触发此事件。 |
domready | none | 当包含 InfoWindow 的内容的 <div> 附加到DOM 时,会触发此事件。 |
position_changed | none | 位置属性更改时会触发此事件。 |
zindex_changed | none | 信息窗口的 zIndex 更改时会触发此事件。 |
InfoWindowOptions 对象规范
属性
属性 | 类型 | 说明 |
---|
map | Map | 信息窗口所属的map。 |
content | content:string|Node | 要在信息窗口中显示的内容。该内容可以是Dom 元素、纯文本字符串或包含 HTML 的字符串。信息窗口将会根据相应内容调整大小。要设置内容的具体大小,请将内容设置为相应大小的 HTML 元素。 |
position | LatLng | 用于定位此信息窗口。如果信息窗口是通过锚点打开的,则使用锚点的位置。 |
zIndex | number | 所有信息窗口按 zIndex 值的大小顺序在地图上显示,zIndex 值较大的信息窗口显示在值较小的信息窗口之前。默认情况下,信息窗口是按纬度显示的,纬度较低的信息窗口显示在纬度较高的信息窗口前。信息窗口始终在标记前面显示。 |
Polyline 类
折线覆盖物。
构造函数
方法
方法 | 返回值 | 说明 |
---|
getMap() | Map | 获取折线的map属性。 |
getPath() | MVCArray.<LatLng> | 获取折线的经纬度坐标数组。 |
getZIndex() | number | 获取折线的zIndex值。 |
getVisible() | boolean | 获取折线的可见性。 |
setMap(map:Map) | none | 在指定地图上渲染此折线。如果地图设置为 Null,则会删除此折线。 |
setPath(arrPath:Array.<LatLng>|MVCArray.<LatLng> | none | 设置折线的经纬度坐标数组。 |
setZIndex(zindex:number) | none | 设置此折线的zIndex值。 |
setVisible(visible:boolean) | none | 设置此折线的可见性。 |
事件
PolylineOptions
属性
属性 | 类型 | 说明 |
---|
map | Map | 要显示折线的目标地图。 |
visible | boolean | 折线是否可见。 |
cursor | string | 折线的鼠标指针手势。 |
zIndex | number | 折线的ZIndex值。 |
strokeColor | Color|string | 折线的边框颜色。 |
strokeWeight | number | 折线的边框线宽。 |
strokeDashStyle | string | 折线的线形。实线是solid,虚线是dash。 |
clickable | boolean | 折线是否可点击。 |
path | Array.<LatLng>|MVCArray.<LatLng> | 折线的路径,以经纬度坐标数组构成 |
Polygon 类
多边形覆盖物。
构造函数
方法
方法 | 返回值 | 说明 |
---|
getMap() | Map | 返回已附加此折线或多边形的地图。 |
getPath() | MVCArray.<LatLng> | 获取多边形的path属性。 |
getZIndex() | number | 获取多边形的zIndex值。 |
getVisible() | boolean | 获取多边形的可见性。 |
setMap(map:Map) | none | 设置多边形所在地图。 |
setPath(arrPath:Array.<LatLng>|MVCArray.<LatLng> | none | 设置多边形的路径,格式为坐标数组。 |
setZIndex(zindex:number) | none | 设置多边形的zIndex值。 |
setVisible(visible:boolean) | none | 设置多边形的可见性。 |
事件
事件 | 参数 | 说明 |
---|
map_changed | none | 当多边形所在地图更改时会触发此事件。 |
visible_changed | none | 当多边形可见性更改时会触发此事件。 |
zindex_changed | none | 当多边形ZIndex值更改时会触发此事件。 |
path_changed | none | 当多边形路径更改时会触发此事件。 |
click | MapsEvent | 点击多边形后会触发此事件。 |
mouseover | MapsEvent | 当鼠标进入多边形区域时会触发此事件。 |
mouseout | MapsEvent | 鼠标离开多边形时触发此事件。 |
mousedown | MapsEvent | 鼠标在多边形上按下触发此事件。 |
mouseup | MapsEvent | 鼠标在多边形释放触发此事件。 |
mousemove | MapsEvent | 鼠标在多边形上移动时此事件。 |
dblclick | MapsEvent | 双击多边形后会触发此事件。 |
rightclick | MapsEvent | 右击多边形后会触发此事件。 |
PolygonOptions
属性
属性 | 类型 | 说明 |
---|
map | Map | 要显示多边形的目标地图。 |
visible | boolean | 多边形是否可见。 |
cursor | string | 多边形的鼠标指针手势。 |
zIndex | number | 多边形的ZIndex值。 |
strokeColor | Color|string | 多边形的边框颜色。 |
fillColor | Color|string | 多边形的填充颜色。 |
strokeWeight | number | 多边形的边框线宽。 |
strokeDashStyle | string | 多边形的线形,实线是solid,虚线是dash。 |
clickable | boolean | 多边形是否可点。 |
path | Array.<LatLng>|MVCArray.<LatLng> | 多边形面坐标的有序序列。可以使用LatLng数组制定路径。 |
Circle 类
圆形覆盖物。
构造函数
方法
方法 | 返回值 | 说明 |
---|
getBounds() | LatLngBounds | 返回圆形覆盖物的地理坐标范围。 |
getMap() | Map | 返回圆形覆盖物所属地图。 |
getCenter() | LatLng | 返回圆形覆盖物的中心点地理坐标。 |
getRadius() | number | 返回圆形覆盖物的半径(单位:米)。 |
getCursor() | string | 返回圆形覆盖物的鼠标样式。 |
getFillColor() | Color|string | 返回圆形覆盖物的填充色。 |
getStrokeColor() | Color|string | 返回圆形覆盖物的边框颜色。 |
getStrokeDashStyle() | string | 返回圆形覆盖物的边框样式。 |
getStrokeWeight() | number | 返回圆形覆盖物的边框宽度。 |
getVisible() | boolean | 返回圆形覆盖物是否可见。 |
getZIndex() | number | 返回圆形覆盖物的zIndex。 |
setMap(map:Map) | none | 设置圆形覆盖物所属地图。 |
setCenter(center:LatLng) | none | 设置圆形覆盖物中心地理坐标 |
setRadius(radius:number) | none | 设置圆形覆盖物的半径(单位:米) |
setCursor(cursor:string) | none | 设置圆形覆盖物的鼠标样式。 |
setFillColor(color:Color) | none | 设置圆形覆盖物的填充色。 |
setStrokeColor(color:Color) | none | 设置圆形覆盖物的边框颜色。 |
setStrokeDashStyle(style:string) | none | 设置圆形覆盖物的边框样式。 |
setStrokeWeight(weight:number) | none | 设置圆形覆盖物的边框宽度。 |
setVisible(visible:boolean) | none | 设置圆形覆盖物的可见性。 |
setZIndex(zindex:number) | none | 设置圆形覆盖物的zIndex。 |
事件
事件 | 参数 | 说明 |
---|
map_changed | none | 圆形覆盖物所属地图变化后会触发此事件。 |
visible_changed | none | 圆形覆盖物可见性变化后触发此事件。 |
center_changed | none | 圆形覆盖物的中心点地理坐标变化后触发此事件。 |
radius_changed | none | 圆形覆盖物的半径变化后触发此事件。 |
cursor_changed | none | 圆形覆盖物的鼠标样式变化后触发此事件。 |
fillcolor_changed | none | 圆形覆盖物的填充色变化后触发此事件。 |
strokecolor_changed | none | 形覆盖物的边框颜色变化后触发此事件。 |
strokedashstyle_changed | none | 圆形覆盖物的边框样式变化后触发此事件。 |
strokeweight_changed | none | 圆形覆盖物的边框宽度变化后触发此事件 |
zindex_changed | none | 圆形覆盖物的zIndex变化后触发此事件。 |
click | MapsEvent | 点击圆形覆盖物后触发此事件。 |
mouseover | MapsEvent | 当鼠标进入圆形覆盖物时触发此事件。 |
mouseout | MapsEvent | 当鼠标移出圆形覆盖物时触发此事件。 |
mousedown | MapsEvent | 当鼠标在圆形覆盖物上按下后触发此事件。 |
mouseup | MapsEvent | 当鼠标在圆形覆盖物上释放时触发此事件。 |
mousemove | MapsEvent | 当鼠标在圆形覆盖物上移动时触发此事件。 |
dblclick | MapsEvent | 当鼠标在圆形覆盖物上双击后触发此事件。 |
rightclick | MapsEvent | 当鼠标在圆形覆盖物上右击后触发此事件。 |
CircleOptions
属性
属性 | 类型 | 说明 |
---|
map | Map | 圆形覆盖物的所属地图。 |
visible | boolean | 圆形覆盖物的可见性。 |
center | LatLng | 圆形覆盖物的中心点地理坐标。 |
radius | number | 圆形覆盖物的半径。 |
cursor | string | 圆形覆盖物的鼠标样式。 |
zIndex | number | 圆形覆盖物的ZIndex。 |
fillColor | Color|string | 圆形覆盖物的内填充色。 |
strokeColor | Color|string | 圆形覆盖物的边框颜色。 |
strokeWeight | number | 圆形覆盖物的边框线宽。 |
strokeDashStyle | string | 圆形覆盖物的边框样式。实线是solid,虚线是dash。 |
Label 类
文本标记。
构造函数
方法
方法 | 返回值 | 说明 |
---|
getMap() | Map | 返回Label所属地图。 |
getPosition() | LatLng | 返回Label的位置信息。 |
getContent() | string | 返回Label的内容信息。 |
getVisible() | boolean | 返回Label的可见性。 |
getZIndex() | number | 返回Label的zIndex值。 |
setOptions(options:LabelOptions) | none | 设置Label属性。 |
setMap(map:Map) | none | 设置Label所属地图。 |
setPosition(position:LatLng) | none | 设置Label所在位置。 |
setContent(content:string) | none | 设置Label的内容信息。 |
setVisible(visible:boolean) | none | 设置Label的可见性。 |
setZIndex(zIndex:number) | none | 设置Label的zIndex值。 |
事件
事件 | 参数 | 说明 |
---|
map_changed | none | Label所属地图变化后会触发此事件。 |
visible_changed | none | Label可见性变化后触发此事件。 |
content_changed | none | Label的内容变化后触发此事件。 |
position_changed | none | Label的位置变化后触发此事件。 |
zindex_changed | none | Label的ZIndex值变化后触发此事件。 |
click | MapsEvent | 点击Label后触发此事件。 |
mouseover | MapsEvent | 当鼠标进入Label时触发此事件。 |
mouseout | MapsEvent | 当鼠标移出Label时触发此事件。 |
mousedown | MapsEvent | 当鼠标在Label上按下后触发此事件。 |
mouseup | MapsEvent | 当鼠标在Label上释放时触发此事件。 |
mousemove | MapsEvent | 当鼠标在Label上移动时触发此事件。 |
rightclick | MapsEvent | 当鼠标在Label上右击后触发此事件。 |
LabelOptions 对象
属性
属性 | 类型 | 说明 |
---|
map | Map | Label所属的map。 |
content | content:string | 要在Label中显示的内容。该内容只可以是string 元素。 |
position | LatLng | 用于定位此Label。 |
zIndex | number | Label的显示顺序。 |
visible | boolean | 此Label的可见性。 |
offset | Size | 此Label的位置偏移值。 |
clickable | boolean | 此Label的是否可点击。 |
GroundOverlay 类
构造函数
方法
方法 | 返回值 | 说明 |
---|
getMap() | Map | 返回GroundOverlay所属地图。 |
getBounds() | LatLngBounds | 返回GroundOverlay的所在矩形区域范围。 |
getImageUrl() | string | 返回GroundOverlay的图片URL。 |
getVisible() | boolean | 返回GroundOverlay的可见性。 |
getZIndex() | number | 返回GroundOverlay的ZIndex值。 |
setOptions(options:GroundOverlayOptions) | none | 设置GroundOverlay属性。 |
setMap(map:Map) | none | 设置GroundOverlay所属地图。 |
setBounds(bounds:LatLngBounds) | none | 设置GroundOverlay所在位置。 |
setImageUrl(imageUrl:string) | none | 设置GroundOverlay的图片URL。 |
setVisible(visible:boolean) | none | 设置GroundOverlay的可见性。 |
setZIndex(zIndex:number) | none | 设置GroundOverlay的ZIndex值。 |
事件
事件 | 参数 | 说明 |
---|
map_changed | none | GroundOverlay所属地图变化后会触发此事件。 |
visible_changed | none | GroundOverlay可见性变化后触发此事件。 |
click | MapsEvent | 点击GroundOverlay后触发此事件。 |
mouseover | MapsEvent | 当鼠标进入GroundOverlay时触发此事件。 |
mouseout | MapsEvent | 当鼠标移出GroundOverlay时触发此事件。 |
mousedown | MapsEvent | 当鼠标在GroundOverlay上按下后触发此事件。 |
mouseup | MapsEvent | 当鼠标在GroundOverlay上释放时触发此事件。 |
mousemove | MapsEvent | 当鼠标在GroundOverlay上移动时触发此事件。 |
rightclick | MapsEvent | 当鼠标在GroundOverlay上右击后触发此事件。 |
GroundOverlayOptions 对象
属性
属性 | 类型 | 说明 |
---|
map | Map | GroundOverlay所属的map。 |
imageUrl | string | 要在GroundOverlay中显示的图片Url。 |
bounds | LatLngBounds | 用于定位此GroundOverlay。 |
zIndex | number | GroundOverlay的显示顺序。 |
visible | boolean | 此GroundOverlay的可见性。 |
clickable | boolean | 此GroundOverlay的是否可点击。 |
cursor | string | 此GroundOverlay的鼠标样式。 |
opacity | number | 此GroundOverlay的透明度。 |
Control 类
如果想在地图上显示自定义类型的控件,则可以使用此类。此类扩展了 MVCObject(该类即将废弃,开发者请使用Map类的controls属性,具体使用方法请参考示例中自定义控件).
构造函数
ControlOptions 对象规范
(该类即将废弃,开发者请使用Map类的controls属性,具体使用方法请参考示例中自定义控件).
属性
属性 | 类型 | 说明 |
---|
map | Map | 设置控件的所属地图。 |
align | ALIGN | 设置控件位置的对齐方式。 |
content | string|Node | 设置控件的内容。 |
margin | Size | 设置控件停靠的偏移量。 |
visible | boolean | 设置控件的可见性。 |
zIndex | number | 设置控件的ZIndex值。 |
NavigationControl 类
平移缩放控件。默认显示在地图的左上角位置,一般用于上下左右平移地图位置。(该属性即将废弃,开发者请使用Map类的zoomControl和panControl属性)|
构造函数
NavigationControlOptions 对象规范
(该属性即将废弃,开发者请使用Map类的zoomControl和panControl属性)
属性
属性 | 类型 | 说明 |
---|
map | Map | 设置平移缩放控件的地图对象。 |
align | ALIGN | 设置平移缩放控件的对齐方式。 |
style | NavigationControlStyle | 设置平移缩放控件的样式,默认为NavigationControlStyle.DEFAULT。 |
zoomTips | object | 设置平移缩放控件地图级别提示。默认值为{17:'街',11:'市',8:'省',4:'国'}。 |
NavigationControlStyle 对象规范
用来设置平移缩放控件的样式的对象。(该属性即将废弃,开发者请使用Map类的zoomControl和panControl属性)
属性
属性 | 类型 | 说明 |
---|
DEFAULT | Const | 默认的平移缩放控件。地图默认使用的控件会因窗口大小和其他因素而有所不同。 |
SMALL | Const | 仅包含缩放功能。 |
ZOOM_PAN | Const | 仅包含缩放滑块和平移方向柄。 |
ScaleControl 类
比例尺控件。默认显示在地图的右下角位置,用于显示当前地图比例。(该属性即将废弃,开发者请使用Map类的scaleControl属性)|
构造函数
ScaleControlOptions 对象规范
属性
ScaleUnit 对象规范
比例尺显示单位 ScaleUnit 的常量。
属性
属性 | 类型 | 说明 |
---|
METRIC | Const | 公制单位。 |
IMPERIAL | Const | 英制单位。 |
MapTypeControl 类
地图类型控件。默认显示在地图的右上角位置,用于切换当前地图类型。(该属性即将废弃,开发者请使用Map类的mapTypeControl属性)
构造函数
MapTypeControlOptions 对象规范
属性
ZoomControlOptions 对象规范
属性
ZoomControlStyle 对象规范
属性
属性 | 类型 | 说明 |
---|
DEFAULT | Const | 默认的缩放控件。会根据地图尺寸的大小和其他因素自动调整样式。 |
LARGE | Const | 标准的缩放控件。包含放大、缩小和滑块。 |
SMALL | Const | 仅包含放大缩小两个按钮。 |
PanControlOptions 对象规范
属性
ControlPosition 对象规范
用来设置对齐样式的对象。
属性
属性 | 类型 | 说明 |
---|
TOP_LEFT | Const | 相对左上角对齐,向右排列。 |
TOP_CENTER | Const | 相对上方中间位置对齐。 |
TOP_RIGHT | Const | 相对右上角对齐,向左排列。 |
BOTTOM_LEFT | Const | 相对左下角对齐,向右排列。 |
BOTTOM_CENTER | Const | 相对下方中间位置对齐。 |
TOP_RIGHT | Const | 相对右下角对齐,向左排列。 |
LEFT_TOP | Const | 相对左上角对齐,向下排列。 |
LEFT_CENTER | Const | 相对左方中间位置对齐。 |
LEFT_BOTTOM | Const | 相对左下角对齐,向上排列。 |
RIGHT_TOP | Const | 相对右上角对齐,向下排列。 |
RIGHT_CENTER | Const | 相对右方中间位置对齐。 |
RIGHT_BOTTOM | Const | 相对右下角对齐,向上排列。 |
SearchService 类
Poi检索类。用于进行本地检索、周边检索等服务。
构造函数
方法
方法 | 返回值 | 说明 |
---|
search(keyword:string) | none | 根据关键字发起检索。 |
searchInBounds(keyword:string,latlngBounds:LatLngBounds) | none | 根据范围和关键字进行指定区域检索。 |
searchNearBy(keyword:string,center:LatLng,radius:number) | none | 根据中心点坐标、半径和关键字进行周边检索。 |
setComplete(callback:function) | none | 设置检索成功后的回调函数。 |
setError(callback:function) | none | 设置检索失败后的回调函数。 |
setLocation(location:string) | LatLng | 设置默认检索范围(默认为全国),类型可以是坐标或指定的城市名称,如:“北京市” |
setPageIndex(pageIndex:number) | none | 设置检索的特定页数。 |
setPageCapacity(pageCapacity:number) | none | 设置每页返回的结果数量。 |
getLocation()) | none | 获取默认检索范围 |
getPageIndex() | none | 获取检索的特定页数。 |
getPageCapacity() | none | 获取每页返回的结果数量。 |
clear() | none | 清空当前结果在map和panel中的展现。 |
SearchServiceOptions 对象
属性
TransferService 类
公交换乘方案类。用于获取公交换乘线路方案的服务。
构造函数
方法
方法 | 返回值 | 说明 |
---|
search(start:string|Poi|LatLng,end:string|Poi|LatLng) | none | 发起公交换乘检索。 - start: 起点,参数可以是关键字、Poi实例,或者LatLng坐标。 - end: 终点,参数可以是关键字、Poi实例,或者LatLng坐标。 |
setPolicy(policy:TransferPolicy) | none | 设置本次公交换乘的策略。 |
setLocation(location:string) | none | 设置本次公交换乘的区域范围。比如“北京”。 |
setComplete(callback:function) | none | 设置检索成功后的回调函数。 |
setError(callback:function,errorDetail:object) | none | 设置检索失败后的回调函数。 |
clear() | none | 清空当前结果在map和panel中的展现。 |
TransferServiceOptions 对象
属性
LineService 类
公共交通线路详情类。用于检索一条公交线路详情信息的服务。
构造函数
方法
方法 | 返回值 | 说明 |
---|
searchById(lineId:string) | none | 根据给定的公交线路Id,进行公交线路信息检索,得到该公交线路的详细信息。lineId是公交线路的唯一标识。 |
setComplete(callback:function) | none | 设置检索成功后的回调函数。 |
setError(callback:function) | none | 设置检索失败后的回调函数。 |
LineServiceOptions 对象
属性
StationService 类
公交站点详情类。用于检索一个公交车站详情信息的服务。
构造函数
方法
方法 | 返回值 | 说明 |
---|
searchById(stationId:string) | none | 根据给定的公交站点Id,进行公交车站信息检索,得到该站点的详细信息。stationId是公交站点的唯一标识。 |
setComplete(callback:function) | none | 设置检索成功后的回调函数。 |
setError(callback:function) | none | 设置检索失败后的回调函数。 |
StationServiceOptions 对象
属性
DrivingService 类
驾车路线获取类。用于获取两个或多个位置之间驾车路线的服务。
构造函数
方法
方法 | 返回值 | 说明 |
---|
search(start:string|Poi|LatLng,end:string|Poi|LatLng) | none | 发起驾车路线检索。 - start: 起点,参数可以是关键字、Poi实例,或者LatLng坐标。 - end: 终点,参数可以是关键字、Poi实例,或者LatLng坐标。 |
setPolicy(policy:DrivingPolicy,time:string) | none | 设置本次获取驾车路线的策略。 - time是时间,当且仅当policy为PREDICT_TRAFFIC时生效,格式为"day mm:ss",例如“0 05:30”代表周日上午5点30分。day为星期,0代表周日,1—6代表周一至周六。mm:ss为24小时制,预测时间以半小时为间隔。 |
setLocation(location:string) | none | 设置本次驾车路线获取的区域范围。比如“北京”。 |
setComplete(callback:function) | none | 设置检索成功后的回调函数。 |
setError(callback:function) | none | 设置检索失败后的回调函数。 |
clear() | none | 清空当前结果在map和panel中的展现。 |
DrivingServiceOptions 对象
属性
属性 | 类型 | 说明 |
---|
policy | DrivingPolicy | 驾车路线的策略。 |
location | string | 驾车路线的区域范围。比如“北京”。 |
time | string | 时间,当且仅当policy为PREDICT_TRAFFIC时生效,格式为"day mm:ss",例如“0 05:30”代表周日5点三十分。day为星期,1—6代表周一至周六,0代表周日。mm:ss为24小时制,预测时间以半小时为间隔。 |
complete | function | 检索成功的回调函数。参数对象:{type:ServiceResultType.DRIVING_INFO,detail:Object.<DrivingInfo>} |
error | function | 检索失败的回调函数。参数:ServiceErrorType。 |
map | Map | 展现结果的地图实例。 |
panel | string|Node | 展现结果的HTML容器id或元素。 |
Geocoder 类
地址解析类。用于在地址和经纬度之间进行转换的服务。
构造函数
方法
方法 | 返回值 | 说明 |
---|
getAddress(latlng:LatLng) | none | 根据指定的坐标进行解析。 |
getLocation(address:string) | none | 根据指定的地址进行解析。 |
setComplete(callback:function) | none | 设置检索成功后的回调函数。参数对象:{type:ServiceResultType.GEO_INFO,detail:Object.<GeoInfo>} |
setError(callback:function) | none | 设置检索失败后的回调函数。 |
GeocoderOptions 对象
属性
属性 | 类型 | 说明 |
---|
complete | function | 检索成功的回调函数。 |
error | function | 检索失败的回调函数 |
CityService 类
城市位置信息查询。根据城市名称、经纬度、IP地址(支持自动获取用户IP)、电话区号获取城市信息。
构造函数
方法
方法 | 返回值 | 说明 |
---|
searchLocalCity() | none | 根据用户IP查询城市信息。 |
searchCityByName(citiName:string) | none | 根据城市名称查询城市信息。cityName为城市名称,如:“北京市”。 |
searchCityByLatLng(#LatLng">LatLng) | none | 根据经纬度查询城市信息。LatLng为经纬度信息。 |
searchCityByIP(IP:string) | none | 根据指定IP地址查询城市信息。IP为IP地址信息。 |
searchCityByAreaCode(areaCode:string) | none | 根据电话区号查询城市信息。areaCode为城市电话区号信息。 |
setComplete(callback:function) | none | 设置检索成功后的回调函数。 |
setError(callback:function) | none | 设置检索失败后的回调函数。 |
CityServiceOptions 对象
属性
ServiceResultType 对象
service所返回结果的类型。
属性
属性 | 类型 | 说明 |
---|
POI_LIST | Const | POI列表 |
CITY_LIST | Const | POI检索结果城市列表 |
AREA_INFO | Const | 行政区划信息 |
GEO_INFO | Const | 地理位置信息 |
STATION_INFO | Const | 公交站点信息 |
LINE_INFO | Const | 公交线路信息 |
TRANSFER_INFO | Const | 公交换乘信息 |
DRIVING_INFO | Const | 驾车线路信息 |
MULTI_DESTINATION | Const | 起点或终点位置不唯一。 |
ServiceErrorType 对象
服务的error回调函数的参数,返回本次服务的错误类型代码。
属性
属性 | 类型 | 说明 |
---|
ERROR | Const | 服务器异常。 |
NO_RESULTS | Const | 没有结果。 |
INVALID_REQUEST | Const | 请求无效。 |
UNKNOWN_ERROR | Const | 发生未知错误,响应不成功。 |
Poi 对象
Poi对象,用于描述一条Poi数据信息。
属性
属性 | 类型 | 说明 |
---|
id | string | 唯一标识。 |
name | string | 名称。 |
latLng | LatLng | 经纬度坐标。 |
type | PoiType | 类型。如普通、公交车站、地铁站等。 |
address | string | 地址。 |
phone | string | 电话。 |
postcode | string | 邮政编码。 |
category | string | 类别。 |
boundary | Array.<LatLng> | 轮廓数据。 |
PoiType 对象
POI类型。
属性
属性 | 类型 | 说明 |
---|
NORMAL | Const | 普通地点。 |
BUS_STATION | Const | 公交车站。 |
SUBWAY_STATION | Const | 地铁站。 |
BUS_LINE | Const | 公交线路。 |
DISTRICT | Const | 行政区域。 |
PoiList 对象
POI列表。
属性
属性 | 类型 | 说明 |
---|
pois | Array.<Poi> | Poi列表 |
pageIndex | number | 请求页码的索引,以 0 起始。 |
pageCapacity | number | 请求每页包含的条数。 |
totalNum | number | 结果总数 |
CityList 对象
POI检索结果城市列表。
属性
属性 | 类型 | 说明 |
---|
cities | Array.<[object]> | 格式:{cityName:"吉林",resultNum:999,cities:[cityName:"长春",resultNum:9]} |
AreaInfo 对象
行政区划信息。
属性
属性 | 类型 | 说明 |
---|
name | string | 名称 |
level | string | 地图级别 |
latLng | LatLng | 经纬度 |
GeoInfo 对象
地理位置信息。
属性
属性 | 类型 | 说明 |
---|
address | string | 地址详细描述文字。 |
addressComponents | addressComponents | 描述地址的层次结构的对象。 |
location | LatLng | 地理坐标点。 |
nearPois | Array.<Poi> | 附近的poi点。 |
similarity | number | 查询字符串与查询结果的相似度。数值值越接近1,查询结果越准确。 |
pcd_conflict_flag | number | 结果与查询的行政区划冲突。返回值: 0:全部一致 1:区不一致 2:市不一致 3:省不一致 4:查询中无行政区划信息 |
gps_type | number | 数据类型。返回值: 1:行政区划中心点 2:道路中心点 3:道路交叉口 4:估算的门址数据 5:POI(如银科大厦、第三极书局这种类型的) 6:门址 |
addressComponents 对象
GeoInfo的addressComponents属性值,描述地址的层次结构。
属性
属性 | 类型 | 说明 |
---|
streetnumber | string | 门牌号码 |
street | string | 街道名称 |
district | string | 区县名称 |
city | string | 城市名称 |
province | string | 省份名称 |
country | string | 国家 |
StationInfo 对象
公交站点信息。
属性
属性 | 类型 | 说明 |
---|
id | string | 此公交车站的唯一标识。 |
name | string | 此公交车站的全称。 |
type | PoiType | 此公交车站的类型。 |
latLng | LatLng | 此公交车站所在的地理坐标。 |
lines | Array.<LineInfo> | 此公交车站途经公交线路。 |
LineInfo 对象
公交线路信息。
属性
属性 | 类型 | 说明 |
---|
id | string | 此公交线路的唯一标识。 |
name | string | 此公交线路的全称。 |
from | string | 此公交线路起始车站名称。 |
to | string | 此公交线路终点车站名称。 |
price | number | 票价。 |
stime | string | 首车时间。 |
etime | string | 末车时间。 |
distance | number | 此公交线路覆盖的总距离。 |
stationNum | number | 此公交线路途经车站数量。 |
path | Array.<LatLng> | LatLng 数组,代表此路线的整个路程。此公交线路途径地理坐标点的序列。 |
bounds | LatLngBounds | 此公交路线的地理范围。 |
stations | Array.<Poi> | 此公交线路途经车站。 |
TransferInfo 对象
公交换乘信息。
属性
TransferPlanInfo 对象
TransferInfo 对象 plan 属性的内容,包含一组公交换乘方案。
属性
TransferActionInfo 对象
公交换乘方案中的换乘行为类。TransferPlanInfo 对象 actions 属性的内容,包含一组公交换乘行为。
属性
TransferActionType 对象
TransferActionInfo的type属性值,表示换乘服务中的换乘的行为类型。
属性
属性 | 类型 | 说明 |
---|
BUS | Const | 乘坐公交。 |
SUBWAY | Const | 乘坐地铁。 |
WALK | Const | 步行。 |
TransferPolicy 对象
公交换乘方案获取的策略。
属性
属性 | 类型 | 说明 |
---|
LEAST_TIME | Const | 较快捷。 |
LEAST_TRANSFER | Const | 少换乘。 |
LEAST_WALKING | Const | 少步行。 |
NO_SUBWAY | Const | 不坐地铁。 |
DrivingInfo 对象
驾车线路信息。
属性
属性 | 类型 | 说明 |
---|
routes | Array.<RouteInfo> | 路线信息,包含自己所含路程和路段的相关信息。 |
policy | DrivingPolicy | 路线计算策略。 |
tmc | boolean | 其值为 true 表示经过城市有实时路况,false 表示无实时路况。 |
start | Poi | 起点位置对象。 |
end | Poi | 终点位置对象。 |
bounds | LatLngBounds | 此路线的地理范围。 |
duration | string | 此路线的总持续时间,单位分钟。 |
distance | number | 此路线覆盖的总距离,单位米。 |
DrivingPolicy 对象
驾车路线获取的策略。
属性
属性 | 类型 | 说明 |
---|
LEAST_TIME | Const | 最少时间。 |
LEAST_DISTANCE | Const | 最短距离。 |
AVOID_HIGHWAYS | Const | 避开高速。 |
REAL_TRAFFIC | Const | 实时路况,避开交通拥堵。 |
PREDICT_TRAFFIC | Const | 预测路况,避开交通拥堵。 |
RouteInfo 对象
表示一条路线,在某些路线下有些字段可能为空。
属性
属性 | 类型 | 说明 |
---|
duration | string | 此路线的总持续时间,单位分钟。 |
distance | Number | 此路线覆盖的总距离,单位米。 |
path | Array.<LatLng> | LatLng 的序列,描述此路线的坐标序列。 |
steps | Array.<StepInfo> | StepInfo 数组,其中每个路段都包含有关此路线中各个路段的信息。 |
start_address | string | 此路线的起点所在的位置名称,通常为道路。 |
start_location | LatLng | 此路程的起点所在地理位置信息。 |
end_address | string | 此路线的终点所在的位置名称,通常为道路。 |
end_location | LatLng | 此路程的终点所在地理位置信息。 |
StepInfo 对象
RouteInfo的steps 属性的值。表示一段路径,在某些路径下有些字段可能为空。
属性
属性 | 类型 | 说明 |
---|
duration | string | 此路段的总持续时间,单位分钟。 |
distance | Number | 此路段覆盖的总距离,单位米。 |
roadname | string | 此路段的名称。 |
start_location | LatLng | 此路段的起点所在地理位置信息。 |
end_location | LatLng | 此路段的终点所在地理位置信息。 |
instructions | string | 此路段的说明。 |
path | Array.<LatLng> | LatLng 的序列,描述此路段的坐标序列。 |
placemarks | Array.<Poi> | 此路段途经的重要地标。 |
cities | Array. | 此路段所属的城市名称。 |
turning | Turning | 此路段结束后的行驶转向。 |
Turning 对象
StepInfo的turning属性的值,表示转向相关信息。
属性
属性 | 类型 | 说明 |
---|
text | string | 转向的字符串表示。 |
latLng | LatLng | 转向所处的地理位置。 |
MultiDestination 对象
当服务返回的的ServiceResultType为MULTI_DESTINATION时的complete回调函数的参数。
属性
geometry.spherical 命名空间 {#geometry.spherical}
计算距离,角度,面积等函数。默认半径是地球半径(6378136.49米)
静态方法 | 返回值 | 说明 |
---|
computeArea(path:Array.<LatLng>|MVCArray.<LatLng>,radius?:number) | number | 返回闭合路径的面积。返回的面积单位为平方米。 |
computeDistanceBetween(from:LatLng,to:LatLng,radius:?number) | number | 返回两个坐标点间的距离。 |
computeHeading(from:LatLng,to:LatLng) | number | 返回从一个坐标到另一个坐标的航向。航向是指从一个坐标指向另一个坐标的向量与正北方向的夹角,范围为[-180,180) |
computeLength(path:Array.<LatLng>|MVCArray.<LatLng>) | number | 返回给定路径的长度。 |
computeOffset(from:LatLng,distance:number,heading:number,radius:?number) | LatLng | 通过起始点坐标、距离以及航向算出终点坐标。 |
computeOffsetOrigin(to:LatLng,distance:number,heading:number,radius:?number) | LatLng | 通过终点坐标、距离以及航向算出起始点坐标。 |
computeSignedArea(loop:Array.<LatLng>|MVCArray.<LatLng>,radius?:number) | number | 返回闭合路径的有向面积。有向面积可以用于检测路径的方向。返回的有向面积单位为平方米。 |
interpolate(from:LatLng,to:LatLng,fraction:number) | LatLng | 返回在起终点连线上位于给定比例的点坐标。比例值fraction范围为0~1 |
place.Autocomplete 类
文本输入提示。
此类扩展了 MVCObject.
方法
方法 | 返回值 | 说明 |
---|
dispose() | none | 销毁实例。 |
事件
事件 | 参数 | 说明 |
---|
confirm | object | 回车或鼠标点击选中某条记录时触发。参数格式:{index:1,value:"xxx"}。 |
place.AutocompleteOptions 对象规范
属性
属性 | 类型 | 说明 |
---|
offset | Size | 提示框与输入框的偏移值。 |
location | string | 指定查询范围。例如:"北京市" |
convertor 命名空间
坐标转换,将标准经纬度或其他地图经纬度转换为SOSO地图经纬度坐标。
静态方法 | 返回值 | 说明 |
---|
translate(points:LatLng|Point|Array.<LatLng|Point>, type:number, callback:function) | none | 将其他地图服务商的坐标批量转换成搜SOSO地图经纬度坐标。type用于说明是哪个服务商的坐标。 type的可选值为 1:gps经纬度,2:搜狗经纬度,3:百度经纬度,4:mapbar经纬度,5:google经纬度,6:搜狗墨卡托 |
MVCObject 类
构造函数
构造函数 | 说明 |
---|
MVCObject() | 实现 KVO 的基类。 |
方法
方法 | 返回值 | 说明 |
---|
bindTo(key:string, target:MVCObject, targetKey?:string, noNotify?:boolean) | none | 将视图绑定到模型。 |
changed(key:string) | none | 针对状态更改的常规处理函数。在子类中覆盖此项,以处理任意状态更改。 |
get(key:string) | * | 获取值。 |
notify(key:string) | none | 通知所有观察者此属性有所改变。这会通知绑定到对象属性的对象以及绑定到的对象。 |
set(key:string, value:*) | none | 设置值。 |
setValues(values:Object|undefined) | none | 设置键值对集合。 |
unbind(key:string) | none | 删除绑定。取消绑定会将未绑定属性设置为其当前值。此行为将不通知相关对象,因为值并未更改。 |
unbindAll() | none | 删除所有绑定。 |
MVCArray 类
此类扩展了 MVCObject.
构造函数
构造函数 | 说明 |
---|
MVCArray(array?:Array) | 一个可变的 MVC 数组。 |
方法
方法 | 返回值 | 说明 |
---|
forEach(callback:function(*, number)) | none | 循环访问每个元素,调用所提供的回调。回调会被每个元素调用,如:callback(element, index)。 |
getAt(i:number) | * | 获取指定索引处的元素。 |
getLength() | number | 传回此数组中的元素数。 |
insertAt(i:number, elem:*) | none | 在指定索引处插入元素。 |
pop() | * | 删除数组的最后一个元素并传回该元素。 |
push(elem:*) | number | 将一个元素添加到数组末尾并传回数组的新长度。 |
removeAt(i:number) | * | 从指定索引处删除元素。 |
setAt(i:number, elem:*) | none | 设置指定索引处的元素。 |
事件
事件 | 参数 | 说明 |
---|
insert_at | element,index | 调用insertAt时触发此事件。 |
remove_at | element,index | 调用removeAt时触发此事件。 |