JavaScript API v2.x 参考



SCGISTiledMapServiceLayer 类

此类主要用于加载四川省基础地理中心发布的REST风格的切片地图服务。


构造函数


构造函数说明参数说明
SCGISTiledMapServiceLayer(url:String,options?:Object) 创建一个切片图层的实例

url:切片服务的URL地址

options:可选参数列表

  -toke:令牌


方法


方法返回值说明参数说明
setToken(token:String) None 设置token,当访问令牌失效后重新设置令牌。

token:令牌

switchTileUrl(url:String, options?:Object)

None 在同一图层切换切片服务的地址。

url:切片服务的URL地址

options:可选参数列表

  -toke:令牌


事件

从严格意义上来说,不能称之为事件,它是在特定的情况下,控件会触发的函数,如token过期等。具体使用方法都一样,参见如下:

     var layer=new scgc.layers.SCGISTiledMapServiceLayer("[SCGISTILEMAP_REST_HTTP]");
     dojo.connect(layer,"onTokenExpired",function(json){
         var tokenTask=new scgc.tasks.TokenTask({getipServer:"http://...",...});
         tokenTask.execute(function(token,context){
             context.layer.setToken(token);
         },{account:"test",password:"test"},{layer:layer});
     });
                       

事件说明参数说明
onTokenExpired(json:Object)

当访问令牌失效后所触发的函数。

json:服务器返回的错误信息。

onUnknowError(ex:Object)

除令牌失效的所有错误消息都会触发此函数。

ex:服务返回的错误信息


NameSearchTask 类

用于调用检索地名地址的服务。


常量


常量说明

scgc.tasks.NameSearchTask.META

返回服务查询的元数据。

scgc.tasks.NameSearchTask.DATA

返回服务查询的数据。

scgc.tasks.NameSearchTask.COUNT

返回查询数据的总个数和最大能返回的数据个数。


构造函数


构造函数说明参数说明
NameSearchTask(url:String,token?:String,context?:Object) 创建一个检索地名地址的实例

url:地名地址服务的URL地址

token:令牌

context:附加参数,在服务器执行回调函数时,会将其值不变的传给回调函数。


方法


方法返回值说明参数说明
execute(params:Object) None 此函数会自动调用远程服务器的REST服务进行数据查询,将服务器的查询结果以JSON Object格式返回给客户端。 如下:
type:scgc.tasks.NameSearchTask.Type(必选)
   - 查询的数据的类型。
   - scgc.tasks.NameSearchTask.META:
     返回服务查询的元数据。
     如果选择此项,则只有callback,token,context,
     url这四个参数有效。其它参数将被忽略。            
   - scgc.tasks.NameSearchTask.DATA:
     返回查询的数据。
     如果选择此项,所有参数都有效,
     各参数必须根据相应的参数说明进行设置。
   - scgc.tasks.NameSearchTask.COUNT:
     返回查询数据的总个数和最大能返回的数据个数。
     如果选择此项,所设置参数除startIndex和
     stopIndex以外,
     其它参数与scgc.tasks.NameSearchTask.DATA相同。
url:String(可选)
   - 查询服务的地址。
   - 如果此处没有设置值,将自动使用用构造函数中的值来代替。
     如果在构造函数中和此处设置同时设置,
     则使用此处设置的值, 但此处设置的值只是临时的,
     仅限当前的一次调用有,
     且不会改变这个类全局(构造函数中设置)的值。
keywords:String(和typeCode必选其一)
   - 要查询的关键词。
typeCode:String(和keywords必选其一)
   - 要查询的类型。
     具体值参见该服务元数据列表中的选项。
statePAC:String(可选)
   - 市级的行政区划代码,由四位数组成。
countyPAC:String(可选)
   - 县级的行政区划代码,由六位数组成。
isOnlyName:Boolean(可选,缺省值:false)
   - 是否只返回名称。
boundingBox:esri.geometry.Extent(可选)
   - 需要搜索的指定范围。
startIndex:Integer(可选,缺省值:0)
   - 返回的数据的开始的索引值。从0开始。
     只有选择scgc.tasks.NameSearchTask.DATA此参数才起作用。
