MapParameter

java.lang.Object
- com.supermap.services.components.commontypes.MapParameter

所有已实现的接口:

java.io.Serializable
```
public class MapParameter
extends java.lang.Object
implements java.io.Serializable
```
地图参数。

该类描述了地图的所有的特征信息。例如：地图的名称 name、地图的比例尺 mapScale、地图的图幅范围 bounds 等等。

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`double`	`angle` 当前地图的旋转角度。
`boolean`	`antialias` 是否反走样地图。
`boolean`	`autoAvoidEffectEnabled` 是否启用自动避让效果。
`Style`	`backgroundStyle` 地图的背景风格。
`Rectangle2D`	`bounds` 地图的全幅范围。
`boolean`	`cacheEnabled` 是否使用缓存。
`Point2D`	`center` 地图二维中心点坐标。
`ChartSetting`	`chartSetting` 海图地图的出图参数配置
`Geometry`	`clipRegion` 地图显示裁剪的区域。
`boolean`	`clipRegionEnabled` 地图显示裁剪区域是否有效。
`MapColorMode`	`colorMode` 地图的颜色模式。
`Unit`	`coordUnit` 地图的坐标单位。
`Rectangle2D`	`customEntireBounds` 自定义的地图全幅显示范围。
`boolean`	`customEntireBoundsEnabled` 自定义的地图全幅显示范围是否有效。
`java.lang.String`	`customParams` 用户自定义参数。
`PrjCoordSysType`	`customPrjCoordSysType` 存储用户设置的坐标投影类型
`java.lang.String`	`description` 当前地图的描述信息。
`Unit`	`distanceUnit` 地图的距离量度单位。
`double`	`dpi` dpi参数如果不设置，默认值使用96
`boolean`	`dynamicProjection` 是否允许地图动态投影显示。
`java.util.List<Layer>`	`layers` 地图中所有图层列表。
`boolean`	`markerAngleFixed` 指定点状符号的角度是否固定。
`double`	`maxScale` 地图的最大显示比例尺。
`double`	`maxVisibleTextSize` 文本的最大可见尺寸，单位为毫米。
`int`	`maxVisibleVertex` 最大几何对象可见节点数，如果几何对象的节点数超过指定的个数，则该几何对象不显示。
`double`	`minScale` 地图的最小显示比例尺。
`double`	`minVisibleTextSize` 文本的最小可见尺寸，单位为毫米。
`java.lang.String`	`name` 目标地图名称。
`boolean`	`overlapDisplayed` 地图对象在同一范围内时，是否重叠显示，默认为False。
`OverlapDisplayedOptions`	`overlapDisplayedOptions` 地图的压盖过滤显示选项，当 `overlapDisplayed` 为 false 时有效。
`boolean`	`paintBackground` 是否绘制地图背景。
`PrjCoordSys`	`prjCoordSys` 地图坐标系统（投影系统）。
`RasterFunctionParameter`	`rasterfunction` 栅格函数参数类（地图代数运算）。
`RectifyType`	`rectifyType` 校验方式。
`boolean`	`returnImage` 地图图片是否立即返回，即是否要求 GIS 服务器生成图片。
`ReturnType`	`returnType` 图片返回类型。
`double`	`scale` 地图的显示比例尺。
`boolean`	`textAngleFixed` 文本角度是否固定。
`boolean`	`textOrientationFixed` 文本朝向是否固定。
`java.lang.String`	`tileversion`
`TrackingLayer`	`trackingLayer` 跟踪图层。
`UserInfo`	`userToken` 用户信息。
`Rectangle2D`	`viewBounds` 视窗（`viewer`，地图图片范围）对应的地图范围。
`Rectangle`	`viewer` 视窗。
`double[]`	`visibleScales` 返回地图的可见比例尺数组。
`boolean`	`visibleScalesEnabled` 返回是否使用固定比例尺来显示地图。

构造器概要

构造器
构造器和说明
`MapParameter()` 默认构造函数。
`MapParameter(MapParameter mapParameter)` 根据一个已有的 MapParameter 对象构造一个新的 MapParameter 对象。
`MapParameter(java.lang.String mapName)`

方法概要

