| 包 | com.supermap.web.iServerJava2.components |
| 类 | public class Legend |
| 继承 | Legend  spark.components.supportClasses.SkinnableComponent |
图例控件用于显示与之关联的地图中所有图层及其子图层的标题及符号。其中图层将以一级结点显示于图例控件中，图层中所包含的子图层将以二级结点显示于控件中。若图层中包含专题图类型子图层，则该专题图所包含的专题子项以三级结点显示于控件中。
目前该控件支持 SuperMap iServer Java 2008 服务提供的动态分块图层（TiledDynamicIServerLayer）和动态图层（DynamicIServerLayer）两种。
| 属性 | 定义方 | ||
|---|---|---|---|
| isExpandChildrenItem : Boolean
是否展开所有结点。默认值为 true。
|
Legend | ||
| isShowOnlyVisibleLayers : Boolean
获取或设置图例控件中是否只显示可见图层，ture 表示仅显示可见图层，false 反之。默认值为 false。
|
Legend | ||
| layerIDs : Array
获取或设置要显示于图例控件中的图层 ID 集合。
|
Legend | ||
| layerItems : ArrayCollection
[read-only] 获取图例中所有一级节点的信息集合 .
|
Legend | ||
| map : Map
获取或设置与图例控件绑定的地图组件——Map。
|
Legend | ||
| 方法 | 定义方 | ||
|---|---|---|---|
|
Legend()
初始化 Legend 类的新实例。
|
Legend | ||
| 方法 | 定义方 | ||
|---|---|---|---|
|
getCurrentSkinState():String
[Override] 获取图例控件当前的状态，包括：disabled 和 normal 两种值.
|
Legend | ||
| 事件 | Summary | 定义方 | ||
|---|---|---|---|---|
| 当图例控件加载完成后触发。 | Legend | |||
| isExpandChildrenItem | 属性 |
isExpandChildrenItem:Boolean
是否展开所有结点。默认值为 true。
public function get isExpandChildrenItem():Boolean public function set isExpandChildrenItem(value:Boolean):void| isShowOnlyVisibleLayers | 属性 |
isShowOnlyVisibleLayers:Boolean
获取或设置图例控件中是否只显示可见图层，ture 表示仅显示可见图层，false 反之。默认值为 false。
public function get isShowOnlyVisibleLayers():Boolean public function set isShowOnlyVisibleLayers(value:Boolean):void| layerIDs | 属性 |
layerIDs:Array
获取或设置要显示于图例控件中的图层 ID 集合。
public function get layerIDs():Array public function set layerIDs(value:Array):void| layerItems | 属性 |
layerItems:ArrayCollection [read-only]
获取图例中所有一级节点的信息集合 .
集合中的每个元素代表一个一级节点，类型为 LegendItemInfo，一级节点的子节点信息均包含在属性 LegendItemInfo.layerItems 集合中，该属性中的每个元素又是一个 LegendItemInfo 对象，如此递归下去，图例中的节点呈现一种树状结构。
public function get layerItems():ArrayCollection另请参见
| map | 属性 |
map:Map
获取或设置与图例控件绑定的地图组件——Map。
public function get map():Map public function set map(value:Map):void| Legend | () | 构造函数 |
public function Legend()
初始化 Legend 类的新实例。
| getCurrentSkinState | () | 方法 |
override protected function getCurrentSkinState():String
获取图例控件当前的状态，包括：disabled 和 normal 两种值.
当属性 map 为 null，或 map.layers 为 null，或 Legend.enabled = false 时，图例控件的状态为 disabled，否则为 normal。
返回String — |
| legendLoaded | 事件 |
com.supermap.web.iServerJava2.components.LegendEvent当图例控件加载完成后触发。