Layer

java.lang.Object
- com.supermap.mapping.Layer

直接已知子类:

LayerGridAggregation, LayerGroup, LayerHeatmap
```
public class Layer
extends java.lang.Object
```
图层类。

该类的实例不可被创建，只可以通过在 Layers 类中的 add() 方法来创建。

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`LayerSetting`	`getAdditionalSetting()` 返回普通图层的风格设置。
`Layer`	`getByCaption(java.lang.String caption)` 获取指定别名的图层
`java.lang.String`	`getCaption()` 返回图层的标题。
`Dataset`	`getDataset()` 返回此图层对应的数据集对象。
`int`	`getDeduplicateThreshold()` 获取抽稀阈值，单位为点个数
`double`	`getDeduplicateTolerance()` 获取抽稀容限，单位为像素
`java.lang.String`	`getDescription()` 返回此图层的描述信息。
`QueryParameter`	`getDisplayFilter()` 返回图层显示过滤条件。
`boolean`	`getIsSwipe()` 获取图层是否使用卷帘效果
`LayerSettingVectorCache`	`getLayerSettingVectorCache()` 获取矢量图层设置风格
`double`	`getMaxVisibleScale()` 返回此图层的最大可见比例尺。
`double`	`getMinVisibleGeometrySize()` 返回几何对象的最小显示大小，以几何对象Bounds宽、高的最大值为准
`double`	`getMinVisibleScale()` 返回此图层的最小可见比例尺。
`java.lang.String`	`getName()` 返回图层的名称。
`LayerGroup`	`getParentGroup()` 获取图层所属的分组图层
`Selection`	`getSelection()` 返回此图层中的选择集对象。
`double`	`getSymbolScale()` 返回符号显示比例的大小。
`Theme`	`getTheme()` 获取专题图层的专题图对象。
`Theme`	`GetTheme()` 已过时。
`java.lang.String`	`getTimeEndField()` 启用时间的时态数据必须具有时间属性，用来表达数据观测的时间或者观测的起始和终止时间，该接口用来返回记录终止时间的字段
`java.util.Date`	`getTimeFilterEnding()` 返回图层时间过滤条件的终止时间值
`java.util.Date`	`getTimeFilterStarting()` 返回图层时间过滤条件的起始时间值
`java.lang.String`	`getTimeStartField()` 启用时间的时态数据必须具有时间属性，用来表达数据观测的时间或者观测的起始和终止时间，该接口用来返回记录起始时间的字段
`TimeSpan`	`getTimeStepInterval()` 返回时态数据的时间步长间隔
`Selection`	`hitTest(Point2D pt, double tolerance)` 返回选中的对象的集合。
`Selection`	`hitTestEx(Point pt, int tolerance)` 返回选中的对象的集合。
`java.lang.Boolean`	`isDeduplicateEnabled()` 获取是否抽稀
`boolean`	`isDisposed()` 返回对象是否已被释放。
`boolean`	`isEditable()` 返回图层是否处于可编辑状态。
`java.lang.Boolean`	`isFastDrawEnabled()` 获取是否快速绘制模式，默认为否，该种模式用于大数据量图层浏览缩放，小数据量和编辑地图不建议使用这种模式
`boolean`	`isSelectable()` 返回图层中对象是否可以选择。
`boolean`	`isSnapable()` 获取图层是否可捕捉。
`boolean`	`isSymbolScalable()` 返回图层的符号大小是否随图缩放。
`boolean`	`IsTimeFilterEnable()` 返回是否启用该图层的时间过滤显示功能，true表示启用，相关时间设置才有效。
`boolean`	`isVisible()` 返回此图层是否可见。
`boolean`	`isVisibleScale(double dScale)` 返回指定的比例尺是否为可视比例尺，即在设定的最小显示比例尺和最大显示比例尺之间。
`void`	`removeCache()` 清除当前显示缓存,重新刷新
`void`	`setAdditionalSetting(LayerSetting layerSetting)` 设置普通图层的风格。
`void`	`setCaption(java.lang.String value)` 设置图层的标题。
`void`	`setDataset(Dataset dataset)` 设置图层关联的数据集。
`void`	`setDeduplicateEnabled(java.lang.Boolean value)` 设置是否抽稀
`void`	`setDeduplicateThreshold(int value)` 设置抽稀阈值，单位为点个数
`void`	`setDeduplicateTolerance(double value)` 设置抽稀容限，单位为像素
`void`	`setDescription(java.lang.String value)` 设置此图层的描述信息。
`void`	`setDisplayFilter(QueryParameter queryParameter)` 设置图层显示过滤条件。
`void`	`setEditable(boolean value)` 设置图层是否处于可编辑状态。
`void`	`setFastDrawDataModefied(boolean isModefied)` 快速绘制模式下数据变更，调用此接口刷新图层数据，非快速绘制模式下调用无效
`void`	`setFastDrawEnabled(java.lang.Boolean value)` 设置是否快速绘制模式，默认为否，该种模式用于大数据量图层浏览缩放，小数据量和编辑地图不建议使用这种模式
`void`	`setIsSwipe(boolean bSwipe)` 设置图层是否使用卷帘效果
`void`	`setMaxVisibleScale(double value)` 设置此图层的最大可见比例尺。
`void`	`setMinVisibleGeometrySize(double value)` 设置几何对象的最小显示大小，以几何对象Bounds宽、高的最大值为准
`void`	`setMinVisibleScale(double value)` 设置此图层的最小可见比例尺。
`void`	`setOpaqueRate(int value)` 设置图层不透明度。
`void`	`setSelectable(boolean value)` 设置图层中对象是否可以选择。
`void`	`setSnapable(boolean value)` 设置图层是否可捕捉。
`void`	`setSymbolScalable(boolean value)` 设置图层的符号大小是否随图缩放。
`void`	`setSymbolScale(double value)` 返回符号显示比例的大小。
`void`	`setTimeEndField(java.lang.String strField)` 启用时间的时态数据必须具有时间属性，用来表达数据观测的时间或者观测的起始和终止时间，该接口用来设置记录终止时间的字段
`void`	`setTimeFilterEnable(boolean bEnable)` 设置是否启用该图层的时间过滤显示功能，true表示启用，相关时间设置才有效。
`void`	`setTimeFilterEnding(java.util.Date endTime)` 设置图层时间过滤条件的终止时间值
`void`	`setTimeFilterStarting(java.util.Date startTime)` 设置图层时间过滤条件的起始时间值
`void`	`setTimeStartField(java.lang.String strField)` 启用时间的时态数据必须具有时间属性，用来表达数据观测的时间或者观测的起始和终止时间，该接口用来设置记录起始时间的字段。
`void`	`setTimeStepInterval(TimeSpan timeSpan)` 设置时态数据的时间步长间隔
`void`	`setVisible(boolean value)` 设置此图层是否可见。
`java.lang.String`	`toXML()` 转XML

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getName
```
public java.lang.String getName()
```
    返回图层的名称。图层的名称在图层所在的地图中唯一标识此图层。该标识不区分大小写。
    
    返回:
    
    图层的名称。
  - toXML
