所有类

概要:
嵌套 |
字段 |
构造器 |
方法

详细资料:
字段 |
构造器 |
方法

java.lang.Object
- com.supermap.mapping.Theme
- - com.supermap.mapping.ThemeGridRange

```
public class ThemeGridRange
extends Theme
```
栅格分段专题图
栅格分段专题图，是根据栅格数据集，将所有单元格的值按照某种分段方式分成多个范围段，值在同一个范围段中的单元格使用相同的颜色进行显示。栅格分段专题图一般用来反映连续分布现象的数量或程度特征。比如某年的全国降水量分布图，将各气象站点的观测值经过内插之后生成的栅格数据进行分段显示。该类类似于分段专题图类，不同点在于分段专题图的操作对象是矢量数据，而栅格分段专题图的操作对象是栅格数据

构造器概要

构造器
构造器和说明
`ThemeGridRange()` 默认构造函数，构造一个新的 ThemeGridRange 对象
`ThemeGridRange(ThemeGridRange themeGridRange)` 根据给定的 ThemeGridRange 对象构造一个与其结构完全相同的新对象

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`addToHead(ThemeGridRangeItem item)` 把一个栅格分段专题图子项添加到分段列表的开头
`boolean`	`addToHead(ThemeGridRangeItem item, boolean normalize)` 把一个栅格分段专题图子项添加到分段列表的开头
`boolean`	`addToTail(ThemeGridRangeItem item)` 把一个栅格分段专题图子项添加到分段列表的尾部
`boolean`	`addToTail(ThemeGridRangeItem item, boolean normalize)` 把一个栅格分段专题图子项添加到分段列表的尾部
`void`	`clear()` 删除栅格分段专题图的一个分段值。
`void`	`dispose()` 释放该对象所占用的资源，当调用该方法之后，此对象不再可用
`boolean`	`fromXML(java.lang.String xml)` 从 XML 字符串中导入专题图信息。
`int`	`getCount()` 返回栅格分段专题图中分段的个数
`ThemeGridRangeItem`	`getItem(int index)` 返回指定序号的栅格分段专题图中分段专题图子项。
`RangeMode`	`getRangeMode()` 获取当前专题图的分段模式。
`int`	`GetSpecialValue()` 返回指定的透明值
`int`	`indexOf(double value)` 返回栅格分段专题图中指定分段字段值在当前分段序列中的序号，如果不存在,返回-1
`boolean`	`isSpecialValueTransparent()` 返回是否按照指定的值透明显示栅格专题图现在实现仅对栅格的分段
`static ThemeGridRange`	`makeDefault(DatasetGrid dataset, RangeMode rangeMode, double rangeParameter)` 根据给定的栅格数据集、分段模式和相应的分段参数生成默认的栅格分段专题图
`static ThemeGridRange`	`makeDefault(DatasetGrid dataset, RangeMode rangeMode, double rangeParameter, ColorGradientType colorGradientType)` 根据给定的栅格数据集、分段模式、相应的分段参数和颜色渐变填充模式生成默认的栅格分段专题图
`boolean`	`merge(int index, int count, Color color, java.lang.String caption)` 合并一个从指定序号起始的给定个数的栅格分段专题图子项，并赋给合并后栅格分段专题图子项颜色和名称。
`void`	`reverseColor()` 对分段专题图中分段的风格进行反序显示
`void`	`setSpecialValue(int nSpecialValue)` 设置指定的透明值
`void`	`setSpecialValueTransparent(boolean bSpecialValueTransparent)` 设置是否按照指定的值透明显示栅格专题图现在实现仅对栅格的分段
`boolean`	`split(int index, double splitValue, Color color1, java.lang.String caption1, Color color2, java.lang.String caption2)` 根据给定的拆分分段值将一个指定序号的栅格分段专题图子项拆分成两个具有各自颜色和名称的栅格分段专题图子项。
`java.lang.String`	`toString()` 输出专题图格式化字符串。

从类继承的方法 com.supermap.mapping.Theme
getMemoryData, getType, setMemoryData, toXML

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

- 构造器详细资料
  - ThemeGridRange
```
public ThemeGridRange()
```
    默认构造函数，构造一个新的 ThemeGridRange 对象
  - ThemeGridRange
```
public ThemeGridRange(ThemeGridRange themeGridRange)
```
    根据给定的 ThemeGridRange 对象构造一个与其结构完全相同的新对象
    
    参数:
    
    themeGridRange - 给定的 ThemeGridRange 对象
- 方法详细资料
  - getRangeMode
```
public RangeMode getRangeMode()
```
    获取当前专题图的分段模式。
    标准差分段模式和等计数分段模式不支持栅格数据
    
    返回:
    
    返回当前专题图的分段模式
  - getItem
