| 包 | com.supermap.web.gears.components |
| 类 | public class LegendItemInfo |
| 继承 | LegendItemInfo  Object |
| Implements | flash.events.IEventDispatcher |
该类用于描述图例控件（Legend）中的结点信息，即每个结点可以用一个 LegendItemInfo 对象进行描述，包括结点名称、与结点关联的图层是否可见、子结点信息等等。
| 属性 | 定义方 | ||
|---|---|---|---|
| caption : String | LegendItemInfo | ||
| description : String
获取或设置图例子项描述信息。
|
LegendItemInfo | ||
| imageHeight : Number
获取或设置图例子项符号高度，默认为 16，单位：像素。该属性最大取值为 24。
|
LegendItemInfo | ||
| imageSource : String
获取图例子项符号路径，默认为服务端返回的图层图标资源地址，如：“http://localhost:8090/iserver/services/map-world/rest/maps/世界地图/layers/ContinentLabel@World@@世界地图/legend.png?height=16&width=16”.
|
LegendItemInfo | ||
| imageWidth : Number
获取或设置图例子项符号宽度，默认为 16，单位：像素。该属性最大取值为 24。
|
LegendItemInfo | ||
| isVisible : Boolean
获取图例子项对应的结点是否可见。默认值为 true 如果用户设置此属性，会立即改变图例子项对应结点的可见性，但并不影响地图中对应图层的可见性。
|
LegendItemInfo | ||
| layerItems : ArrayCollection
[read-only] 获取图例子项的所有子结点信息集合。集合中的每个元素均是一个 LegendItemInfo 对象。
|
LegendItemInfo | ||
| name : String
获取或设置图例子项对应的结点名称。由服务端返回的图层 name 字段作为初始值。
|
LegendItemInfo | ||
| 方法 | 定义方 | ||
|---|---|---|---|
|
初始化 LegendItemInfo 类的新实例。
|
LegendItemInfo | ||
|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
|
LegendItemInfo | ||
|
dispatchEvent(event:Event):Boolean
|
LegendItemInfo | ||
|
hasEventListener(type:String):Boolean
|
LegendItemInfo | ||
|
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
|
LegendItemInfo | ||
|
willTrigger(type:String):Boolean
|
LegendItemInfo | ||
| caption | 属性 |
caption:String
此属性可用作数据绑定的源。修改此属性后，将调度 Bindable 事件。
public function get caption():String public function set caption(value:String):void| description | 属性 |
description:String
获取或设置图例子项描述信息。
此属性可用作数据绑定的源。修改此属性后，将调度 Bindable 事件。
public function get description():String public function set description(value:String):void| imageHeight | 属性 |
imageHeight:Number
获取或设置图例子项符号高度，默认为 16，单位：像素。该属性最大取值为 24。
此属性可用作数据绑定的源。修改此属性后，将调度 Bindable 事件。
public function get imageHeight():Number public function set imageHeight(value:Number):void| imageSource | 属性 |
imageSource:String
获取图例子项符号路径，默认为服务端返回的图层图标资源地址，如：“http://localhost:8090/iserver/services/map-world/rest/maps/世界地图/layers/ContinentLabel@World@@世界地图/legend.png?height=16&width=16”.
例如，SuperMap 桌面产品中用如下图所示的图片来表示单值专题图：
用户可通过该属性使用自已的图片作为图例的标识符号。
此属性可用作数据绑定的源。修改此属性后，将调度 Bindable 事件。
public function get imageSource():String public function set imageSource(value:String):void| imageWidth | 属性 |
imageWidth:Number
获取或设置图例子项符号宽度，默认为 16，单位：像素。该属性最大取值为 24。
此属性可用作数据绑定的源。修改此属性后，将调度 Bindable 事件。
public function get imageWidth():Number public function set imageWidth(value:Number):void| isVisible | 属性 |
isVisible:Boolean
获取图例子项对应的结点是否可见。默认值为 true
如果用户设置此属性，会立即改变图例子项对应结点的可见性，但并不影响地图中对应图层的可见性。
public function get isVisible():Boolean public function set isVisible(value:Boolean):void| layerItems | 属性 |
layerItems:ArrayCollection [read-only]
获取图例子项的所有子结点信息集合。集合中的每个元素均是一个 LegendItemInfo 对象。
public function get layerItems():ArrayCollection| name | 属性 |
name:String
获取或设置图例子项对应的结点名称。由服务端返回的图层 name 字段作为初始值。
此属性可用作数据绑定的源。修改此属性后，将调度 Bindable 事件。
public function get name():String public function set name(value:String):void| LegendItemInfo | () | 构造函数 |
public function LegendItemInfo()
初始化 LegendItemInfo 类的新实例。
| addEventListener | () | 方法 |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
参数
type:String |
|
listener:Function |
|
useCapture:Boolean (default = false) |
|
priority:int (default = 0) |
|
weakRef:Boolean (default = false) |
| dispatchEvent | () | 方法 |
public function dispatchEvent(event:Event):Boolean
参数
event:Event |
Boolean |
| hasEventListener | () | 方法 |
public function hasEventListener(type:String):Boolean
参数
type:String |
Boolean |
| removeEventListener | () | 方法 |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
参数
type:String |
|
listener:Function |
|
useCapture:Boolean (default = false) |
| willTrigger | () | 方法 |
public function willTrigger(type:String):Boolean
参数
type:String |
Boolean |