# Class: ServerLayer

## ServerLayer()

#### new ServerLayer()

服务图层

Source:
  - ServerLayer.js, line 16

### Methods

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

清除缓存(内存缓存+本地文件缓存)

Source:
  - ServerLayer.js, line 204

##### Returns:

Type
  Promise.<Void>

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

根据类型创建地图服务

##### Parameters:

Name | Type | Description
--- | --- | ---
`type` | String | MapServer中的类型常量，如：MapServer.MapServerType.MAPSERVER_TYPE_OGC_WMS

Source:
  - ServerLayer.js, line 169

##### Returns:

返回创建好的MapServer对象

Type
  Promise.<MapServer>

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

构造一个新的ServerLayer对象

Source:
  - ServerLayer.js, line 39

##### Returns:

Type
  Promise.<ServerLayer>

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

获取服务图层的数据读取模式

Source:
  - ServerLayer.js, line 137

##### Returns:

地图服务访问模式（int类型的Number），例：1--MapServerAccessMode.ServerAndCache

Type
  Number

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

获取是否开启自适应显示。

Source:
  - ServerLayer.js, line 233

##### Returns:

true为开启,false不开启。默认情况下不开启。

Type
  boolean

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

获取缓存路径。

Source:
  - ServerLayer.js, line 267

##### Returns:

缓存路径

Type
  String

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

获取地图服务

Source:
  - ServerLayer.js, line 86

##### Returns:

Type
  Promise.<MapServer>

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

获取透明度

Source:
  - ServerLayer.js, line 369

##### Returns:

透明度,0-100的整数。 默认为0,表示不透明

Type
  Number

#### (async, static) preFetch(lMinZoom, lMaxZoom, rect) → {Number}

预缓存(可根据级别或者范围进行缓存) 该方法为异步方法，用户可以通过ServerLayer上的TilePreFetchListener获取预缓存的任务状态

##### Parameters:

Name | Type | Description
--- | --- | ---
`lMinZoom` | Number | 预缓存的最小级别
`lMaxZoom` | Number | 预缓存的最小级别
`rect` | Object | 预缓存的空间范围 （Rect类型的Object）

Source:
  - ServerLayer.js, line 288

##### Returns:

（int类型的Number） >=0成功,返回任务ID,-1:没有设置MapServer,-2:MapServer类型不支持预缓存,-3:参数不合法. 任务ID,从0开始，用户可以通过该返回值区分不同的预缓存任务.

Type
  Number

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

设置预缓存状态监听类

Source:
  - ServerLayer.js, line 324

##### Returns:

1 ：成功，0：失败。

Type
  Number

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

移除预缓存状态监听类

Source:
  - ServerLayer.js, line 339

##### Returns:

预缓存状态监听对象。

Type
  Object

#### (async, static) setAccessMode(accessMode) → {Promise.<void>}

设置服务图层的数据读取模式

##### Parameters:

Name | Type | Description
--- | --- | ---
`accessMode` | Number | 地图服务访问模式（int类型的Number），例：1--MapServerAccessMode.ServerAndCache

Source:
  - ServerLayer.js, line 72

##### Returns:

Type
  Promise.<void>

#### (async, static) setAutoScaleFlag(flag) → {Promise.<Void>}

设置是否开启自适应显示

##### Parameters:

Name | Type | Description
--- | --- | ---
`flag` | boolean | true为开启,false不开启。默认情况下不开启。

Source:
  - ServerLayer.js, line 219

##### Returns:

Type
  Promise.<Void>

#### (async, static) setCacheLocation(strCacheLocation) → {Number}

设置缓存路径

##### Parameters:

Name | Type | Description
--- | --- | ---
`strCacheLocation` | String | 缓存路径.用户需要保证该目录存在，否则设置失败。

Source:
  - ServerLayer.js, line 249

##### Returns:

0:失败.1:成功（int类型的Number）

Type
  Number

#### (async, static) setMapServer(mapServer) → {Promise.<Void>}

设置地图服务

##### Parameters:

Name | Type | Description
--- | --- | ---
`mapServer` | Object | 地图服务对象 （MapServer类型的Object）

Source:
  - ServerLayer.js, line 57

##### Returns:

Type
  Promise.<Void>

#### (async, static) setTransparency(trans) → {Number}

设置透明度,0-100 默认为0,表示不透明

##### Parameters:

Name | Type | Description
--- | --- | ---
`trans` | Number | 透明度，0-100的整数

Source:
  - ServerLayer.js, line 354

##### Returns:

1：成功，0：失败。(int类型的Number)

Type
  Number

#### (async, static) setURL(strURL) → {boolean}

设置服务URL

##### Parameters:

Name | Type | Description
--- | --- | ---
`strURL` | String | 服务URL

Source:
  - ServerLayer.js, line 153

##### Returns:

成功返回true

Type
  boolean

#### (async, static) stopFetch(taskId) → {Number}

停止预缓存

##### Parameters:

Name | Type | Description
--- | --- | ---
`taskId` | Number | 任务Id (int类型的Number)

Source:
  - ServerLayer.js, line 309

##### Returns:

>0成功 （int类型的Number）

Type
  Number