```
public java.lang.String toXML()
```
    转XML
    
    返回:
    
    String
  - getCaption
```
public java.lang.String getCaption()
```
    返回图层的标题。图层的标题为图层的显示名称，例如在图例或排版制图时显示的图层的名称即为图层的标题。注意与图层的名称相区别。
    
    返回:
    
    图层的标题。
  - setCaption
```
public void setCaption(java.lang.String value)
```
    设置图层的标题。图层的标题为图层的显示名称，例如在图例或排版制图时显示的图层的名称即为图层的标题。注意与图层的名称相区别。
    
    参数:
    
    value - 指定图层的标题。
  - getDescription
```
public java.lang.String getDescription()
```
    返回此图层的描述信息。
    
    返回:
    
    此图层的描述信息。
    
    默认值:
    
    默认值为一个空字符串。
  - setDescription
```
public void setDescription(java.lang.String value)
```
    设置此图层的描述信息。
    
    参数:
    
    value - 指定图层的描述信息。
  - getDataset
```
public Dataset getDataset()
```
    返回此图层对应的数据集对象。图层是对数据集的引用，因而，一个图层与一个数据集相对应。
    
    返回:
    
    此图层对应的数据集对象。
  - GetTheme
```
@Deprecated
public Theme GetTheme()
```
    已过时。
    
    获取专题图层的专题图对象。
    
    返回:
    
    Theme 此图层对应的专题图对象。
  - getTheme
