ThemeLabel类参考

标签专题图类。 更多...

继承自Theme。

所有成员的列表。

公有成员
(id)	- initThemeLabel:
	拷贝构造函数，根据给定的 <ThemeLabel> 对象构造一个与其完全相同的新对象。
(NSMutableArray *)	- getLableItemList
	获取标签专题图子项列表。
(void)	- setBackShape:
	设置标签专题图背景形状。
(GeoStyle *)	- getBackStyle
	获取标签专题图背景形状。
(void)	- setRangeExpression:
	设置分段字段表达式。其中分段表达式中的值必须为数值型的。
(void)	- setLabelExpression:
	设置标注字段表达式。
(NSString *)	- getLabelExpression
	获取标注字段表达式。
(int)	- getCount
	返回标签专题图中分段的个数。
(BOOL)	- addToHead:
	把一个标签专题图子项添加到分段列表的开头。
(BOOL)	- addToHead:normalise:
	把一个标签专题图子项添加到分段列表的开头。
(BOOL)	- addToTail:
	把一个标签专题图子项添加到分段列表的尾部。
(BOOL)	- addToTail:normalise:
	把一个标签专题图子项添加到分段列表的尾部。
(void)	- clear
	删除标签专题图的子项。执行该方法后，所有的标签专题图子项都被释放，不再可用。
(void)	- dispose
	释放对象所占用的资源。调用该方法之后，此对象不再可用。
(ThemeLabelItem *)	- getItem:
	返回指定序号的标签专题图中标签专题图子项。有关标签专题图子项详细信息，请参见 <ThemeLabelItem> 类。
(ThemeLabel *)	- getParent
	返回当前标签专题图所归属的专题图，即其父对象。
(int)	- indexOf:
	返回标签专题图中指定分段字段值在当前分段序列中的序号。
(BOOL)	- split:SplitValue:Style1:Caption1:Style2:Caption2:
	根据给定的拆分分段值将一个指定序号的标签专题图子项拆分成两个具有各自风格和名称的标签专题图子项。
(BOOL)	- merge:Count:TextStyle:Caption:
	合并一个从指定序号起始的给定个数的标签专题图子项，并赋给合并后标签专题图子项显示风格和名称。执行该方法后，被合并的对象将被释放，不可再用。
(NSString *)	- toString
	返回标签专题图格式化字符串。
(void)	- setOffsetX:
	设置标签专题图中标记文本相对于要素内点的水平偏移量。标签偏移量的单位为地图单位。
(void)	- setOffsetY:
	设置标签专题图中标记文本相对于要素内点的垂直偏移量。标签偏移量的单位为地图单位。
(NSString *)	- getOffsetX
	获取标签专题图中标记文本相对于要素内点的水平偏移量。标签偏移量的单位为地图单位。
(NSString *)	- getOffsetY
	获取标签专题图中标记文本相对于要素内点的垂直偏移量。标签偏移量的单位为地图单位。
(void)	- setOverLengthMode:
	设置超长标签的处理方式。对超长标签可以不作任何处理，也可以省略超出的部分，或者以换行方式进行显示。
(smOverLengthLabelMode)	- getOverLengthMode
	获取超长标签的处理方式。对超长标签可以不作任何处理，也可以省略超出的部分，或者以换行方式进行显示。
(void)	- setMaxLabelLength:
	设置标签在每一行显示的最大长度,如果超过这个长度,将以省略号显示。
(int)	- getMaxLabelLength
	返回标签在每一行显示的最大长度。
静态公有成员
(ThemeLabel *)	+ makeDefault:rangeExpression:rangeMode:rangeParameter:
	根据给定的矢量数据集、分段字段表达式、分段模式和相应的分段参数生成默认的标签专题图。
(ThemeLabel *)	+ makeDefault:rangeExpression:rangeMode:rangeParameter:colorGradientType:
	根据给定的矢量数据集、分段字段表达式、分段模式、相应的分段参数和颜色渐变模式生成默认的标签专题图。
(ThemeLabel *)	+ makeDefault:rangeExpression:rangeMode:rangeParameter:colorGradientType:joinItems:
	根据给定的矢量数据集、分段字段表达式、分段模式、相应的分段参数、颜色渐变填充模式和外部连接表项生成默认的标签专题图。
