Краткая информация
LegendItem обеспечивает доступ к информации на уровне элемента легенды в LegendElement.
Обсуждение
Свойство items класса LegendElement возвращает список объектов LegendItem. Для каждого элемента легенды вы можете изменить такие свойства, как arrangement, patchHeight и его статус visible. Типичный рабочий процесс состоит в том, чтобы итерировать список элементов, определять интересующий элемент по его свойству name, а затем вносить соответствующие изменения.
Примечание:
Свойства, указываемая для класса LegendItem, не применяются ко всем типам средств визуализации. Важно поймать эти исключения при необходимости.
Свойства
| Свойство | Описание | Тип данных |
| arrangement (чтение и запись) | Строка, определяющая выравнивание элементов легенды. Ниже приведен действительный список значений:
| String |
| column (чтение и запись) | Положение столбца для элемента легенды. Свойство столбца применяется только к легендам, использующим стратегию расположения ManualColumns. | Long |
| name (только чтение) | Возвращает имя элемента легенды. Имя элемента легенды задается путем изменения имени слоя. | String |
| patchHeight (чтение и запись) | Высота образца элемента легенды. Единицы указаны в пунктах. | Double |
| patchWidth (чтение и запись) | Ширина образца элемента легенды. Единицы указаны в пунктах. | Double |
| showFeatureCount (чтение и запись) | Логическое значение, которое определяет, размещается ли количество объектов рядом с текстом элемента легенды. Отображаемое значение зависит от настройки showVisibleFeatures. | Boolean |
| showVisibleFeatures (чтение и запись) | Логическое значение, которое определяет, отображаются ли для элемента легенды все значения или только те значения, которые отображаются в видимом экстенте. | Boolean |
| type (только чтение) | Возвращает значение LEGEND_ITEM. | String |
| visible (чтение и запись) | Возвращает True, если элемент легенды виден в легенде. | Boolean |
Обзор метода
| Метод | Описание |
| applyStyleItem (style_item) | Применяет StyleItem к LegendItem. |
Методы
applyStyleItem (style_item)
При привязывании StyleItem с помощью метода listStyleItems для класса ArcGISProject параметр style_class должен быть LEGEND_ITEM. Обратитесь к разделу справки StyleItem для получения дополнительной информации и примеров кода.
Примечание:
Перед использованием метода applyStyleItem необходимо добавить стили в проект. Стили можно добавить, используя метод updateStyles для класса ArcGISProject.
Пример кода
Следующий скрипт итерирует все элементы легенды в легенде. Он устанавливает patchHeight и patchWidth для всех элементов легенды, затем устанавливает showVisibleFeatures для определенного элемента легенды.
p = arcpy.mp.ArcGISProject('current')
lyt = p.listLayouts('Layout')[0]
leg = lyt.listElements('LEGEND_ELEMENT')[0]
#Change the patch size for all legend items
#only display features in the visible map frame extent
for itm in leg.items:
itm.patchHeight = 15
itm.patchWidth = 30
if itm.name == 'Geological Types':
itm.showVisibleFeatures = True