Skip To Content

LegendElement

Summary

The LegendElement object provides access to properties that enable its positioning and resizing on the page layout as well as modifying its title.

Discussion

A LegendElement is very similar to MapSurroundElement. It has an association with a MapFrame using a property called mapFrame but it also has a property called title.

The listElements method on the Layout object returns a Python list of page layout element objects. To return a list of MapsurroundElements only, use the MAPSURROUND_ELEMENT constant for the element_type parameter. A wildcard can also be used to further refine the search based on the element name. It is important that each page layout element be given a unique name so that it can be easily isolated using ArcPy scripting.

By default, layers added to a Map automatically get added to a legend. This makes it possible to author a Layout with an empty map and legend but have those items dynamically update when new layers are added to the map.

The elementPositionX and elementPositionY values are based on the element's anchor position, which is set on the Format tab. If you prefer that a LegendElement grows downward when layers are added, it is best to set the anchor position to be upper left.

Properties

PropertyExplanationData Type
elementHeight
(Read and Write)

The height of the element in page units.

Double
elementPositionX
(Read and Write)

The x location of the element's anchor position. The units assigned or reported are in page units.

Double
elementPositionY
(Read and Write)

The y location of the element's anchor position. The units assigned or reported are in page units.

Double
elementRotation
(Read and Write)

Rotates the element relative to the anchor position. Positive values are counter-clockwise and negative values are clockwise.

Double
elementWidth
(Read and Write)

The width of the element in page units.

Double
mapFrame
(Read and Write)

A reference to the associated MapFrame.

MapFrame
name
(Read and Write)

The name of the element. It is important that all elements have a unique name so they can be easily referenced.

String
showTitle
(Read and Write)

A boolean that controls if the title is displayed in the legend.

Boolean
syncLayerOrder
(Read and Write)

A boolean that controls if the items in the legend are in the same order as the layers in the map.

Boolean
syncLayerVisibility
(Read and Write)

A boolean that controls if an item should automatically appear in the legend if it is visible in the map.

Boolean
syncNewLayer
(Read and Write)

A boolean that controls if an item should automatically be added to the legend when added to the map.

Boolean
syncReferenceScale
(Read and Write)

A boolean that controls if the symbols in the legend should match the scaling of the symbols in a map if a reference scale is set.

Boolean
title
(Read and Write)

The text string that represents the legend's title.

String
type
(Read Only)

Returns a value of LEGEND_ELEMENT.

String
visible
(Read and Write)

Returns True if the element is visible on the layout. Rather than having to move unwanted objects off the page before printing or exporting, you can toggle the element's visibility.

Boolean

Code sample

LegendElement example

The following script will add layers to a map that includes an inserted legend element named Legend. The layers will automatically get added to the legend and its title gets updated.

import arcpy
aprx = arcpy.mp.ArcGISProject(r"C:\Projects\YosemiteNP\Yosemite.aprx")
lyr1 = arcpy.mp.LayerFile(r"C:\Projects\Yosemite\LYRs\Trails.lyrx")
lyr2 = arcpy.mp.LayerFile(r"C:\Projects\Yosemite\LYRs\PointsOfInterest.lyrx")
m = aprx.listMaps("Yose*")[0]
m.addLayer(lyr1, "TOP")
m.addLayer(lyr2, "TOP")
lyt = aprx.listLayouts("Main Attrations")[0]
legend = lyt.listElements("LEGEND_ELEMENT", "Legend")[0]
legend.title = "Yosemite National Park"
aprx.save()
del aprx