arcpylegend
I can't remove item from the legend (lyr called "atikot") using arcpy with this code:
import arcpy
from arcpy import env
removeLyr = arcpy.mapping.ListLayers(mxd, "atikot")[0]
mxd = arcpy.mapping.MapDocument(r"C:\Project\Project.mxd")
legend = arcpy.mapping.ListLayoutElements(mxd,"LEGEND_ELEMENT")[0]
for lyr in legend.listLegendItemLayers():
if lyr.name == "atikot":
legend.removeItem(lyr)
del mxd
The code does not work. Does anyone have an idea as to what's wrong with the code?
With the AddLayer method you cannot be more precise than "TOP" or "BOTTOM" as shown above.
However, if you use the InsertLayer method (ESRI Help Pages), you can specify a reference layer (or multiple reference layers) and add your new layer in reference to that.
import arcpy
mxd = arcpy.mapping.MapDocument(r"C:\Project\Project.mxd")
df = arcpy.mapping.ListDataFrames(mxd, "County Maps")[0]
refLayer = arcpy.mapping.ListLayers(mxd, "Lakes", df)[0]
insertLayer = arcpy.mapping.Layer(r"C:\Project\Data\Rivers.lyr")
arcpy.mapping.InsertLayer(df, refLayer, insertLayer, "BEFORE")
mxd.saveACopy(r"C:\Project\Project2.mxd")
del mxd, insertLayer
The trick to doing this is to first create a legend style item either in your user style file or in a custom style file. For the sake of simplicity, I'll show you how to do it using your user style.
You need to create a custom Legend Style item. Specifically, to do what you want to do, you need to create a a Horizontal Legend Style Item.
Right-Click on the Legend Folder in your User Style File and select New > Horizontal... from the context menu. Don't select Horizontal Bar. That's not what you want.
Under the Arrangement tab, select the third radio button from the top, which displays the legend patch all the way to the right. Then press OK and give your legend style item a name. For the sake of simplicity, I named mine 'Justified-Left-Patch-Right'
Close the Style Manager.
Next you need to just insert a plain old legend. In ArcMap, select Insert > Legend and just zip through the Legend Wizard. We need the Legend Element in order to update it with your preferred style. If you plan on creating maps dynamically, you would just keep a default legend in the MXD and then update it as needed prior to export. I don't know of a way to just automatically insert a default legend through arcpy.
Once you've got a default legend and your preferred style item in place, we can update the legend with your preferred style through arcpy.
# Reference the Current MXD
mxd = arcpy.mapping.MapDocument("CURRENT")
# Acquire the default legend item manually inserted into the MXD
legend = arcpy.mapping.ListLayoutElements(mxd, "LEGEND_ELEMENT")[0]
# Reference your custom style item from your user style
# Note: "USER_STYLE" is a keyword in the ListStyleItems function which
# automatically references the custom style file ArcGIS auto-creates for
# your user profile
styleItem = arcpy.mapping.ListStyleItems("USER_STYLE", "Legend Items", "Justified-Left-Patch-Right")[0]
At this point, you're ready to update your legend with your preferred style. As you can see, I have the normal default legend in my mxd.
All you need to do now, is iterate through the items in the Legend, and update them with your style item.
for lyr in legend.listLegendItemLayers():
legend.updateItem(lyr, styleItem)
You can find more information about updating your legend style through arcpy as well as some additional workflows on with legends in the LegendElement documentation.
Note that while this is the method ESRI provides to update the legend through arcpy, I found it to be fairly unstable. I experienced several hard crashes of ArcMap when doing it. It seemed to occur any time I attempted to update the legend layers after immediately after making a configuration change to my style item in the style manager.
Hope this helps.
Best Answer
I think the problem with your code is that you have not included an
mxd.save()before deleting your map document (mxd) object at the end. You're also referring to yourmxdvariable before you have assigned it.Your modified code should look like this:
Make sure that you save the map document (mxd) object before you delete it.