```
public ThemeGridRangeItem getItem(int index)
```
    返回指定序号的栅格分段专题图中分段专题图子项。有关栅格分段专题图子项详细信息，请参见 ThemeGridRangeItem 类
    
    参数:
    
    index - 指定的栅格分段专题图子项序号
    
    返回:
    
    指定序号的栅格分段专题图中分段专题图子项
  - getCount
```
public int getCount()
```
    返回栅格分段专题图中分段的个数
    
    返回:
    
    返回栅格分段专题图中分段的个数，默认值为 0
  - addToHead
```
public boolean addToHead(ThemeGridRangeItem item)
```
    把一个栅格分段专题图子项添加到分段列表的开头
    
    参数:
    
    item - 需要添加的栅格分段专题图子项
    
    返回:
    
    如果添加成功返回 true，否则返回 false
  - addToTail
```
public boolean addToTail(ThemeGridRangeItem item)
```
    把一个栅格分段专题图子项添加到分段列表的尾部
    
    参数:
    
    item - 需要添加的栅格分段专题图子项
    
    返回:
    
    如果添加成功返回 true；否则返回 false
  - addToHead
```
public boolean addToHead(ThemeGridRangeItem item,
                         boolean normalize)
```
    把一个栅格分段专题图子项添加到分段列表的开头
    
    参数:
    
    item - 需要添加的栅格分段专题图子项
    
    normalize - 表示是否规整化，normalize 为 true时， item 值不合法，则进行规整，normalize 为 fasle时， item 值不合法则抛异常。
    
    返回:
    
    如果添加成功返回 true，否则返回 false
  - addToTail
```
public boolean addToTail(ThemeGridRangeItem item,
                         boolean normalize)
```
    把一个栅格分段专题图子项添加到分段列表的尾部
    
    参数:
    
    item - 需要添加的栅格分段专题图子项
    
    normalize - 示是否规整化，normalize 为 true时， item 值不合法，则进行规整，normalize 为 fasle时， item 值不合法则抛异常
    
    返回:
    
    如果添加成功返回 true；否则返回 false
  - split
```
public boolean split(int index,
                     double splitValue,
                     Color color1,
                     java.lang.String caption1,
                     Color color2,
                     java.lang.String caption2)
```
    根据给定的拆分分段值将一个指定序号的栅格分段专题图子项拆分成两个具有各自颜色和名称的栅格分段专题图子项。注：splitValue 必须在拆分的范围之内。即大于栅格分段专题图子项的起始值(Start)并且小于栅格分段专题图子项的终止值（End），如果不满足上述条件，则抛出异常
    
    参数:
    
    index - 指定的栅格分段专题图子项的序号
    
    splitValue - 指定的拆分分段值
    
    color1 - 被拆分的两个栅格分段专题图子项中的一个栅格分段专题图子项的颜色
    
    caption1 - 被拆分的两个栅格分段专题图子项中的一个栅格分段专题图子项的名称
    
    color2 - 被拆分的两个栅格分段专题图子项中的另一个栅格分段专题图子项的颜色
    
    caption2 - 被拆分的两个栅格分段专题图子项中的另一个栅格分段专题图子项的名称
    
    返回:
    
    如果拆分成功返回 true；否则返回 false
  - merge
```
public boolean merge(int index,
                     int count,
                     Color color,
                     java.lang.String caption)
```
    合并一个从指定序号起始的给定个数的栅格分段专题图子项，并赋给合并后栅格分段专题图子项颜色和名称。执行该方法后，被合并的对象将被释放，不再可用
    
    参数:
    
    index - 指定的栅格分段专题图子项的序号，以此序号为合并的起始序号
    
    count - 要合并的栅格分段专题图子项个数，即从指定的序号开始计算
    
    color - 合并后的栅格分段专题图子项的颜色
    
    caption - 合并后的栅格分段专题图子项名称
    
    返回:
    
    如果合并成功返回 true；否则返回 false
  - clear
```
public void clear()
```
    删除栅格分段专题图的一个分段值。执行该方法后，所有的栅格分段专题图子项都被释放，不再可用
  - makeDefault
```
public static ThemeGridRange makeDefault(DatasetGrid dataset,
                                         RangeMode rangeMode,
                                         double rangeParameter,
                                         ColorGradientType colorGradientType)
```
    根据给定的栅格数据集、分段模式、相应的分段参数和颜色渐变填充模式生成默认的栅格分段专题图
    
    参数:
    
    dataset - 栅格数据集
    
    rangeMode - 分段模式。只支持等距离分段法，平方根分段法，对数分段法，以及自定义距离法。
    
    rangeParameter - 分段参数。当分段模式为等距离分段法，平方根分段法，对数分段法其中一种时，该参数为分段个数；当分段模式为自定义距离时，该参数表示自定义距离
    
    colorGradientType - 颜色渐变模式
    
    返回:
    
    根据参数构造得到一个新的 ThemeGridRange 的对象实例
  - makeDefault
