Layer

Краткая информация

Предоставляет доступ к базовым свойствам слоя и методам.

Обсуждение

На слои можно ссылаться из проекта, используя метод listLayers класса Map, или из файла слоя (.lyr или .lyrx), хранящегося на диске, используя метод listLayers класса LayerFile.

Объект Layer имеет единый универсальный дизайн для работы со всеми слоями. Существует множество типов слоев, и не все они поддерживают один и тот же набор свойств. Например, векторный слой поддерживает определяющий запрос, тогда как растровый слой его не поддерживает, при этом каталог растров - поддерживает. Вместо того, чтобы работать с разными отдельными объектами слоя для всех возможных типов слоев и комбинаций свойств, есть некоторые полезные свойства, которые позволяют получить информацию о слое и поддерживаемых им свойствах. Существует множество свойств is, которые позволяют определить, подходит ли слой к общей категории: is3DLayer, isFeatureLayer, isGroupLayer, isRasterLayer и isServiceLayer.

Есть несколько специализированных слоев и наборов данных, которые не попадают ни в одну из этих общих категорий: подклассы аннотаций, объекты-размеры, наборы данных Terrain, наборы данных топологии и так далее. В этих случаях вам может потребоваться протестировать другие свойства, чтобы изолировать интересующий слой, прежде чем что-то с ним делать. Метод supports доступен, чтобы помочь определить, какой конкретный слой поддерживает какое конкретное свойство слоя. Это дает возможность проверить, поддерживает ли слой свойство, прежде чем пытаться получить или установить его значение, уменьшая необходимость в дополнительном поиске ошибок. Например, см. следующий код:

if lyr.supports("BRIGHTNESS"):
    lyr.brightness = 10

Метод listLayers Map Class возвращает значения индекса, которые генерируются сверху вниз в том виде, в каком они появляются в таблице содержания или в том виде, как они появляются в файле слоя. То же самое происходит, если составной слой находится внутри другого составного слоя. Например, карта с одним составным слоем, содержащим три подслоя, возвратит список из четырех имен слоев, при этом групповой слой будет первым, а три подслоя - вторым, третьим и четвертым. Есть два способа определения составного слоя. Во-первых, вы можете проверить, поддерживает ли слой свойство isGroupLayer. Во-вторых, вы можете оценить свойство longName. Значение слоя longName будет включать имя группы в дополнение к имени слоя. Например, слой с именем Layer1 в составном слое Group1, будет иметь значение longName Group1\Layer1. Если значение name равно значению longName, слой не находится внутри составного слоя. При работе с подслоями составных слоев свойство longName будет содержать и имя подслоя и имя слоя верхнего уровня.

ArcGIS Pro может читать устаревшие типы файлов .lyr, но сохранять может только типы файлов .lyrx. При ссылке на тип файла .lyr и вызове метода save он будет преобразован в тип файла .lyrx, но с тем же именем файла.

Изменение источника данных слоя – это общее требование. Для этого у объекта Layer есть метод и свойство. Более подробное обсуждение, сведения о параметрах, сценарии и примеры кода см. в разделе справки Обновление и исправление источников данных.

Свойства

Свойство	Описание	Тип данных
brightness (чтение и запись)	Значение яркости слоя. По умолчанию нормальная яркость - 0 процентов. Введите любое значение от +100 процентов до -100 процентов. Введите знак плюс или минус слева от значения, чтобы указать, находится ли оно выше или ниже 0.	Integer
connectionProperties (только чтение)	Возвращает информацию о подключении к источнику данных слоя как словарь Python.	Dictionary
contrast (чтение и запись)	Значение контраста слоя. По умолчанию нейтральный контраст - 0 процентов. Введите любое значение от +100 процентов до -100 процентов. Введите знак плюс или минус слева от значения, чтобы указать, находится ли оно выше или ниже 0.	Integer
dataSource (только чтение)	Возвращает полный путь к источнику данных слоя. Он включает полный путь к рабочей области и имя набора данных. Для слоев многопользовательских баз геоданных возвращается строка, содержащая информацию о подключении слоя. Подсказка: Слои многопользовательских баз геоданных в проекте ArcGIS Pro не хранят путь к файлу подключения к базе данных (.sde), который использовался для создания слоя.	String
definitionQuery (чтение и запись)	Определяющий запрос слоя.	String
is3DLayer (только чтение)	Возвращает True, если слой является 3D слоем.	Boolean
isBasemapLayer (только чтение)	Возвращает True, если слой является слоем базовой карты.	Boolean
isBroken (только чтение)	Возвращает True, если источник данных слоя поврежден.	Boolean
isFeatureLayer (только чтение)	Возвращает True, если слой является векторным.	Boolean
isGroupLayer (только чтение)	Возвращает True, если слой является составным.	Boolean
isNetworkAnalystLayer (только чтение)	Возвращает True, если слой является слоем Дополнительный модуль ArcGIS Network Analyst.	Boolean
isNetworkDatasetLayer (только чтение)	Возвращает True, если слой является слоем набора сетевых данных Дополнительный модуль ArcGIS Network Analyst.	Boolean
isRasterLayer (только чтение)	Возвращает True, если слой является растровым.	Boolean
isSceneLayer (только чтение)	Возвращает True, если слой является слоем сцены.	Boolean
isTimeEnabled (только чтение)	Указывает, включено ли время в слое. Если isTimeEnabled возвращает True, свойство time слоя можно использовать для возврата объекта LayerTime. Используйте метод enableTime, чтобы включить время на слое, содержащем информацию о времени.	Boolean
isWebLayer (только чтение)	Возвращает True, если слой является сервисом ГИС. ГИС сервисы – это автоматизированные географические информационные сервисы, которые опубликованы и доступны в Интернете с помощью стандартных технологий и протоколов. Примером являются базовые карты Esri.	Boolean
longName (только чтение)	Полное имя слоя, включая структуру составного слоя.	String
maxThreshold (чтение и запись)	Порог максимального масштаба слоя для 2D-карт и его максимальное расстояние над поверхностью земли для 3D-карт. Слой не будет отображаться, если степень увеличения превзошла максимальный масштаб. Для очистки максимального масштаба установите значение на 0.	Double
metadata (чтение и запись)	Получите или задайте информацию о Метаданных класса слоя. Примечание: Установка метаданных зависит от значения свойства isReadOnly.	Metadata
minThreshold (чтение и запись)	Порог минимального масштаба слоя для 2D-карт и его максимальное расстояние над поверхностью земли для 3D-карт. Слой не будет отображаться, если степень уменьшения превзошла минимальный масштаб. Для очистки минимального масштаба установите значение на 0.	Double
name (чтение и запись)	Имя слоя в том виде, в каком оно будет выглядеть в таблице содержания. Можно использовать пробелы. Является важным, чтобы все слои карты имели уникальные имена, благодаря чему на них было бы легко ссылаться по имени.	String
showLabels (чтение и запись)	Управляет отображением надписей слоя. Если задано True, надписи отображаются; если задано False, надписи не отображаются.	Boolean
symbology (чтение и запись)	Обеспечивает доступ к символам слоя.	Object
time (только чтение)	Возвращает объект LayerTime, если на слое включено время.	LayerTime
transparency (чтение и запись)	Значение прозрачности слоя. Это свойство позволяет вам видеть сквозь слой. Используйте значения между 0 и 100. Значение 0 соответствует полной непрозрачности. Значение прозрачности более 90 процентов обычно приводит к тому, что слой не отображается совсем.	Integer
visible (чтение и запись)	Управляет отображением слоя. Если задано True, слой отображается; если задано False, слой не отображается.	Boolean

Обзор метода

Метод	Описание
enableTime ({startTimeField}, {endTimeField}, {autoCalculateTimeRange})	Включает время в слое, если информация о времени хранится в полях.
extrusion ({extrusion_type}, {expression})	Вытягивает 2D объекты слоя для отображения 3D символов.
getDefinition (cim_version)	Получает определение слоя CIM.
getSelectionSet ()	Возвращает выборку слоя в виде набора идентификаторов объектов Python.
listLabelClasses ({wildcard})	Возвращает список Python объектов LabelClass в слое.
listLayers ({wildcard})	Возвращает список Python для объектов Слой из группового слоя.
saveACopy (file_name)	Сохраняет слой в файл слоя (.lyrx).
setDefinition (definition_object)	Настраивает определение слоя CIM.
setSelectionSet ({oidList}, {method})	Задает выборку слоя, используя список Object ID Python.
supports (layer_property)	Используется для определения, поддерживает ли конкретный тип слоя свойство для объекта слоя. Не все слои поддерживают одинаковый набор свойств; свойство supports может быть использовано для тестирования, поддерживает ли слой данное свойство перед попыткой его установить.
updateConnectionProperties (current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})	Заменяет свойства подключения, используя словарь либо путь к рабочей области.
updateLayerFromJSON (json_data)	Обновляет слой из строки JSON.

Методы

enableTime ({startTimeField}, {endTimeField}, {autoCalculateTimeRange})

Параметр	Описание	Тип данных
startTimeField	The name of the field containing the start time values. If each feature has a single time field, specify that field name in the startTimeField and leave endTimeField blank. If each feature has a start and end time field, specify both the startTimeField and endTimeField. (Значение по умолчанию — None)	String
endTimeField	The name of the field containing the end time values. Not all layers use an end time field. If each feature has a single time field, specify that field name in the startTimeField and leave endTimeField blank. If each feature has a start and end time field, specify both the startTimeField and endTimeField. (Значение по умолчанию — None)	String
autoCalculateTimeRange	If set to True, the start and end time attribute information is used to calculate the layer's time extent. (Значение по умолчанию — True)	Boolean

Все параметры метода enableTime являются необязательными. Если startTimeField и endTimeField не указаны, метод оценит данные и попытается найти соответствующие значения по умолчанию.

После запуска метода enableTime свойство time слоя можно использовать для возврата объекта LayerTime. Если MapFrame в Компоновке содержит слои с включенным временем, класс MapTime можно использовать для доступа к настройкам времени карты.

extrusion ({extrusion_type}, {expression})

Параметр	Описание	Тип данных
extrusion_type	Строка, задающая метод вытягивания. Значение по умолчанию равно NONE, что выключает вытягивание слоя. ABSOLUTE_HEIGHT —Пространственный объект вытягивается в соответствии с указанным z-значением подобно плоской вершине, независимо от z-значения самого объекта. BASE_HEIGHT —Z-значения вычисляется для каждой вершины основания пространственного объекта, поэтому объект вытягивается на различные z-значения, создавая многогранную вершину. MAX_HEIGHT —Добавляет высоту вытягивания к минимальному z-значению пространственного объекта, и объект вытягивается в плоскую вершину на данное значение. MIN_HEIGHT —Добавляет высоту вытягивания к минимальному z-значению пространственного объекта, и объект вытягивается в плоскую вершину на данное значение. NONE —Объекты не вытянуты. (Значение по умолчанию — NONE)	String
expression	Строка, которая определяет выражение вытягивания, которое предоставляет абсолютную высоту вытягивания для каждого объекта. (Значение по умолчанию — None)	String

Вытягивание представляет собой процесс вертикального растяжения плоских 2D форм для создания 3D объекта. Это предоставляет метод создания трехмерных символов из двухмерных пространственных объектов. Полигональные и линейные объекты имеют все пять доступных опций extrusion_type; точечные объекты не используют опции MAX_HEIGHT или MIN_HEIGHT.

getDefinition (cim_version)

Параметр	Описание	Тип данных
cim_version	Строка, представляющая основную версию CIM.	String

Доступ уровня CIM к дополнительным свойствам объектов, которые появились в версии 2.4. Esri соблюдает спецификацию семантики версий. Это означает, что до следующего выпуска основной версии, например, версии 3.0, при появлении существенных изменений в API, для cim_version будет использовано значение V2. После выпуска версии 3.0 станет доступной новая опция V3. Это дает авторам скриптов Python контроль над версией CIM, которая будет использоваться во время выполнения, если есть вероятность, что будут внесены существенные изменения в новую версию.

Более подробно о работе с CIM и примеры см. Доступ к CIM в Python.

getSelectionSet ()

Это простейший способ получения текущей выборки слоя.

listLabelClasses ({wildcard})

Параметр	Описание	Тип данных
wildcard	Групповой символ базируется на имени класса надписей и не является чувствительным к регистру. Для наложения ограничений на результирующий список можно использовать сочетание звездочек (*) и символов. (Значение по умолчанию — None)	String

Возвращаемое значение

Тип данных	Описание
List	Возвращает список Python объектов LabelClass в слое.

Возвращает список Python объектов LabelClass в слое.

listLayers ({wildcard})

Параметр	Описание	Тип данных
wildcard	Подстановочный знак основан на имени слоя и не чувствителен к регистру. Для наложения ограничений на результирующий список можно использовать сочетание звездочек (*) и символов. (Значение по умолчанию — None)	String

Возвращаемое значение

Тип данных	Описание
List	Возвращает список Python для объектов Слой из группового слоя.

Возвращает список Python для объектов Слой из группового слоя.

saveACopy (file_name)

Параметр	Описание	Тип данных
file_name	Строка, которая включает местоположение и имя выходного файла слоя (.lyrx).	String

Если групповой слой будет сохранен, все слои, перечисленные ниже в таблице содержания, будут также сохранены в файл слоя (.lyrx).

setDefinition (definition_object)

Параметр	Описание	Тип данных
definition_object	Объект измененного определения CIM, изначально полученный с помощью getDefinition.	Object

Более подробно о работе с CIM и примеры см. Доступ к CIM в Python.

setSelectionSet ({oidList}, {method})

Параметр	Описание	Тип данных
oidList [oidList,...]	Список Object ID Python для работы с соответствующим способом выборки объектов. (Значение по умолчанию — None)	Integer
method	Строка, задающая используемый метод выборки. NEW —Создает новую выборку объектов из oidList. DIFFERENCE —Выбирает объекты, не входящие в текущую выборку, но находящиеся в oidList. INTERSECT —Выбирает объекты, входящие в текущую выборку и в oidList. SYMDIFFERENCE —Выбирает объекты, входящие либо в текущую выборку, либо в oidList, но не в оба списка одновременно. UNION —Выбирает все объекты, входящие как в текущую выборку, так и в oidList. (Значение по умолчанию — NEW)	String

Это простейший способ управления текущей выборкой слоя. Чтобы очистить выборку, воспользуйтесь методом выборки NEW с пустым списком, или без параметров.

Примечание: Списки Python можно применять для oidList, но наборы Python возвращаются методом getSelectionSet объекта Layer.

supports (layer_property)

Параметр	Описание	Тип данных
layer_property	The name of a particular layer property that will be tested. BRIGHTNESS —A raster layer's brightness value. CONNECTIONPROPERTIES —A Layer's connection information. CONTRAST —A raster layer's contrast value DATASOURCE —A layer's file path or connection file. DEFINITIONQUERY —A layer's definition query string. LONGNAME —A layer's path including the group layers it may be nested within. MAXTHRESHOLD —A layer's maximum threshold to display the features. MINTHRESHOLD —A layer's minimum threshold to display the features. NAME —A layer's name. TIME —A layer's time properties. TRANSPARENCY —A layer's transparency value. (Значение по умолчанию — name)	String

Возвращаемое значение

Тип данных	Описание
Boolean

Существует много типов слоев, и не все они поддерживают одинаковый набор свойств. Например, векторный слой поддерживает определяющий запрос, тогда как растровый слой его не поддерживает, при этом каталог растров - поддерживает. Вместо того чтобы создавать отдельные объекты слоя для всех возможных типов слоев и комбинаций свойств, можно использовать метод supports, который позволяет определить, какие свойства поддерживает тот или иной тип слоя. Метод support дает возможность проверить, поддерживается ли свойство, чтобы не пытаться получить или задать его значение в типе слоя, который его не поддерживает. Свойство supports возвращает True, если слой поддерживает данное свойство.