stopIndex:Integer(可选,缺省值:100)
   - 返回的数据的结束索引值。
     如果最大个数小于此索引值,则该值不起作用。
     只有选择scgc.tasks.NameSearchTask.DATA此参数才起作用。
callback:Function(必选)
   - 服务器返回后执行的回调函数。
error:Function(可选)
   - 当执行发生错误时执行的函数。
token:String(可选)
   - 向服务器发出查询请求的今牌。
   - 如果此服务为加密服务,则令牌不能为空。
     如果此处没有设置值,
     将自动使用用构造函数中的值来代替。
     如果在构造函数中和此处设置同时设置,
     则使用此处设置的值,
     但此处设置的值只是临时的,
     仅限当前的一次调用有,
     且不会改变这个类全局(构造函数中设置)的值。
context:Object(可选)
   - 附加参数,在服务器执行回调函数时,
     会将其值不变的传给回调函数。
               

事件

从严格意义上来说,不能称之为事件,它是在特定的情况下,控件会触发的函数,如token过期等。具体使用方法都一样,参见如下:

     var layer=new scgc.layers.SCGISTiledMapServiceLayer("[SCGISTILEMAP_REST_HTTP]");
     dojo.connect(layer,"onTokenExpired",function(json){
         var tokenTask=new scgc.tasks.TokenTask({getipServer:"http://...",...});
         tokenTask.execute(function(token,context){
             context.layer.setToken(token);
         },{account:"test",password:"test"},{layer:layer});
     });
                       

事件说明参数说明

onError(ex:Object, context:Object)

服务没有调用成功所触发的事件。

ex:服务返回的错误信息

context:附加参数,execute或构造函数中的context的值。


BufferTask 类

用于调用检索地名地址的服务。


常量


常量说明

scgc.tasks.BufferTask.META

返回服务查询的元数据。

scgc.tasks.BufferTask.DATA

返回服务查询的数据。

scgc.tasks.BufferTask.COUNT

返回查询数据的总个数和最大能返回的数据个数。


构造函数


构造函数说明参数说明
NameSearchTask(url:String,token?:String,context?:Object) 创建一个检索地名地址的实例

url:地名地址服务的URL地址

token:令牌

context:附加参数,在服务器执行回调函数时,会将其值不变的传给回调函数。


方法


方法返回值说明参数说明
execute(params:Object) None 此函数会自动调用远程服务器的REST服务进行数据查询,将服务器的查询结果以JSON Object格式返回给客户端。 如下:
type:scgc.tasks.BufferTask.Type(必选)
   - 查询的数据的类型。
   - scgc.tasks.BufferTask.META:
     返回服务查询的元数据。
     如果选择此项,则只有callback,token,context,url这四个个参数有效。
     其它参数将被忽略。            
   - scgc.tasks.BufferTask.DATA:
     返回查询的数据。
     如果选择此项,所有参数都有效,各参数必须根据相应的参数说明进行设置。
   - scgc.tasks.BufferTask.COUNT:
     返回查询数据的总个数和最大能返回的数据个数。
     如果选择此项,所设置参数除startIndex和stopIndex以外,
     其它参数与scgc.tasks.BufferTask.DATA相同。
url:String(可选)
   - 查询服务的地址。
   - 如果此处没有设置值,将自动使用用构造函数中的值来代替。
     如果在构造函数中和此处设置同时设置,则使用此处设置的值,
     但此处设置的值只是临时的,仅限当前的一次调用有,
     且不会改变这个类全局(构造函数中设置)的值。
keywords:String(和typeCode必选其一)
   - 要查询的关键词。
typeCode:String(和keywords必选其一)
   - 要查询的类型。
     具体值参见该服务元数据列表中的选项。
center:esri.geometry.Point(必选)
   - 搜索中心点坐标。
radius:Number(必选)
   - 搜索半径,单位为m(米)。
startIndex:Integer(可选,缺省值:0)
   - 返回的数据的开始的索引值。从0开始。
     只有选择scgc.tasks.BufferTask.DATA此参数才起作用。