方法
限定符和类型	方法和说明
`boolean`	`compareLayerQueryable(java.util.List<Layer> targetLayers)` 比较图层的可查询性是否一致。
`boolean`	`compareLayerVisible(java.util.List<Layer> targetLayers)` 比较图层的可见性是否一致。
`boolean`	`equals(java.lang.Object obj)` 判断一个对象与当前 MapParam 对象是否相等。
`int`	`getMapStatusHashCode()`
`int`	`hashCode()` 生成哈希码。
`void`	`rectify(MapParameter referMapParam)` 调整中心点、比例尺、viewBounds 与 viewer 相一致。
`void`	`rectify(MapParameter referMapParam, RectifyType rectifyType)` 调整中心点、比例尺、viewBounds 以及 viewer，使互相保持一致。
`void`	`standardize(MapParameter standardMapParam)` 规范化 MapParam 对象，如果残缺就补齐必须的参数，确保各项属性非空。
`int`	`toMapStatusHashCode()` 生成地图状态相关参数的哈希码,不包括中心点，视窗范围。
`java.lang.String`	`toString()`
`java.lang.String`	`toStringSimple()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - minScale
```
public double minScale
```
    地图的最小显示比例尺。
    
    该值为0时，表示没有比例尺显示限制。
  - scale
```
public double scale
```
    地图的显示比例尺。
  - maxScale
```
public double maxScale
```
    地图的最大显示比例尺。
    
    该值为0时，表示没有比例尺显示限制。
  - name
```
public java.lang.String name
```
    目标地图名称。
  - center
```
public Point2D center
```
    地图二维中心点坐标。
  - viewBounds
```
public Rectangle2D viewBounds
```
    视窗（viewer，地图图片范围）对应的地图范围。
    
    单位是地理坐标。
  - returnType
```
public ReturnType returnType
```
    图片返回类型。
    
    图片可以以二进制、文件路径、URL路径等形式返回。当returnImage为true时有效。
  - bounds
```
public Rectangle2D bounds
```
    地图的全幅范围。
    
    单位是地理坐标。
  - viewer
```
public Rectangle viewer
```
    视窗。也可称为地图图片范围（像素坐标）。
    
    在请求地图图片的时候，会请求需要多大的图片（像素坐标，比如 512*512），即视窗的范围。
  - returnImage
```
public boolean returnImage
```
    地图图片是否立即返回，即是否要求 GIS 服务器生成图片。
  - layers
```
public java.util.List<Layer> layers
```
    地图中所有图层列表。
  - trackingLayer
```
public TrackingLayer trackingLayer
```
    跟踪图层。
    
    跟踪图层是一个空白的透明图层，总是在地图各图层的最上层，用于在一个处理或分析过程中，临时存放一些图形对象，以及一些文本等，目前主要用来存放高亮的信息，因此也可称跟踪图层为高亮图层。
  - prjCoordSys
```
public PrjCoordSys prjCoordSys
```
    地图坐标系统（投影系统）。
    
    在地理信息系统中，地图投影是一个很重要的概念，是地理数据表达基础。由于各个国家、各个区域所采用的地图投影系统不同，会造成在地理信息分析过程中的难度和差异，这就要求将不同的地图投影转换成为地理信息系统分析所需要的统一的投影坐标系下。
    
    一般来说，国内最常用的两种投影方式为高斯-克吕格投影和墨卡托投影。
  - customPrjCoordSysType
```
public PrjCoordSysType customPrjCoordSysType
```
    存储用户设置的坐标投影类型
  - cacheEnabled
```
public boolean cacheEnabled
```
    是否使用缓存。
  - customParams
```
public java.lang.String customParams
```
    用户自定义参数。
    
    可以是任何形式组织的字符串。用户可以通过该属性向自定义的接口传入自定义的参数。
  - userToken
```
public UserInfo userToken
```
    用户信息。
  - rectifyType
```
public RectifyType rectifyType
```
    校验方式。
  - clipRegion
```
public Geometry clipRegion
```
    地图显示裁剪的区域。
  - clipRegionEnabled
```
public boolean clipRegionEnabled
```
    地图显示裁剪区域是否有效。
  - customEntireBounds
```
public Rectangle2D customEntireBounds
```
    自定义的地图全幅显示范围。
    
    当 customEntireBoundsEnabled 属性值为 true 时，Map 组件中的 viewEntire() 方法会使用该字段标识的范围来进行全幅显示。
  - customEntireBoundsEnabled
```
public boolean customEntireBoundsEnabled
```
    自定义的地图全幅显示范围是否有效。
    
    当该属性为 true 时，Map 组件中的 viewEntire() 方法会使用 customEntireBounds 字段所标识的范围来进行全幅显示。
  - angle
```
public double angle
```
    当前地图的旋转角度。
  - antialias
```
public boolean antialias
```
    是否反走样地图。
  - backgroundStyle
```
public Style backgroundStyle
```
    地图的背景风格。
  - colorMode
```
public MapColorMode colorMode
```
    地图的颜色模式。
  - coordUnit
```
public Unit coordUnit
```
    地图的坐标单位。
  - distanceUnit
```
public Unit distanceUnit
```
    地图的距离量度单位。
  - description
```
public java.lang.String description
```
    当前地图的描述信息。
  - dynamicProjection
```
public boolean dynamicProjection
```
    是否允许地图动态投影显示。
  - markerAngleFixed
```
public boolean markerAngleFixed
```
    指定点状符号的角度是否固定。
  - maxVisibleTextSize
```
public double maxVisibleTextSize
```
    文本的最大可见尺寸，单位为毫米。
    
    默认值为1000，即几何对象的尺寸超过1000毫米的时候将不被显示。
  - maxVisibleVertex
```
public int maxVisibleVertex
```
    最大几何对象可见节点数，如果几何对象的节点数超过指定的个数，则该几何对象不显示。
  - minVisibleTextSize
```
public double minVisibleTextSize
```
    文本的最小可见尺寸，单位为毫米。
    
    默认值为0.1。
  - overlapDisplayed
```
public boolean overlapDisplayed
```
    地图对象在同一范围内时，是否重叠显示，默认为False。
    
    如果为 True，则同一范围内的对象会直接压盖；如果为 False 则通过 overlapDisplayedOptions 控制对象不压盖显示。
  - overlapDisplayedOptions
```
public OverlapDisplayedOptions overlapDisplayedOptions
```
    地图的压盖过滤显示选项，当 overlapDisplayed 为 false 时有效。
    
    用来增强处理地图中各种对象的压盖显示。
  - paintBackground
```
public boolean paintBackground
```
    是否绘制地图背景。
  - textAngleFixed
```
public boolean textAngleFixed
```
    文本角度是否固定。
  - textOrientationFixed
```
public boolean textOrientationFixed
```
    文本朝向是否固定。
  - visibleScales
```
public double[] visibleScales
```
    返回地图的可见比例尺数组。
  - visibleScalesEnabled
```
public boolean visibleScalesEnabled
```
    返回是否使用固定比例尺来显示地图。
  - autoAvoidEffectEnabled
```
public boolean autoAvoidEffectEnabled
```
    是否启用自动避让效果。
  - tileversion
```
public java.lang.String tileversion
```
  - rasterfunction
```
public RasterFunctionParameter rasterfunction
```
    栅格函数参数类（地图代数运算）。
  - dpi
```
public double dpi
```
    dpi参数如果不设置，默认值使用96
  - chartSetting
```
public ChartSetting chartSetting
```
    海图地图的出图参数配置
- 构造器详细资料
  - MapParameter
```
public MapParameter()
```
    默认构造函数。
  - MapParameter
```
public MapParameter(java.lang.String mapName)
```
  - MapParameter
```
public MapParameter(MapParameter mapParameter)
```
    根据一个已有的 MapParameter 对象构造一个新的 MapParameter 对象。
    
    参数:
    
    mapParameter - 地图参数。
    
    抛出:
    
    IllegalArgumentException当地图参数为 Null 时抛出异常。
- 方法详细资料
  - hashCode
```
public int hashCode()
```
    生成哈希码。
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    返回:
    
    返回 int 类型的哈希码。
  - equals
```
public boolean equals(java.lang.Object obj)
```
    判断一个对象与当前 MapParam 对象是否相等。
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    参数:
    
    obj - 与当前 MapParam 对象进行比较的对象。
    
    返回:
    
    返回一个 boolean 类型的值，表达是否对比对象相等。
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - toStringSimple
```
public java.lang.String toStringSimple()
```
  - compareLayerQueryable
```
public boolean compareLayerQueryable(java.util.List<Layer> targetLayers)
```
    比较图层的可查询性是否一致。
    
    参数:
    
    targetLayers - 要比较的图层数组。
    
    返回:
    
    返回一个 boolean 类型的值，表达比较的图层的可查性是否一致。
  - compareLayerVisible
```
public boolean compareLayerVisible(java.util.List<Layer> targetLayers)
```
    比较图层的可见性是否一致。
    
    参数:
    
    targetLayers - 要比较的图层数组。
    
    返回:
    
    返回一个 boolean 类型的值，表达比较的图层的可见性是否一致。
  - standardize
```
public void standardize(MapParameter standardMapParam)
```
    规范化 MapParam 对象，如果残缺就补齐必须的参数，确保各项属性非空。
    
    参数:
    
    standardMapParam - 需要规范化的地图状态参数。
  - rectify
```
public void rectify(MapParameter referMapParam)
```
    调整中心点、比例尺、viewBounds 与 viewer 相一致。
    
    默认情况下，各个参数的优先级：Viewer > 比例尺 > 中心点 > viewBounds。
    
    由于是通过 referMapParam 来进行校验，所以 referMapParam 的值必须正确有效。
    
    该方法对 minScale、maxScale 和 mapScale 也进行了校验。
    
    暂不支持对不同坐标系的 MapParam 进行调整与校验。请在调用前对坐标系的差异进行处理。相当于调用 rectify(referMapParam, RectifyType.DEFAULT)。
    
    参数:
    
    referMapParam - 用来进行校验的参考 MapParameter 对象。通常为地图服务的默认 MapParameter。
  - rectify
```
public void rectify(MapParameter referMapParam,
           RectifyType rectifyType)
