ThemeRange类参考

分段专题图类。 更多...

继承自Theme

所有成员的列表。

公有成员

(BOOL) - fromXML:
 从 XML字符串中导入专题图信息。
(void) - setRangeExpression:
 设置分段字段表达式。
(NSString *) - getRangeExpression
 返回分段字段表达式。
(int) - getCount
 返回分段专题图中分段的个数。
(BOOL) - addToHead:
 把一个分段专题图子项添加到分段列表的开头。
(BOOL) - addToTail:
 把一个分段专题图子项添加搭配分段列表的尾部。
(BOOL) - addToHead:Normalize:
 把一个分段专题图子项添加到分段列表的开头。
(BOOL) - addToTail:Normalize:
 把一个分段专题图子项添加到分段列表的尾部。
(ThemeRangeItem *) - getItem:
 返回指定序号的分段专题图中分段专题图子项。有关分段专题图子项详细信息,请参见 ThemeRangeItem 类。
(BOOL) - splitIndex:SplitValue:Style1:Caption1:Style2:Caption2:
 根据给定的拆分分段值将一个给定序号的分段专题图子项拆分成两个具有各自风格和名称的分段专题图子项。
(BOOL) - merge:Count:GeoStyle:Caption:
 合并一个从指定序号起始的给定个数的分段专题图子项,并赋给合并后分段专题图子项显示风格和名称。执行该方法后,被合并的对象将被释放,不再可用。
(double) - getPrecision
 获取范围分段专题图的舍入精度。
(void) - setPrecision:
 设置范围分段专题图的舍入精度。
(int) - indexOf:
 返回分段专题图中指定分段字段值在当前分段序列中的序号。
(void) - setOffsetX:
 设置X偏移量。
(void) - setOffsetY:
 设置Y偏移量。
(NSString *) - getOffsetX
 返回X偏移量
(NSString *) - getOffsetY
 返回Y偏移量。
(double) - getCustomInterVal
 获取自定义段长。
(void) - setOffsetFixed:
 设置是否固定偏移量。
(NSMutableArray *) - getRangeItemList
 获取分段专题图子项列表。
(BOOL) - isOffsetFixed
 返回是否固定偏移量。
(NSString *) - toString
 返回分段专题图格式化字符串。
(void) - reverseStyle
 对分段专题图中分段的风格进行反序显示。
(void) - clear
 删除分段专题图的所有分段子项。
(void) - dispose
 释放对象所占用的资源。调用该方法之后,此对象不再可用。

静态公有成员

(ThemeRange *) + makeDefaultDataSet:RangeExpression:RangeMode:RangeParameter:
 根据给定的矢量数据集、分段字段表达式、分段模式和相应的分段参数生成默认的分段专题图。
(ThemeRange *) + makeDefaultDataSet:RangeExpression:RangeMode:RangeParameter:ColorGradientType:
 根据给定的矢量数据集、分段字段表达式、分段模式、相应的分段参数和颜色渐变模式生成默认的分段专题图。
(ThemeRange *) + makeDefaultDataSet:RangeExpression:RangeMode:RangeParameter:ColorGradientType:JoinItems:
 根据给定的矢量数据集、分段字段表达式、分段模式、相应的分段参数、颜色渐变填充模式和外部连接表项生成默认的分段专题图。
(ThemeRange *) + makeDefaultDataSet:RangeExpression:RangeMode:RangeParameter:ColorGradientType:JoinItems:Precision:
 根据给定的矢量数据集、分段字段表达式、分段模式、相应的分段参数、颜色渐变填充模式、外部连接表项和分段值的精度生成默认的分段专题图。

属性

RangeMode mRangeMode
 获取或设置当前的分段模式。

详细描述

分段专题图类。

按照提供的分段方法对字段的属性值进行分段,并根据每个属性值所在的分段范围赋予相应对象的显示风格。

注意:

制作分段专题图,如果首尾区间没有设置风格,且没有设置默认风格,那么无论是采用 addToHead 还是 ddToTail 方法,首尾区间默认采用用户所添加的第一个分段的风格,比如:总共分5段,addToTail 方法依次添加 [0,1)、[1,2)、[2,4)三段,那么首区间(负无穷,0),尾区间[4,正无穷),采用[0,1)的风格。


成员函数文档

- (BOOL) addToHead: (ThemeRangeItem *)  item  

把一个分段专题图子项添加到分段列表的开头。

参数:
item 需要添加的分段专题图子项。
返回:
一个布尔值,分段专题图子项添加成功返回true,否则返回false。
- (BOOL) addToHead: (ThemeRangeItem *)  item
Normalize: (BOOL)  bNormalize 

把一个分段专题图子项添加到分段列表的开头。

参数:
item 需要添加的分段专题图子项。
bNormalize 表示是否规整化,bNormalize 为 true时, item 值不合法,则进行规整,bNormalize 为 fasle时, item 值不合法则抛异常。
返回:
一个布尔值,分段专题图子项添加成功返回true,否则返回false。
- (BOOL) addToTail: (ThemeRangeItem *)  item  

把一个分段专题图子项添加搭配分段列表的尾部。

参数:
item 需要添加的分段专题图子项。
返回:
一个布尔值,分段专题图子项添加成功返回true,否则返回false。
- (BOOL) addToTail: (ThemeRangeItem *)  item
Normalize: (BOOL)  bNormalize 

把一个分段专题图子项添加到分段列表的尾部。

参数:
item 需要添加的分段专题图子项。
bNormalize 表示是否规整化,bNormalize 为 true时, item 值不合法,则进行规整,bNormalize 为 fasle时, item 值不合法则抛异常。
返回:
一个布尔值,分段专题图子项添加成功返回true,否则返回false。
- (void) clear  

删除分段专题图的所有分段子项。

执行该方法后,所有的分段专题图子项都被释放,不再可用。

- (void) dispose  

释放对象所占用的资源。调用该方法之后,此对象不再可用。

- (BOOL) fromXML: (NSString *)  xml  

从 XML字符串中导入专题图信息。

在 SuperMap 中,各种专题图的风格的设置都可以导出成 XML 格式的字符串,此 XML 格式的字符串中记录了关于这种专题图的所有设置,如对于标签专题图的 XML 格式字符串会记录专题图类型,可见比例尺,标签风格的设置,是否流动显示,是否自动避让等等对该标签专题图的所有风格的设置以及用来制作标签专题图的字段或表达式。这种 XML 格式字符串可以用来导入,对专题图进行设置。

参数:
xml 包含专题图信息的 XML 字符串。
返回:
一个布尔值,导入成功返回 true,否则返回 false。

实现了Theme

- (int) getCount  

返回分段专题图中分段的个数。

默认值为0。

分段专题图中分段的个数。

- (double) getCustomInterVal  

获取自定义段长。

返回:
自定义段长。
- (ThemeRangeItem*) getItem: (int)  index  

返回指定序号的分段专题图中分段专题图子项。有关分段专题图子项详细信息,请参见 ThemeRangeItem 类。

参数:
index 指定的分段专题图序号。
返回:
指定序号的分段专题图中分段专题图子项。
- (NSString*) getOffsetX  

返回X偏移量

返回:
X偏移量。
- (NSString*) getOffsetY  

返回Y偏移量。

返回:
Y偏移量。
- (double) getPrecision  

获取范围分段专题图的舍入精度。

返回:
舍入精度。
- (NSString *) getRangeExpression  

返回分段字段表达式。

通过对比某要素分段字段表达式的值与(按照一定的分段模式确定的)各分段范围的分段值,来确定该要素所在的范围段,从而对落在不同分段内的要素设置为不同的风格。

默认值为一个空字符串。

返回:
分段字段表达式。
- (NSMutableArray *) getRangeItemList  

获取分段专题图子项列表。

