nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Table of Contents - Legend Widget for FlexViewer 2.x

RobertScheitlin__GISP

All,

Here is the next in my line of widgets for the FlexViewer 2.x.

The legend portion of this widget is the same code as my dynamic legend widget so,

IT IS FOR ARCGIS SERVER 10 OR GREATER ONLY

This is just a simple TOC Widget that includes my dynamic legend component.
This widget also includes my enhancement for map service transparency,
right click context menu for zoom to make layer visible, and my scale
dependent renderer for the TOC checkboxes.

Find more posts tagged with

Accepted answers

All comments

JeffLegato

Jeff,
However, curious if you still have the issues if you set the mapswitcherwidget.xml layerlist tag to false? <layerlist visible="false"> since the TOC widget is not designed to run with it set to true?

That did it!!

Thanks a million! I'll be sure to disable that in my apps!

Jeff

RobertScheitlin__GISP

Jeff,

Rhett is spot on. The readme.txt warns:

It is your responsibility to disable the layerlist portion of the MapSwitcherWidget or eMapSwitcherWidget by setting the
<layerlist visible="false">
Also ensure you do not use the TOCWidget with the LayerListWidget.

BradChampagne

I have a map service with several group layers, one group has 3 layers (2 polygon, 1 raster) and the polygon layers have labels. When I turn the group checkbox off/on in the TOC widget, all layers turn off/on including labels as expected. Problem occurs when I add both polygon layers to the <excludelayers> section in TOCWidget.xml. When I turn the group layer off (it's on by default), the features and labels disappear from the map (so far so good), but when I turn the group layer back on, the features appear but no labels. Turning the group layer on/off has no affect on making the labels reappear. Am using Flex Viewer 3.3 and ArcGIS Server 10.1.

Brad

RhettZufelt

Brad,

The TOC widget lets you exlude layer(s) by layer label in the config.xml. If you add the label of a layer to the exlude section of the TOC, you should not see that service in the TOC to be able to turn on/off in the first place.

It sounds like you are trying to exclude a sub-layer from the TOC. I don't see anywhere that says that is possible, unless the sub-layer was loaded separatly so that it had it's own <layer> tag in the config.xml file.

R_

BradChampagne

Rhett,

Yes, they are sub-layers that I'm excluding, and the TOC-Legend widget allows that using this type of code in TOCWidget.xml:

<excludelayers>
<excludelayer mapservice="ACLMV2">32</excludelayer> 
<excludelayer mapservice="ACLMV2">33</excludelayer> 
</excludelayers>

32 and 33 are the index values for the layers in the ACLMV2 map service. I want to hide those layers from the Map Contents list, but I want the layers to behave normally when their group layer is turned on and off. The features behave normally, but unfortunately the labels do not.

Brad

RobertScheitlin__GISP

Brad,

I am dealing with a lot of 3.4 upgrade stuff right now and normal work so I will have to take a look at this when time allows. Obviously it should not be doing what it is doing with the labels not coming back on. 😞

RhettZufelt

Brad, you are correct, it seems I was a little confused..... or something.....

Anyway, I'd have to defer to Robert's post above.

R_

RobertScheitlin__GISP

Rhett,

I guess the pdf does not explain this ability but it is listed in the ReadMe.txt
Version 2.3.5 - 7 June, 2011

* Whole map services AND/OR INDIVIDUAL layers can be excluded from the TOC.

RhettZufelt

I see that now. Just had a momentary BF today.

R_

BenScott1

Hi Robert - again thankyou for a great widget.

I am experiencing an error which a few others have reported, in that I am getting a blank table of contents on first load. When this occurs all other widgets in the viewer cease to function as well. The problem reappears when the viewer is first opened or straight after the browser cache has been cleared. Once the page is refreshed it works fine.

I have done some testing with different services etc and have found that the problem occurs with as few as two dynamic services which have 7 layers each if there are popups configured for each sublayer. When no popups are specified the toc works fine with a large number of dynamic services. It also seems to work fine with tiled services regardless of number of services and popups.

Specifying a large legend timeout time in the config doesn't seem to fix the problem. The normal layer list widget configured for the same services etc works ok.

Cheers,
Ben

RobertScheitlin__GISP

Ben,

Thanks for narrowing down the issue to DLs with popups configured for sublayers. It is likely that I will be retiring this widget in lieu of an enhanced LayerListWidget soon as I have added most of the TOCWidget features to esris LayerListWidget and it has better response time for rendering and does not require some of the work arounds in code that I had to do for the TOC Widget. I will let the community know one way or another.

GISDev1

Hi Robert - again thankyou for a great widget.

I am experiencing an error which a few others have reported, in that I am getting a blank table of contents on first load. When this occurs all other widgets in the viewer cease to function as well. The problem reappears when the viewer is first opened or straight after the browser cache has been cleared. Once the page is refreshed it works fine.

I have done some testing with different services etc and have found that the problem occurs with as few as two dynamic services which have 7 layers each if there are popups configured for each sublayer. When no popups are specified the toc works fine with a large number of dynamic services. It also seems to work fine with tiled services regardless of number of services and popups.

Specifying a large legend timeout time in the config doesn't seem to fix the problem. The normal layer list widget configured for the same services etc works ok.

Cheers,
Ben

You might want to give this a shot if you are still seeing this issue. No guarantees it won't break your entire application or anything, but it fixed the problem for me.

This is how I fixed this in the createChildren function in TocMapLayerItem.as found in Robert's TOC Widget v 3.3.0 (5/6/13) code here: /widgets/TOC/toc/tocClasses/TocMapLayerItem.as around line 912:

private function createChildren():void
     {
         children = null;
         var layerInfos:Array; // of LayerInfo
         var visibleLayers:Array;
   var li:LayerInfo;
         if (layer is ArcGISTiledMapServiceLayer){
             layerInfos = ArcGISTiledMapServiceLayer(layer).layerInfos;
  
         }else if (layer is ArcGISDynamicMapServiceLayer){
    var arcGISDynamicMapServiceLayer:ArcGISDynamicMapServiceLayer = ArcGISDynamicMapServiceLayer(layer);
    
    if (arcGISDynamicMapServiceLayer.visibleLayers == null) { //Added if check for bugfix
     trace("found null");
    }
    else {
     arcGISDynamicMapServiceLayer.visibleLayers.addEventListener(CollectionEvent.COLLECTION_CHANGE, visibleLayersChangeHandler);
    }
    
    _visibleLayersChangeWatcher = ChangeWatcher.watch(arcGISDynamicMapServiceLayer, "visibleLayers", visibleLayersChange);
    
    _dynamicMapServiceLayerInfos = arcGISDynamicMapServiceLayer.dynamicLayerInfos ? arcGISDynamicMapServiceLayer.dynamicLayerInfos : arcGISDynamicMapServiceLayer.layerInfos; //Added per commit on GH
         
    
    if (_isVisibleLayersSet){
....all code is the same for the rest of the createChildren function

GISDev1

Ben,

Thanks for narrowing down the issue to DLs with popups configured for sublayers. It is likely that I will be retiring this widget in lieu of an enhanced LayerListWidget soon as I have added most of the TOCWidget features to esris LayerListWidget and it has better response time for rendering and does not require some of the work arounds in code that I had to do for the TOC Widget. I will let the community know one way or another.

Thanks for keeping us updated on your development plans for your awesome TOC widget Robert. Much appreciated. I am looking forward to seeing the Enhanced LayerListWidget.

RobertScheitlin__GISP

All,

This widget has now been retired. For Flex Viewer 3.4 and above start using the Enhanced Layer List Widget:

http://www.arcgis.com/home/item.html?id=58d9bb5693c94918a3934781d7234d18

BenScott1

Ben,

Thanks for narrowing down the issue to DLs with popups configured for sublayers. It is likely that I will be retiring this widget in lieu of an enhanced LayerListWidget soon as I have added most of the TOCWidget features to esris LayerListWidget and it has better response time for rendering and does not require some of the work arounds in code that I had to do for the TOC Widget. I will let the community know one way or another.

Thanks Robert - much appreciated.

Patrick Huls

Hi Robert,

I am having an issue with the settings in the XML file. I am using the 3.5 complied version, and I have changed the visibility label and I have chosen to not collapse the legends so that the symbology is showing and the user does not need to expand everything, but my changes in the XML are not reflected in the widget. Do you know what that is? Thanks.

[ATTACH=CONFIG]28138[/ATTACH]

Capture.JPG

RobertScheitlin__GISP

Patrick,

If you need everything expanded at startup then you need to set the expand tag to true and its everything attribute to true as well.

Patrick Huls

Patrick,

If you need everything expanded at startup then you need to set the expand tag to true and its everything attribute to true as well.

I don't want everything expanded, just the legend/symbology. Also, I changed the widget label to 'Legend,' but it still says 'Layer Visibility.' Thanks.

RobertScheitlin__GISP

Patrick,

There is NO option to have the legends expanded and not thier parent nodes. You need to check if you are pointing to the correct xml file in the main config.xml and that you have cleared your browsers cache.

Patrick Huls

Patrick,

There is NO option to have the legends expanded and not thier parent nodes. You need to check if you are pointing to the correct xml file in the main config.xml and that you have cleared your browsers cache.

Yeah, I've cleared my cache and am having the same issues. What does the <collapselegends></collapselegends> tag do? Before when I had it set to FALSE, the legends were automatically expanded under the layer, but now, switching back and forth from TRUE to FALSE has no differentiating effect on the widget.

Thanks again for your help.

RobertScheitlin__GISP

Patrick,

Something is definitely off then. The collapselegends tag specifies whether the legend swatch is visible by default when the parent node is expanded. So here is an example of how to expand all nodes without their legends being visible:

        <expanded everything="false">true</expanded>
        <collapselegends>true</collapselegends>

If you set the everything attribute to true this overrides the collapselegends tag.

I found an bug in the widget and the visibilitylabel is not used. In version 3.5 add a title tag instead.

    <labels>
        <title>Legend</title>
        <expandall>Expand All Layers</expandall>
        <collapseall>Collapse All Layers</collapseall>
        <zoomtomakevisible>Zoom To Make Visible</zoomtomakevisible>
    </labels>

Patrick Huls

Patrick,

Something is definitely off then. The collapselegends tag specifies whether the legend swatch is visible by default when the parent node is expanded. So here is an example of how to expand all nodes without their legends being visible:
        <expanded everything="false">true</expanded>
        <collapselegends>true</collapselegends>
If you set the everything attribute to true this overrides the collapselegends tag.

I found an bug in the widget and the visibilitylabel is not used. In version 3.5 add a title tag instead.
    <labels>
        <title>Legend</title>
        <expandall>Expand All Layers</expandall>
        <collapseall>Collapse All Layers</collapseall>
        <zoomtomakevisible>Zoom To Make Visible</zoomtomakevisible>
    </labels>

Thanks, I added the <title> and it works fine now. And I do want the legend swatch to be visible by default. So I have it as:
<expanded everything="false">false</expanded>
<collapselegends>false</collapselegends>
But when I expand the layer items, I must expand again to see the symbols and its not showing by default.

RobertScheitlin__GISP

Patrick,

Yep, it will not work the way you want it to. The legends with only be open by default if the parent node is open by default.

Patrick Huls

Okay, thanks Robert. I think just remember it working that way when it was the TOC widget. Thanks for the clarification.

RobertScheitlin__GISP

Patrick,

Hmm... Something I will have to look into then.

KeisukeNozaki

I am trying to exclude one layer in the legend.

<excludelayers>
<excludelayer mapservice="mcdonough_highway">white_background</excludelayer>
</excludelayers>

I confirmed map service and layer name are correct.
But the layer still shows up.
Please let me know if I am missing something.
I use TOC widget 3.3.
Thank you.

Keisuke

RobertScheitlin__GISP

Keisuke,

I see that I do not cover this in the documentation. What you have to do is use the mapservice name but the layer ID not a string.

<excludelayers>
    <excludelayer mapservice="mcdonough_highway">2,3,5</excludelayer>
    </excludelayers>

<excludelayers>
    <excludelayer mapservice="mcdonough_highway">1</excludelayer>
    </excludelayers>

BretWhiteley1

Robert, I am trying to create a legend in the FLEX viewer (using builder) that allows for layer groupings. I contacted ESRI Tech Support and they indicated that the best way to achieve this is through the use of your tool. I downloaded and successfully added the widget "For_AppBuilder3.5" to my FLEX builder. Now I am trying to figure out how to actually group the layers I want grouped. When I published the data from ArcMAP (10.1 sp1), it was grouped and as such the layer id from the REST service skips numbers where the layer group is. I have tried to find documentation regarding your widget on how to achieve the grouping - but cannot seem to find it. Can you provide a link to instructions?

I should qualify that I am using feature services, not map services!!

Thanks kindly for a great service.

Bret.

KeisukeNozaki

Robert,

I thought it worked, but the layer still shows up.
The layer I want to hide is http://gis.wiu.edu/arcgis/rest/services/mcdonough_highway/MapServer/28 and here is my code.

<configuration>
<labels>
<visibilitylabel>Layer Visibility</visibilitylabel>
<expandall>Expand All Layers</expandall>
<collapseall>Collapse All Layers</collapseall>
<zoomtomakevisible>Zoom To Make Visible</zoomtomakevisible>
<generatinglegendmsg>Generating TOC Legend</generatinglegendmsg>
</labels>
<tocsettings>
<expanded everything="false">true</expanded>
<collapselegends>true</collapselegends>
<disablezoomtomenuoption>false</disablezoomtomenuoption>
</tocsettings>
<excludelayers>
<excludelayer mapservice="mcdonough_highway">28</excludelayer>
</excludelayers>
<excludegraphiclayers>true</excludegraphiclayers>
<excludebasemaplayers>true</excludebasemaplayers>
<usenewesridescription>false</usenewesridescription>
</configuration>

Thank you for your time.

Keisuke

RobertScheitlin__GISP

Bret,

Not sure what the analyst was thinking of but there is not a way to configure groups in my eLayerList Widget (which must be the one you are using, as the TOC widget was retired, and is not available for 3.5). If you have grouped layers ArcMap then they will be grouped in the Layer List Widget and the eLayer List Widget as well.

Join the Conversation

Signed in members can post, follow updates, and more. New here? Register a free account.

Quick Links

Community Help
Find useful guides, FAQs, and documents to help you navigate and make the most of Esri Community.