Reference Source
public class | source

MapConfig

Extends:

L~L.Evented → MapConfig

地图设置类

Example:

遍历并输出配置的图层数据:
function printLayerGroup(layergroup) {
  // for less debug info
  var copy = L.extend({}, layergroup);
  copy.layer = null;
  copy._parent = null;
  console.log('layer group!' + JSON.stringifyOnce(copy));
}

function printLayer(layer) {
  // for less debug info
  layer._parent = null;
  console.log('layer!' + JSON.stringifyOnce(layer));
}

function visitLayerGroup(layergroup) {
  var subLayers = config.getLayerSubLayer(layergroup);
  for (var n = 0; n < subLayers.length; ++n) {
    if (config.isLayerGroup(subLayers[n])) {
      visitLayerGroup(subLayers[n]);
    }
    else {
      printLayer(subLayers[n]);
    }
  }
}

var layers = config.layers();
for (var i = 0; i < layers.length; ++i) {
  if (config.isLayerGroup(layers[i])) {
    console.log('layer group! continue visit!');
    printLayerGroup(layers[i]);
    visitLayerGroup(layers[i]);
  } else {
    printLayer(layers[i]);
  }
}

Static Method Summary

Static Public Methods
public static

createLayerConfig(options: *): *

public static

获取实例对象

public static

isHasControl(controlType: *): boolean

Constructor Summary

Public Constructor
public

构造函数

Method Summary

Public Methods
public

获取控件的数组

public

findLayer(origin_src_name: String, id: String): Object

根据原始数据源名称和图层id查找图层对象

public

获取全部图层的列表

public

获取需要网络分析的图层列表

public

获取需要栅格分析的图层列表

public
public
public

获取配置文件中写的投影信息(esri)。

public

获取配置文件中写的投影信息(proj4)。

public

getControl(controlType: String): Object

获取控件

public

获取控件的高

public

获取控件位置

public

getControlProperty(control: Object, property: String): String

获取控件属性

public

获取控件类型

public

获取控件宽度

public

获取控件权限

public

获取draw控件的选项

public

getEPSG(): *

public

获取全图范围

public

获取地图初始化范围

public

获取地图语言

public

获取图层ID

public

获取图层的icon路径

public

获取图层的key,该key可以唯一标识一个图层

public

获取图层的显示名称

public

获取图层的透明度

public

getLayerProperty(layer: Object, property: String): String

获取图层属性

public

获取图层的数据源名称

public

获取图层的子图层数组

public

获取图层的提示信息框

public

获取图层类型

public

getLayerVtId(layer: *): *

public

获取图层权限

public

获取地图背景色

public
public
public

获取最小比例尺索引号,影响地图缩放的最小层级

public

获取数据源的原始名称

public

getPrj(isUseDefault: *): String

获取投影信息(esri)。如果没有投影,将会猜测单位并且设置默认投影。

public

获取投影信息(proj4)。 如果没有投影,将会猜测单位并且设置默认投影。

public

获取投影的范围

public

获取投影的原点

public

获取橡皮框控件的选项

public

根据比例尺索引号获取比例尺对象。

public

获取比例尺ID。在google模式下,ID是google比例尺的层级号。

public

获取scale的偏移值,默认情况下为0

public

getSourceByName(sourceName: String, isOrigin: Boolean): Object

通过数据源名称获取数据源对象

public

获取数据源的图层类型。预处理后,一个数据源只有一个图层类型。

public

获取数据源的图层

public

获取数据源名称

public

getSourceScaleOffset(source: *): *

public

获取数据源类型

public

获取数据源的url

public

获取数据源Geometry服务的url

public

获取数据源的ip和端口的url

public
public

获取数据源ServicesRoot服务的url

public

getSubControl(parent_control: Object, subcontrol_type: String): Object

获取父控件的子控件

public

getSubControls(parent_control: Object): Object

获取父控件的子控件列表

public

返回树控件最大的选中数量

public

获取单位