stopIndex:Integer(可选,缺省值:100)
   - 返回的数据的结束索引值。如果最大个数小于此索引值,则该值不起作用。
     只有选择scgc.tasks.BufferTask.DATA此参数才起作用。
callback:Function(必选)
   - 服务器返回后执行的回调函数。
error:Function(可选)
   - 当执行发生错误时执行的函数。
   - 别一种方法就是
     dojo.connect(your_task_instance,"onError",yourErrorFunction);
     errorFunction格式:function onTaskError(ex,context);
token:String(可选)
   - 向服务器发出查询请求的今牌。
   - 如果此服务为加密服务,则令牌不能为空。
     如果此处没有设置值,将自动使用用构造函数中的值来代替。
     如果在构造函数中和此处设置同时设置,则使用此处设置的值,
     但此处设置的值只是临时的,仅限当前的一次调用有,
     且不会改变这个类全局(构造函数中设置)的值。
context:Object(可选)
   - 附加参数,在服务器执行回调函数时,会将其值不变的传给回调函数。
               

事件


事件说明参数说明

onError(ex:Object, context:Object)

服务没有调用成功所触发的事件。

ex:服务返回的错误信息

context:附加参数,execute或构造函数中的context的值。


ShortPathTask 类

用于调用路径分析的服务。


常量


常量说明

scgc.tasks.ShortPathTask.META

返回服务查询的元数据。

scgc.tasks.ShortPathTask.DATA

返回服务查询的数据。


构造函数


构造函数说明参数说明
ShortPathTask(url:String,token?:String,context?:Object) 创建一个调用路径分析类的实例

url:路径分析服务的URL地址

token:令牌

context:附加参数,在服务器执行回调函数时,会将其值不变的传给回调函数。


方法


方法返回值说明参数说明
execute(params:Object) None 此函数会自动调用远程服务器的REST服务进行数据查询,将服务器的查询结果以JSON Object格式返回给客户端。 如下:
type:scgc.tasks.ShortPathTask.Type(必选)
   - 查询的数据的类型。
   - scgc.tasks.ShortPathTask.META:
     返回服务查询的元数据。
     如果选择此项,则只有callback,token,context这三个参数有效,
     其它参数将被忽略。            
   - scgc.tasks.ShortPathTask.DATA。
     返回查询的数据。
     如果选择此项,所有参数都有效,各参数必须根据相应的参数说明进行设置。
url:String(可选)
   - 查询服务的地址。
   - 如果此处没有设置值,将自动使用用构造函数中的值来代替。
     如果在构造函数中和此处设置同时设置,则使用此处设置的值,
     但此处设置的值只是临时的,仅限当前的一次调用有,
     且不会改变这个类全局(构造函数中设置)的值。
start:esri.geometry.Point(必选)
   - 路径的起点。
stop:esri.geometry.Point(必选)
   - 路径的终点。
vias:esri.geometry.Multipoint(可选)
   - 路径的途经点。
barriers:esri.geometry.Multipoint(可选)
   - 路径的障碍点。
direction:Boolean(可选,缺省值:false) 
   - 是否输出方向文本描述信息。
power:String(必选)
   - 求最短路径所使用的权值,即可根据用户的需求选择不同的路径方案。
   - 此参数可根据先请求的元数据中的信息获取。
   - 如power="POWER"表示尽量走高速。power="LENGTH"表示走路程最短。
callback:Function(必选)
   - 服务器返回后执行的回调函数。
error:Function(可选)
   - 当执行发生错误时执行的函数。
token:String(可选)
   - 向服务器发出查询请求的今牌。
   - 如果此服务为加密服务,则令牌不能为空。
     如果此处没有设置值,将自动使用用构造函数中的值来代替。
     如果在构造函数中和此处设置同时设置,则使用此处设置的值,
     但此处设置的值只是临时的,仅限当前的一次调用有,
     且不会改变这个类全局(构造函数中设置)的值。
context:Object(可选)
   - 附加参数,在服务器执行回调函数时,会将其值不变的传给回调函数。
               

事件