保护属性
RangeMode	_mRangeMode
NSMutableArray *	_mLableItems
ThemeLabel *	_mThemeLabel
TextStyle *	_mUniformStyle
GeoStyle *	_mBackStyle
GeoStyle *	_mLeaderLineStyle
MixedTextStyle *	_mixedTextStyle
LabelMatrix *	_mLabelMatrix
Size2D *	_mSize2D
属性
TextStyle *	mUniformStyle
	获取或设置统一文本风格。
RangeMode	mRangeMode
	获取或设置当前的分段模式。
AlongLineDirection	alongLineDirection
	获取或设置标签沿线标注方向。

---

详细描述

标签专题图类。

标签专题图的标注可以是数字、字母与文字，例如：河流、湖泊、海洋、山脉、城镇、村庄等地理名称，高程、等值线数值、河流流速、公路段里程、航海线里程等。

在标签专题图中，你可以对标签的显示风格和位置进行设置或控制，你可以为所有的标签都设置统一的显示风格和位置选项来显示，也可以通过分段的方式，对单个或每个分段内的标签的风格分别进行设置，另外，单个标签的位置也是可以修改的。

注：地图上一般还会出现图例说明，图名，比例尺等等，哪些都是制图元素，不属于标签专题图标注的范畴。

---

成员函数文档

- (BOOL) addToHead:

(ThemeLabelItem *)

item

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

参数:

item

需要添加的子项。

返回:

一个布尔值，如果添加成功返回true,否则返回false。

- (BOOL) addToHead:		(ThemeLabelItem *)	item
normalise:		(BOOL)	normalise

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

参数:

	item	需要添加的子项。
	normalise	表示是否规整化，normalise为true时，item值不合法，则进行规整，normalise为false时,item值不合法则抛异常。

返回:

一个布尔值，如果添加成功返回true,否则返回false。

- (BOOL) addToTail:

(ThemeLabelItem *)

item

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

参数:

item

需要添加的标签专题图子项。

返回:

一个布尔值，如果添加成功返回true,否则返回false。

- (BOOL) addToTail:		(ThemeLabelItem *)	item
normalise:		(BOOL)	normalise

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

参数:

	item	需要添加的标签专题图子项。
	normalise	表示是否规整化，normalise为true时，item 值不合法，则进行规整，normalise为false时，item值不合法则抛异常。

返回:

一个布尔值，如果添加成功返回true,否则返回false。

- (void) clear

删除标签专题图的子项。执行该方法后，所有的标签专题图子项都被释放，不再可用。

- (void) dispose

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

- (GeoStyle*) getBackStyle

获取标签专题图背景形状。

- (int) getCount

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

默认值为0。

返回:

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

- (ThemeLabelItem *) getItem:

(int)

index

返回指定序号的标签专题图中标签专题图子项。有关标签专题图子项详细信息，请参见 <ThemeLabelItem> 类。

参数:

index

指定标签专题图子项的序号。

返回:

指定序号的标签专题图中标签专题图子项。

- (NSString*) getLabelExpression

获取标注字段表达式。

返回:

标签专题图中的标注字段表达式。

- (NSMutableArray *) getLableItemList

获取标签专题图子项列表。

返回:

标签专题图子项列表。

- (int) getMaxLabelLength

返回标签在每一行显示的最大长度。

- (NSString *) getOffsetX

获取标签专题图中标记文本相对于要素内点的水平偏移量。标签偏移量的单位为地图单位。

该偏移量的值为一个常量值或者字段表达式所表示的值，即如果字段表达式为 SmID，其中 SmID=2，那么偏移量的值为 2。

默认值为一个空字符串。

返回:

标签专题图中标记文本相对于要素内点的水平偏移量。

- (NSString *) getOffsetY

获取标签专题图中标记文本相对于要素内点的垂直偏移量。标签偏移量的单位为地图单位。

该偏移量的值为一个常量值或者字段表达式所表示的值，即如果字段表达式为 SmID，其中 SmID=2，那么偏移量的值为 2。

默认值为一个空字符串。

返回:

标签专题图中标记文本相对于要素内点的垂直偏移量。

- (smOverLengthLabelMode) getOverLengthMode

获取超长标签的处理方式。对超长标签可以不作任何处理，也可以省略超出的部分，或者以换行方式进行显示。

默认值为 SM_NONE，即对超长标签不进行处理。

返回:

超长标签的处理方式。

- (ThemeLabel*) getParent

返回当前标签专题图所归属的专题图，即其父对象。

默认值为空。

返回:

ThemeLabel 对象。

- (int) indexOf:

(double)

value

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

参数:

value

给定的分段字段值。

返回:

分段字段值在分段序列中的序号。如果该值不存在，就返回-1。

- (id) initThemeLabel:

(ThemeLabel *)

themeLabel

拷贝构造函数，根据给定的 <ThemeLabel> 对象构造一个与其完全相同的新对象。

参数:

themeLabel

给定的 <ThemeLabel> 对象。

+ (ThemeLabel *) makeDefault:		(DatasetVector *)	dataset
rangeExpression:		(NSString *)	rangeExpression
rangeMode:		(RangeMode)	rangeMode
rangeParameter:		(double)	rangeParameter

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

参数:

	dataset	矢量数据集。
	rangeExpression	分段字段表达式。
	rangeMode	分段模式。包括等距离分段法，平方根分段法，标准差分段法，对数分段法，等计数分段法以及自定义距离法。
	rangeParameter	分段参数。当分段模式为等距离分段法，平方根分段法其中一种模式时，该参数为分段值；当分段模式为标准差分段法的时候，该参数不起作用；当分段模式为自定义距离时，该参数表示自定义距离。

返回:

根据参数构造得到一个新的 <ThemeLabel> 的对象实例。

+ (ThemeLabel *) makeDefault:		(DatasetVector *)	dataset
rangeExpression:		(NSString *)	rangeExpression
rangeMode:		(RangeMode)	rangeMode
rangeParameter:		(double)	rangeParameter
colorGradientType:		(ColorGradientType)	colorGradientType

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

参数:

	dataset	矢量数据集。
	rangeExpression	分段字段表达式。
	rangeMode	分段模式。包括等距离分段法，平方根分段法，标准差分段法，对数分段法，等计数分段法以及自定义距离法。
	rangeParameter	分段参数。当分段模式为等距离分段法，平方根分段法其中一种模式时，该参数为分段值；当分段模式为标准差分段法是时候，该参数不起作用；当分段模式为自定义距离时，该参数表示自定义距离。
	colorGradientType	颜色渐变模式。

返回:

根据参数构造得到一个新的 <ThemeLabel> 的对象实例。

+ (ThemeLabel *) makeDefault:		(DatasetVector *)	dataset
rangeExpression:		(NSString *)	rangeExpression
rangeMode:		(RangeMode)	rangeMode
rangeParameter:		(double)	rangeParameter
colorGradientType:		(ColorGradientType)	colorGradientType
joinItems:		(JoinItems *)	joinItems

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

参数:

	dataset	矢量数据集。
	rangeExpression	分段字段表达式。
	rangeMode	分段模式。包括等距离分段法，平方根分段法，标准差分段法，对数分段法，等计数分段法以及自定义距离法。
	rangeParameter	分段参数。当分段模式为等距离分段法，平方根分段法其中一种模式时，该参数为分段值；当分段模式为标准差分段法的时候，该参数不起作用；当分段模式为自定义距离时，该参数表示自定义距离。
	colorGradientType	颜色渐变模式。
	joinItems	外部表连接项。

返回:

根据参数构造得到一个新的 <ThemeLabel> 的对象实例。

- (BOOL) merge:		(int)	index
Count:		(int)	count
TextStyle:		(TextStyle *)	style
Caption:		(NSString *)	caption

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

参数:

	index	指定的标签专题图子项的序号，并以此序号为起始。
	count	要合并的标签专题图子项个数，即从指定的序号开始计算。
	style	合并后的标签专题图子项的风格。
	caption	合并后的标签专题图子项的名称。

- (void) setBackShape:

(LabelBackShape)

value

设置标签专题图背景形状。

参数:

value

指定背景形状。