public
public
public

获取wms数据源的瓦片的高度

public

获取wms数据源的瓦片的宽度

public

获取wms数据源的untiled属性

public
public

async initAsync(xmlstring: String, isZip: Boolean, callback: Function): Promise

初始化

public

控件是否有权限

public

是否自定义所有控件

public

是否为google比例尺

public

isHasControl(controlType: String): Boolean

是否含有控件

public

isHideTreeLabel(): Bool

是否隐藏Tree Label

public

图层是否是动态图层

public

是否为复合图层

public

图层是否有权限

public

图层是否为历史回放图层

public

图层是否为遮罩图层

public

图层是否为迷你图图层

public

图层是否在图层树里被使用

public

图层是否默认选中

public
public

获取使用的语言

public

layers(isIncludeUnuse: Boolean): Array

获取图层列表

public

获取图例标签的模式

public

获取遮罩图层列表

public

获取迷你图的图层列表

public
public

permission(value: String[]): String[]

设置或获取权限,如果不传参数则为获取

public

获取分辨率,meter / pixel

public

转换比例尺ID到比例尺索引。

public

转换比例尺索引到比例尺ID。

public

获取比例尺列表

public

setDrawOption(option: Object): Null

设置Draw控件的参数

public

setLayerOpacity(layer: Object, opacity: Number): Null

设置图层的透明度

public

setRubberBandOption(option: Object): Null

设置橡皮框控件的选项

public

setSources(sources: Array): Array

设置数据源数组

public

获取数据源列表

public

获取主题名称

public

获取图层树的图标

public

获取图层树的标题

Static Public Methods

public static createLayerConfig(options: *): * source

Params:

NameTypeAttributeDescription
options *

Return:

*

public static getInstance(): MapConfig source

获取实例对象

Return:

MapConfig

public static isHasControl(controlType: *): boolean source

Params:

NameTypeAttributeDescription
controlType *

Return:

boolean

Public Constructors

public constructor() source

构造函数

Public Methods

public controls(): Array source

获取控件的数组

Return:

Array

public findLayer(origin_src_name: String, id: String): Object source

根据原始数据源名称和图层id查找图层对象

Params:

NameTypeAttributeDescription
origin_src_name String

原始数据源名称

id String

图层id

Return:

Object

public getAllLayerList(): Array source

获取全部图层的列表

Return:

Array

public getAllNetworkAnalysisLayers(): Array source

获取需要网络分析的图层列表

Return:

Array

public getAllRasterAnalysisLayers(): Array source

获取需要栅格分析的图层列表

Return:

Array

public getBuildingHeightRate(): number source

Return:

number

public getBuildingMinScaleValue(): number source

Return:

number

public getConfigPrj(): String source

获取配置文件中写的投影信息(esri)。

Return:

String

public getConfigProj4(): String source

获取配置文件中写的投影信息(proj4)。

Return:

String

public getControl(controlType: String): Object source

获取控件

Params:

NameTypeAttributeDescription
controlType String

控件类型,如:"zoom","tree"

Return:

Object

或 null

public getControlHeight(control: String): String source

获取控件的高

Params:

NameTypeAttributeDescription
control String

控件对象

Return:

String

public getControlPosition(control: String): String source

获取控件位置

Params:

NameTypeAttributeDescription
control String

控件对象.

Return:

String

'topleft', 'topright', 'bottomleft' or 'bottomright'

public getControlProperty(control: Object, property: String): String source

获取控件属性

Params:

NameTypeAttributeDescription
control Object

控件对象

property String

属性名称,如:"url","type"

Return:

String

public getControlType(control: Object): String source

获取控件类型

Params:

NameTypeAttributeDescription
control Object

控件对象

Return:

String

public getControlWidth(control: String): String source

获取控件宽度

Params:

NameTypeAttributeDescription
control String

控件对象

Return:

String

public getControlpermission(control: Object): String[] source

获取控件权限

Params:

NameTypeAttributeDescription
control Object

