# Class: MapServer

## MapServer()

#### new MapServer()

地图服务对象，此类中定义服务类型的字符串常量，例：MAPSERVER_TYPE_TDF等

##### Properties:

Name | Type | Description
--- | --- | ---
`MapServerType.MAPSERVER_TYPE_TDF` | String | MapGISHDF 。
`MapServerType.MAPSERVER_TYPE_MBTILES` | String | MBTiles 。
`MapServerType.MAPSERVER_TYPE_TPKTILE` | String | TPKTile 。
`MapServerType.MAPSERVER_TYPE_GEOPACKAGETILE` | String | GeoPackageTile 。
`MapServerType.MAPSERVER_TYPE_IGSERVER_TILE` | String | MapGISIGServerTile 。
`MapServerType.MAPSERVER_TYPE_IGSERVER_VECTOR` | String | MapGISIGServerVector 。
`MapServerType.MAPSERVER_TYPE_IGSERVER_VECTORTILE` | String | MapGISIGServerVectorTile 。
`MapServerType.MAPSERVER_TYPE_IGSERVER_SCENE` | String | MapGISIGServerScene 。
`MapServerType.MAPSERVER_TYPE_OGC_WMS` | String | OGCWMS 。
`MapServerType.MAPSERVER_TYPE_OGC_WMTS` | String | OGCWMTS 。
`MapServerType.MAPSERVER_TYPE_OGC_WFS` | String | OGCWFS 。
`MapServerType.MAPSERVER_TYPE_TIANDITU` | String | Tianditu 。
`MapServerType.MAPSERVER_TYPE_TIANDITU_EMAP` | String | TianDiTuEMap 。
`MapServerType.MAPSERVER_TYPE_TIANDITU_ANNMAP` | String | TianDiTuAnnMap 。
`MapServerType.MAPSERVER_TYPE_TIANDITU_SATELLITEMAP` | String | TianDiTuSatelliteMap 。
`MapServerType.MAPSERVER_TYPE_TIANDITU_SATELLITEANNMAP` | String | TianDiTuSatelliteAnnMap 。
`MapServerType.MAPSERVER_TYPE_TIANDITU_MERCATOR_EMAP` | String | TianDiTuMercatorEMap 。
`MapServerType.MAPSERVER_TYPE_TIANDITU_MERCATOR_ANNMAP` | String | TianDiTuMercatorAnnMap 。
`MapServerType.MAPSERVER_TYPE_TIANDITU_MERCATOR_SATELLITEMAP` | String | TianDiTuMercatorSatelliteMap 。
`MapServerType.MAPSERVER_TYPE_TIANDITU_MERCATOR_SATELLITEANNMAP` | String | TianDiTuMercatorSatelliteAnnMap 。
`MapServerType.MAPSERVER_TYPE_OPENSTREET_STANDARD` | String | OpenStreetStandard 。
`MapServerType.MAPSERVER_TYPE_OPENSTREET_CYCLE` | String | OpenStreetCycle 。
`MapServerType.MAPSERVER_TYPE_OPENSTREET_TRANSPORT` | String | OpenStreetTransport 。
`MapServerType.MAPSERVER_TYPE_OPENSTREET_MAPQUESTOPEN` | String | OpenStreetMapQuestOpen 。
`MapServerType.MAPSERVER_TYPE_OPENSTREET_HUNAMITARIAN` | String | OpenStreetHunamitarian 。
`MapServerType.MapServerType.MAPSERVER_TYPE_BING_MAP` | String | BingMap 。
`MapServerType.MAPSERVER_TYPE_BING_SATELLITEMAP` | String | BingSatelliteMap 。
`MapServerType.MAPSERVER_TYPE_BING_HYBRIDMAP` | String | BingHybridMap 。
`MapServerType.MAPSERVER_TYPE_YAHOO_MAP` | String | YahooMap 。
`MapServerType.MAPSERVER_TYPE_YAHOO_MAPSATELLITE` | String | YahooMapSatellite 。
`MapServerType.MAPSERVER_TYPE_YAHOO_MAPVECTOR` | String | YahooMapVector 。
`MapServerType.MAPSERVER_TYPE_YAHOO_MAPHYBRID` | String | YahooMapHybrid 。
`MapServerType.MAPSERVER_TYPE_GOOGLE_MAP` | String | GoogleMap 。
`MapServerType.MAPSERVER_TYPE_GOOGLE_SATELLITEMAP` | String | GoogleSatelliteMap 。
`MapServerType.MAPSERVER_TYPE_GOOGLE_MAPVECTOR` | String | GoogleMapVector 。
`MapServerType.MAPSERVER_TYPE_GOOGLE_MAPHYBRID` | String | GoogleMapHybrid 。
`MapServerType.MAPSERVER_TYPE_GOOGLE_MAPTERRAIN` | String | GoogleMapTerrain 。
`MapServerType.MAPSERVER_TYPE_GOOGLE_CHINA_MAP` | String | GoogleChinaMap 。
`MapServerType.MAPSERVER_TYPE_GOOGLE_CHINA_MAPSATELLITE` | String | GoogleChinaMapSatellite 。
`MapServerType.MAPSERVER_TYPE_GOOGLE_CHINA_MAPVECTOR` | String | GoogleChinaMapVector 。
`MapServerType.MAPSERVER_TYPE_GOOGLE_CHINA_MAPHYBRID` | String | GoogleChinaMapHybrid 。
`MapServerType.MAPSERVER_TYPE_GOOGLE_CHINA_MAPTERRAIN` | String | GoogleChinaMapTerrain 。
`MapServerType.MAPSERVER_TYPE_BAIDU_MAP` | String | BaiduMap 。
`MapServerType.MAPSERVER_TYPE_BAIDU_MAPSATELLITE` | String | BaiduMapSatellite 。
`MapServerType.MAPSERVER_TYPE_BAIDU_MAPVECTOR` | String | BaiduMapVector 。
`MapServerType.MAPSERVER_TYPE_BAIDU_MAPHYBRID` | String | BaiduMapHybrid 。
`MapServerType.MAPSERVER_TYPE_TMC_MAPABCMAP` | String | TMCMapABCMap 。
`MapServerType.MAPSERVER_TYPE_TMC_SOSOMAP` | String | TMCSOSOMap 。
`MapServerType.MAPSERVER_TYPE_AMAP_MERCATOR_EMAP` | String | AMapMercatorEMap 高德电子地图 。
`MapServerType.MAPSERVER_TYPE_AMAP_MERCATOR_SATELLITEMAP` | String | AMapMercatorSatelliteMap 高德卫星图 。
`MapServerType.MAPSERVER_TYPE_AMAP_MERCATOR_SATELLITEANNMAP` | String | AMapMercatorSatelliteAnnMap 高德卫星图 。

