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; } } }

Another Enhanced TOC/Legend Widget

ZillaPlace

Hi guys,

I don't like an idea of separating TOC and legend. Maybe I am an old-fashion guy, but I like to have a widget where I could see icons and names, turn on/off layers, tell whether or not a layer is in its display scale range. And it has to handle sublayers because I have a lot of layers with subtypes. It would be cool if I could click a layer and see the layer properties. It doesn't have to show all of them, but just some major pieces. You know, something like the TOC in ArcMap.

And some of my friends are still using 9.3.1 and others have gone to 10. The widget should work for all of them, although I wouldn't mind telling them that it runs faster and more smoothly with 10. The widget should load the legend for a meshup of services hosted on either 10 or 9.3.1.

If you were like me, take a look at this widget. You may like it. It's a beta version developed on FlexViewer 2.2.

Find more posts tagged with

Accepted answers

All comments

PeterHoffman

I have tried this legend 2 widget on my api 2.5 project and I am getting this error when I run it:

TypeError: Error #1009: Cannot access a property or method of a null object reference.
at com.esri.viewer.managers::WidgetManager/createWidget()
at com.esri.viewer.managers::WidgetManager/runWidget()
at com.esri.viewer.managers::WidgetManager/widgetReadyHandler()
at flash.events::EventDispatcher/dispatchEventFunction()
at flash.events::EventDispatcher/dispatchEvent()
at ModuleInfoProxy/moduleEventHandler()
at flash.events::EventDispatcher/dispatchEventFunction()
at flash.events::EventDispatcher/dispatchEvent()
at ModuleInfo/readyHandler()
at flash.events::EventDispatcher/dispatchEventFunction()
at flash.events::EventDispatcher/dispatchEvent()
at mx.core::FlexModuleFactory/update()
at mx.core::FlexModuleFactory/docFrameHandler()
at mx.core::FlexModuleFactory/docFrameListener()

The legend widget that comes with the api works fine.

Any ideas?

andreasen315

Plaizilla-

I'm trying to use your widget in my web mapping application and (being a newbie) I'm having trouble.

