---
title: Class: Service
source: https://vjmap.com/en/doc/Class_Service.html
---

# Class: Service

`Service` 服务类.

### Table of contents

#### Constructors

- [constructor](#constructor)

#### Properties

- [accessToken](#accesstoken)
- [serverUrl](#serverurl)

#### Methods

- [addAccessKey](#addaccesskey)
- [addSecretKey](#addsecretkey)
- [baseUrl](#baseurl)
- [blankTileUrl](#blanktileurl)
- [checkFileHasUpload](#checkfilehasupload)
- [clearCache](#clearcache)
- [clone](#clone)
- [cmdClearMapCache](#cmdclearmapcache)
- [cmdClearTileCache](#cmdcleartilecache)
- [cmdCreateEntitiesGeomData](#cmdcreateentitiesgeomdata)
- [cmdDeleteCache](#cmddeletecache)
- [cmdDeleteMap](#cmddeletemap)
- [cmdDeleteStyle](#cmddeletestyle)
- [cmdExportLayout](#cmdexportlayout)
- [cmdGetAccessKey](#cmdgetaccesskey)
- [cmdGetDrawBounds](#cmdgetdrawbounds)
- [cmdGetSupportFormat](#cmdgetsupportformat)
- [cmdMapDiff](#cmdmapdiff)
- [cmdMatchObject](#cmdmatchobject)
- [cmdPrjWktToPrj4](#cmdprjwkttoprj4)
- [cmdRenameMap](#cmdrenamemap)
- [cmdResetAccessKey](#cmdresetaccesskey)
- [cmdRunStatus](#cmdrunstatus)
- [cmdSetMapPassword](#cmdsetmappassword)
- [cmdSliceLayer](#cmdslicelayer)
- [cmdSwitchLayers](#cmdswitchlayers)
- [cmdTransform](#cmdtransform)
- [cmdUpdateStyle](#cmdupdatestyle)
- [composeNewMap](#composenewmap)
- [conditionQueryFeature](#conditionqueryfeature)
- [createStyle](#createstyle)
- [currentMapParam](#currentmapparam)
- [deleteCustomData](#deletecustomdata)
- [execCommand](#execcommand)
- [exprQueryFeature](#exprqueryfeature)
- [fileMd5](#filemd5)
- [getConstData](#getconstdata)
- [getCurWorkspaceName](#getcurworkspacename)
- [getCustomData](#getcustomdata)
- [getCustomDataKeysByPrefix](#getcustomdatakeysbyprefix)
- [getFontsCapacity](#getfontscapacity)
- [getMapLayers](#getmaplayers)
- [getSliceCacheZoom](#getslicecachezoom)
- [getStyleLayerName](#getstylelayername)
- [getWorkspaces](#getworkspaces)
- [glyphsUrl](#glyphsurl)
- [listMaps](#listmaps)
- [metadata](#metadata)
- [openMap](#openmap)
- [pointQueryFeature](#pointqueryfeature)
- [processQueryResult](#processqueryresult)
- [pwdToSecretKey](#pwdtosecretkey)
- [qrcodeUrl](#qrcodeurl)
- [rasterBlankStyle](#rasterblankstyle)
- [rasterLayerId](#rasterlayerid)
- [rasterSourceId](#rastersourceid)
- [rasterStyle](#rasterstyle)
- [rasterTileUrl](#rastertileurl)
- [rectQueryFeature](#rectqueryfeature)
- [removeAccessKey](#removeaccesskey)
- [removeSecretKey](#removesecretkey)
- [saveCustomData](#savecustomdata)
- [serviceUrl](#serviceurl)
- [setCurrentMapParam](#setcurrentmapparam)
- [setSprite](#setsprite)
- [spriteUrl](#spriteurl)
- [strMd5](#strmd5)
- [styleVersion](#styleversion)
- [switchWorkspace](#switchworkspace)
- [thumbnailUrl](#thumbnailurl)
- [toLayerIndex](#tolayerindex)
- [updateMap](#updatemap)
- [updateMetadata](#updatemetadata)
- [uploadMap](#uploadmap)
- [uploadUrl](#uploadurl)
- [vectorStyle](#vectorstyle)
- [vectorTileUrl](#vectortileurl)
- [waitMapOpenFinish](#waitmapopenfinish)
- [webMapUrl](#webmapurl)
- [wmsTileUrl](#wmstileurl)
- [workspaceCreate](#workspacecreate)
- [workspaceDelete](#workspacedelete)
- [workspaceModify](#workspacemodify)

### Constructors

#### constructor

\+ **new Service**(`url`: *string*, `token?`: *string*, `req?`: [*IRequest*](#interfacesdefaultirequestmd)): [*Service*](#classesdefaultservicemd)

构造函数

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `url` | *string* | 服务地址 |
| `token?` | *string* | 访问凭证 |
| `req?` | [*IRequest*](#interfacesdefaultirequestmd) | 请求的方法实现（默认内部实现) |

**Returns:** [*Service*](#classesdefaultservicemd)

### Properties

#### accessToken

• **accessToken**: *string*= ""

访问凭证

___

#### serverUrl

• **serverUrl**: *string*= ""

服务器地址

### Methods

#### addAccessKey

▸ **addAccessKey**(`key`: *string*): *Set*<string\>

增加访问key

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `key` | *string* | key值 |

**Returns:** *Set*<string\>

___

#### addSecretKey

▸ **addSecretKey**(`key`: *string*): *Set*<string\>

增加秘钥key

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `key` | *string* | key值 |

**Returns:** *Set*<string\>

___

#### baseUrl

▸ **baseUrl**(): *string*

服务根地址

**Returns:** *string*

___

#### blankTileUrl

▸ **blankTileUrl**(): *string*

空白瓦片地址

**Returns:** *string*

___

#### checkFileHasUpload

▸ **checkFileHasUpload**(`filemd5`: *string*): *Promise*<any\>

检查文件是否上传过

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `filemd5` | *string* | 文件md5值 |

**Returns:** *Promise*<any\>

___

#### clearCache

▸ **clearCache**(`prefix?`: *string*): *Promise*<{}\>

清空服务器缓存数据

##### Parameters

| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `prefix` | *string* | "" | key前缀 |

**Returns:** *Promise*<{}\>

___

#### clone

▸ **clone**(`isCloneWorkspace?`: *boolean*): [*Service*](#classesdefaultservicemd)

克隆一个新的服务实例对象

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `isCloneWorkspace?` | *boolean* | 是否克隆当前工作区 (默认是) |

**Returns:** [*Service*](#classesdefaultservicemd)

Service

___

#### cmdClearMapCache

▸ **cmdClearMapCache**(`mapid`: *string*, `version`: *string*): *Promise*<any\>

清空地图的几何和瓦片缓存数据

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `mapid` | *string* | 地图ID |
| `version` | *string* | 版本号 |

**Returns:** *Promise*<any\>

___

#### cmdClearTileCache

▸ **cmdClearTileCache**(`mapid`: *string*, `version`: *string*): *Promise*<any\>

清空地图的瓦片缓存数据

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `mapid` | *string* | 地图ID |
| `version` | *string* | 版本号 |

**Returns:** *Promise*<any\>

___

#### cmdCreateEntitiesGeomData

▸ **cmdCreateEntitiesGeomData**(`param`: [*ICreateEntitiesGeomData*](#interfacesdefaulticreateentitiesgeomdatamd), `cb?`: (`point`: [*number*, *number*]) => *undefined* \| ``null`` \| [*number*, *number*]): *Promise*<any\>

获取创建实体的几何数据

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*ICreateEntitiesGeomData*](#interfacesdefaulticreateentitiesgeomdatamd) | 参数 |
| `cb?` | (`point`: [*number*, *number*]) => *undefined* \| ``null`` \| [*number*, *number*] | 结果中每个点的处理回调。如果返回空的话，则用默认处理方法 |

**Returns:** *Promise*<any\>

___

#### cmdDeleteCache

▸ **cmdDeleteCache**(`param`: [*IDeleteCache*](#interfacesdefaultideletecachemd)): *Promise*<any\>

删除地图缓存

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*IDeleteCache*](#interfacesdefaultideletecachemd) | 缓存接口 |

**Returns:** *Promise*<any\>

___

#### cmdDeleteMap

▸ **cmdDeleteMap**(`mapid`: *string*, `version`: *string*, `retainVersionMaxCount?`: *number*): *Promise*<any\>

删除地图

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `mapid` | *string* | 地图ID |
| `version` | *string* | 版本号，如删除所有版本，输入"*"号 |
| `retainVersionMaxCount?` | *number* | 删除所有版本时，保留的最新的版本总数。如总共有10个版本，retainVersionMaxCount为3时，会保存最新的3个版本，其余的都会删除 |

**Returns:** *Promise*<any\>

___

#### cmdDeleteStyle

▸ **cmdDeleteStyle**(`param`: [*IDeleteStyle*](#interfacesdefaultideletestylemd)): *Promise*<any\>

删除地图样式

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*IDeleteStyle*](#interfacesdefaultideletestylemd) | 样式接口 |

**Returns:** *Promise*<any\>

___

#### cmdExportLayout

▸ **cmdExportLayout**(`param`: [*IExportLayout*](#interfacesdefaultiexportlayoutmd)): *Promise*<any\>

导出布局空间为dwg图

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*IExportLayout*](#interfacesdefaultiexportlayoutmd) | 参数 |

**Returns:** *Promise*<any\>

___

#### cmdGetAccessKey

▸ **cmdGetAccessKey**(`mapid`: *string*, `key`: *string*): *Promise*<any\>

获取地图的AccessKey，获取之前请确保已成功打开了地图

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `mapid` | *string* | 地图ID |
| `key` | *string* | secretKey秘钥和超级管理员superKey |

**Returns:** *Promise*<any\>

___

#### cmdGetDrawBounds

▸ **cmdGetDrawBounds**(`mapid?`: *string*, `version?`: *string*): *Promise*<``null`` \| [*GeoBounds*](#classesdefaultgeoboundsmd)\>

获取图形中有数据的范围区域

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `mapid?` | *string* | 地图id |
| `version?` | *string* | 版本号 |

**Returns:** *Promise*<``null`` \| [*GeoBounds*](#classesdefaultgeoboundsmd)\>

___

#### cmdGetSupportFormat

▸ **cmdGetSupportFormat**(): *Promise*<any\>

获取支持的格式类型

**Returns:** *Promise*<any\>

___

#### cmdMapDiff

▸ **cmdMapDiff**(`param`: [*IMapDiff*](#interfacesdefaultimapdiffmd)): *Promise*<any\>

比较地图不同

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*IMapDiff*](#interfacesdefaultimapdiffmd) | 组合参数 |

**Returns:** *Promise*<any\>

___

#### cmdMatchObject

▸ **cmdMatchObject**(`param`: [*IMatchObject*](#interfacesdefaultimatchobjectmd)): *Promise*<any\>

目标匹配

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*IMatchObject*](#interfacesdefaultimatchobjectmd) | 参数 |

**Returns:** *Promise*<any\>

___

#### cmdPrjWktToPrj4

▸ **cmdPrjWktToPrj4**(`wkt`: *string*, `from?`: ``""`` \| ``"url"`` \| ``"wmsauto"`` \| ``"xml"`` \| ``"urn"`` \| ``"crsurl"`` \| ``"micoordsys"`` \| ``"pci"``): *Promise*<any\>

投影prj文件WKT字符转proj4字符串

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `wkt` | *string* | - |
| `from?` | ``""`` \| ``"url"`` \| ``"wmsauto"`` \| ``"xml"`` \| ``"urn"`` \| ``"crsurl"`` \| ``"micoordsys"`` \| ``"pci"`` | 字符串来源，为空为话为WKT |

**Returns:** *Promise*<any\>

___

#### cmdRenameMap

▸ **cmdRenameMap**(`oldMapID`: *string*, `newMapID`: *string*): *Promise*<any\>

地图ID重命名

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `oldMapID` | *string* | 旧地图ID |
| `newMapID` | *string* | 新地图ID |

**Returns:** *Promise*<any\>

___

#### cmdResetAccessKey

▸ **cmdResetAccessKey**(`mapid`: *string*, `key`: *string*): *Promise*<any\>

重置地图的AccessKey，获取之前请确保已成功打开了地图

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `mapid` | *string* | 地图ID |
| `key` | *string* | secretKey秘钥和超级管理员superKey |

**Returns:** *Promise*<any\>

___

#### cmdRunStatus

▸ **cmdRunStatus**(`bDetail?`: *boolean*): *Promise*<any\>

获取当前运行状态

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `bDetail?` | *boolean* | 是否需要细节 (默认false) |

**Returns:** *Promise*<any\>

___

#### cmdSetMapPassword

▸ **cmdSetMapPassword**(`mapid`: *string*, `key`: *string*, `newKey`: *string*): *Promise*<any\>

重置地图的密码，如果之前有密码，则是修改密码。如果之前没有密码，则是把此地图设置了密码保护。如果设置密码为空，则取消对此地图的密码保护。

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `mapid` | *string* | 地图ID |
| `key` | *string* | 旧的secretKey秘钥和超级管理员superKey |
| `newKey` | *string* | 新的secretKey秘钥 |

**Returns:** *Promise*<any\>

___

#### cmdSliceLayer

▸ **cmdSliceLayer**(`param`: [*ISliceLayer*](#interfacesdefaultislicelayermd)): *Promise*<any\>

对图层进行切片缓存

##### Parameters

| Name | Type |
| :------ | :------ |
| `param` | [*ISliceLayer*](#interfacesdefaultislicelayermd) |

**Returns:** *Promise*<any\>

___

#### cmdSwitchLayers

▸ **cmdSwitchLayers**(`visibleLayers`: *string*[]): *Promise*<any\>

切换图层

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `visibleLayers` | *string*[] | 让可见的图层列表数组 |

**Returns:** *Promise*<any\>

___

#### cmdTransform

▸ **cmdTransform**(`srs`: *string*, `crs`: *string*, `points`: [*GeoPoint*](#classesdefaultgeopointmd) \| [*GeoPoint*](#classesdefaultgeopointmd)[], `fourParameter?`: *string* \| *string*[], `isInverseFourParamter?`: *boolean*): *Promise*<any\>

坐标转换

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `srs` | *string* | 源坐标系名称，如 EPSG:4326 |
| `crs` | *string* | 目标坐标系名称，如 EPSG:3857 |
| `points` | [*GeoPoint*](#classesdefaultgeopointmd) \| [*GeoPoint*](#classesdefaultgeopointmd)[] | 要转换的坐标 |
| `fourParameter?` | *string* \| *string*[] | 四参数(x偏移,y偏移,缩放，旋转弧度)，可选，对坐标最后进行修正 |
| `isInverseFourParamter?` | *boolean* | 是否是上面四参数坐标的反算 |

**Returns:** *Promise*<any\>

___

#### cmdUpdateStyle

▸ **cmdUpdateStyle**(`param`: [*IUpdateStyle*](#interfacesdefaultiupdatestylemd)): *Promise*<any\>

更新样式

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*IUpdateStyle*](#interfacesdefaultiupdatestylemd) | 样式参数 |

**Returns:** *Promise*<any\>

Example:
```typescript
const res = svc.cmdUpdateStyle({
    name: "style1",
    layeron: [0,1,2,4,5,6,7,8,9],
    layeroff: "",
    clipbounds: "",
    backcolor: 0,
    lineweight:[1,1,0]
    expression: "gOutColorRed := gInColorGreen;gOutColorGreen := gInColorBlue;gOutColorBlue := gInColorRed;gOutColorAlpha := gInColorAlpha;"
});
```

___

#### composeNewMap

▸ **composeNewMap**(`param`: [*IComposeNewMap*](#interfacesdefaulticomposenewmapmd) \| [*IComposeNewMap*](#interfacesdefaulticomposenewmapmd)[]): *Promise*<any\>

组合成新地图

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*IComposeNewMap*](#interfacesdefaulticomposenewmapmd) \| [*IComposeNewMap*](#interfacesdefaulticomposenewmapmd)[] | 组合参数 |

**Returns:** *Promise*<any\>

___

#### conditionQueryFeature

▸ **conditionQueryFeature**(`param`: [*IConditionQueryFeatures*](#interfacesdefaulticonditionqueryfeaturesmd), `cb?`: (`point`: [*number*, *number*]) => *undefined* \| ``null`` \| [*number*, *number*]): *Promise*<any\>

条件查询实体

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*IConditionQueryFeatures*](#interfacesdefaulticonditionqueryfeaturesmd) | 参数 |
| `cb?` | (`point`: [*number*, *number*]) => *undefined* \| ``null`` \| [*number*, *number*] | 结果中每个点的处理回调。如果返回空的话，则用默认处理方法 |

**Returns:** *Promise*<any\>

___

#### createStyle

▸ **createStyle**(`style`: [*IMapStyleParam*](#interfacesdefaultimapstyleparammd), `mapid?`: *string*, `version?`: *string*, `isGeomLayer?`: *boolean*): *Promise*<any\>

获取样式图层名

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `style` | [*IMapStyleParam*](#interfacesdefaultimapstyleparammd) | 样式参数 |
| `mapid?` | *string* | 地图ID |
| `version?` | *string* | 版本号，为空，则获取最新的; |
| `isGeomLayer?` | *boolean* | 几何渲染图层优先(默认true) |

**Returns:** *Promise*<any\>

___

#### currentMapParam

▸ **currentMapParam**(): ``null`` \| [*IOpenMapResponse*](#interfacesdefaultiopenmapresponsemd)

当前地图参数

**Returns:** ``null`` \| [*IOpenMapResponse*](#interfacesdefaultiopenmapresponsemd)

___

#### deleteCustomData

▸ **deleteCustomData**(`key`: *string* \| *string*[], `isPrefix?`: *boolean*): *Promise*<any\>

删除用户自定义数据

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `key` | *string* \| *string*[] | 键名，如果是数组的话，可以查询 |
| `isPrefix?` | *boolean* | 是否删除所有前缀为key的所有键值，默认false |

**Returns:** *Promise*<any\>

___

#### execCommand

▸ **execCommand**(`cmdname`: *string*, `param?`: *Record*<string, any\>, `mapid?`: *string*, `version?`: *string*, `useGet?`: *boolean*): *Promise*<any\>

执行命令

##### Parameters

| Name | Type |
| :------ | :------ |
| `cmdname` | *string* |
| `param?` | *Record*<string, any\> |
| `mapid?` | *string* |
| `version?` | *string* |
| `useGet?` | *boolean* |

**Returns:** *Promise*<any\>

___

#### exprQueryFeature

▸ **exprQueryFeature**(`param`: [*IExprQueryFeatures*](#interfacesdefaultiexprqueryfeaturesmd), `cb?`: (`point`: [*number*, *number*]) => *undefined* \| ``null`` \| [*number*, *number*]): *Promise*<any\>

表达式查询实体

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*IExprQueryFeatures*](#interfacesdefaultiexprqueryfeaturesmd) | 参数 |
| `cb?` | (`point`: [*number*, *number*]) => *undefined* \| ``null`` \| [*number*, *number*] | 结果中每个点的处理回调。如果返回空的话，则用默认处理方法 |

**Returns:** *Promise*<any\>

___

#### fileMd5

▸ **fileMd5**(`file`: File): *Promise*<any\>

获取文件的Md5值

##### Parameters

| Name | Type |
| :------ | :------ |
| `file` | File |

**Returns:** *Promise*<any\>

___

#### getConstData

▸ **getConstData**(): *Promise*<any\>

获取服务后台常量设置

**Returns:** *Promise*<any\>

___

#### getCurWorkspaceName

▸ **getCurWorkspaceName**(): *string*

获取当前的工作区名称

**Returns:** *string*

___

#### getCustomData

▸ **getCustomData**(`key`: *string* \| *string*[], `options?`: { `contentType?`: ``""`` \| ``"image"`` ; `retDataType?`: ``""`` \| ``"value"`` \| ``"prop"``  }): *Promise*<any\>

获取用户自定义数据

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `key` | *string* \| *string*[] | 键名，如果是数组的话，可以查询. |
| `options?` | *object* | 选项 retDataType为空时查询数据及属性,"value"只查询数据，"prop"只查询属性。contentType返回类型,为空时为json，为"image"时为图片. |
| `options.contentType?` | ``""`` \| ``"image"`` | - |
| `options.retDataType?` | ``""`` \| ``"value"`` \| ``"prop"`` | - |

**Returns:** *Promise*<any\>

___

#### getCustomDataKeysByPrefix

▸ **getCustomDataKeysByPrefix**(`prefix`: *string*): *Promise*<any\>

通过前缀获取用户自定义数据的键值

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `prefix` | *string* | 键名前缀 |

**Returns:** *Promise*<any\>

___

#### getFontsCapacity

▸ **getFontsCapacity**(): *Promise*<{}\>

得到所有矢量字体名称

**Returns:** *Promise*<{}\>

___

#### getMapLayers

▸ **getMapLayers**(): [*IMapLayer*](#interfacesdefaultimaplayermd)[]

得到地图图层集合，调用前请确保地图已打开，否则会抛异常

**Returns:** [*IMapLayer*](#interfacesdefaultimaplayermd)[]

___

#### getSliceCacheZoom

▸ **getSliceCacheZoom**(`param`: [*ISliceCacheZoom*](#interfacesdefaultislicecachezoommd)): *Promise*<any\>

获取已缓存的切片级别

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*ISliceCacheZoom*](#interfacesdefaultislicecachezoommd) | 参数 |

**Returns:** *Promise*<any\>

___

#### getStyleLayerName

▸ **getStyleLayerName**(`mapid`: *string*, `version?`: *string*, `isGeomLayer?`: *boolean*, `name?`: *string*): *Promise*<any\>

获取样式图层名

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `mapid` | *string* | 地图ID |
| `version?` | *string* | 版本号，为空，则获取最新的; |
| `isGeomLayer?` | *boolean* | 几何渲染图层优先(默认true) |
| `name?` | *string* | 有名称时，根据名称来查找; |

**Returns:** *Promise*<any\>

___

#### getWorkspaces

▸ **getWorkspaces**(): *Promise*<any\>

获取所有工作区(如果不是root权限的token获取非公开的工作区名称将返回空)

**Returns:** *Promise*<any\>

___

#### glyphsUrl

▸ **glyphsUrl**(): *string*

字体地址

**Returns:** *string*

___

#### listMaps

▸ **listMaps**(`mapid?`: *string* \| *string*[] \| { `curPage`: *number* ; `mapIds?`: *string*[] ; `pageCount`: *number*  }, `version?`: *string*): *Promise*<any\>

获取所有地图信息

##### Parameters

| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `mapid` | *string* \| *string*[] \| { `curPage`: *number* ; `mapIds?`: *string*[] ; `pageCount`: *number*  } | "\_" | 地图ID，为空，则获取所有的；如果传入的是地图ID数组，则获取指定的地图ID数组的信息。如果不想一次性获取，可通过传入分页对象获取，如{curPage: 1, pageCount: 10} |
| `version` | *string* | "\_" | 版本号，为空，则获取最新的; * 则获取所有的版本 |

**Returns:** *Promise*<any\>

___

#### metadata

▸ **metadata**(`mapid?`: *string*, `version?`: *string*): *Promise*<any\>

获取地图元数据

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `mapid?` | *string* | 地图ID ，为空, 则为当前打开的图形 |
| `version?` | *string* | 版本号，为空 则为当前打开的版本; |

**Returns:** *Promise*<any\>

___

#### openMap

▸ **openMap**(`param`: [*IOpenMapParam*](#interfacesdefaultiopenmapparammd), `isWaitFinish?`: *boolean*): *Promise*<any\>

打开图

##### Parameters

| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `param` | [*IOpenMapParam*](#interfacesdefaultiopenmapparammd) | - |  |
| `isWaitFinish` | *boolean* | true | 是否等待打开完成 |

**Returns:** *Promise*<any\>

___

#### pointQueryFeature

▸ **pointQueryFeature**(`param`: [*IPointQueryFeatures*](#interfacesdefaultipointqueryfeaturesmd), `cb?`: (`point`: [*number*, *number*]) => *undefined* \| ``null`` \| [*number*, *number*]): *Promise*<any\>

点查询实体

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*IPointQueryFeatures*](#interfacesdefaultipointqueryfeaturesmd) | 参数 |
| `cb?` | (`point`: [*number*, *number*]) => *undefined* \| ``null`` \| [*number*, *number*] | 结果中每个点的处理回调。如果返回空的话，则用默认处理方法 |

**Returns:** *Promise*<any\>

___

#### processQueryResult

▸ **processQueryResult**(`param`: *any*, `cb?`: (`point`: [*number*, *number*]) => *undefined* \| ``null`` \| [*number*, *number*]): *any*

处理查询结果

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | *any* | 参数 |
| `cb?` | (`point`: [*number*, *number*]) => *undefined* \| ``null`` \| [*number*, *number*] | 结果中每个点的处理回调。如果返回空的话，则用默认处理方法 |

**Returns:** *any*

___

#### pwdToSecretKey

▸ **pwdToSecretKey**(`pwd`: *string*): *string*

密码转换为秘钥

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `pwd` | *string* | 密码 |

**Returns:** *string*

___

#### qrcodeUrl

▸ **qrcodeUrl**(`content`: *string*, `size?`: *number*): *string*

二维码图片地址

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `content` | *string* | 生成二维码的内容 |
| `size?` | *number* | 生成二维码的大小，默认256 |

**Returns:** *string*

___

#### rasterBlankStyle

▸ **rasterBlankStyle**(`minzoom?`: *number*, `maxzoom?`: *number*, `prefix?`: *string*): Style

空白栅格style

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `minzoom?` | *number* | 最小级别，缺省0 |
| `maxzoom?` | *number* | 最大级别，缺省24 |
| `prefix?` | *string* | 前缀，缺省rasterBlank |

**Returns:** Style

___

#### rasterLayerId

▸ **rasterLayerId**(`prefix?`: *string*): *string*

获取栅格图层ID

##### Parameters

| Name | Type |
| :------ | :------ |
| `prefix?` | *string* |

**Returns:** *string*

___

#### rasterSourceId

▸ **rasterSourceId**(`prefix?`: *string*): *string*

获取栅格源ID

##### Parameters

| Name | Type |
| :------ | :------ |
| `prefix?` | *string* |

**Returns:** *string*

___

#### rasterStyle

▸ **rasterStyle**(`tileUrl?`: *string*, `minzoom?`: *number*, `maxzoom?`: *number*, `prefix?`: *string*): Style

栅格style

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `tileUrl?` | *string* | 栅格瓦片地址 |
| `minzoom?` | *number* | 最小级别，缺省0 |
| `maxzoom?` | *number* | 最大级别，缺省24 |
| `prefix?` | *string* | 前缀，缺省raster |

**Returns:** Style

___

#### rasterTileUrl

▸ **rasterTileUrl**(`param?`: [*ITileUrlParam*](#interfacesdefaultitileurlparammd)): *string*

栅格瓦片地址

##### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `param` | [*ITileUrlParam*](#interfacesdefaultitileurlparammd) | {} |

**Returns:** *string*

___

#### rectQueryFeature

▸ **rectQueryFeature**(`param`: [*IRectQueryFeatures*](#interfacesdefaultirectqueryfeaturesmd), `cb?`: (`point`: [*number*, *number*]) => *undefined* \| ``null`` \| [*number*, *number*]): *Promise*<any\>

矩形查询实体

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `param` | [*IRectQueryFeatures*](#interfacesdefaultirectqueryfeaturesmd) | 参数 |
| `cb?` | (`point`: [*number*, *number*]) => *undefined* \| ``null`` \| [*number*, *number*] | 结果中每个点的处理回调。如果返回空的话，则用默认处理方法 |

**Returns:** *Promise*<any\>

___

#### removeAccessKey

▸ **removeAccessKey**(`key`: *string*): *void*

移除访问key, 如果key为undefined时，则移除所有的

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `key` | *string* | key值 |

**Returns:** *void*

___

#### removeSecretKey

▸ **removeSecretKey**(`key`: *string*): *undefined* \| *Set*<string\>

移除秘钥key, 如果key为undefined时，则移除所有的

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `key` | *string* | key值 |

**Returns:** *undefined* \| *Set*<string\>

___

#### saveCustomData

▸ **saveCustomData**(`key`: *string* \| { `key`: *string* ; `prop?`: *any* ; `ttl?`: *number* ; `value`: *any*  }[], `value?`: *any*, `prop?`: *any*, `ttl?`: *number*): *Promise*<any\>

保存用户自定义数据

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `key` | *string* \| { `key`: *string* ; `prop?`: *any* ; `ttl?`: *number* ; `value`: *any*  }[] | 键名(必须唯一，否则会覆盖之前的数据，同类型的key前缀尽量一样)，如果是数组的话，可以批量 |
| `value?` | *any* | 键值 |
| `prop?` | *any* | 属性值 |
| `ttl?` | *number* | 有效时间，单位秒，默认长期有效 |

**Returns:** *Promise*<any\>

___

#### serviceUrl

▸ **serviceUrl**(`u`: *string*): *string*

得到服务地址

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `u` | *string* | 要拼接的地址 |

**Returns:** *string*

string

___

#### setCurrentMapParam

▸ **setCurrentMapParam**(`param`: [*IOpenMapResponse*](#interfacesdefaultiopenmapresponsemd)): ``null`` \| [*IOpenMapResponse*](#interfacesdefaultiopenmapresponsemd)

设置打开地图参数

##### Parameters

| Name | Type |
| :------ | :------ |
| `param` | [*IOpenMapResponse*](#interfacesdefaultiopenmapresponsemd) |

**Returns:** ``null`` \| [*IOpenMapResponse*](#interfacesdefaultiopenmapresponsemd)

___

#### setSprite

▸ **setSprite**(`name`: *string*): *string*

设置精灵图片名称

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `name` | *string* | 精灵名称 |

**Returns:** *string*

___

#### spriteUrl

▸ **spriteUrl**(`name`: *string*): *string*

精灵图片名称

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `name` | *string* | 精灵名称 |

**Returns:** *string*

___

#### strMd5

▸ **strMd5**(`str`: *string*): *string*

获取字符串的Md5值

##### Parameters

| Name | Type |
| :------ | :------ |
| `str` | *string* |

**Returns:** *string*

___

#### styleVersion

▸ **styleVersion**(): *number*

得到style的版本号

**Returns:** *number*

___

#### switchWorkspace

▸ **switchWorkspace**(`workspaceName`: *string*): *void*

切换至工作区

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `workspaceName` | *string* | 工作区名称 |

**Returns:** *void*

___

#### thumbnailUrl

▸ **thumbnailUrl**(`mapid?`: *string*, `version?`: *string*, `width?`: *number*, `height?`: *number*, `darkTheme?`: *boolean*): *string*

获取图的缩略图

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `mapid?` | *string* |  |
| `version?` | *string* |  |
| `width?` | *number* |  |
| `height?` | *number* |  |
| `darkTheme?` | *boolean* | 是否是深色主题，是的话，图片将反色（黑色变白色） |

**Returns:** *string*

___

#### toLayerIndex

▸ **toLayerIndex**(`layernames`: *string*[], `layers`: *any*[]): *number*[]

把图层名称数组转成图层索引数组

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `layernames` | *string*[] | 图层名称数组 |
| `layers` | *any*[] | 图层列表 |

**Returns:** *number*[]

___

#### updateMap

▸ **updateMap**(`param`: [*IUpdateMapParam*](#interfacesdefaultiupdatemapparammd), `isWaitFinish?`: *boolean*): *Promise*<any\>

更新地图

##### Parameters

| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `param` | [*IUpdateMapParam*](#interfacesdefaultiupdatemapparammd) | - |  |
| `isWaitFinish` | *boolean* | true | 是否等待打开完成 |

**Returns:** *Promise*<any\>

___

#### updateMetadata

▸ **updateMetadata**(`meta`: *Record*<string, undefined \| ``null`` \| string \| number \| boolean\>, `mapid?`: *string*, `version?`: *string*): *Promise*<any\>

修改地图元数据

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `meta` | *Record*<string, undefined \| ``null`` \| string \| number \| boolean\> | 要修改的元数据项 |
| `mapid?` | *string* | 地图ID ，为空, 则为当前打开的图形 |
| `version?` | *string* | 版本号，为空 则为当前打开的版本; |

**Returns:** *Promise*<any\>

___

#### uploadMap

▸ **uploadMap**(`file`: File): *Promise*<any\>

上传地图

##### Parameters

| Name | Type |
| :------ | :------ |
| `file` | File |

**Returns:** *Promise*<any\>

___

#### uploadUrl

▸ **uploadUrl**(): *string*

返回上传文件的url地址

**Returns:** *string*

___

#### vectorStyle

▸ **vectorStyle**(`tileUrl?`: *string* \| *Record*<string, any\>, `minzoom?`: *number*, `maxzoom?`: *number*, `prefix?`: *string*, `hoverColor?`: *string*, `hoverOpacity?`: *number*, `hoverLineWidth?`: *number*, `customColorCaseExpr?`: *any*[], `customOpacityCaseExpr?`: *any*[], `customLineWidthCaseExpr?`: *any*[], `disableHover?`: *boolean*): Style

矢量style

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `tileUrl?` | *string* \| *Record*<string, any\> | 矢量瓦片地址 或者为一个Object，为Object时，设置项为参数的每个项值，做为一个参数传入 |
| `minzoom?` | *number* | 最小级别，缺省0 |
| `maxzoom?` | *number* | 最大级别，缺省24 |
| `prefix?` | *string* | 前缀，缺省vector |
| `hoverColor?` | *string* | 高亮时颜色，缺省rgba(0,0,255,255) |
| `hoverOpacity?` | *number* | 高亮时透明度,缺省0.5 |
| `hoverLineWidth?` | *number* | 高亮时线宽,缺省3 |
| `customColorCaseExpr?` | *any*[] | 自定义颜色表达式，必须为数组[条件1，值，条件2，值,...]，如[['==', ['feature-state', 'status'], 'alarm'], '#ff0000', ['==', ['feature-state', 'status'], 'normal'], '#00ff00'],缺省默认 |
| `customOpacityCaseExpr?` | *any*[] | 自定义透明度表达式，必须为数组,缺省默认 |
| `customLineWidthCaseExpr?` | *any*[] | 自定义线宽表达式，必须为数组,缺省默认 |
| `disableHover?` | *boolean* | 禁止hover |

**Returns:** Style

___

#### vectorTileUrl

▸ **vectorTileUrl**(`param?`: [*ITileUrlParam*](#interfacesdefaultitileurlparammd)): *string*

矢量瓦片地址

##### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `param` | [*ITileUrlParam*](#interfacesdefaultitileurlparammd) | {} |

**Returns:** *string*

___

#### waitMapOpenFinish

▸ **waitMapOpenFinish**(`mapid`: *string*, `version`: *string*, `tryTime?`: *number*, `maxTryTimes?`: *number*): *Promise*<any\>

等待地图打开完成

##### Parameters

| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `mapid` | *string* | - | 地图ID |
| `version` | *string* | - | 地图版本号 |
| `tryTime` | *number* | 5 | 每次尝试时间间隔(秒) |
| `maxTryTimes` | *number* | 120 | 最大尝试次数 |

**Returns:** *Promise*<any\>

___

#### webMapUrl

▸ **webMapUrl**(`tileProvider`: { `fourParameterAfter?`: *string* ; `fourParameterBefore?`: *string* ; `mapbounds?`: *string* ; `srs?`: *string* ; `tileCrs?`: ``"gcj02"`` \| ``"wgs84"`` ; `tileFlipY?`: *boolean* ; `tileMaxZoom?`: *number* ; `tileRetina?`: *number* ; `tileShards?`: *string* ; `tileSize?`: *number* ; `tileToken?`: *string* \| *string*[] ; `tileUrl`: *string* \| *string*[]  }): *string*

获取服务器地图服务地址

##### Parameters

| Name | Type |
| :------ | :------ |
| `tileProvider` | *object* |
| `tileProvider.fourParameterAfter?` | *string* |
| `tileProvider.fourParameterBefore?` | *string* |
| `tileProvider.mapbounds?` | *string* |
| `tileProvider.srs?` | *string* |
| `tileProvider.tileCrs?` | ``"gcj02"`` \| ``"wgs84"`` |
| `tileProvider.tileFlipY?` | *boolean* |
| `tileProvider.tileMaxZoom?` | *number* |
| `tileProvider.tileRetina?` | *number* |
| `tileProvider.tileShards?` | *string* |
| `tileProvider.tileSize?` | *number* |
| `tileProvider.tileToken?` | *string* \| *string*[] |
| `tileProvider.tileUrl` | *string* \| *string*[] |

**Returns:** *string*

___

#### wmsTileUrl

▸ **wmsTileUrl**(`param`: [*IWmsTileUrl*](#interfacesdefaultiwmstileurlmd)): *string*

##### Parameters

| Name | Type |
| :------ | :------ |
| `param` | [*IWmsTileUrl*](#interfacesdefaultiwmstileurlmd) |

**Returns:** *string*

___

#### workspaceCreate

▸ **workspaceCreate**(`workspace`: [*IWorkspace*](#interfacesdefaultiworkspacemd)): *Promise*<any\>

创建工作区(默认需要root权限)

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `workspace` | [*IWorkspace*](#interfacesdefaultiworkspacemd) | 工作区设置 |

**Returns:** *Promise*<any\>

___

#### workspaceDelete

▸ **workspaceDelete**(`name`: *string*): *Promise*<any\>

删除工作区（会同时删除工作区下面的所有目录文件）(默认需要root权限)

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `name` | *string* | 要删除的工作区名称 |

**Returns:** *Promise*<any\>

___

#### workspaceModify

▸ **workspaceModify**(`workspace`: [*IWorkspace*](#interfacesdefaultiworkspacemd)): *Promise*<any\>

修改工作区(默认需要root权限)

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `workspace` | [*IWorkspace*](#interfacesdefaultiworkspacemd) | 工作区 |

**Returns:** *Promise*<any\>


<a name="classesskylayermd"></a>

[vjmap](#readmemd) / [Exports](#modulesmd) / SkyLayer