控件对象

Return:

String[]

public getDrawOption(): Object source

获取draw控件的选项

Return:

Object

public getEPSG(): * source

Return:

*

public getFullExtent(): Array source

获取全图范围

Return:

Array

左下右上

public getInitExtent(): Array source

获取地图初始化范围

Return:

Array

左下右上

public getLanguage(): String source

获取地图语言

Return:

String

'cn','en'

public getLayerID(layer: Object): Number source

获取图层ID

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

Number

public getLayerIcon(layer: Object): String source

获取图层的icon路径

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

String

public getLayerKey(layer: Object): String source

获取图层的key,该key可以唯一标识一个图层

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

String

public getLayerLabel(layer: Object): String source

获取图层的显示名称

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

String

public getLayerOpacity(layer: Object): Number source

获取图层的透明度

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

Number

public getLayerProperty(layer: Object, property: String): String source

获取图层属性

Params:

NameTypeAttributeDescription
layer Object

图层对象

property String

属性名称,如:"url","type"

Return:

String

public getLayerSourceName(layer: Object): String source

获取图层的数据源名称

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

String

public getLayerSubLayer(layer: Object): Array source

获取图层的子图层数组

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

Array

public getLayerTooltip(layer: Object): String source

获取图层的提示信息框

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

String

public getLayerType(layer: Object): String source

获取图层类型

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

String

'sl'矢量; 'yx'影像

public getLayerVtId(layer: *): * source

Params:

NameTypeAttributeDescription
layer *

Return:

*

public getLayerpermission(layer: Object): String[] source

获取图层权限

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

String[]

public getMapBackgroundColor(): Color source

获取地图背景色

Return:

Color

public getMapBuilder_dbInfomations(): * source

Return:

*

public getMapBuilder_fileServerUrl(): * source

Return:

*

public getMinScaleID(): Number source

获取最小比例尺索引号,影响地图缩放的最小层级

Return:

Number

public getOriginSourceName(source: Object): String source

获取数据源的原始名称

Params:

NameTypeAttributeDescription
source Object

数据源对象

Return:

String

public getPrj(isUseDefault: *): String source

获取投影信息(esri)。如果没有投影,将会猜测单位并且设置默认投影。

Params:

NameTypeAttributeDescription
isUseDefault *

Return:

String

public getProj4(): String source

获取投影信息(proj4)。 如果没有投影,将会猜测单位并且设置默认投影。

Return:

String

public getProjectionBounds(): Array source

获取投影的范围

Return:

Array

[left, top, right, bottom]

public getProjectionOrigin(): Array source

获取投影的原点

Return:

Array

[x, y]

public getRubberBandOption(): Object source

获取橡皮框控件的选项

Return:

Object

public getScaleByIndex(index: Number): Number source

根据比例尺索引号获取比例尺对象。

Params:

NameTypeAttributeDescription
index Number

比例尺索引

Return:

Number

public getScaleID(scale: Object): Number source

获取比例尺ID。在google模式下,ID是google比例尺的层级号。

Params:

NameTypeAttributeDescription
scale Object

比例尺对象

Return:

Number

public getScaleOffset(): Number source

获取scale的偏移值,默认情况下为0

Return:

Number

public getSourceByName(sourceName: String, isOrigin: Boolean): Object source

通过数据源名称获取数据源对象

Params:

NameTypeAttributeDescription
sourceName String

数据源名称

isOrigin Boolean

是否在原始数据源里查找

Return:

Object

public getSourceLayerType(source: Object): String source

获取数据源的图层类型。预处理后,一个数据源只有一个图层类型。

Params:

NameTypeAttributeDescription
source Object

数据源对象

Return:

String

"sl" "yx" ""...

public getSourceLayers(source: Object): Array source

获取数据源的图层

Params:

NameTypeAttributeDescription
source Object

数据源对象

Return:

Array

public getSourceName(source: Object): String source

获取数据源名称

Params:

NameTypeAttributeDescription
source Object