I added the code in the Viewer config file and saved the Legend2 folder to the widget folder. Then, I put the SOAP URL in the Arcgis.com shared tool (http://arcgis.com/sharing/tools/legend?soapUrl=xyz&f=html) and generated the TOC (as HTML). The TOC looks great.

What is the next step after that? I was anticipating entering the URL of the shared tool page in the widget config file (xml), but I did not identify a place to add that. Did I miss something or should I be doing something else?

Can you help, or direct me to a resource that can help me figure out what to do next?

Thanks

LeeAllen

Hi I am looking for the JavaScript sample that does exaclty what is shown on your picture. Does it work on ArcGIS 9.3.1. Woudl you share the code or any leads.

Many thanks,
Lawrence
City of London

I do not actually have that javascript code, it was just from another site that I was looking at.

chena

I wonder if the author release the source code or not. If so, would you please share it here? thanks

AM

Hi I am looking for the JavaScript sample that does exaclty what is shown on your picture. Does it work on ArcGIS 9.3.1. Woudl you share the code or any leads.

Many thanks,
Lawrence
City of London

LawrenceDhliwayo

I looks like there are multiple requests on the widget comments to please release code, me being one of them. This is a great widget, and I really want to implement!!

I have another request/improvement: Since you now have the symbol and layer name showing up together, is it possible to have the symbol to the left of the layer name instead of below? This would save much needed space and excessive scrolling. I have seen this in javascript, picture example is below.

[ATTACH=CONFIG]5691[/ATTACH]

Hi I am looking for the JavaScript sample that does exaclty what is shown on your picture. Does it work on ArcGIS 9.3.1. Woudl you share the code or any leads.

Many thanks,
Lawrence
City of London

LeeAllen

Bump on the code request.

Great job! This TOC/Legend widget is exactly what I need. I've got it running but I'm using a custom widget skin in my application and I'd like to monkey with the styling a bit.

Offering a six pack of your choosing.

Thanks.

That's my only need for the code as well, so I can use it with custom skins. Make that two six packs!!

MarcCavallaro

Bump on the code request.

Great job! This TOC/Legend widget is exactly what I need. I've got it running but I'm using a custom widget skin in my application and I'd like to monkey with the styling a bit.

Offering a six pack of your choosing.

Thanks.

JacksonTrappett

Two questions:
1. Does anyone have a link to a working sample where I could take a look at this legend widget?

2. Plaizilla, you are still the only person who has written a widget like this. Any possibility of releasing the code? Having this as a widget doesn't work for my app, since my table of contents is not running as a widget, and I am also not using the flex viewer so I can't even load it at all.

EmilyLaMunyon

Thanks Denise. After looking at the post, I noticed the space. It is not in my REST url, just a typo in the post. I appreciate your response!

DeniseMoore

Hi Emily,

If your URL is printed exactly as you have it in your code, I think you have an extra space before public
HTH,
D

EmilyLaMunyon

Hi Plaizilla,
Great widget! I am having some issues getting it to work with my map though. I am using a 9.3 server and my rest service is public, however I am getting an error that reads:
Error: Unable to generate legends: EndpointAddress - URL is not a valid URL

/www.gis.slco.org/wwwrest/services/ public/Weeds/MapServer/

Do you have any insight?

Thanks, Emily.

ErwanCaradec

Plaizilla,
sorry my services are not reachable from the public internet.

* for the null object reference, i tried to compile it myself with the source code that was included in the zip file (they are not anymore included now ?) and then didn't have the error, i tried with the last compiled one and still have the error. Any idea ?
* for the toggle problem, at the initialization, when a group layer is uncheched, in debug mode i saw that the trace of visible layers was updated correctly but not the layers visibility on the map. Then i uncheck and check again the service, and after when the group is toggled it is ok.

Erwan

AlexZhuk

Zilla,

Thanks for the great widget. It's exactly what I need. I now can get rid of this stupid standard MapSwitcherWidget. I only have one issue with it; I hope it's minor. Your widget works well for me when I'm on a big screen. When I try to test drive my application on a laptop, the bottom of your widget is below the bottom of the browser and there is NO WAY to resize it. Overall the size of the widget's panel looks a little too large to me. Is there a way to make the size user-configurable?

We here appreciate your help!

Alex Zhuk,
San Francisco, CA

RobertScheitlin__GISP

Zilla,

I notice that you do not handle layers that are FeatureLayer and I thought I would share how I deal with them. Maybe you can use this in your code.

else if (layer is FeatureLayer)
    {
     var FeatServId:Number = Number.NaN;
     var msName:String = FeatureLayer(layer).url.replace("FeatureServer","MapServer");
     var x:String = msName.substring(msName.length - 9);
     if(msName.substring(msName.length - 9) != "MapServer")
     {
      httpServ.url = msName.substring(0,msName.lastIndexOf("/")) + "/legend?f=json";
      FeatServId = parseInt(msName.substring(msName.lastIndexOf("/")+ 1));
     }else{
      httpServ.url = msName + "/legend?f=json";
     }
     httpServ.resultFormat = "text";
     lname = FeatureLayer(layer).id;
     httpServ.addEventListener(ResultEvent.RESULT,function(event:ResultEvent):void{processLegend(event,lname,FeatServId)});
     httpServ.send();
    }

ZillaPlace

I'm experiencing an error with a map service that is published as both a feature service and a mapservice when I hit the properties button:

I have the feature service layers excluded in the xml so that only dynamic map services will show up.
All other map services that are not published as feature service will show the properties. any ideas

You ran into the same error as Erwen. The updated code with the 4-15-2011 revision checks the null object reference rather than throw an error. However, I still couldn't get esri sample services and my test ones to produce any null value in either layer or service properties, as your service did. Is it possible for me to test the widget on your services?

I don't understand your second point. Do you want to show the feature service with other regular map services? Can you elaborate it?

ZillaPlace

Hello zilla,
thanks for the last update.

But, now i've got an error popup when the property button in front of a service is clicked (the buttons in front of groups or layers are ok)
error : Null object reference at :
Legend2.Handlers:DynamicMapDetailHandler/buildMapDespt()
DynamicMapDetailHandler.as at line 71

and i still have the problem whith the checkbox of groups an layers until the checkbox of the service is not checked/unchecked

Erwan

Hi Erwan,

The updated code with the 4-15-2011 revision checks the null object reference rather than throw an error. However, I still couldn't get esri sample services and my test ones to produce any null value in either layer or service properties, as your service did. Is it possible for me to test the widget on your services?

As for your question on checkboxes, you need to turn on a service checkbox in order to see any layer from that map service. Turning off a service checkbox will turn off all layers.

The service checkbox controls whether the output image from that service will display or not.
The layer checkbox controls whether the map service will include that layer in the output image.

Does it make sense to you?

NathanEnge

I'm experiencing an error with a map service that is published as both a feature service and a mapservice when I hit the properties button:

TypeError: Error #1009: Cannot access a property or method of a null object reference.
at widgets.Legend2.Handlers::DynamicMapDetailHandler/buildMapDespt()
at widgets.Legend2.Handlers::DynamicMapDetailHandler/buildDetailForm()
at widgets.Legend2.Handlers::DynamicMapDetailHandler/result()
at com.esri.ags.tasks::DetailsTask/handleDetails()
at Function/http://adobe.com/AS3/2006/builtin::call()
at com.esri.ags.tasks::BaseTask/handleResult()
at MethodInfo-1684()
at mx.rpc::Responder/result()
at mx.rpc::AsyncToken/http://www.adobe.com/2006/flex/mx/internal::applyResult()
at mx.rpc.events::ResultEvent/http://www.adobe.com/2006/flex/mx/internal::callTokenResponders()
at HTTPOperation/http://www.adobe.com/2006/flex/mx/internal::dispatchRpcEvent()
at mx.rpc::AbstractInvoker/http://www.adobe.com/2006/flex/mx/internal::resultHandler()
at mx.rpc::Responder/result()
at mx.rpc::AsyncRequest/acknowledge()
at DirectHTTPMessageResponder/completeHandler()
at flash.events::EventDispatcher/dispatchEventFunction()
at flash.events::EventDispatcher/dispatchEvent()
at flash.net::URLLoader/onComplete()

I have the feature service layers excluded in the xml so that only dynamic map services will show up.
All other map services that are not published as feature service will show the properties. any ideas

ErwanCaradec

Hello zilla,
thanks for the last update.

But, now i've got an error popup when the property button in front of a service is clicked (the buttons in front of groups or layers are ok)
error : Null object reference at :
Legend2.Handlers:DynamicMapDetailHandler/buildMapDespt()
DynamicMapDetailHandler.as at line 71

and i still have the problem whith the checkbox of groups an layers until the checkbox of the service is not checked/unchecked

Erwan

ZillaPlace

I'm actually on 10 already. I don't know if my service is available to the public, though. How would I determine that? If I had to take my best guess, I'd guess it's not, as we operate in an environment where internet is not available, only intranet. Thanks for your help, and I'll look forward to hearing back from you...

Justin

If you are on 10 already, please make sure you apply SP1 to your arcgis server.

iiakdenipl00120 is host name, but unreachable. Check if your server is accessible outside your domain. Usually your server's qualified host name should be something like gis.server.edu.

JustinRiggs

Hi Justin,

Actually the widget depends on a shared tool on arcgis.com/sharing/tools/legend?soapUrl=xyz to generate a legend on 9.3.1. Your service (SOAP) has to be accessible to the public, so the shared tool could generate the legend for your service. It is definitely possible to write a separate tool on my own, but I am not sure if it's worth the effort, since more and more people are moving to 10 (fast). Sorry about that. I posted that limitation a couple of days ago in Code Gallery.

What is your time frame of moving to 10 like?

I'm actually on 10 already. I don't know if my service is available to the public, though. How would I determine that? If I had to take my best guess, I'd guess it's not, as we operate in an environment where internet is not available, only intranet. Thanks for your help, and I'll look forward to hearing back from you...

Justin

ZillaPlace

Hi lallen/philip,

I implemented your suggestion and uploaded the new widget. Please check it out. Thanks for the suggestions!

1. added propertyEnabled in the widget config to show or hide the property buttons
2. added filterEnabled in the widget config to show or hide the keyword filter and collapse/expand all buttons

lallen, you could include multiple excludedLayer tags, one for each layer to be excluded. The syntax is like this:
<excludelayer>sample_layer1</excludelayer>
<excludelayer>sample_layer2</excludelayer>

ZillaPlace

Plaizilla,

When I tried to implement your widget I get the following error message:

Failed to load the legend for States
Code: 500
Error: Unable to generate legends: iiakdenipl00120
Unable to connect to Host: iiakdenipl00120 Port: -1
Please verify the Service URL specified is correct :- http://iiakdenipl00120/ArcGIS/services/AMV/States/MapServer

The URL is correct (all the data displays correctly on the map) - do you have any idea what's going on?

Thanks for a great widget, and I'll look forward to hearing your response...

Justin

Hi Justin,

Actually the widget depends on a shared tool on arcgis.com/sharing/tools/legend?soapUrl=xyz to generate a legend on 9.3.1. Your service (SOAP) has to be accessible to the public, so the shared tool could generate the legend for your service. It is definitely possible to write a separate tool on my own, but I am not sure if it's worth the effort, since more and more people are moving to 10 (fast). Sorry about that. I posted that limitation a couple of days ago in Code Gallery.

What is your time frame of moving to 10 like?

JustinRiggs

Plaizilla,

When I tried to implement your widget I get the following error message:

Failed to load the legend for States
Code: 500
Error: Unable to generate legends: iiakdenipl00120
Unable to connect to Host: iiakdenipl00120 Port: -1
Please verify the Service URL specified is correct :- http://iiakdenipl00120/ArcGIS/services/AMV/States/MapServer

The URL is correct (all the data displays correctly on the map) - do you have any idea what's going on?

Thanks for a great widget, and I'll look forward to hearing your response...

Justin

LeeAllen

Zilla:

Is there any way that you can add options in the xml to:
1. disable Layer Properties button - my users don't need see this info, and I think it will add confusion
2. disable the filter ability - when using app for very specific tasks, only a few layers are included, so this is not needed.
3. is it possible to exclude multiple layers from the legend? If so, what is the syntax?

Thanks.

philippschnetzer

The option to disable the 'Layer properties state' would be great. Although it's a nice feature it is not needed for certain apps.
Thanks.

NathanEnge

BLASTED!.
Thats the ticket. thanks mate.

ZillaPlace

Plaizilla
Until you decided whether to support WMS, or not...is there a way to turn off the messag boxes when there are WMS layers referenced in the config file?

Hi Nathan,

You could use the excludelayer tag in Legend2Widget.xml to exclude the wms layers from the legend.

<excludelayer>your layer label in [operationallayers]</excludelayer>

NathanEnge

Plaizilla
Until you decided whether to support WMS, or not...is there a way to turn off the messag boxes when there are WMS layers referenced in the config file?

ZillaPlace

Thanks Erwan. I will work on fixing those bugs.

-That's ok now, i'm seeing my v10 operational layers without error popup.
Great!
-"The last version is able to handle tiled services", is there a way to configure the widget to do it ? I don't see my tiled services (v10).
If you add a tiled service into the operationalLayers tag, the widget will generate a legend. However, the widget does ignore any basemap layer.
-could you please set all the text labels to be configurable in the Legend2Widget.xml ?
fixed in Revision 4-4-2011
- does the widget only use the color style of the application ? the fields list would need more contrast or different color (see the picture in attachment)
Yes it only uses the app color style. I agree the field list needs a better style.
- A problem with the TOC checkboxes : when a check box in front of a layer group or a layer is defauld checked, when it is unchecked the layer or group layer stay visible. It doesn't work until the service's check box is unchecked and re-checked.
Let me look into this.
- A little problem with the icons, when the 3 points icon i used to switch the property view, the selected icon on the top right doesn't switch.
fixed in Revision 4-4-2011
- Like Robert, i'd prefer plus & minus icons too.
Please feel free to modify the icons (i_xyz_collapsed.png and i_xyz_expanded) or any other icon.

ZillaPlace

I looks like there are multiple requests on the widget comments to please release code, me being one of them. This is a great widget, and I really want to implement!!

I have another request/improvement: Since you now have the symbol and layer name showing up together, is it possible to have the symbol to the left of the layer name instead of below? This would save much needed space and excessive scrolling. I have seen this in javascript, picture example is below.

[ATTACH=CONFIG]5691[/ATTACH]

The widget does have the icon and name of each layer on the same row (as showed in the widget thumbnail). Please let me know if you see anything different.

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.