搜狗地图 JavaScript API V1.0 开发手册

参考目录

  • 类(构造器)信息

    public Bounds (<Number>minX , <Number>minY , <Number>maxX , <Number>maxY)

      地图边界类

      表示为四个坐标值,分别为地图左下角的坐标(minX,minY)和右上角的坐标(maxX,maxY)。

      注:地图的坐标轴:横轴向右为正,纵轴向上为正。

    参数

      minX

      边界的左下角坐标minX

      minY

      边界的左下角坐标minY

      maxX

      边界的右上角坐标maxX

      maxY

      边界的右上角坐标maxY

    静态属性与方法
    intersection public 获取两个Bounds相交部分的Bounds。
    merge public 合并两个Bounds。


    公用属性与方法
    clone public 克隆bounds。
    contains public 判断Bounds是否包含指定的Bounds for google api。
    containsBounds public 判断Bounds是否包含指定的Bounds。
    containsSegment public 判断Bounds是否包含线段。
    extend public 扩展Bounds。
    getCenter public 计算该 Bounds 的中心。
    intersects public 判断Bounds是否与指定的Bounds相交 for google api。
    isEmpty public 判断是否为空bounds for google api。
    isIntersect public 判断Bounds是否与指定的Bounds相交。


    静态属性与方法详细信息

    static public <Bounds> intersection (<Bounds>bounds1 , <Bounds>bounds2)
      获取两个Bounds相交部分的Bounds (要先判断两个Bounds是否相交)

    参数

      bounds1

      边界Bounds1

      bounds2

      边界Bounds2

    返回

      相交部分的Bounds


    static public <Bounds> merge (<Bounds>bounds1 , <Bounds>bounds2)
      合并两个Bounds

    参数

      bounds1

      边界Bounds1

      bounds2

      边界Bounds2

    返回

      合并的Bounds



    公用属性详细信息

    public clone (<Bounds>bounds)
      克隆bounds

    参数

      bounds

      被克隆的Bounds


    public <boolean> contains (<Bounds>bounds)
      判断Bounds是否包含指定的Bounds for google api

    参数

      bounds

      指定要判断是否包含的 Bounds

    返回

      true||false


    public <boolean> containsBounds (<Bounds>bounds)
      判断Bounds是否包含指定的Bounds

    参数

      bounds

      指定要判断是否包含的 Bounds

    返回

      true||false


    public <boolean> containsSegment (<Point>point1 , <Point>point2)
      判断Bounds是否包含线段

    参数

      point1

      线段端点1 point1

      point2

      线段端点2 point2

    返回

      true||false


    public extend (<Point>point)
      扩展Bounds 当点落在bounds外,将使边界扩大;当点落在bounds内,边界不变。

    参数

      point

      点坐标 Point


    public <Point> getCenter ()
      计算该 Bounds 的中心。

    参数

    返回

      中心Point


    public <boolean> intersects (<Bounds>bounds)
      判断Bounds是否与指定的Bounds相交 for google api

    参数

      bounds

      指定要判断相交的 Bounds

    返回

      true||false


    public <boolean> isEmpty ()
      判断是否为空bounds for google api

    参数

    返回

      true||false


    public <boolean> isIntersect (<Bounds>bounds)
      判断Bounds是否与指定的Bounds相交

    参数

      bounds

      指定要判断相交的 Bounds

    返回

      true||false



  • 类(构造器)信息

    public Browser ()

      浏览器版本判断类

      支持"opera","msie","firefox","chrome","applewebkit","camino","mozilla" 还支持终端判断"x11;","macintosh","windows","android","iphone"

    参数

    公用属性与方法
    getCompatMode public 是否为兼容模式。
    isGecko public 是否为Gecko。
    isLowIE7 public 是否低于ie7。
    isMobile public 是否为移动终端iPod、iPhone、Android。
    isMozilla public 是否为Mozilla。


    公用属性详细信息

    public <boolean> getCompatMode ()
      是否为兼容模式

    返回

      true||false


    public <boolean> isGecko ()
      是否为Gecko

    返回

      true||false


    public <boolean> isLowIE7 ()
      是否低于ie7

    返回

      true||false


    public <boolean> isMobile ()
      是否为移动终端iPod、iPhone、Android

    返回

      true||false


    public <boolean> isMozilla ()
      是否为Mozilla

    返回

      true||false



  • 类(构造器)信息

    public ConvertorLLndMC ()

      坐标互转工具类

      经纬度与MC坐标(Sogou地图坐标)相互转换

      计算指定半径内的边界

      计算两点之间的距离

    参数

    公用属性与方法
    boundByLL public 获取某地点(经纬度)指定半径内的边界。
    boundByMC public 获取某地点指定半径内的边界。
    convertLL2MC public 经纬度转Sogou地图坐标。
    distanceByLL public 计算两点之间的距离(经纬度)。
    distanceByMC public 计算两点之间的距离(Sogou地图坐标系)。


    公用属性详细信息

    public <Array> boundByLL (<Point>point , <Number>radius)
      获取某地点(经纬度)指定半径内的边界

    参数

      point

      坐标点 new Point(经度,纬度1)

      radius

      半径,单位米

    返回

      返回经纬度边界数组 [minLng,minLat,maxLng,maxLat]。


    public <Array> boundByMC (<Point>point , <Number>radius)
      获取某地点指定半径内的边界

    参数

      point

      坐标点 new Point(MC.x,MC.y)

      radius

      半径,单位米

    返回

      返回边界数组[minX,minY,maxX,maxY],单位米


    public <Point> convertLL2MC (<Point>point , <Point>targetPoint)
      经纬度转Sogou地图坐标

    参数

      point

      经纬度

      targetPoint

      Sogou地图坐标,用于改变指定的Point对象的坐标值,可缺省。

    返回

      返回Sogou地图坐标


    public <Number> distanceByLL (<Point>point1 , <Point>point2)
      计算两点之间的距离(经纬度)

    参数

      point1

      坐标点1 new Point(经度1,纬度1)

      point2

      坐标点2 new Point(经度2,纬度2)

    返回

      返回距离,单位米


    public <Number> distanceByMC (<Point>point1 , <Point>point2)
      计算两点之间的距离(Sogou地图坐标系)

    参数

      point1

      坐标点1

      point2

      坐标点2

    返回

      返回距离,单位米



  • 类(构造器)信息

    public DataNode (<String>id , <Array[FeatureNode]>features , <Bounds>bounds , <XMLDOM>xmldom)

      数据节点类

      用于封装的点(S)线(L)面(R)对象数据集合

      S=Symbol,表示点对象,一般为地图上的当个图标。

      L=Line,表示线对象。一般为地图上绘制的道路,公交自驾方案等。

      R=Region,表示面对象。一般为地图上绘制的行政区划轮廓等。

      一个DataNode下面包含多个FeatureNode对象。

      通常客户端和服务器端的数据协议都是用DataNode来封装,如:

      <Data id="73473567">

        <Feature id="1" type="S" caption="" cpid="" dataid="">

          <Points></Points>

          <Style id="S01" />

          <Label id="F01" on="true"/>

          <Detail src="" href="" ></Detail>

        </Feature>

        <Feature id="2" type="L" caption="" cpid="" dataid="">

          <Points></Points>

          <Style id="L01" />

          <Label id="F01" on="true"/>

          <Detail src="" href="" ></Detail>

        </Feature>

      ...

      </Data>

      注:map5.0后的版本改为json格式的DataNode数据,数据结构与以上xml结构相同。

      [

        {

          "id":"1","type":"S","caption":"","cpid":""."dataid":"",

          "Points":[],

          "Style":{"id":"S01"},

          "Label":{"id","F01","on":"true"},

          "Detail":{"src":"","href":""}

        },

        {

          "id":"2","type":"L","caption":"","cpid":""."dataid":"",

          "Points":[],

          "Style":{"id":"L01"},

          "Label":{"id","F01","on":"true"},

          "Detail":{"src":"","href":""}

        },

      ...

      ]

    参数

      id

      数据唯一编号

      features

      FeatureNode对象数组

      bounds

      Bounds对象,所有FeatureNode对象边界值(将所有FeatureNode对象包含在内)

      xmldom

      XMLDOM对象



    公用属性与方法
    loadFromXML public 通过新的xml文档改变当前DataNode实例的信息。



    公用属性详细信息

    public loadFromXML (<String>xmlString)
      通过新的xml文档改变当前DataNode实例的信息

    参数

      xmlString

      xml字符串



  • 类(构造器)信息

    public FeatureNode (<String>uid , <String>caption , <String>type , <Array[Point]>points , <Bounds>bounds , <StyleNode>style , <Object>label , <Object>detail , <Array[[Point]]>segments , <XMLDOMElement>xmldom)

      点线面对象节点类

      用于封装的点(S)线(L)面(R)对象数据

      S=Symbol,表示点对象,一般为地图上的当个图标。

      L=Line,表示线对象。一般为地图上绘制的道路,公交自驾方案等。

      R=Region,表示面对象。一般为地图上绘制的行政区划轮廓等。

      数据格式:

        <Feature id="1" type="S" caption="" cpid="" dataid="">

          <Points></Points>

          <Style id="S01" />

          <Label style="F01" on="true"/>

          <Detail src="" href="" ></Detail>

        </Feature>

      注:map5.0后的版本改为json格式的FeatureNode数据,数据结构与以上xml结构相同。

        {

          "id":"1","type":"S","caption":"","cpid":""."dataid":"","level":"",

          "Points":[""],

          "Style":{"id":"S01"},

          "Label":{"style","F01","on":"true"},

          "Detail":{"src":"","href":""}

        }

      当FeatureNode对象被MapArea的addFeature加到地图区后,将在FeatureNode对象上增加element属性,指向MarkerElement对象。

    参数

      uid

      点线面对象的唯一编号,uid

      caption

      标题,名称

      type

      对象类型, 取值:S||L||R,S=Symbol,表示点对象,L=Line,表示线对象,R=Region,表示面对象。

      points

      Point坐标点集合

      bounds

      边界

      style

      样式结点类StyleNode实例

      label

      描述点线对象旁得lable的Object,{"style":"F01","on":true},style的值指向css className,on表示是否显示

      detail

      detail信息,默认值为{"href":"","content":"","src":"","infowin":"false"}

      segments

      点的分段数组,用于描述线面对象分成多个不连接的部分。Points节点的坐标用#分隔不连接的part。

      xmldom

      xml文档结点,一般为根结点

    静态属性与方法
    loadFromJson public 从json对象中提取特征信息。


    公用属性与方法
    clone public 克隆一个新的FeatureNode实例。


    静态属性与方法详细信息

    static public <FeatureNode> loadFromJson (<jsonObject>jsonObject)
      从json对象中提取特征信息

    参数

      jsonObject

      json 对象

    返回

      将json对象的信息以FeatureNode的数据结构存储



    公用属性详细信息

    public <FeaturnNode> clone ()
      克隆一个新的FeatureNode实例

    参数

    返回

      新的FeatureNode实例



  • 类(构造器)信息

    public MapArea (<HTMLDOMElement>container , <Array>mapSpecObjects , <Number>mapWidth , <Number>mapHeight , <boolean>disablePanArrow , <boolean>disableDragging , <Number>copyrightType)

      地图区域类

      控制,管理地图的主要操作,所有跟地图区域相关的功能都集中在此类中。

      其中包括地图瓦片的载入,坐标转换,拖动,缩放,

      图层的叠加,对点线面对象的绘制,以及地图的自动调整功能等

      坐标系说明:

      Sogou地图坐标:Sogou地图坐标或者经纬度坐标(经纬度与Sogou地图坐标可以通过ConvertorLLndMC类相互转换),地图上的每个地理位置都有对应的坐标值,每个POI都有一个坐标,每条道路或线路由多个坐标组成;Sogou地图坐标系为平面直角坐标系,向上、向右的为正;经纬度坐标系为球面坐标系,北半球向上、向右的为正,南半球向下、向右为正。

      像素坐标:以Sogou地图坐标的原点作为原点,建立直角坐标系,每个单位为1像素,向上、向右方向为正。

      页面坐标:以MapArea类中点线面对象的容器DIV元素(可被拖拽移动)的左上角为原点,建立直角坐标系,每个单位为1像素,向下、向右方向为正。

      屏幕坐标:以地图区(地图的取景框)容器DIV元素的左上角为原点,建立直角坐标系,每个单位为1像素,向下、向右方向为正。

      注:后三种坐标系的单位都是像素,不同的只是坐标原点和方向。

    参数

      container

      装载地图的容器对象

      mapSpecObjects

      MapSpec数组,可缺省

      mapWidth

      地图的宽度,可缺省

      mapHeight

      地图的高度,可缺省

      disablePanArrow

      true为不可漫游,false为默认值,已废弃

      disableDragging

      true 不可拖拽,false 为默认值,可缺省

      copyrightType

      版本信息的类型 100(二进制)-Logo 010(二进制)-比例尺 001(二进制)-文字版权



    公用属性与方法
    addFeature public 在地图上绘制点线面对象,并触发地图的addfeature事件。
    addLine public 在地图上绘制一个线对象。
    addPoint public 在地图上绘制一个点对象。
    centerAtLatLng public 指定地图的中心点Sogou地图坐标,并转换成中心点像素坐标调整地图。
    checkAndResetState public 检查中心点坐标的位置并调整至视窗中心,重新确定点线面对象在地图上的位置。
    clearAll public 删除所有非固定住的点线面对象,包括清除查询范围,以及点线面等点线面对象。
    clearFeatures public 清除掉所有非固定的点线面对象,并触发地图的clearfeatures事件。
    closeInfoWindow public 关闭详细信息弹出窗口。
    divToBitmapCoordinate public 将“页面坐标”值转换成“像素坐标”值。
    getBitmapBounds public 获取当前视窗内像素坐标的边界值。
    getCenterLatLng public 获取当前视窗内地图中心点的Sogou地图坐标(Sogou地图坐标)。
    getDivCoordinate public 将“像素坐标”值转换成“页面坐标”值。
    getLatLngBounds public 获取当前视窗的Sogou地图坐标的边界值。
    getMcXYBySC public 获取鼠标事件点的Sogou地图坐标。
    getScreenCoord public 获取指定点的Sogou地图坐标在地图视窗中的相对位置(比值)。
    hideFeatures public 隐藏所有的特殊元素,关闭信息窗,并触发地图的hidefeatures事件。
    isInited public 判断地图是否已经初始化。
    mc2sc public 将go2amp坐标转换成页面坐标。
    onResize public 根据视窗大小的改变,调整地图的可视区域的大小。
    panToInfoWindow public 当要在某坐标点显示信息窗时,移动地图以保证信息窗在地图区视窗之内。
    recenterOrPanToLatLng public 重新设置视窗中心点的Sogou地图坐标。
    removeFeature public 删除地图中指定的点线面对象,并更新现有的点线面对象的集合。
    removeFeatures public 删除掉所有的点线面对象,并触发地图的removefeatures事件。
    removeQueryArea public 清除地图上绘制的查询范围。
    repositionFeature public 指定坐标或者坐标系列,重新调整某个点线面对象的位置。
    repositionFeatures public 重新计算所有点线面对象的位置。
    repositionInfoWindow public 重新设置信息信息窗的位置。
    resetMap public 恢复默认的视野范围,即恢复视窗中默认的地图中心点位置。
    sc2mc public 将页面坐标转换成go2amp坐标。
    setQueryArea public 用于绘制周边查询的查询范围。
    zoomTo public 将地图缩放到指定的级别,并触发地图的zoom事件。



    公用属性详细信息

    public addFeature (<FeatureNode>featureNode , <boolean>isFix)
      在地图上绘制点线面对象,并触发地图的addfeature事件

    参数

      featureNode

      要绘制的点线面对象

      isFix

      是否固定在地图上,不被clearAll方法删除,取true固定,缺省则为:false。


    public <FeatureNode> addLine (<Array[Point]>points , <String>caption , <String>id , <String>styleId , <Object>labelObject , <Object>detailInfoObject , <boolean>isFix)
      在地图上绘制一个线对象

    参数

      points

      Sogou地图坐标系中的坐标点

      caption

      显示的标题的名称

      id

      id编号,唯一标识

      styleId

      样式编号,如:线对象L01

      labelObject

      标题样式说明对象{"on":"true","style":"Label01"} on 标识标题是否显示,style 标识样式的id,指向css。

      detailInfoObject

      弹出窗口详细信息,默认值为{"href":"","content":"","src":"","infowin":"false"}

      isFix

      是否固定在地图上,不被clearAll方法删除,取true固定,缺省则为:false。

    返回

      返回添加的线元素针指


    public <FeatureNode> addPoint (<Number>x , <Number>y , <String>caption , <String>id , <String>styleId , <Object>labelObject , <Object>detailInfoObject , <boolean>isFix)
      在地图上绘制一个点对象

    参数

      x

      Sogou地图坐标系中的横坐标或者经度

      y

      Sogou地图坐标系中的纵坐标或者纬度

      caption

      显示的标题的名称

      id

      id编号,唯一标识

      styleId

      样式id,如:点对象S01

      labelObject

      标题样式说明对象{"on":"true","style":"Label01"} on 标识标题是否显示,style 标题样式的id,指向css。

      detailInfoObject

      属性信息框中的信息,默认值为{"href":"","content":"","src":"","infowin":"false"}

      isFix

      是否固定在地图上,不被clearAll方法删除,取true固定,缺省则为:false。

    返回

      返回添加的点线面对象针指


    public centerAtLatLng (<Point>coordPoint)
      指定地图的中心点Sogou地图坐标,并转换成中心点像素坐标调整地图

    参数

      coordPoint

      Sogou地图坐标点


    public checkAndResetState ()
      检查中心点坐标的位置并调整至视窗中心,重新确定点线面对象在地图上的位置

    参数


    public clearAll ()
      删除所有非固定住的点线面对象,包括清除查询范围,以及点线面等点线面对象

    参数


    public clearFeatures ()
      清除掉所有非固定的点线面对象,并触发地图的clearfeatures事件

    参数


    public closeInfoWindow ()
      关闭详细信息弹出窗口

    参数


    public <Point> divToBitmapCoordinate (<Number>divCoordinateX , <Number>divCoordinateY , <Point>targetPoint)
      将“页面坐标”值转换成“像素坐标”值 关于坐标系的说明请参考最上方的说明

    参数

      divCoordinateX

      页面坐标系中x坐标值

      divCoordinateY

      页面坐标系中y坐标值

      targetPoint

      需要被更新的目标Point,可缺省

    返回

      返回转换后的像素坐标值


    public <Bounds> getBitmapBounds (<Bounds>targetBounds)
      获取当前视窗内像素坐标的边界值

    参数

      targetBounds

      需要被更新的目标Bounds,可缺省

    返回

      当前视窗内像素坐标的边界值Bounds


    public <Point> getCenterLatLng (<Point>targetPoint)
      获取当前视窗内地图中心点的Sogou地图坐标(Sogou地图坐标)

    参数

      targetPoint

      需要被更新的目标Point,可缺省

    返回

      返回当前地图中心点的Sogou地图坐标


    public <Point> getDivCoordinate (<Number>bitmapCoordinateX , <Number>bitmapCoordinateY , <Point>targetPoint)
      将“像素坐标”值转换成“页面坐标”值 关于坐标系的说明请参考最上方的说明

    参数

      bitmapCoordinateX

      像素坐标值的x坐标

      bitmapCoordinateY

      像素坐标值的y坐标

      targetPoint

      需要被更新的目标Point,可缺省

    返回

      返回页面坐标值(关于页面坐标请参考最上方的说明)


    public <Bounds> getLatLngBounds (<Bounds>targetBounds)
      获取当前视窗的Sogou地图坐标的边界值

    参数

      targetBounds

      需要被更新的目标Bounds,可缺省

    返回

      当前视窗的Sogou地图坐标的边界值Bounds


    public <Point> getMcXYBySC (<Event>event , <Number>offsetX , <Number>offetY)
      获取鼠标事件点的Sogou地图坐标

    参数

      event

      鼠标事件对象,ie下为window.event

      offsetX

      事件横坐标偏移量

      offetY

      事件纵坐标偏移量

    返回

      鼠标事件点的Sogou地图坐标


    public getScreenCoord (<Point>point)
      获取指定点的Sogou地图坐标在地图视窗中的相对位置(比值) 用于计算屏幕坐标

    参数

      point

      Sogou地图坐标


    public hideFeatures ()
      隐藏所有的特殊元素,关闭信息窗,并触发地图的hidefeatures事件

    参数


    public <boolean> isInited ()
      判断地图是否已经初始化

    参数

    返回

      返回true为已初始化,否则为未初始化


    public <Point> mc2sc (<Point>go2mapCoordPoint)
      将go2amp坐标转换成页面坐标

    参数

      go2mapCoordPoint

      Sogou地图坐标

    返回

      返回页面坐标


    public onResize ()
      根据视窗大小的改变,调整地图的可视区域的大小

    参数


    public panToInfoWindow (<Point>point , <Number>width , <Number>height , <Number>left , <Number>top)
      当要在某坐标点显示信息窗时,移动地图以保证信息窗在地图区视窗之内

    参数

      point

      坐标位置

      width

      信息窗的宽度

      height

      信息窗的高度

      left

      信息窗相对基准点的left值

      top

      信息窗相对基准点的top值


    public recenterOrPanToLatLng (<Point>coordPoint)
      重新设置视窗中心点的Sogou地图坐标

    参数

      coordPoint

      Sogou地图坐标


    public removeFeature (<FeatureNode>featureNode)
      删除地图中指定的点线面对象,并更新现有的点线面对象的集合

    参数

      featureNode

      准备删除的点线面对象


    public removeFeatures ()
      删除掉所有的点线面对象,并触发地图的removefeatures事件

    参数


    public removeQueryArea ()
      清除地图上绘制的查询范围

    参数


    public repositionFeature (<FeatureNode>featureNode , <Array[Point]|Point>points)
      指定坐标或者坐标系列,重新调整某个点线面对象的位置

    参数

      featureNode

      需要被调整的FeatureNode点线面对象

      points

      点坐标Point(当为点对象时)或者点坐标Point数组(当为线面对象时)


    public repositionFeatures (<boolean>isNoReposition)
      重新计算所有点线面对象的位置

    参数

      isNoReposition

      当对象为线面时,控制是否要调整


    public repositionInfoWindow ()
      重新设置信息信息窗的位置 并触发地图的repositioninfowin事件

    参数


    public resetMap ()
      恢复默认的视野范围,即恢复视窗中默认的地图中心点位置

    参数


    public <Point> sc2mc (<Point>divCoordPoint)
      将页面坐标转换成go2amp坐标

    参数

      divCoordPoint

      页面坐标

    返回

      返回go2amp坐标


    public setQueryArea (<FeatureNode>featureNode)
      用于绘制周边查询的查询范围

    参数

      featureNode

      要绘制的范围的点线面对象


    public zoomTo (<Number>zoomLevel)
      将地图缩放到指定的级别,并触发地图的zoom事件

    参数

      zoomLevel

      要缩放到的级别



  • 类(构造器)信息

    public MapClient (<HTMLDOMElement>container , <boolean>disablePanArrow , <boolean>disableDragging)

      地图客户端类

      用于绘制地图,提供地图功能的外部接口

    参数

      container

      装载地图的容器对象

      disablePanArrow

      true为不可漫游,false为默认值

      disableDragging

      true不可拖拽,false为默认值

    公用属性与方法
    adjustMapFitFeature public 调整地图以适应特征元素的显示,用于查询(搜索,公交,自驾)。
    animateZoomTo public 以过渡(动画)方式进行缩放地图。
    clearAll public 同MapArea类的clearAll方法,删除所有特征无素,包括清除查询范围,以及点线面等特征元素。
    coordRecenterTo public 将地图重新定位到指定的点(一般会将地图移动到视窗的中心位置),缩放到指定的级别。
    getBounds public 获取视窗中地图的大地边界值。
    getCenterX public 获取视图中心点地图的XSogou地图坐标。
    getCenterY public 获取视窗中心点地图的YSogou地图坐标。
    getFeatureById public 通过特征元素的id 号获取地图上的点线面对象。
    getFeatures public 获取地图所有的点线面对象。
    getHbState public 获取地图卫片的状态信息,是否显示卫片,是否显示路网。
    getInfoWinArgs public 获取信息窗的的参数。
    getLevelIndex public 获取地图当前的缩放级别。
    getMapAreaContainer public 获取地图容器对象。
    getMapAreaLayer public 获取地图容器对象。
    getMapHeight public 获取视窗的高,即地图显示范围的高。
    getMapLeft public 获取视窗的左边界在页面中的相对位置,即地图可见区域的左边界在页面中的位置。
    getMapTop public 获取视窗上边界距页面顶部的相对位置,即地图可见区域的上边界在页面中的位置。
    getMapWidth public 获取视窗的宽,即地图显示范围的宽。
    getMouseX public 获取鼠标离视窗左边界的距离。
    getMouseY public 获取鼠标离视窗上边界的距离。
    getStyleLibraryRoot public 获取样式根目录。
    getWindowSize public 获取可视化窗口的大小。
    resetMap public 恢复地图的初始状态,恢复默认的视野范围。
    resizeTo public 改变地图显示区域的大小并更新地图的大小。
    setCursor public 设置鼠标样式。
    setHyBrid public 设置卫星地图,同时触发hybrid事件。
    setQueryArea public 用于绘制周边查询的查询范围 。
    setStyleLibraryRoot public 设置样式根目录。
    showInfoWindow public 显示信息提示窗口。
    winsc2mc public 将指定的屏幕像素坐标(相对视窗左边,上边的像素距离)转换成Sogou地图坐标。


    公用属性详细信息

    public adjustMapFitFeature (<FeatureNode>featureNode , <Number>maxLevel)
      调整地图以适应特征元素的显示,用于查询(搜索,公交,自驾) 根据特征元素的边界信息,在不超过给定的最大的显示级别的同时计算能够显示所有特征点的的缩放级别,并缩放以适应所有特征元素

    参数

      featureNode

      点线面对象

      maxLevel

      指定的最大的显示级别,放大不能超过这一级


    public animateZoomTo (<Number>zoomLevel , <Object>savedOffset)
      以过渡(动画)方式进行缩放地图

    参数

      zoomLevel

      要缩放的级别

      savedOffset

      相对基准点当前底图层的位置{x:,y:}


    public clearAll ()
      同MapArea类的clearAll方法,删除所有特征无素,包括清除查询范围,以及点线面等特征元素

    参数


    public coordRecenterTo (<Number>x , <Number>y , <Number>zoomLevel)
      将地图重新定位到指定的点(一般会将地图移动到视窗的中心位置),缩放到指定的级别

    参数

      x

      Sogou地图坐标系中的横坐标

      y

      Sogou地图坐标系中的纵坐标

      zoomLevel

      缩放级别


    public <Bounds> getBounds ()
      获取视窗中地图的大地边界值

    参数

    返回

      视窗中地图的大地边界值


    public <Number> getCenterX ()
      获取视图中心点地图的XSogou地图坐标

    参数

    返回

      视图中心点地图的XSogou地图坐标


    public <Number> getCenterY ()
      获取视窗中心点地图的YSogou地图坐标

    参数

    返回

      视图中心点地图的YSogou地图坐标


    public <FeatureNode> getFeatureById (<String>featureId)
      通过特征元素的id 号获取地图上的点线面对象

    参数

      featureId

      点线面对象id

    返回

      返回找到的点线面对象FeatureNode


    public <Array> getFeatures ()
      获取地图所有的点线面对象

    参数

    返回

      FeatureNode数组


    public <Array> getHbState ()
      获取地图卫片的状态信息,是否显示卫片,是否显示路网

    参数

    返回

      返回是否显示卫星图片,是否显示路网


    public <Array> getInfoWinArgs (<FeatureNode>featureNode , <boolean>isMoveToInfoWin)
      获取信息窗的的参数

    参数

      featureNode

      点线面对象

      isMoveToInfoWin

      打开信息窗时是否移动信息窗使其在视窗内全部可见

    返回

      信息窗的的参数数组


    public <Number> getLevelIndex ()
      获取地图当前的缩放级别

    参数

    返回

      返回当前的缩放级别


    public <HTMLDOMElement> getMapAreaContainer ()
      获取地图容器对象

    参数

    返回

      地图容器对象


    public <HTMLDOMElement> getMapAreaLayer ()
      获取地图容器对象

    参数

    返回

      地图容器对象


    public <Number> getMapHeight ()
      获取视窗的高,即地图显示范围的高

    参数

    返回

      视窗的高


    public <Number> getMapLeft ()
      获取视窗的左边界在页面中的相对位置,即地图可见区域的左边界在页面中的位置

    参数

    返回

      视窗左边界距页面左边界的相对位置


    public <Number> getMapTop ()
      获取视窗上边界距页面顶部的相对位置,即地图可见区域的上边界在页面中的位置

    参数

    返回

      视窗上边界距页面顶部的相对位置


    public <Number> getMapWidth ()
      获取视窗的宽,即地图显示范围的宽

    参数

    返回

      视窗的宽


    public <Number> getMouseX ()
      获取鼠标离视窗左边界的距离

    参数

    返回

      鼠标离视窗左边界的距离


    public <Number> getMouseY ()
      获取鼠标离视窗上边界的距离

    参数

    返回

      鼠标离视窗上边界的距离


    public <String> getStyleLibraryRoot ()
      获取样式根目录

    参数

    返回

      样式根目录


    public <Scope> getWindowSize (<Scope>scope)
      获取可视化窗口的大小

    参数

      scope

      记录窗口的大小,可缺省

    返回

      窗口的大小


    public resetMap ()
      恢复地图的初始状态,恢复默认的视野范围

    参数


    public resizeTo (<Number>width , <Number>height)
      改变地图显示区域的大小并更新地图的大小

    参数

      width

      地图显示区域的宽度

      height

      地图显示区域的高度


    public setCursor (<String>cursor , <String>tiptxt , <boolean>isCustomPath , <String>position)
      设置鼠标样式

    参数

      cursor

      鼠标样式图片

      tiptxt

      鼠标提示信息

      isCustomPath

      是否是指定路径,若是指定的路径那么a参数就应该是完整的图片路径

      position

      非ie浏览器下,鼠标光标对应在自定义图片上的位置


    public setHyBrid (<boolean>isHybrid , <boolean>isHbLbl , <String>rmpId)
      设置卫星地图,同时触发hybrid事件

    参数

      isHybrid

      true显示卫星地图

      isHbLbl

      true 显示路网

      rmpId

      rmd编号


    public setQueryArea (<FeatureNode>featureNode)
      用于绘制周边查询的查询范围

    参数

      featureNode

      要绘制的范围的FeatureNode


    public setStyleLibraryRoot (<String>baseURL)
      设置样式根目录

    参数

      baseURL

      样式根目录


    public showInfoWindow (<FeatureNode>featureNode , <boolean>isMoveToInfoWin , <boolean>isFixView , <boolean>disableLessLevel)
      显示信息提示窗口

    参数

      featureNode

      需要打开信息窗的点线面对象

      isMoveToInfoWin

      打开信息窗时是否移动信息窗使其在视窗内全部可见

      isFixView

      是否固定信息窗不动,取true或false,缺省则为:false。

      disableLessLevel

      不启用打开信息窗时自动缩放到featureNode.level指定的最小级别 注:featureNode.level指定的最小级别,指动态在featureNode增加的level属性,用于打开属性窗时,如果当前级别小于level,则调整级别到指定的level,否则不调整。


    public <Point> winsc2mc (<Number>left , <Number>top)
      将指定的屏幕像素坐标(相对视窗左边,上边的像素距离)转换成Sogou地图坐标

    参数

      left

      相对视窗左边的距离

      top

      相对视窗上边的距离

    返回

      Sogou地图坐标



  • 类(构造器)信息

    public MapSpec (<Sds>sds)

      地图规格类

      构造地图坐标系,提供坐标轴的说明,坐标系的转换方法,坐标点的计算方法,以及计算并获取瓦片的方法

    参数

      sds

      地图规格参数

    公用属性与方法
    getBitmapCoordinate public 将Sogou地图坐标(MC)或经纬度坐标(LL)转换成像素坐标。
    getLatLng public 将像素坐标值转换成Sogou地图坐标。
    getLowestZoomLevel public 获取给定的Sogou地图坐标宽高范围小于给定范围的最小显示级别。
    getMeterPerPixel public 根据缩放级别获取一个像素代表的米数。
    getTileCoordinate public 获取Sogou地图坐标所落在的那种瓦片的编号。
    zoomBitmapCoord public 缩放后根据当前记录的中心点像素坐标,获取缩放后的中心点像素坐标。


    公用属性详细信息

    public <Point> getBitmapCoordinate (<Number>y , <Number>x , <Number>zoomLevel , <Point>point)
      将Sogou地图坐标(MC)或经纬度坐标(LL)转换成像素坐标

    参数

      y

      轴Sogou地图坐标或经纬度坐标

      x

      轴Sogou地图坐标或经纬度坐标

      zoomLevel

      当前的显示级别

      point

      需要改变的目标Point对象,可缺省

    返回

      得到转换后的像素坐标


    public <Point> getLatLng (<Number>x , <Number>y , <Number>zoomLevel , <Point>point)
      将像素坐标值转换成Sogou地图坐标

    参数

      x

      X轴像素坐标

      y

      Y轴像素坐标

      zoomLevel

      当前的显示级别

      point

      需要改变的目标Point对象,可缺省

    返回

      得到转换后的Sogou地图坐标


    public <number> getLowestZoomLevel (<Scope>scope , <Number>width , <Number>height)
      获取给定的Sogou地图坐标宽高范围小于给定范围的最小显示级别 用于查询时判断特征点全部能够显示下的最小级别

    参数

      scope

      Sogou地图坐标的宽度与高度的范围

      width

      指定的像素宽度

      height

      指定的像素高度

    返回

      返回显示级别


    public <Number> getMeterPerPixel (<Number>zoomLevel)
      根据缩放级别获取一个像素代表的米数

    参数

      zoomLevel

      级别数,取值范围:0到18之间的整数

    返回

      返回指定的显示级别中每个像素代表的米数


    public <Point> getTileCoordinate (<Number>y , <Number>x , <Number>zoomLevel , <Point>point)
      获取Sogou地图坐标所落在的那种瓦片的编号 用于地图瓦片编号边界值的计算

    参数

      y

      y轴Sogou地图坐标或经纬度坐标

      x

      x轴Sogou地图坐标或经纬度坐标

      zoomLevel

      当前的显示级别

      point

      需要改变的目标Point对象,可缺省

    返回

      瓦片的编号Point


    public <Point> zoomBitmapCoord (<Number>nextZoomLevel , <Number>preZoomLevel , <Point>centerBitmapPoint)
      缩放后根据当前记录的中心点像素坐标,获取缩放后的中心点像素坐标

    参数

      nextZoomLevel

      缩放前的级别

      preZoomLevel

      缩放后的级别

      centerBitmapPoint

      当前中心像素坐标

    返回

      缩放后的中心像素坐标



  • 类(构造器)信息

    public MarkerElement (<Array>icons , <HTMLDOMElement>container)

      绘制地图POI/点对象标记元素类

      地图上有三种对象,分别为点(S=Symbol)、线(L=Line)、面(R=Region)

      MarkerElement则为点对象(S=Symbol)

      一般用过MapArea的addPoint方法或者addFeature方法来创建

    参数

      icons

      图标对象数组

      container

      点对象标记元素的DIV容器

    公用属性与方法
    appendTo public 添加或显示所有的图标。
    blur public 图标失去焦点时,更改样式。
    create public 创建样式图标。
    focus public 鼠标移动到图标上时,切换样式。
    hide public 隐藏图标。
    isVisible public 判断图标是否已显示。
    setPosition public 设置图标在地图上的位置。
    setZIndex public 设置图标蒙板层的z-index。
    show public 显示所有的图标层。
    wink public 闪烁功能,图标在失去焦点与聚焦中切换。


    公用属性详细信息

    public appendTo (<HTMLDOMElement>container)
      添加或显示所有的图标

    参数

      container

      加载图标的容器


    public blur ()
      图标失去焦点时,更改样式

    参数


    public create (<Object>imgObject , <Number>zIndex)
      创建样式图标

    参数

      imgObject

      图标样式对象

      zIndex

      图标的z-index


    public focus ()
      鼠标移动到图标上时,切换样式

    参数


    public hide ()
      隐藏图标

    参数


    public <true>boolean isVisible ()
      判断图标是否已显示

    参数

    返回

      图标显示,false不显示


    public setPosition (<Number>left , <Number>top)
      设置图标在地图上的位置

    参数

      left

      指定标上图标的x轴位置(相对图标容器的页面位置)

      top

      指定标上图标的y轴位置


    public setZIndex (<Number>zIndex)
      设置图标蒙板层的z-index

    参数

      zIndex

      蒙板层的z-index


    public show ()
      显示所有的图标层

    参数


    public wink (<boolean>enalble)
      闪烁功能,图标在失去焦点与聚焦中切换

    参数

      enalble

      true则闪烁,false或者缺省则停止闪烁



  • 类(构造器)信息

    public Point (<Number>x , <Number>y)
      点坐标

    参数

      x

      坐标x

      y

      坐标y

    公用属性与方法
    approxEquals public 判断两个Point是否近似。
    distanceFrom public 计算两个Point的直线距离。
    equals public 判断两个Point是否相同。
    x public 坐标x。
    y public 坐标y。


    公用属性详细信息

    public <boolean> approxEquals (<Point>piont)
      判断两个Point是否近似

    参数

      piont

      要比较的Point

    返回

      两个Point是否近似


    public <Number> distanceFrom (<Point>piont)
      计算两个Point的直线距离

    参数

      piont

      要计算的Point

    返回

      两个Point的直线距离


    public <boolean> equals (<Point>piont)
      判断两个Point是否相同

    参数

      piont

      要比较的Point

    返回

      两个Point是否相同


    public x
      坐标x

    public y
      坐标y


  • 类(构造器)信息

    public SEvent ()

      事件类

      用于管理控制对象的事件

      分两种事件,一类是在普通对象上的自定义事件;另一种是HTMLElement上的Event事件(click、mousedown等鼠标事件)

    参数

    静态属性与方法
    addBuiltInListener public 为HTMLElement对象添加监听事件。
    addListener public 监听对象事件。
    clearListeners public 清除监听对象的特定的监听事件。
    removeBuiltInListener public 删除对象的指定事件。
    removeListener public 删除指定的监听事件,参数为EventRelate实例记录了相关信息(监听对象,监听的事件,响应事件)。
    trigger public 触发指定对象上的被监听的事件。


    静态属性与方法详细信息

    static public <MapsEventListener> addBuiltInListener (<HTMLElement>HTMLElement , <String>eventName , <Function>handler)
      为HTMLElement对象添加监听事件 ,事件皆为javascript默认事件

    参数

      HTMLElement

      HTMLElement对象

      eventName

      事件名称

      handler

      监听的事件被触发时的响应函数/处理函数

    返回

      返回记录事件信息的对象(对象,事件名称,响应事件)


    static public <MapsEventListener> addListener (<Object>targetObjectiInstance , <String>eventName , <Function>handler)
      监听对象事件

    参数

      targetObjectiInstance

      被监听的对象实例

      eventName

      被监听的对象事件名称

      handler

      监听的事件被触发时的响应函数/处理函数

    返回

      返回记录了监听事件的相关信息(监听对象,监听的事件,响应事件)


    static public clearListeners (<Object>targetObjectiInstance , <String>eventName)
      清除监听对象的特定的监听事件

    参数

      targetObjectiInstance

      被监听的对象实例

      eventName

      被监听的事件名称


    static public removeBuiltInListener (<MapsEventListener|Object> , <String>eventName , <Function>handler)
      删除对象的指定事件

    参数

      object||mapsEventListener 实例对象 或者 为记录事件信息的对象(对象,事件名称,响应事件)

      eventName

      事件名称(当a为记录事件信息的对象时,此参数可缺省)

      handler

      监听的事件被触发时的响应函数/处理函数(当a为记录事件信息的对象时,此参数可缺省)


    static public removeListener (<MapsEventListener>mapsEventListener)
      删除指定的监听事件,参数为EventRelate实例记录了相关信息(监听对象,监听的事件,响应事件)

    参数

      mapsEventListener

      记录了监听事件的相关信息(监听对象,监听的事件,响应事件)


    static public trigger (<Object>targetObjectiInstance , <String>eventName)
      触发指定对象上的被监听的事件

      触发事件的同时还可以传递多个参数

      如:SEvent.trigger(targetObjectiInstance,"click",arg1,arg2,arg3,...);

      handler函数会接收到这些参数

    参数

      targetObjectiInstance

      被监听的对象实例

      eventName

      被监听的事件名称



  • 类(构造器)信息

    public Scope (<Number>width , <Number>height)

      范围/尺寸类

      {"width":width,"height":height}

    参数

      width

      宽度

      height

      高度




  • 类(构造器)信息

    public StyleLib ()

      样式库类

      加载和缓存样式StyleNode对象,提供根据样式id获取样式对象的方法

    参数

    静态属性与方法
    getIconClass public 获取样式模板,非点线面样式,例如阴影。
    getStyleById public 通过样式编号取得样式信息。
    loadStyle public 加载指定的样式文件。
    preLoadJson public 预加载json格式的样式信息。
    preLoadStyle public 预加载样式信息,将下载的样式信息放入样式仓库中。


    静态属性与方法详细信息

    static public <Object> getIconClass (<String>id)
      获取样式模板,非点线面样式,例如阴影

    参数

      id

      样式id,即样式名称

    返回

      返回样式的json格式


    static public <StyleNode> getStyleById (<String>id)
      通过样式编号取得样式信息

    参数

      id

      样式编号 例如:S01

    返回

      样式信息


    static public loadStyle (<String>id , <Function>callback)
      加载指定的样式文件

    参数

      id

      样式名称,即样式的id

      callback

      回调函数,function(json);


    static public preLoadJson (<Array>styleJsonObjects , <boolean>type)
      预加载json格式的样式信息

    参数

      styleJsonObjects

      json的样式数组

      点样式:

      StyleLib.preLoadJson([{id:"S01",img:{src:"6702.GIF",width:6,height:6,pointcoord:"3,3",iconclass:"C1"}}]);

      线样式:

      StyleLib.preLoadJson([id:"L01",{"v:stroke":{"xmlns:v":"v",color:"#3366FF",weight:"5",endcap:"Round",opacity:"50%",startArrow:"None",endArrow:"None",dashstyle:"Solid",src:"",filltype:"solid"}}]);

      面样式:

      StyleLib.preLoadJson([{id:"R01","v:stroke":{"xmlns:v":"v",color:"#3366FF",weight:"1pt",endcap:"Round",opacity:"100%",startArrow:"None",endArrow:"None",dashstyle:"ShortDashDot"},"v:fill":{"xmlns:v":"v",on:"true",color:"#ffff00",color2:"#ffff00",type:"pattern",src:"",opacity:"30%"}}]);

      模板样式:(仅对点对象有效,用于定义阴影,鼠标在图标上的热区,坐标对应在图标上的位置,属性框尖角指在图标的位置等,以复用设置。在点样式中用iconclass来指定使用哪个模板)

      StyleLib.preLoadJson([{id:"C1",mask:{src:G.lib_i+"m1.png",width:21,height:28,pointcoord:"10,28",shadowoffset:"8,8",map:"10,27,1,13,1,8,7,0,14,0,20,8,20,13"},shadow:{ src:G.lib_i+"c1.png",width:412,height:146,pointcoord:"10,28",clip:"381,78,31,28"}}],1);

      type

      false是json样式信息,true是样式模板(json格式),前者主要是针对点,线,面的样式,后者为其他


    static public preLoadStyle (<String>fileName , <String>fileType)
      预加载样式信息,将下载的样式信息放入样式仓库中

    参数

      fileName

      样式文件名称

      fileType

      样式文件的类别



  • 类(构造器)信息

    public StyleNode (<String>styleId , <String>type , <Object>obj , <XMLDOM>xmldom)

      样式节点类

      记录指定的样式的信息

    参数

      styleId

      样式类编号例如S01

      type

      添加的样式的类别 S:点,L:线,R:面

      obj

      以json方式记录样式信息

      xmldom

      xml结点方式记录样式信息

    静态属性与方法
    loadFromJson public 解析json对象获取样式信息。
    loadFromXML public 解析xml结点,获取样式信息。


    公用属性与方法
    getObject public 获取样式信息对象(json)。


    静态属性与方法详细信息

    static public <StyleNode> loadFromJson (<Object>styleJson)
      解析json对象获取样式信息

    参数

      styleJson

      json方式记录的样式信息

      点样式:

      StyleNode.loadFromJson({id:"S01",img:{src:"6702.GIF",width:6,height:6,pointcoord:"3,3",iconclass:"C1"}});

      线样式:

      StyleNode.loadFromJson(id:"L01",{"v:stroke":{"xmlns:v":"v",color:"#3366FF",weight:"5",endcap:"Round",opacity:"50%",startArrow:"None",endArrow:"None",dashstyle:"Solid",src:"",filltype:"solid"}});

      面样式:

      StyleNode.loadFromJson({id:"R01","v:stroke":{"xmlns:v":"v",color:"#3366FF",weight:"1pt",endcap:"Round",opacity:"100%",startArrow:"None",endArrow:"None",dashstyle:"ShortDashDot"},"v:fill":{"xmlns:v":"v",on:"true",color:"#ffff00",color2:"#ffff00",type:"pattern",src:"",opacity:"30%"}});

    返回

      样式信息


    static public <StyleNode> loadFromXML (<XMLDOM>styleXmlDom)
      解析xml结点,获取样式信息

    参数

      styleXmlDom

      xml样式对象

    返回

      返回解析后的样式信息



    公用属性详细信息

    public <Object> getObject ()
      获取样式信息对象(json)

    参数

    返回

      样式信息(json)