数据源对象

Return:

String

public getSourceScaleOffset(source: *): * source

Params:

NameTypeAttributeDescription
source *

Return:

*

public getSourceType(source: Object): String source

获取数据源类型

Params:

NameTypeAttributeDescription
source Object

数据源对象

Return:

String

"kqmapping" "wms" ...

public getSourceUrl(source: Object): String source

获取数据源的url

Params:

NameTypeAttributeDescription
source Object

数据源对象

Return:

String

public getSourceUrl_GeometryService(source: Object): String source

获取数据源Geometry服务的url

Params:

NameTypeAttributeDescription
source Object

数据源对象

Return:

String

public getSourceUrl_IPPort(source: Object): String source

获取数据源的ip和端口的url

Params:

NameTypeAttributeDescription
source Object

数据源对象

Return:

String

public getSourceUrl_ManagerService(source: *): * source

Params:

NameTypeAttributeDescription
source *

Return:

*

public getSourceUrl_ServicesRoot(source: Object): String source

获取数据源ServicesRoot服务的url

Params:

NameTypeAttributeDescription
source Object

数据源对象

Return:

String

public getSubControl(parent_control: Object, subcontrol_type: String): Object source

获取父控件的子控件

Params:

NameTypeAttributeDescription
parent_control Object

父控件

subcontrol_type String

子控件类型

Return:

Object

or {null}

public getSubControls(parent_control: Object): Object source

获取父控件的子控件列表

Params:

NameTypeAttributeDescription
parent_control Object

父控件列表

Return:

Object

public getTreeSelectMaxCount(): Number source

返回树控件最大的选中数量

Return:

Number

public getUnit(): String source

获取单位

Return:

String

'meter', 'degree', 'us-ft', 'other'

public getUrlFromSourceName(name: String, isOrigin: Boolean): String source

Params:

NameTypeAttributeDescription
name String

数据源的名称

isOrigin Boolean

是否原始的数据源名称

Return:

String

返回数据源的url地址

public getVectorTileOptions(map: *): * source

Params:

NameTypeAttributeDescription
map *

Return:

*

public getWmsSourceTileHeight(source: Object): String source

获取wms数据源的瓦片的高度

Params:

NameTypeAttributeDescription
source Object

数据源对象

Return:

String

"256"

public getWmsSourceTileWidth(source: Object): String source

获取wms数据源的瓦片的宽度

Params:

NameTypeAttributeDescription
source Object

数据源对象

Return:

String

"256"

public getWmsSourceUntiled(source: Object): String source

获取wms数据源的untiled属性

Params:

NameTypeAttributeDescription
source Object

数据源对象

Return:

String

"0" "1" ...

public hasVectorTileSource(): * source

Return:

*

public async initAsync(xmlstring: String, isZip: Boolean, callback: Function): Promise source

初始化

Params:

NameTypeAttributeDescription
xmlstring String

地图设置信息,xml格式,如果设置为空则调用固定路径下的配置文件

isZip Boolean

使用固定路径下的配置文件时,该标志指定配置文件是否是zip格式

callback Function

初始化后执行的函数

Return:

Promise

public isControlHasPermission(control: Object): Boolean source

控件是否有权限

Params:

NameTypeAttributeDescription
control Object

控件对象

Return:

Boolean

public isControlsCustom(): Boolean source

是否自定义所有控件

Return:

Boolean

public isGoogleScale(): Boolean source

是否为google比例尺

Return:

Boolean

public isHasControl(controlType: String): Boolean source

是否含有控件

Params:

NameTypeAttributeDescription
controlType String

控件类型,如:"zoom","tree"

Return:

Boolean

public isHideTreeLabel(): Bool source

是否隐藏Tree Label

Return:

Bool

public isLayerDynamic(layer: Object): Boolean source

图层是否是动态图层

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

Boolean

public isLayerGroup(layer: Object): Boolean source

是否为复合图层

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

Boolean

