com.supermap.web.iServerJava2.themeServices
public class ThemeLabel
继承 ThemeLabel Inheritance Theme Inheritance Object

标签专题图.

标签专题图是用文本的形式在图层中显示点、线、面等对象的属性信息,一般将文本型或数值型字段标注于图层中,如地名、道路名称、河流等级、宽度等信息。
标签专题图有两种表达方式:第一种为分段标签专题图。这种方法是对标签专题图进行分段,要求属性 rangeExpression 必须不为空并且合法,而且 items 中的每个子对象的 [Start,End] 分段值必须来源于属性 rangeExpression 的字段值;
第二种是统一标签专题图,即将指定图层的表达式的所有值使用统一的风格输出,这种情况下必须设置属性 LabelExpression,用于设定标签专题图所使用的字段,因此这种情况下属性 labelExpression 必须合法。
两种方法以第一种为主,即如果两种方法都设置合法,则优先使用第一种方式进行标签专题图的制作。
下图对各省、直辖市名称生成的标签专题图:



公共属性
  属性 定义方
    backStyle : ServerStyle
获取或设置标签的背景风格.
ThemeLabel
    isAlongLine : Boolean
获取或设置文本是否沿着线的方向标注。false 表示不沿线标注。默认值为 false。该属性仅对线图层和网络图层有效。
ThemeLabel
    isAngleFixed : Boolean
获取或设置当沿线显示文本时是否将文本角度固定。false 表示不固定,按照沿线角度显示文本。
ThemeLabel
    isFlowEnabled : Boolean
获取或设置是否流动显示标签。false 表示不流动.
ThemeLabel
    isLabelRepeated : Boolean
获取或设置当线对象较长时,是否进行循环标注。false 表示不进行循环标注.
ThemeLabel
    isLeaderLineDisplayed : Boolean
获取或设置是否显示标签和它标注对象之间的牵引线。false 表示不显示.
ThemeLabel
    isOverlapAvoided : Boolean
获取或设置是否允许以文本避让方式显示文本。true 表示自动避免文本叠盖.
ThemeLabel
    items : Array
获取或设置标签专题图子项 ThemeLableItem。
ThemeLabel
    labelBackShape : int
获取或设置标签专题图中标签的背景形状.
ThemeLabel
    labelExpression : String
获取或设置标注使用的字段或字段表达式。系统将设置的字段值以标签的形式显示在图层中。
ThemeLabel
    labelRepeatInterval : Number
获取或设置沿线循环标注的间隔。长度的单位与地图单位一致。只有当 IsLabelRepeated 为 true 时,该属性才有效。
ThemeLabel
    leaderLineStyle : ServerStyle
获取或设置标签与其标注对象之间牵引线的风格.
ThemeLabel
    maxLabelLength : Number
获取或设置标签单行显示的最大长度.
ThemeLabel
    offsetX : String
获取或设置标签专题图中标记相对于要素内点的水平偏移量,单位为地图单位.
ThemeLabel
    offsetY : String
获取或设置标签专题图中标记相对于要素内点的垂直偏移量,单位为地图单位.
ThemeLabel
    overLengthLabelMode : int
获取或设置超长标签处理模式
ThemeLabel
    rangeExpression : String
获取或设置分段字段表达式。.
ThemeLabel
  Inherited themeType : int
获取或设置专题图类型。
Theme
    uniformStyle : ServerTextStyle
获取或设置标签文本的统一风格.
ThemeLabel
公共方法
  方法 定义方
   
初始化 ThemeLable 类的新实例。
ThemeLabel
属性详细信息
backStyle 属性
backStyle:ServerStyle

获取或设置标签的背景风格.

当背景形状 LabelBackShape 属性为默认值,即不显示任何风格时,该属性无效。


Implementation
    public function get backStyle():ServerStyle
    public function set backStyle(value:ServerStyle):void
isAlongLine 属性  
isAlongLine:Boolean

获取或设置文本是否沿着线的方向标注。false 表示不沿线标注。默认值为 false。该属性仅对线图层和网络图层有效。


Implementation
    public function get isAlongLine():Boolean
    public function set isAlongLine(value:Boolean):void
isAngleFixed 属性  
isAngleFixed:Boolean

获取或设置当沿线显示文本时是否将文本角度固定。false 表示不固定,按照沿线角度显示文本。

默认值为: false.


Implementation
    public function get isAngleFixed():Boolean
    public function set isAngleFixed(value:Boolean):void
isFlowEnabled 属性  
isFlowEnabled:Boolean

获取或设置是否流动显示标签。false 表示不流动.

即标签会随着地图窗口的变化而移动以达到全部显示的优化效果,流动显示只适合于线和面要素的标注。

默认值为: false.


Implementation
    public function get isFlowEnabled():Boolean
    public function set isFlowEnabled(value:Boolean):void
isLabelRepeated 属性  
isLabelRepeated:Boolean

获取或设置当线对象较长时,是否进行循环标注。false 表示不进行循环标注.