- (void) setLabelExpression:

(NSString *)

var

设置标注字段表达式。

参数:

var

指定标注字段表达式。

- (void) setMaxLabelLength:

(NSInteger)

value

设置标签在每一行显示的最大长度,如果超过这个长度,将以省略号显示。

参数:

value

指定标签专题图中标记文本的最大长度。

- (void) setOffsetX:

(NSString *)

value

设置标签专题图中标记文本相对于要素内点的水平偏移量。标签偏移量的单位为地图单位。

该偏移量的值为一个常量值或者字段表达式所表示的值，即如果字段表达式为 SmID，其中 SmID=2，那么偏移量的值为 2。

参数:

value

指定标签专题图中标记文本相对于要素内点的水平偏移量。

- (void) setOffsetY:

(NSString *)

value

设置标签专题图中标记文本相对于要素内点的垂直偏移量。标签偏移量的单位为地图单位。

该偏移量的值为一个常量值或者字段表达式所表示的值，即如果字段表达式为 SmID，其中 SmID=2，那么偏移量的值为 2。

参数:

value

标签专题图中标记文本相对于要素内点的垂直偏移量。

- (void) setOverLengthMode:

(smOverLengthLabelMode)

value

设置超长标签的处理方式。对超长标签可以不作任何处理，也可以省略超出的部分，或者以换行方式进行显示。

参数:

value

指定超长标签的处理方式。

- (void) setRangeExpression:

(NSString *)

var

设置分段字段表达式。其中分段表达式中的值必须为数值型的。

用户根据该方法的设置值来比较其从开始到结束的每一个分段值，以确定采用什么风格来显示给定标注字段表达式相应的标注文本。

参数:

var

指定分段字段表达式。

- (BOOL) split:		(int)	index
SplitValue:		(double)	splitValue
Style1:		(TextStyle *)	style1
Caption1:		(NSString *)	caption1
Style2:		(TextStyle *)	style2
Caption2:		(NSString *)	caption2

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

注：splitValue 必须在拆分的范围之内。即大于标签专题图子项的起始值（Start）并且小于标签专题图子项的终止值（End）,如果不满足上述条件，则抛出异常。

参数:

	index	指定的标签专题图子项的序号。
	splitValue	指定的拆分分段值。
	style1	被拆分的两个标签专题图子项中的一个标签专题图子项的风格。
	caption1	被拆分的两个标签专题图子项中的一个标签专题图子项的名称。
	style2	被拆分的两个标签专题图子项中的另一个标签专题图子项的风格。
	caption2	被拆分的两个标签专题图子项中的另一个标签专题图子项的名称。

返回:

一个布尔值，拆分成功返回true，否则返回false。

- (NSString *) toString

返回标签专题图格式化字符串。

返回:

标签专题图格式化字符串。

---

成员数据文档

- (GeoStyle*) _mBackStyle [protected]

- (MixedTextStyle*) _mixedTextStyle [protected]

- (LabelMatrix*) _mLabelMatrix [protected]

- (NSMutableArray*) _mLableItems [protected]

- (GeoStyle*) _mLeaderLineStyle [protected]

- (RangeMode) _mRangeMode [protected]

- (Size2D*) _mSize2D [protected]

- (ThemeLabel*) _mThemeLabel [protected]

- (TextStyle*) _mUniformStyle [protected]

---

属性文档

- (AlongLineDirection) alongLineDirection [read, write, assign]

获取或设置标签沿线标注方向。

默认值为LEFT_TOP_TO_RIGHT_BOTTOM。

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

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

- (TextStyle*) mUniformStyle [read, write, assign]

获取或设置统一文本风格。

注：当 ThemeLabelItem 的个数大于等于1的时候，设置统一文本风格将不起作用。

默认值为 {Alignment=MiddleCenter,BackColor=Color [A=255, R=0, G=0, B=0],BackOpaque=False,Bold=False,FontHeight=4,FontWidth=0,ForeColor=Color [A=255, R=0, G=0, B=255],IsSizeFixed=True,Italic=False,Outline=False,Rotation=0,Shadow=False,Strikeout=False,Underline=False,Weight=0}

---

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

• ThemeLabel.h