public isLayerHasPermission(layer: Object): Boolean source

图层是否有权限

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

Boolean

public isLayerHistory(layer: Object): Boolean source

图层是否为历史回放图层

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

Boolean

public isLayerMask(layer: Object): Boolean source

图层是否为遮罩图层

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

Boolean

public isLayerMini(layer: Object): Boolean source

图层是否为迷你图图层

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

Boolean

public isLayerUse(layer: Object): Boolean source

图层是否在图层树里被使用

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

Boolean

public isLayerVisible(layer: Object): Boolean source

图层是否默认选中

Params:

NameTypeAttributeDescription
layer Object

图层对象

Return:

Boolean

public isMapBuilder(): * source

Return:

*

public language(): string source

获取使用的语言

Return:

string

public layers(isIncludeUnuse: Boolean): Array source

获取图层列表

Params:

NameTypeAttributeDescription
isIncludeUnuse Boolean

是否包含不使用的图层.

Return:

Array

public legendLabelMode(): Number source

获取图例标签的模式

Return:

Number

public maskLayers(): Array source

获取遮罩图层列表

Return:

Array

public miniLayers(): Array source

获取迷你图的图层列表

Return:

Array

public originSources(): * source

Return:

*

public permission(value: String[]): String[] source

设置或获取权限,如果不传参数则为获取

Params:

NameTypeAttributeDescription
value String[]

希望设置的权限值

Return:

String[]

public resolutions(): Array source

获取分辨率,meter / pixel

Return:

Array

public scaleIDToIndex(id: Number): Number source

转换比例尺ID到比例尺索引。

Params:

NameTypeAttributeDescription
id Number

比例尺ID

Return:

Number

public scaleIndexToID(index: Number): Number source

转换比例尺索引到比例尺ID。

Params:

NameTypeAttributeDescription
index Number

比例尺索引

Return:

Number

public scales(): Array source

获取比例尺列表

Return:

Array

public setDrawOption(option: Object): Null source

设置Draw控件的参数

Params:

NameTypeAttributeDescription
option Object

设置选项

option.importMaxFeatureCount Number

一次最大导入的要素数量

option.dataFormatList Array

使用的数据模式列表,如:['G', 'S', 'D', 'T', 'E']

option.importTxtFunction function(file: Object): null

“txt”模式下导入按钮被点击时调用的函数

option.exportTxtFunction function(): null

“txt”模式下导出按钮被点击时调用的函数

option.importExcelFunction function(file: Object): null

“excel”模式下导入按钮被点击时调用的函数

option.exportExcelFunction function(): null

“excel”模式下导出按钮被点击时调用的函数

option.importDwgDxfFunction function(file: Object): null

“dwg,dxf”模式下导入按钮被点击时调用的函数

option.exportDwgDxfFunction function(): null

“dwg,dxf”模式下导出按钮被点击时调用的函数

option.isFeatureCenterFullscreen Boolean

调用元素居中时是否全屏显示,默认为false,居中时以屏幕上半部分为范围

option.drawDefaultColor String

绘制时默认使用的颜色,默认是‘#3388ff’

Return:

Null

public setLayerOpacity(layer: Object, opacity: Number): Null source

设置图层的透明度

Params:

NameTypeAttributeDescription
layer Object

图层对象

opacity Number

图层透明度, 0~1

Return:

Null

public setRubberBandOption(option: Object): Null source

设置橡皮框控件的选项

Params:

NameTypeAttributeDescription
option Object

设置选项

option.rubberBandFunction function(): null

橡皮框控件选定范围后调用的函数

Return:

Null

public setSources(sources: Array): Array source

设置数据源数组

Params:

NameTypeAttributeDescription
sources Array

data source array

Return:

Array

public sources(): Array source

获取数据源列表

Return:

Array

public themeName(): String source

获取主题名称

Return:

String

public treeIcon(): String source

获取图层树的图标

Return:

String

public treeLabel(): String source

获取图层树的标题

Return:

String