返回:
分段专题图子项列表。
- (int) indexOf: (double)  value  

返回分段专题图中指定分段字段值在当前分段序列中的序号。

参数:
value 给定的分段字段值。
返回:
分段字段值在分段序列中的序号。如果该值不存在,就返回-1。
- (BOOL) isOffsetFixed  

返回是否固定偏移量。

返回:
一个布尔值,固定偏移量返回True,否则返回false。
+ (ThemeRange*) makeDefaultDataSet: (DatasetVector *)  dataset
RangeExpression: (NSString *)  rangeExpression
RangeMode: (RangeMode rangeMode
RangeParameter: (double)  value 

根据给定的矢量数据集、分段字段表达式、分段模式和相应的分段参数生成默认的分段专题图。

参数:
dataset 矢量数据集。
rangeExpression 分段字段表达式。
rangeMode 分段模式。包括等距离分段法,平方根分段法,标准差分段法,对数分段法,等计数分段法,以及自定义距离法。
value 分段参数。当分段模式为等距离分段法,平方根分段,对数分段法,等计数分段法其中一种模式时,该参数为分段个数;当分段模式为标准差分段法的时候,该参数不起作用;当分段模式为自定义距离时,该参数表示自定义距离。
返回:
根据参数构造得到一个新的 <ThemeRange> 的对象实例。
+ (ThemeRange*) makeDefaultDataSet: (DatasetVector *)  dataset
RangeExpression: (NSString *)  rangeExpression
RangeMode: (RangeMode rangeMode
RangeParameter: (double)  value
ColorGradientType: (ColorGradientType colorGradientType 

根据给定的矢量数据集、分段字段表达式、分段模式、相应的分段参数和颜色渐变模式生成默认的分段专题图。

参数:
dataset 矢量数据集。
rangeExpression 分段字段表达式。
rangeMode 分段模式。包括等距离分段法,平方根分段法,标准差分段法,对数分段法,等计数分段法,以及自定义距离法。
value 分段参数。当分段模式为等距离分段法,平方根分段,对数分段法,等计数分段法其中一种模式时,该参数为分段个数;当分段模式为标准差分段法的时候,该参数不起作用;当分段模式为自定义距离时,该参数表示自定义距离。
colorGradientType 颜色渐变模式。
返回:
根据参数构造得到一个新的 <ThemeRange> 的对象实例。
+ (ThemeRange*) makeDefaultDataSet: (DatasetVector *)  dataset
RangeExpression: (NSString *)  rangeExpression
RangeMode: (RangeMode rangeMode
RangeParameter: (double)  value
ColorGradientType: (ColorGradientType colorGradientType
JoinItems: (JoinItems *)  joinItems 

根据给定的矢量数据集、分段字段表达式、分段模式、相应的分段参数、颜色渐变填充模式和外部连接表项生成默认的分段专题图。

参数:
dataset 矢量数据集。
rangeExpression 分段字段表达式。
rangeMode 分段模式。包括等距离分段法,平方根分段法,标准差分段法,对数分段法,等计数分段法,以及自定义距离法。
value 分段参数。当分段模式为等距离分段法,平方根分段,对数分段法,等计数分段法其中一种模式时,该参数为分段个数;当分段模式为标准差分段法的时候,该参数不起作用;当分段模式为自定义距离时,该参数表示自定义距离。
colorGradientType 颜色渐变模式。
joinItems 外部表连接项。
返回:
根据参数构造得到一个新的 <ThemeRange> 的对象实例。
+ (ThemeRange*) makeDefaultDataSet: (DatasetVector *)  dataset
RangeExpression: (NSString *)  rangeExpression
RangeMode: (RangeMode rangeMode
RangeParameter: (double)  value
ColorGradientType: (ColorGradientType colorGradientType
JoinItems: (JoinItems *)  joinItems
Precision: (double)  precision 

根据给定的矢量数据集、分段字段表达式、分段模式、相应的分段参数、颜色渐变填充模式、外部连接表项和分段值的精度生成默认的分段专题图。

参数:
dataset 矢量数据集。
rangeExpression 分段字段表达式。
rangeMode 分段模式。包括等距离分段法,平方根分段法,标准差分段法,对数分段法,等计数分段法,以及自定义距离法。
value 分段参数。当分段模式为等距离分段法,平方根分段,对数分段法,等计数分段法其中一种模式时,该参数为分段个数;当分段模式为标准差分段法的时候,该参数不起作用;当分段模式为自定义距离时,该参数表示自定义距离。
colorGradientType 颜色渐变模式。
joinItems 外部表连接项。
precision 分段值的精度。如,计算得到的分段值为13.02145,而分段精度为0.001,则分段值取13.021。
返回:
根据参数构造得到一个新的 <ThemeRange> 的对象实例。
- (BOOL) merge: (int)  index
Count: (int)  count
GeoStyle: (GeoStyle *)  style
Caption: (NSString *)  caption 

合并一个从指定序号起始的给定个数的分段专题图子项,并赋给合并后分段专题图子项显示风格和名称。执行该方法后,被合并的对象将被释放,不再可用。

参数:
index 指定的分段专题图子项的序号,并以此序号为起始。
count 要合并的分段专题图子项个数,即从指定的序号开始计算。
style 合并后的分段专题图子项的风格。
caption 合并后的分段专题图子项的名称。
返回:
一个布尔值,如果合并成功返回true,否则返回false。
- (void) reverseStyle  

对分段专题图中分段的风格进行反序显示。

比如,专题图有三个分段,分别为 item1,item2,item3,调用反序显示后,item3 的风格与 item1 会调换,item2 的显示风格不变。

- (void) setOffsetFixed: (BOOL)  bFixed  

设置是否固定偏移量。

参数:
bFixed 参数为True表示固定偏移量,否则表示不固定偏移量。
- (void) setOffsetX: (NSString *)  value  

设置X偏移量。

参数:
value X偏移量。
- (void) setOffsetY: (NSString *)  value  

设置Y偏移量。

参数:
value Y偏移量。
- (void) setPrecision: (double)  value  

设置范围分段专题图的舍入精度。

参数:
value 舍入精度。
- (void) setRangeExpression: (NSString *)  var  

设置分段字段表达式。

通过对比某要素分段字段表达式的值与(按照一定的分段模式确定的)各分段范围的分段值,来确定该要素所在的范围段,从而对落在不同分段内的要素设置为不同的风格。

参数:
var 指定分段字段表达式。
- (BOOL) splitIndex: (int)  index
SplitValue: (double)  splitValue
Style1: (GeoStyle *)  style1
Caption1: (NSString *)  caption1
Style2: (GeoStyle *)  style2
Caption2: (NSString *)  caption2 

根据给定的拆分分段值将一个给定序号的分段专题图子项拆分成两个具有各自风格和名称的分段专题图子项。

注:splitValue必须在拆分的范围之内,即大于分段专题图子项的起始值(Start)且小于分段专题图子项的终止项(End),如果不满足以上条件,则抛出异常。

参数:
index 指定的分段专题图子项的序号。
splitValue 指定的拆分分段值。
style1 被拆分的两个分段专题图子项中的一个分段专题图子项的风格。
caption1 被拆分的两个分段专题图子项中的一个分段专题图子项的名称。
style2 被拆分的两个分段专题图子项中的另一个分段专题图子项的风格。
caption2 被拆分的两个分段专题图子项中的另一个分段专题图子项的名称。
返回:
一个布尔值,如果拆分成功返回true,否则返回false。
- (NSString *) toString  

返回分段专题图格式化字符串。

返回:
分段专题图格式化字符串。

属性文档

- (RangeMode) mRangeMode [read, write, assign]

获取或设置当前的分段模式。

返回:
当前的分段模式。

该类的文档由以下文件生成: