# Fusion.Widget.Legend

A widget to display a legend of all layers.

#### Inherits from

- Fusion.Widget

Summary

Fusion.Widget.Legend | A widget to display a legend of all layers.
Constants |
defaultLayerDWFIcon | {String} The default image for DWF layer
defaultLayerRasterIcon | {String} The default image for Raster layer
defaultLayerThemeIcon | {String} The default image for layers that are currently themed.
defaultDisabledLayerIcon | {String} The default image for layers that are out of scale.
defaultRootFolderIcon | {String} The default image for the root folder
defaultLayerInfoIcon | {String} The default image for layer info
defaultGroupInfoIcon | {String} The default image for groupd info
outOfRangeIcon | {String}: The default image for layers outside the current visible scale range
Fusion.Widget.Legend.LegendRenderer | This is a class designed to help users to create their own renderer for customize the legend.
Properties |
oLegend | {Fusion.Widget.Legend} The parent widget that uses the renderer.
layerRoot | {Groups} The groups of all layers.
Functions |
renderLegend | Abstract method that have the main purpose to draw the legend.
mapLoaded | Abstract method that handle the event: Fusion.Event.MAP_LOADED.
mapReloaded | Abstract method that handle the event: Fusion.Event.MAP_RELOADED.
mapRefresh | Abstract method that handle the event: Fusion.Event.MAP_LAYER_ORDER_CHANGED.
getMap | Helper method to obtains the map.
Fusion.Widget.Legend.LegendRendererDefault | This class provide a default legend as a collapsable tree.
Properties |
showRootFolder | {Boolean} This controls whether the tree will have a single root node that contains the name of the map as its label.
currentNode | {Jx.TreeNode} The current selected node.
bIsDrawn | {Boolean} Determine if the map is drawn.
updateDelay | {Integer} number of milliseconds to delay the update of legend
targetFolder | {Jx.TreeFolder} The current TreeFolder that the mouse will interact with.
bIncludeVisToggle | {Boolean} Determine if non-visible layer must be draw in the legend.

### Constants

### defaultLayerDWFIcon

{String} The default image for DWF layer

### defaultLayerRasterIcon

{String} The default image for Raster layer

### defaultLayerThemeIcon

{String} The default image for layers that are currently themed.

### defaultDisabledLayerIcon

{String} The default image for layers that are out of scale.

### defaultRootFolderIcon

{String} The default image for the root folder

### defaultLayerInfoIcon

{String} The default image for layer info

### defaultGroupInfoIcon

{String} The default image for groupd info

### outOfRangeIcon

{String}: The default image for layers outside the current visible scale range

## Fusion.Widget.Legend.LegendRenderer

This is a class designed to help users to create their own renderer for customize the legend.

Summary

Properties |
oLegend | {Fusion.Widget.Legend} The parent widget that uses the renderer.
layerRoot | {Groups} The groups of all layers.
Functions |
renderLegend | Abstract method that have the main purpose to draw the legend.
mapLoaded | Abstract method that handle the event: Fusion.Event.MAP_LOADED.
mapReloaded | Abstract method that handle the event: Fusion.Event.MAP_RELOADED.
mapRefresh | Abstract method that handle the event: Fusion.Event.MAP_LAYER_ORDER_CHANGED.
getMap | Helper method to obtains the map.

### Properties

### oLegend

{Fusion.Widget.Legend} The parent widget that uses the renderer.

### layerRoot

{Groups} The groups of all layers.

### Functions

### renderLegend

> renderLegend: function()

Abstract method that have the main purpose to draw the legend. This method should be implemented by all concrete class.

### mapLoaded

> mapLoaded: function()

Abstract method that handle the event: Fusion.Event.MAP_LOADED. This method occur only at the first load of the map and should be implemented by all concrete class.

### mapReloaded

> mapReloaded: function()

Abstract method that handle the event: Fusion.Event.MAP_RELOADED. This method should be implemented by all concrete class.

### mapRefresh

> mapRefresh: function()

Abstract method that handle the event: Fusion.Event.MAP_LAYER_ORDER_CHANGED. This method should be implemented by all concrete class.

### getMap

> getMap: function()

Helper method to obtains the map.

#### Returns

{<Fusion.Maps>} The map that uses the SelectionPanel Widget.

## Fusion.Widget.Legend.LegendRendererDefault

This class provide a default legend as a collapsable tree.

Summary

Properties |
showRootFolder | {Boolean} This controls whether the tree will have a single root node that contains the name of the map as its label.
currentNode | {Jx.TreeNode} The current selected node.
bIsDrawn | {Boolean} Determine if the map is drawn.
updateDelay | {Integer} number of milliseconds to delay the update of legend
targetFolder | {Jx.TreeFolder} The current TreeFolder that the mouse will interact with.
bIncludeVisToggle | {Boolean} Determine if non-visible layer must be draw in the legend.

### Properties

### showRootFolder

{Boolean} This controls whether the tree will have a single root node that contains the name of the map as its label. By default, the root node does not appear. Set to “true” or “1” to make the root node appear.

### currentNode

{Jx.TreeNode} The current selected node.

### bIsDrawn

{Boolean} Determine if the map is drawn.

### updateDelay

{Integer} number of milliseconds to delay the update of legend

### targetFolder

{Jx.TreeFolder} The current TreeFolder that the mouse will interact with.

### bIncludeVisToggle

{Boolean} Determine if non-visible layer must be draw in the legend.

A widget to display a legend of all layers.

> renderLegend: function()

Abstract method that have the main purpose to draw the legend.

> mapLoaded: function()

Abstract method that handle the event: Fusion.Event.MAP_LOADED.

> mapReloaded: function()

Abstract method that handle the event: Fusion.Event.MAP_RELOADED.

> mapRefresh: function()

Abstract method that handle the event: Fusion.Event.MAP_LAYER_ORDER_CHANGED.

> getMap: function()

Helper method to obtains the map.
This is the base class for all widgets.
Close