```
public Theme getTheme()
```
    获取专题图层的专题图对象。
    
    返回:
    
    Theme 此图层对应的专题图对象。
  - getSelection
```
public Selection getSelection()
```
    返回此图层中的选择集对象。选择集是个集合，其中包含选择的图层中的一个或多个要素。在选择集中的要素才可以被编辑。注意选择集只适用于矢量数据集，栅格数据集和影像数据集没有选择集。
    
    返回:
    
    此图层中的选择集对象。
  - isSelectable
```
public boolean isSelectable()
```
    返回图层中对象是否可以选择。
    当需要对图层进行一些选择或查询时，需要将图层设置为可选择。当图层为可选择状态时，可以选择感兴趣的要素，查询其相关属性及统计信息等。
    
    返回:
    
    一个布尔值，指示图层中对象是否可以选择，true 表示此图层中的对象可被选择，false 表示此图层中对象不可选。
    
    默认值:
    
    默认值为 true，即图层中的对象可以选择。
  - setSelectable
```
public void setSelectable(boolean value)
```
    设置图层中对象是否可以选择。
    true 表示此图层中的对象可被选择，false 表示此图层中对象不可选。当需要对图层进行一些选择或查询时，需要将图层设置为可选择。当图层为可选择状态时，你可以选择感兴趣的要素，查询其相关属性及统计信息等。
    
    参数:
    
    value - 指定图层中对象是否可以选择。
  - isEditable
```
public boolean isEditable()
```
    返回图层是否处于可编辑状态。该方法控制是否对图层所引用的数据进行修改。
    当图层为可编辑时，意味着可以对图层所引用的数据进行修改和编辑，通过图层，可以对数据进行可视化的编辑。当你只希望对图层所引用的数据进行渲染或相关分析操作而不希望影响原数据时，建议将图层设置为不可编辑，以免不经意的操作修改了数据。
    
    返回:
    
    图层是可编辑状态，返回true；否则返回false。
  - setEditable
```
public void setEditable(boolean value)
```
    设置图层是否处于可编辑状态。该方法控制是否对图层所引用的数据进行修改。
    当图层为可编辑时，意味着可以对图层所引用的数据进行修改和编辑，通过图层，可以对数据进行可视化的编辑。当你只希望对图层所引用的数据进行渲染或相关分析操作而不希望影响原数据时，建议将图层设置为不可编辑，以免不经意的操作修改了数据。
    
    参数:
    
    value - 图层是否处于可编辑状态。
  - isSymbolScalable
```
public boolean isSymbolScalable()
```
    返回图层的符号大小是否随图缩放。
    
    返回:
    
    一个布尔值，指示图层的符号大小是否随图缩放，true,表示图层的符号大小随图缩放，false,表示不随图缩放。
    
    默认值:
    
    默认值为 false,即图层的符号大小不可随图缩放。
  - setSymbolScalable
```
public void setSymbolScalable(boolean value)
```
    设置图层的符号大小是否随图缩放。
    
    参数:
    
    value - 指定图层的符号大小是否随图缩放。
  - isVisible
```
public boolean isVisible()
```
    返回此图层是否可见。true 表示此图层可见，false 表示图层不可见。当图层不可见时，其他所有的属性的设置将无效。
    
    返回:
    
    图层是否可见。
    
    默认值:
    
    默认值为 true。即图层可见。
  - setVisible
```
public void setVisible(boolean value)
```
    设置此图层是否可见。true 表示此图层可见，false 表示图层不可见。当图层不可见时，其他所有的属性的设置将无效。
    
    参数:
    
    value - 指定图层是否可见。
  - getAdditionalSetting
```
public LayerSetting getAdditionalSetting()
```
    返回普通图层的风格设置。LayerSettingVector 类用来对矢量数据图层风格进行设置和修改。
    
    返回:
    
    普通图层的风格设置。
  - getMaxVisibleScale
```
public double getMaxVisibleScale()
```
    返回此图层的最大可见比例尺。最大可见比例尺不可为负，当地图的当前显示比例尺大于或等于图层最大可见比例尺时，此图层将不显示。
    
    返回:
    
    图层的最大可见比例尺。
    
    默认值:
    
    默认值为 0。
  - setMaxVisibleScale