Булевы свойства не требуют тестирования с использованием supports потому, что если свойство слоя не поддерживается для данного типа слоя, то возвращается значение False.

updateConnectionProperties (current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})

Параметр	Описание	Тип данных
current_connection_info	Строка, представляющая собой путь к рабочей области либо словарь Python, содержащий свойства подключения к источнику, который вы собираетесь удалять.	String
new_connection_info	Строка, представляющая собой путь к рабочей области либо словарь Python, содержащий свойства подключения с информацией о новом источнике.	String
auto_update_joins_and_relates	Если задано значение True, способ updateConnectionProperties также обновляет подключения для соответствующих связей и соединений. (Значение по умолчанию — True)	Boolean
validate	Если задано значение True, свойства подключения обновляются, только если значением new_connection_info является допустимое подключение. Если оно недопустимо, подключение не заменяется.  При значении False все подключения будут соответствовать new_connection_info, независимо от корректности соответствия. В этом случае, если соответствий нет, источники данных повреждены. (Значение по умолчанию — True)	Boolean
ignore_case	Определяет, будет ли поиск чувствителен к регистру. По умолчанию, запросы чувствительны к регистру. Чтобы выполнять не чувствительные к регистру запросы, задайте для ignore_case значение True. (Значение по умолчанию — False)	Boolean

Более подробное описание, сведения о параметрах, сценарии и примеры кода см. в разделе справки Обновление и исправление источников данных.

updateLayerFromJSON (json_data)

Параметр	Описание	Тип данных
json_data	The layer definition in JavaScript Object Notation (JSON) format. See the ExportWebMap JSON specification for more information. ArcGIS API for JavaScript and ArcGIS Web AppBuilder allow you to get this JSON string from the web app. The layer definition is a subset of the webmap_json used in the ConvertWebMapToArcGISProject function. You don't need to create the web map JSON; the APIs take care of it for you. However, you need to extract the layer definition from the full webmap_json.	String

Эта функция предназначена для использования в веб-инструментах, в которых функция ConvertWebMapToArcGISProject используется в приложениях для печати веб-карт, поддерживающих изменение способа отображения (или других свойств) динамических слоев веб-сервисов. Если ваш веб-инструмент заменит слои сервиса промежуточными векторными слоями после запуска ConvertWebMapToArcGISProject, updateLayerFromJSON применит метод отображения (или другие свойства слоя), как указано в webmap_json для соответствующих промежуточных векторных слоев в шаблоне компоновки. Дополнительная информация и пример кода находятся в разделе ConvertWebMapToArcGISProject.

Пример кода

Layer, пример 1

Следующий скрипт печатает имя каждой карты в проекте и перечисляет имена слоев каждой карты. Скрипт также добавляет префикс (BROKEN) к имени слоя, если он имеет поврежденный источник данных.

import arcpy
aprx = arcpy.mp.ArcGISProject(r"C:\Projects\YosemiteNP\Yosemite.aprx")
for m in aprx.listMaps():
    print("Map: {0} Layers".format(m.name))
    for lyr in m.listLayers():
        if lyr.isBroken:
            print("(BROKEN) " + lyr.name)
        else:
            print("  " + lyr.name)
del aprx

Layer, пример 2

Следующий скрипт очищает все запросы определения слоев и отключает надписи для всех слоев на карте с именем Yosemite National Park.

import arcpy
aprx = arcpy.mp.ArcGISProject(r"C:\Projects\YosemiteNP\Yosemite.aprx")
m = aprx.listMaps("Yosemite National Park")[0]
for lyr in m.listLayers():
    if lyr.supports("DEFINITIONQUERY"):
        lyr.definitionQuery = ""
    if lyr.supports("SHOWLABELS"):
        lyr.showLabels = False
aprx.save()
del aprx