```
    调整中心点、比例尺、viewBounds 以及 viewer，使互相保持一致。
    
    默认情况下，各个参数的优先级：viewer > 比例尺 > 中心点 > viewBounds。
    
    由于是通过 referMapParam 来进行校验，所以 referMapParam 的值必须正确有效。
    
    该方法对 minScale、maxScale 和 mapScale 也进行了校验。
    
    外部调用必须保证 viewer 的正确合理性。
    
    根据 rectifyType 的设置进行相应调整。调整过程：
    
    1、默认首先调整中心点、比例尺和 viewBounds，如果中心点不存在，就根据 viewBounds 来得到中心点。
    
    2、如果比例尺存在，调整中心点和 viewBounds 相一致。否则就以 viewBounds 为准去调整中心点和比例尺。
    
    3、根据 viewer 来调整 viewBounds （调整长宽比相一致）。
    
    4、如果设置了 minScale 或 maxScale，则调整 mapScale 之后再进行一次 viewBounds 的调整。
    
    暂不支持对不同坐标系的 MapParameter 进行调整与校验。请在调用前对坐标系的差异进行处理。
    
    参数:
    
    referMapParam - 用来进行校验的参考 MapParameter 对象，通常为地图服务的默认 MapParameter。
    
    rectifyType - 校验方式。
    
    抛出:
    
    IllegalArgumentException当地图参数不合法，如地图比例尺<=0时抛出异常。
  - toMapStatusHashCode
```
public int toMapStatusHashCode()
```
    生成地图状态相关参数的哈希码,不包括中心点，视窗范围。
    
    返回:
  - getMapStatusHashCode
```
public int getMapStatusHashCode()
```

类 MapParameter

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

minScale

scale

maxScale

name

center

viewBounds

returnType

bounds

viewer

returnImage

layers

trackingLayer

prjCoordSys

customPrjCoordSysType

cacheEnabled

customParams

userToken

rectifyType

clipRegion

clipRegionEnabled

customEntireBounds

customEntireBoundsEnabled

angle

antialias

backgroundStyle

colorMode

coordUnit

distanceUnit

description

dynamicProjection

markerAngleFixed

maxVisibleTextSize

maxVisibleVertex

minVisibleTextSize

overlapDisplayed

overlapDisplayedOptions

paintBackground

textAngleFixed

textOrientationFixed

visibleScales

visibleScalesEnabled

autoAvoidEffectEnabled

tileversion

rasterfunction

dpi

chartSetting

构造器详细资料

MapParameter

MapParameter

MapParameter

方法详细资料

hashCode

equals

toString

toStringSimple

compareLayerQueryable

compareLayerVisible

standardize

rectify

rectify

toMapStatusHashCode

getMapStatusHashCode