```
public void setMaxVisibleScale(double value)
```
    设置此图层的最大可见比例尺。最大可见比例尺不可为负，当地图的当前显示比例尺大于或等于图层最大可见比例尺时，此图层将不显示。
    
    参数:
    
    value - 指定图层的最大可见比例尺。
  - getMinVisibleScale
```
public double getMinVisibleScale()
```
    返回此图层的最小可见比例尺。最小可见比例尺不可为负。当地图的当前显示比例尺小于图层最小可见比例尺时，此图层将不显示。
    
    返回:
    
    图层的最小可见比例尺。
    
    默认值:
    
    默认值为 0。
  - setAdditionalSetting
```
public void setAdditionalSetting(LayerSetting layerSetting)
```
    设置普通图层的风格。普通图层风格的设置对矢量数据图层、栅格数据图层以及影像数据图层是不相同的。LayerSettingVector类用来对矢量数据图层的风格进行设置和修改。
    
    参数:
    
    layerSetting - 普通图层的风格设置。
  - setMinVisibleScale
```
public void setMinVisibleScale(double value)
```
    设置此图层的最小可见比例尺。最小可见比例尺不可为负。当地图的当前显示比例尺小于图层最小可见比例尺时，此图层将不显示。
    
    参数:
    
    value - 指定图层的最小可见比例尺。
  - getDisplayFilter
```
public QueryParameter getDisplayFilter()
```
    返回图层显示过滤条件。
    
    返回:
    
    QueryParameter 图层显示过滤条件。
  - setDisplayFilter
```
public void setDisplayFilter(QueryParameter queryParameter)
```
    设置图层显示过滤条件。
    
    参数:
    
    queryParameter - 图层显示过滤条件。
  - hitTest
```
public Selection hitTest(Point2D pt,
                         double tolerance)
```
    返回选中的对象的集合。若指定的点与对象上最近点的距离在指定容限范围的范围内，则该对象被选中。如果地图上有多个重叠的对象都满足条件，则都被选中，并返回多个对象。
    
    参数:
    
    pt - 要测试的点，为地理坐标点。
    
    tolerance - 指定的容限，为地理长度。
    
    返回:
    
    被选中的对象的集合。
  - hitTestEx
```
public Selection hitTestEx(Point pt,
                           int tolerance)
```
    返回选中的对象的集合。若指定的点与对象上最近点的距离在指定容限范围的范围内，则该对象被选中。如果地图上有多个重叠的对象都满足条件，则都被选中，并返回多个对象。
    
    参数:
    
    pt - 要测试的点，为屏幕上点。
    
    tolerance - 指定的容限，为屏幕坐标点。
    
    返回:
    
    被选中的对象的集合。
  - isVisibleScale
```
public boolean isVisibleScale(double dScale)
```
    返回指定的比例尺是否为可视比例尺，即在设定的最小显示比例尺和最大显示比例尺之间。
    
    参数:
    
    dScale - 指定的显示比例尺。
    
    返回:
    
    指定的比例尺为可视比例尺则返回true；否则为 false。
  - isDisposed
```
public boolean isDisposed()
```
    返回对象是否已被释放。若为 true时，操作该类的其他方法，都会抛出异常，意味着对象已被释放。
    
    返回:
    
    对象已经被释放，返回 true；否则返回 false。
  - getParentGroup
```
public LayerGroup getParentGroup()
```
    获取图层所属的分组图层
    
    返回:
    
    对象所属的分组图层
  - setDataset
```
public void setDataset(Dataset dataset)
```
    设置图层关联的数据集。设置的数据集必须与当前地图属于同一工作空间，且数据集类型与原有数据集类型一致，否则会抛出异常。
    
    参数:
    
    dataset - 图层关联的数据集
  - setOpaqueRate
```
public void setOpaqueRate(int value)
```
    设置图层不透明度。
    
    参数:
    
    value - 不透明度，取值为0-100。
  - removeCache
```
public void removeCache()
```
    清除当前显示缓存,重新刷新
  - isSnapable