```
public static ThemeGridRange makeDefault(DatasetGrid dataset,
                                         RangeMode rangeMode,
                                         double rangeParameter)
```
    根据给定的栅格数据集、分段模式和相应的分段参数生成默认的栅格分段专题图
    
    参数:
    
    dataset - 栅格数据集
    
    rangeMode - 分段模式。只支持等距离分段法，平方根分段法，对数分段法，以及自定义距离法
    
    rangeParameter - 分段参数。当分段模式为等距离分段法，平方根分段法，对数分段法其中一种时，该参数为分段个数；当分段模式为自定义距离时，该参数表示自定义距离
    
    返回:
    
    根据参数构造得到一个新的 ThemeGridRange 的对象实例
  - indexOf
```
public int indexOf(double value)
```
    返回栅格分段专题图中指定分段字段值在当前分段序列中的序号，如果不存在,返回-1
    
    参数:
    
    value - 给定的分段字段的值
    
    返回:
    
    分段字段值在分段序列中的序号。如果给定的分段字段的值不存在与其对应的序号，就返回-1
  - reverseColor
```
public void reverseColor()
```
    对分段专题图中分段的风格进行反序显示
  - toString
```
public java.lang.String toString()
```
    从类复制的说明: Theme
    输出专题图格式化字符串。格式化字符串提供专题图的相关设置信息，与 XML 字符串不同的是，格式化字符串不可导入显示专题图，只用于提供专题图的相关信息。
    1. 对于栅格分段专题图，其格式为{Caption=”china”, Start=10 End=20, Visible=true?false, Style={linestyle=,markerstyle=,fillstyle=} }；
    2. 对于栅格单值专题图，其格式为{Caption=”china”, Unique =20, Visible=true?false, Style={linestyle=,markerstyle=,fillstyle=} }；
    3. 对于标签专题图，其格式为{Caption=”China”, Start=10 End=20, Visible=true, Style={name=,width=,height=,color=()} }；
    4. 对于分段专题图，其格式为{Caption=”china”, Start=10 End=20, Visible=true?false, Style={linestyle=,markerstyle=,fillstyle=}；
    5. 对于单值专题图，其格式为{Caption=”china”, Unique =20, Visible=true?false, Style={linestyle=,markerstyle=,fillstyle=} }。
    指定者:
    
    toString 在类中 Theme
    
    返回:
    
    专题图的格式化字符串。
    
    另请参阅:
    
    Theme.toString()
  - dispose
```
public void dispose()
```
    释放该对象所占用的资源，当调用该方法之后，此对象不再可用
  - fromXML
```
public boolean fromXML(java.lang.String xml)
```
    从类复制的说明: Theme
    
    从 XML 字符串中导入专题图信息。
    在 SuperMap 中，各种专题图的风格的设置都可以导出成 XML 格式的字符串，此 XML 格式的字符串中记录了关于这种专题图的所有设置，如对于标签专题图的 XML 格式字符串会记录专题图类型，可见比例尺，标签风格的设置，是否流动显示，是否自动避让等等对该标签专题图的所有风格的设置以及用来制作标签专题图的字段或表达式。这种 XML 格式字符串可以用来导入，对专题图进行设置。
    
    覆盖:
    
    fromXML 在类中 Theme
    
    参数:
    
    xml - 包含专题图信息的 XML 字符串。
    
    返回:
    
    一个布尔值，导入成功返回 true，否则返回 false。
    
    另请参阅:
    
    Theme.fromXML(java.lang.String)
  - setSpecialValueTransparent
```
public void setSpecialValueTransparent(boolean bSpecialValueTransparent)
```
    设置是否按照指定的值透明显示栅格专题图现在实现仅对栅格的分段
    
    参数:
    
    bSpecialValueTransparent - 是否按照指定的值透明显示栅格专题图
  - isSpecialValueTransparent
```
public boolean isSpecialValueTransparent()
```
    返回是否按照指定的值透明显示栅格专题图现在实现仅对栅格的分段
    
    返回:
    
    如果按照指定的值透明显示返回 true；否则返回 false
  - setSpecialValue
```
public void setSpecialValue(int nSpecialValue)
```
    设置指定的透明值
    
    参数:
    
    nSpecialValue - 指定的透明值
  - GetSpecialValue
```
public int GetSpecialValue()
```
    返回指定的透明值
    
    返回:
    
    返回指定的透明值

跳过导航链接

所有类

概要:
嵌套 |
字段 |
构造器 |
方法

详细资料:
字段 |
构造器 |
方法

类 ThemeGridRange

构造器概要

方法概要

从类继承的方法 com.supermap.mapping.Theme

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

构造器详细资料

ThemeGridRange

ThemeGridRange

方法详细资料

getRangeMode

getItem

getCount

addToHead

addToTail

addToHead

addToTail

split

merge

clear

makeDefault

makeDefault

indexOf

reverseColor

toString

dispose

fromXML

setSpecialValueTransparent

isSpecialValueTransparent

setSpecialValue

GetSpecialValue