Source:
  - MapServer.js, line 14

### Methods

#### (async, static) connectData() → {Number}

连接数据 (真实地连接数据源，可以获取服务返回相关信息 如HDF瓦片信息。)

Source:
  - MapServer.js, line 197

##### Returns:

1-成功； 0-失败 （int类型的Number）

Type
  Number

#### (async, static) createObj() → {Promise.<MapServer>}

构建一个新的MapServer对象

Source:
  - MapServer.js, line 90

##### Returns:

地图服务对象

Type
  Promise.<MapServer>

#### (async, static) getAuthenticPassword() → {String}

获密码或验证码（比如token验证码）

Source:
  - MapServer.js, line 370

##### Returns:

密码或验证码

Type
  String

#### (async, static) getAuthenticUser() → {String}

获取用户名

Source:
  - MapServer.js, line 355

##### Returns:

用户名

Type
  String

#### (async, static) getCopyright() → {String}

获取服务版权

Source:
  - MapServer.js, line 319

##### Returns:

服务版权

Type
  String

#### (async, static) getCurrentVersion() → {String}

获取服务的当前版本

Source:
  - MapServer.js, line 435

##### Returns:

返回当前版本

Type
  String

#### (async, static) getEntireExtent() → {Object}

获取全图范围（数据范围）