```
public boolean isSnapable()
```
    获取图层是否可捕捉。
    
    返回:
    
    boolean 返回图层是否可捕捉，true 表示该图层可捕捉，false 表示该图层不可捕捉。
  - setSnapable
```
public void setSnapable(boolean value)
```
    设置图层是否可捕捉。
    
    参数:
    
    value - 图层是否可捕捉，true 表示该图层可捕捉，false 表示该图层不可捕捉。
  - getMinVisibleGeometrySize
```
public double getMinVisibleGeometrySize()
```
    返回几何对象的最小显示大小，以几何对象Bounds宽、高的最大值为准
    
    返回:
    
    double 最小显示大小
  - setMinVisibleGeometrySize
```
public void setMinVisibleGeometrySize(double value)
```
    设置几何对象的最小显示大小，以几何对象Bounds宽、高的最大值为准
    
    参数:
    
    value - 最小显示大小
  - getByCaption
```
public Layer getByCaption(java.lang.String caption)
```
    获取指定别名的图层
    
    参数:
    
    caption - 图层别名
    
    返回:
    
    指定别名的图层
  - setIsSwipe
```
public void setIsSwipe(boolean bSwipe)
```
    设置图层是否使用卷帘效果
    
    参数:
    
    bSwipe - 是否使用卷帘效果，默认为false
  - getIsSwipe
```
public boolean getIsSwipe()
```
    获取图层是否使用卷帘效果
    
    返回:
    
    是否使用卷帘效果
  - getLayerSettingVectorCache
```
public LayerSettingVectorCache getLayerSettingVectorCache()
```
    获取矢量图层设置风格
    
    返回:
    
    获取矢量图层设置风格
  - getSymbolScale
```
public double getSymbolScale()
```
    返回符号显示比例的大小。如果符号大小不随着地图的缩放而缩放（SymbolScalable ＝ False），符号的大小按 Style.symbolsize 大小显示；如果符号随着地图的缩放而缩放（SymbolScalable ＝ True），则符号的大小和图层的显示比例有关系，一般设置为和图层的显示比例相等。
    
    返回:
    
    double
  - setSymbolScale
```
public void setSymbolScale(double value)
```
    返回符号显示比例的大小。如果符号大小不随着地图的缩放而缩放（SymbolScalable ＝ False），符号的大小按 Style.symbolsize 大小显示；如果符号随着地图的缩放而缩放（SymbolScalable ＝ True），则符号的大小和图层的显示比例有关系，一般设置为和图层的显示比例相等。
    
    参数:
    
    value - 符号大小是否随着地图的缩放而缩放
  - IsTimeFilterEnable
```
public boolean IsTimeFilterEnable()
```
    返回是否启用该图层的时间过滤显示功能，true表示启用，相关时间设置才有效。默认值为false，表示不启用
    
    参数:
    
    -
  - setTimeFilterEnable
```
public void setTimeFilterEnable(boolean bEnable)
```
    设置是否启用该图层的时间过滤显示功能，true表示启用，相关时间设置才有效。默认值为false，表示不启用。
    
    参数:
    
    -
  - getTimeStartField
```
public java.lang.String getTimeStartField()
```
    启用时间的时态数据必须具有时间属性，用来表达数据观测的时间或者观测的起始和终止时间，该接口用来返回记录起始时间的字段
    
    参数:
    
    -
  - setTimeStartField
```
public void setTimeStartField(java.lang.String strField)
```
    启用时间的时态数据必须具有时间属性，用来表达数据观测的时间或者观测的起始和终止时间，该接口用来设置记录起始时间的字段。
    
    参数:
    
    -
  - getTimeEndField
```
public java.lang.String getTimeEndField()
```
    启用时间的时态数据必须具有时间属性，用来表达数据观测的时间或者观测的起始和终止时间，该接口用来返回记录终止时间的字段
    
    参数:
    
    -
  - setTimeEndField
```
public void setTimeEndField(java.lang.String strField)
```
    启用时间的时态数据必须具有时间属性，用来表达数据观测的时间或者观测的起始和终止时间，该接口用来设置记录终止时间的字段
    
    参数:
    
    -
  - getTimeFilterStarting
```
public java.util.Date getTimeFilterStarting()
```
    返回图层时间过滤条件的起始时间值
    
    参数:
    
    -
  - setTimeFilterStarting
