| 1 | [[PageOutline]] |
| 2 | [[BR]] |
| 3 | || '''Automatically generated page, do not modify. User Notes can be created at: [wiki:Widgets/LegendUsageNotes]'''|| |
| 4 | [[BR]] |
| 5 | |
| 6 | = Widget: Legend = |
| 7 | |
| 8 | A widget that displays a listing of all layers that make up the map as a tree structure |
| 9 | |
| 10 | == Usage Notes == |
| 11 | |
| 12 | See: [wiki:Widgets/LegendUsageNotes] |
| 13 | |
| 14 | == Common Widget Properties == |
| 15 | |
| 16 | * '''Location''' : |
| 17 | * '''Label''' : Legend |
| 18 | * '''Tooltip''' : Map Legend |
| 19 | * '''StatusText''' : |
| 20 | * '''ImageUrl''' : |
| 21 | * '''ImageClass''' : |
| 22 | * '''StandardUi''' : false |
| 23 | * '''ContainableBy''' : |
| 24 | |
| 25 | == Parameters == |
| 26 | |
| 27 | === HideInvisibleLayers === |
| 28 | |
| 29 | * '''Description''' : Suppress invisible layers from the legend |
| 30 | * '''Type''' : boolean |
| 31 | * '''Label''' : Hide Invisible Layers |
| 32 | * '''DefaultValue''' : false |
| 33 | * '''IsMandatory''' : false |
| 34 | |
| 35 | === ShowRootFolder === |
| 36 | |
| 37 | * '''Description''' : flag to indicate if the root folder is shown |
| 38 | * '''Type''' : boolean |
| 39 | * '''Label''' : Show the root folder |
| 40 | * '''DefaultValue''' : false |
| 41 | * '''IsMandatory''' : false |
| 42 | |
| 43 | === ShowMapFolder === |
| 44 | |
| 45 | * '''Description''' : flag to indicate if the map folder is shown |
| 46 | * '''Type''' : boolean |
| 47 | * '''Label''' : Show the map folder |
| 48 | * '''DefaultValue''' : false |
| 49 | * '''IsMandatory''' : false |
| 50 | |
| 51 | === LayerRasterIcon === |
| 52 | |
| 53 | * '''Description''' : Icon to use for raster layers |
| 54 | * '''Type''' : String |
| 55 | * '''Label''' : Raster layer icon |
| 56 | * '''DefaultValue''' : images/icons/legend-raster.png |
| 57 | * '''IsMandatory''' : false |
| 58 | |
| 59 | === LayerDWFIcon === |
| 60 | |
| 61 | * '''Description''' : Icon to use for DWF layers |
| 62 | * '''Type''' : String |
| 63 | * '''Label''' : DWF layer icon |
| 64 | * '''DefaultValue''' : images/icons/legend-DWF.png |
| 65 | * '''IsMandatory''' : false |
| 66 | |
| 67 | === LayerThemeIcon === |
| 68 | |
| 69 | * '''Description''' : Icon to use for theme layers |
| 70 | * '''Type''' : String |
| 71 | * '''Label''' : Theme layer icon |
| 72 | * '''DefaultValue''' : images/icons/legend-theme.png |
| 73 | * '''IsMandatory''' : false |
| 74 | |
| 75 | === DisabledLayerIcon === |
| 76 | |
| 77 | * '''Description''' : Icon to use for disabled layers |
| 78 | * '''Type''' : String |
| 79 | * '''Label''' : Disabled layer icon |
| 80 | * '''DefaultValue''' : images/icons/legend-layer.png |
| 81 | * '''IsMandatory''' : false |
| 82 | |
| 83 | === LayerInfoIcon === |
| 84 | |
| 85 | * '''Description''' : Icon to use for layer information |
| 86 | * '''Type''' : String |
| 87 | * '''Label''' : Layer information icon |
| 88 | * '''DefaultValue''' : images/icons/tree_layer_info.png |
| 89 | * '''IsMandatory''' : false |
| 90 | |
| 91 | === GroupInfoIcon === |
| 92 | |
| 93 | * '''Description''' : Icon to use for layer groups |
| 94 | * '''Type''' : String |
| 95 | * '''Label''' : Group information icon |
| 96 | * '''DefaultValue''' : images/icons/tree_group_info.png |
| 97 | * '''IsMandatory''' : false |
| 98 | |
| 99 | === RootFolderIcon === |
| 100 | |
| 101 | * '''Description''' : Icon to use for the root folder |
| 102 | * '''Type''' : String |
| 103 | * '''Label''' : Map root folder icon |
| 104 | * '''DefaultValue''' : images/icons/legend-map.png |
| 105 | * '''IsMandatory''' : false |
| 106 | |