ThemeGridRange (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.data.InternalHandleDisposable
  - - com.supermap.mapping.Theme
    - - com.supermap.mapping.ThemeGridRange

所有已实现的接口:

IDisposable
```
public class ThemeGridRange
extends Theme
```
栅格分段专题图

构造器概要

构造器
构造器和说明

ThemeGridRange()
构造默认分段专题图

ThemeGridRange(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(String xml)` 从 XML 字符串中导入专题图信息。
`int`	`getCount()` 获取分段数量
`ThemeGridRangeItem`	`getItem(int index)` 获取某个分段，
`RangeMode`	`getRangeMode()` 获取分段模式
`int`	`GetSpecialValue()` 已过时。
`Color`	`getSpecialValueColor()` 获取特殊值的颜色
`double`	`getThemeSpecialValue()` 返回已经设置的特殊像素值。
`int`	`indexOf(double value)` 查找某段分段值的序号, 如果不存在,返回-1
`boolean`	`isSpecialValueTransparent()` 返回是否透明显示指定的像元。
`static ThemeGridRange`	`makeDefault(DatasetGrid dataset, RangeMode rangeMode, double rangeParameter)` 生成默认的标签专题图,只有在设置了RangeExpression时可用
`static ThemeGridRange`	`makeDefault(DatasetGrid dataset, RangeMode rangeMode, double rangeParameter, ColorGradientType colorGradientType)` 生成默认的标签专题图
`boolean`	`merge(int index, int count, Color color, String caption)` 根据索引合并对应数量的分段值
`void`	`reverseColor()` 将专题图分段颜色序列进行反转
`void`	`setSpecialValue(int nSpecialValue)` 已过时。
`void`	`setSpecialValueColor(Color value)` 设置特殊值的颜色
`void`	`setSpecialValueTransparent(boolean bSpecialValueTransparent)` 设置是否透明显示指定的像元。
`void`	`setThemeSpecialValue(double nSpecialValue)` 设置特殊像素值，可用于设置影像的部分像素透明。
`boolean`	`split(int index, double splitValue, Color color1, String caption1, Color color2, String caption2)` 拆分一个分段值 splitValue必须在拆分的范围之内
`String`	`toString()` 对象参数序列化为string

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

从类继承的方法 com.supermap.data.InternalHandleDisposable
makeSureNativeObjectLive

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

- 构造器详细资料
  - ThemeGridRange
```
public ThemeGridRange()
```
    构造默认分段专题图
  - ThemeGridRange
```
public ThemeGridRange(ThemeGridRange themeGridRange)
```
    构造分段专题图
    
    参数:
    
    themeGridRange -
- 方法详细资料
  - getRangeMode
```
public RangeMode getRangeMode()
```
    获取分段模式
    
    返回:
    
    分段模式
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
  - getItem
```
public ThemeGridRangeItem getItem(int index)
```
    获取某个分段，
    
    参数:
    
    index -
    
    返回:
    
    对应分段子项
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
  - getCount
```
public int getCount()
```
    获取分段数量
    
    返回:
    
    数量值
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
  - addToHead
```
public boolean addToHead(ThemeGridRangeItem item)
```
    添加一个分段值到开始
    
    参数:
    
    item -
    
    返回:
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
  - addToTail
```
public boolean addToTail(ThemeGridRangeItem item)
```
    添加一个分段值到尾部
    
    参数:
    
    item -
    
    返回:
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
  - addToHead
```
public boolean addToHead(ThemeGridRangeItem item,
                         boolean normalize)
```
    添加一个分段值到开始
    
    参数:
    
    item - 分段子项
    
    normalize - 是否修正值（当item.getStart() >= item.getEnd()时）
    
    返回:
    
    是否成功
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
    
    IllegalArgumentException - 非法参数
  - addToTail
```
public boolean addToTail(ThemeGridRangeItem item,
                         boolean normalize)
```
    添加一个分段值
    
    参数:
    
    item - 分段子项
    
    normalize - 是否修修正值（当item.getStart() >= item.getEnd()时）
    
    返回:
    
    是否成功
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
    
    IllegalArgumentException - 非法参数
  - split
```
public boolean split(int index,
                     double splitValue,
                     Color color1,
                     String caption1,
                     Color color2,
                     String caption2)
```
    拆分一个分段值 splitValue必须在拆分的范围之内
    
    参数:
    
    index - 分段索引
    
    splitValue - 拆分值
    
    color1 - 颜色1
    
    caption1 - 标题1
    
    color2 - 颜色2
    
    caption2 - 标题2
    
    返回:
    
    返回是否成功
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
    
    IndexOutOfBoundsException - 超过范围
    
    IllegalArgumentException - 非法参数
  - merge
```
public boolean merge(int index,
                     int count,
                     Color color,
                     String caption)
```
    根据索引合并对应数量的分段值
    
    参数:
    
    index - 索引值
    
    count - 数量
    
    color - 合并后颜色
    
    caption - 合并后标题
    
    返回:
    
    是否成功
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
    
    IndexOutOfBoundsException - 超过范围
    
    IllegalArgumentException - 非法参数
  - clear
```
public void clear()
```
    清除所有分段值
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
  - makeDefault
```
public static ThemeGridRange makeDefault(DatasetGrid dataset,
                                         RangeMode rangeMode,
                                         double rangeParameter,
                                         ColorGradientType colorGradientType)
```
    生成默认的标签专题图
    
    参数:
    
    dataset - 数据集
    
    rangeMode - 分段模式
    
    rangeParameter - 分段参数
    
    colorGradientType - 颜色渐变类型
    
    返回:
    
    专题图对象
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
    
    IllegalArgumentException - 参数异常
  - makeDefault
```
public static ThemeGridRange makeDefault(DatasetGrid dataset,
                                         RangeMode rangeMode,
                                         double rangeParameter)
```
    生成默认的标签专题图,只有在设置了RangeExpression时可用
    
    参数:
    
    dataset - 数据集
    
    rangeMode - 分段模式
    
    rangeParameter - 分段参数
    
    返回:
    
    分段专题图对象
  - indexOf
```
public int indexOf(double value)
```
    查找某段分段值的序号, 如果不存在,返回-1
    
    参数:
    
    value - 分段值
    
    返回:
    
    序列号
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
  - reverseColor
```
public void reverseColor()
```
    将专题图分段颜色序列进行反转
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
  - toString
```
public String toString()
```
    对象参数序列化为string
    
    指定者:
    
    toString 在类中 Theme
    
    返回:
    
    专题图的格式化字符串。
  - dispose
```
public void dispose()
```
    释放对象的资源
  - fromXML
```
public boolean fromXML(String xml)
```
    从 XML 字符串中导入专题图信息。
    在 SuperMap 中，各种专题图的风格的设置都可以导出成 XML 格式的字符串，此 XML 格式的字符串中记录了关于这种专题图的所有设置，如对于标签专题图的 XML 格式字符串会记录专题图类型，可见比例尺，标签风格的设置，是否流动显示，是否自动避让等等对该标签专题图的所有风格的设置以及用来制作标签专题图的字段或表达式。这种 XML 格式字符串可以用来导入，对专题图进行设置。
    
    覆盖:
    
    fromXML 在类中 Theme
    
    参数:
    
    xml - 包含专题图信息的 XML 字符串。
    
    返回:
    
    一个布尔值，导入成功返回 true，否则返回 false。
  - isSpecialValueTransparent
```
public boolean isSpecialValueTransparent()
```
    返回是否透明显示指定的像元。
    
    返回:
    
    true表示透明显示指定的像元；false表示不会透明显示指定的像元。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
  - setSpecialValueTransparent
```
public void setSpecialValueTransparent(boolean bSpecialValueTransparent)
```
    设置是否透明显示指定的像元。
    只有先创建了对应的专题图图层，才能成功设置指定的像元透明显示。
    
    参数:
    
    bSpecialValueTransparent - true表示会透明显示指定的像元，false表示不会透明显示指定的像元。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
  - setSpecialValue
```
@Deprecated
public void setSpecialValue(int nSpecialValue)
```
    已过时。
    
    废弃，参见：setThemeSpecialValue
  - GetSpecialValue
```
@Deprecated
public int GetSpecialValue()
```
    已过时。
    
    废弃，参见：getThemeSpecialValue
  - getThemeSpecialValue
```
public double getThemeSpecialValue()
```
    返回已经设置的特殊像素值。
    
    返回:
    
    特殊像素值。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
  - setThemeSpecialValue
```
public void setThemeSpecialValue(double nSpecialValue)
```
    设置特殊像素值，可用于设置影像的部分像素透明。
    只有先创建了对应的专题图图层，才能成功设置特殊的像素值。
    
    参数:
    
    nSpecialValue - 特殊像素值。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
  - getSpecialValueColor
```
public Color getSpecialValueColor()
```
    获取特殊值的颜色
    
    返回:
    
    特殊值颜色
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
  - setSpecialValueColor
```
public void setSpecialValueColor(Color value)
```
    设置特殊值的颜色
    
    参数:
    
    value - 颜色值
    
    抛出:
    
    IllegalStateException - 当前对象已被释放

类 ThemeGridRange

构造器概要

方法概要

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

从类继承的方法 com.supermap.data.InternalHandleDisposable

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

构造器详细资料

ThemeGridRange

ThemeGridRange

方法详细资料

getRangeMode

getItem

getCount

addToHead

addToTail

addToHead

addToTail

split

merge

clear

makeDefault

makeDefault

indexOf

reverseColor

toString

dispose

fromXML

isSpecialValueTransparent

setSpecialValueTransparent

setSpecialValue

GetSpecialValue

getThemeSpecialValue

setThemeSpecialValue

getSpecialValueColor

setSpecialValueColor