事件说明参数说明

onError(ex:Object, context:Object)

服务没有调用成功所触发的事件。

ex:服务返回的错误信息

context:附加参数,execute或构造函数中的context的值。


DataSearchTask 类

用于调用要素查询的服务。


常量


常量说明

scgc.tasks.DataSearchTask.META

返回服务查询的元数据。

scgc.tasks.DataSearchTask.DATA

返回服务查询的数据。

DataSearchTask.SpatialRel.INTERSECTS

Intersects。

DataSearchTask.SpatialRel.CONTAINS

Contains。

DataSearchTask.SpatialRel.OVERLAPS

Overlaps。

DataSearchTask.SpatialRel.WITHIN

Within。


构造函数


构造函数说明参数说明
DataSearchTask(url:String,token?:String,context?:Object) 创建一个要素查询类的实例

url:要素查询服务的URL地址

token:令牌

context:附加参数,在服务器执行回调函数时,会将其值不变的传给回调函数。


方法


方法返回值说明参数说明
execute(params:Object) None 此函数会自动调用远程服务器的REST服务进行数据查询,将服务器的查询结果以JSON Object格式返回给客户端。 如下:
type:scgc.tasks.DataSearchTask.Type(必选)
   - 查询的数据的类型。
   - scgc.tasks.DataSearchTask.META:
     返回服务查询的元数据。
     如果选择此项,则只有callback,token,context,url这四个个参数有效。
     其它参数将被忽略。            
   - scgc.tasks.DataSearchTask.DATA:
     返回查询的数据。
     如果选择此项,所有参数都有效,各参数必须根据相应的参数说明进行设置。
url:String(可选)
   - 查询服务的地址。
   - 如果此处没有设置值,将自动使用用构造函数中的值来代替。
     如果在构造函数中和此处设置同时设置,则使用此处设置的值,
     但此处设置的值只是临时的,仅限当前的一次调用有,
     且不会改变这个类全局(构造函数中设置)的值。
layerID:Integer(必选)
   - 要查询的图层。
geometry:esri.geometry.Geometry(可选)
(只支持esri.geometry.Point | 
       esri.geometry.Polyline | 
       esri.geometry.Polygon)
   - 输入的几何图形。
radius:Number(可选)
   - 搜索半径,单位为m(米)。
     如果不需要要缓冲查询则不输入此值,如果输入的此值就一定会执行缓冲区查询
spatialRel:几何关系(可选,缺省值:
           scgc.layers.DataSearchTask.SpatialRel.INTERSECTS)
   - 和要查询的要素的几何关系。
whereClause:Integer(必选)
   - 查询的条件。
returnGeometry:Boolean(可选,缺省值:true)
   - 是否返回几何信息
outFields:Array(可选,缺省值:[])
   - 返回的字段,如果不设置则返回所有字段。
callback:Function(必选)
   - 服务器返回后执行的回调函数。
error:Function(可选)
   - 当执行发生错误时执行的函数。
   - 别一种方法就是
   dojo.connect(your_task_instance,"onError",yourErrorFunction);
   errorFunction格式:function onTaskError(ex,context);
token:String(可选)
   - 向服务器发出查询请求的今牌。
   - 如果此服务为加密服务,则令牌不能为空。
     如果此处没有设置值,将自动使用用构造函数中的值来代替。
     如果在构造函数中和此处设置同时设置,则使用此处设置的值,
     但此处设置的值只是临时的,仅限当前的一次调用有,
     且不会改变这个类全局(构造函数中设置)的值。
context:Object(可选)
   - 附加参数,在服务器执行回调函数时,会将其值不变的传给回调函数。
               

事件


事件说明参数说明

onError(ex:Object, context:Object)

服务没有调用成功所触发的事件。

ex:服务返回的错误信息

context:附加参数,execute或构造函数中的context的值。

主办单位:四川测绘地理信息局 承办单位:自然资源部四川基础地理信息中心  地址:成都市高新区九兴大道7号  电话:028-66065506   蜀ICP备11018666号 甲测资字51002001 技术支持:自然资源部四川基础地理信息中心