例如:用于道路标注时,需要设定是否每隔一段距离重复显示道路标注。只有当标签设为沿线标注时,该属性有效,即 isAlongLine 属性值为 true。

默认值为: false.


Implementation
    public function get isLabelRepeated():Boolean
    public function set isLabelRepeated(value:Boolean):void

另请参见

isLeaderLineDisplayed 属性  
isLeaderLineDisplayed:Boolean

获取或设置是否显示标签和它标注对象之间的牵引线。false 表示不显示.

只有当 isFlowEnabled 为 true 且水平或垂直偏移量任意一值不为 0 时,牵引线会显示。

默认值为: false.


Implementation
    public function get isLeaderLineDisplayed():Boolean
    public function set isLeaderLineDisplayed(value:Boolean):void
isOverlapAvoided 属性  
isOverlapAvoided:Boolean

获取或设置是否允许以文本避让方式显示文本。true 表示自动避免文本叠盖.

该属性只针对标签专题图层中的文本数据。
异常:在标签重叠度很大的情况下,使用该属性可能无法实现自动避让功能。

默认值为: true.


Implementation
    public function get isOverlapAvoided():Boolean
    public function set isOverlapAvoided(value:Boolean):void
items 属性  
items:Array

获取或设置标签专题图子项 ThemeLableItem。


Implementation
    public function get items():Array
    public function set items(value:Array):void

另请参见

ThemeLableItem
labelBackShape 属性  
labelBackShape:int

获取或设置标签专题图中标签的背景形状.

背景形状可以是矩形、圆角矩形、菱形、椭圆形、三角形和符号等,默认为不显示任何背景。


Implementation
    public function get labelBackShape():int
    public function set labelBackShape(value:int):void

另请参见

labelExpression 属性  
labelExpression:String

获取或设置标注使用的字段或字段表达式。系统将设置的字段值以标签的形式显示在图层中。


Implementation
    public function get labelExpression():String
    public function set labelExpression(value:String):void
labelRepeatInterval 属性  
labelRepeatInterval:Number

获取或设置沿线循环标注的间隔。长度的单位与地图单位一致。只有当 IsLabelRepeated 为 true 时,该属性才有效。


Implementation
    public function get labelRepeatInterval():Number
    public function set labelRepeatInterval(value:Number):void

另请参见

leaderLineStyle 属性  
leaderLineStyle:ServerStyle

获取或设置标签与其标注对象之间牵引线的风格.

如果标签偏移对象,它们间可以用牵引线连接。


Implementation
    public function get leaderLineStyle():ServerStyle
    public function set leaderLineStyle(value:ServerStyle):void
maxLabelLength 属性  
maxLabelLength:Number

获取或设置标签单行显示的最大长度.

当注记长度超过这个长度,可以采用三种方式来处理:请参见 OverLengthLabelMode 类。

默认值为: 256.


Implementation
    public function get maxLabelLength():Number
    public function set maxLabelLength(value:Number):void
offsetX 属性  
offsetX:String

获取或设置标签专题图中标记相对于要素内点的水平偏移量,单位为地图单位.

可以直接输入数值设置偏移量;也可以选择该图层的一个数值型字段,使用字段值作为偏移量。例如设置水平偏移量为字段表达式 SmID 的值,若 SmID=2,那么水平偏移量的值为2。


Implementation
    public function get offsetX():String
    public function set offsetX(value:String):void
offsetY 属性  
offsetY:String

获取或设置标签专题图中标记相对于要素内点的垂直偏移量,单位为地图单位.

可以直接输入数值设置偏移量;也可以选择该图层的一个数值型字段,使用字段值作为偏移量。例如设置垂直偏移量为字段表达式 SmID 的值,若 SmID=2,那么垂直移量的值为2。


Implementation
    public function get offsetY():String
    public function set offsetY(value:String):void
overLengthLabelMode 属性  
overLengthLabelMode:int

获取或设置超长标签处理模式

默认值为: 0.


Implementation
    public function get overLengthLabelMode():int
    public function set overLengthLabelMode(value:int):void

另请参见

rangeExpression 属性  
rangeExpression:String

获取或设置分段字段表达式。.

该表达式对应的字段或字段表达式的值必须为数值型。当 RangeExpression 和 LabelExpression 都设置时,以 RangeExpression 属性优先。


Implementation
    public function get rangeExpression():String
    public function set rangeExpression(value:String):void

另请参见

uniformStyle 属性  
uniformStyle:ServerTextStyle

获取或设置标签文本的统一风格.

当标签专题图子项未设置 style 属性时,所有标签会以该风格显示;但如果专题图子项已设置 style 属性,该属性就不起作用。


Implementation
    public function get uniformStyle():ServerTextStyle
    public function set uniformStyle(value:ServerTextStyle):void
构造函数详细信息
ThemeLabel () 构造函数
public function ThemeLabel()

初始化 ThemeLable 类的新实例。