Source:
  - MapServer.js, line 244

##### Returns:

Rect 范围

Type
  Object

#### (async, static) getIsValid() → {boolean}

判断服务地址URL是否有效性

Source:
  - MapServer.js, line 212

##### Returns:

true-服务地址有效； false-服务地址无效

Type
  boolean

#### (async, static) getMapBrowseType() → {Number}

获取地图浏览类型

Source:
  - MapServer.js, line 122

##### Returns:

地图浏览类型（int类型的Number） 例：0-MapServerBrowseType.MapTile

Type
  Number

#### (async, static) getMapServer(index) → {Object}

获取索引对应的地图服务对象

##### Parameters:

Name | Type | Description
--- | --- | ---
`index` | Number | 索引 （int类型的Number）

Source:
  - MapServer.js, line 279

##### Returns:

返回地图服务对象

Type
  Object

#### (async, static) getMapServerCount() → {Number}

返回服务对象个数 获得本服务对象下的服务对象列表,主要针对混合服务图层由多个服务对象组成。 eg. CGGoogleHybridMapServer谷歌混合地图由CGGoogleSatelliteMapServer卫星地图和CGGoogleVectorMapServer矢量地图组成

Source:
  - MapServer.js, line 262

##### Returns:

服务对象个数 （int类型的Number）

Type
  Number

#### (async, static) getName() → {String}

获取具体服务名称

Source:
  - MapServer.js, line 152

##### Returns:

具体服务名称

Type
  String

#### (async, static) getSRS() → {Object}

获取地图服务的源参照系

Source:
  - MapServer.js, line 227

##### Returns:

SRefData 参照系

Type
  Object

#### (async, static) getType() → {String}

获取服务类型

Source:
  - MapServer.js, line 107

##### Returns:

服务类型

Type
  String

#### (async, static) getURL() → {String}

获取服务地址URL

Source:
  - MapServer.js, line 182

##### Returns:

Type
  String

#### (async, static) getVersion(index) → {String}

获取索引对应的版本名称

##### Parameters:

Name | Type | Description
--- | --- | ---
`index` | Number | 索引 （int类型的Number）

Source:
  - MapServer.js, line 404

##### Returns:

版本名称

Type
  String

#### (async, static) getVersionCount() → {Number}

我们认为所有服务都存在一个“Default version”默认版本

Source:
  - MapServer.js, line 388

##### Returns:

服务版本个数 （int类型的Number）

Type
  Number

#### (async, static) setAuthentication(strUser, strPwd) → {Number}

设置用户名和密码认证信息

##### Parameters:

Name | Type | Description
--- | --- | ---
`strUser` | String | 用户名
`strPwd` | String | 密码（或Token）,可用来设置Token验证码.

Source:
  - MapServer.js, line 336

##### Returns:

1-成功 ；0-失败 （int类型的Number）

Type
  Number

#### (async, static) setCopyright(strCopyright) → {Number}

设置服务版权

##### Parameters:

Name | Type | Description
--- | --- | ---
`strCopyright` | String | 服务版权

Source:
  - MapServer.js, line 304

##### Returns:

1-成功 ； 0-失败 （int类型的Number）

Type
  Number

#### (async, static) setCurrentVersion(strVersion) → {Number}

设置服务的当前版本

##### Parameters:

Name | Type | Description
--- | --- | ---
`strVersion` | String | 当前版本

Source:
  - MapServer.js, line 420

##### Returns:

1-成功 ； 0-失败 （int类型的Number）

Type
  Number

#### (async, static) setName(name) → {Promise.<Void>}

设置具体服务名称

##### Parameters:

Name | Type | Description
--- | --- | ---
`name` | String | 具体服务名称

Source:
  - MapServer.js, line 138

##### Returns:

Type
  Promise.<Void>

#### (async, static) setURL(URL) → {Promise.<Void>}

设置服务地址URL

##### Parameters:

Name | Type | Description
--- | --- | ---
`URL` | String | 服务地址URL

Source:
  - MapServer.js, line 168

##### Returns:

Type
  Promise.<Void>