```
public void setTimeFilterStarting(java.util.Date startTime)
```
    设置图层时间过滤条件的起始时间值
    
    参数:
    
    -
  - getTimeFilterEnding
```
public java.util.Date getTimeFilterEnding()
```
    返回图层时间过滤条件的终止时间值
    
    参数:
    
    -
  - setTimeFilterEnding
```
public void setTimeFilterEnding(java.util.Date endTime)
```
    设置图层时间过滤条件的终止时间值
    
    参数:
    
    -
  - getTimeStepInterval
```
public TimeSpan getTimeStepInterval()
```
    返回时态数据的时间步长间隔
    
    参数:
    
    -
  - setTimeStepInterval
```
public void setTimeStepInterval(TimeSpan timeSpan)
```
    设置时态数据的时间步长间隔
    
    参数:
    
    -
  - setDeduplicateEnabled
```
public void setDeduplicateEnabled(java.lang.Boolean value)
```
    设置是否抽稀
    
    参数:
    
    value - 是否抽稀
  - isDeduplicateEnabled
```
public java.lang.Boolean isDeduplicateEnabled()
```
    获取是否抽稀
    
    返回:
    
    是否抽稀
  - setFastDrawEnabled
```
public void setFastDrawEnabled(java.lang.Boolean value)
```
    设置是否快速绘制模式，默认为否，该种模式用于大数据量图层浏览缩放，小数据量和编辑地图不建议使用这种模式
    
    参数:
    
    value - 是否快速绘制模式
  - isFastDrawEnabled
```
public java.lang.Boolean isFastDrawEnabled()
```
    获取是否快速绘制模式，默认为否，该种模式用于大数据量图层浏览缩放，小数据量和编辑地图不建议使用这种模式
    
    返回:
    
    是否快速绘制模式
  - setFastDrawDataModefied
```
public void setFastDrawDataModefied(boolean isModefied)
```
    快速绘制模式下数据变更，调用此接口刷新图层数据，非快速绘制模式下调用无效
    
    参数:
    
    isModefied - 数据是否变更
  - setDeduplicateTolerance
```
public void setDeduplicateTolerance(double value)
```
    设置抽稀容限，单位为像素
    
    参数:
    
    value - 抽稀容限
  - getDeduplicateTolerance
```
public double getDeduplicateTolerance()
```
    获取抽稀容限，单位为像素
    
    返回:
    
    抽稀容限
  - setDeduplicateThreshold
```
public void setDeduplicateThreshold(int value)
```
    设置抽稀阈值，单位为点个数
    
    参数:
    
    value - 点个数
  - getDeduplicateThreshold
```
public int getDeduplicateThreshold()
```
    获取抽稀阈值，单位为点个数
    
    返回:
    
    点个数

类 Layer

方法概要

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

方法详细资料

getName

toXML

getCaption

setCaption

getDescription

setDescription

getDataset

GetTheme

getTheme

getSelection

isSelectable

setSelectable

isEditable

setEditable

isSymbolScalable

setSymbolScalable

isVisible

setVisible

getAdditionalSetting

getMaxVisibleScale

setMaxVisibleScale

getMinVisibleScale

setAdditionalSetting

setMinVisibleScale

getDisplayFilter

setDisplayFilter

hitTest

hitTestEx

isVisibleScale

isDisposed

getParentGroup

setDataset

setOpaqueRate

removeCache

isSnapable

setSnapable

getMinVisibleGeometrySize

setMinVisibleGeometrySize

getByCaption

setIsSwipe

getIsSwipe

getLayerSettingVectorCache

getSymbolScale

setSymbolScale

IsTimeFilterEnable

setTimeFilterEnable

getTimeStartField

setTimeStartField

getTimeEndField

setTimeEndField

getTimeFilterStarting

setTimeFilterStarting

getTimeFilterEnding

setTimeFilterEnding

getTimeStepInterval

setTimeStepInterval

setDeduplicateEnabled

isDeduplicateEnabled

setFastDrawEnabled

isFastDrawEnabled

setFastDrawDataModefied

setDeduplicateTolerance

getDeduplicateTolerance

setDeduplicateThreshold

getDeduplicateThreshold