# > Объект карты сети

Следующие объекты напрямую связаны с `map` API.

### Карта сети

Объект карты сети имеет следующие свойства.

|Свойство|Тип|Описание|
|----------------|------|----------------|
|sysmapid|строка|*(только чтение)* ID карты сети.|
|**height**<br>(требуется)|целое число|Высота карты сети в пикселях.|
|**name**<br>(требуется)|строка|Имя карты сети.|
|**width**<br>(требуется)|целое число|Ширина карты сети в пикселях.|
|backgroundid|строка|ID изображения, которое используется в качестве фона на карте сети.|
|expand\_macros|целое число|Необходимо ли раскрывать макросы в подписях при настройке карты сети.<br><br>Возможные значения:<br>0 - *(по умолчанию)* не раскрывать макросы;<br>1 - раскрывать макросы.|
|expandproblem|целое число|Необходимо ли отображать проблемный триггер по всем элементам с единственной проблемой.<br><br>Возможные значения:<br>0 - всегда отображать количество проблем;<br>1 - *(по умолчанию)* отображать проблемный триггер, если имеется только одна проблема.|
|grid\_align|целое число|Требуется ли включить выравнивание по сетке.<br><br>Возможные значения:<br>0 - отключение выравнивания по сетке;<br>1 - *(по умолчанию)* включение выравнивания по сетке.|
|grid\_show|целое число|Требуется ли отображать сетку на карте.<br><br>Возможные значения:<br>0 - не отображать сетку;<br>1 - *(по умолчанию)* отображать сетку.|
|grid\_size|целое число|Размер сетки карты сети в пикселях.<br><br>Возможные значения: 20, 40, 50, 75 и 100.<br><br>По умолчанию: 50.|
|highlight|целое число|Необходимо ли активировать подсветку иконок.<br><br>Возможные значения:<br>0 - подсветка отключена;<br>1 - *(по умолчанию)* подсветка включена.|
|iconmapid|строка|ID соответствия иконок, которое используется картой сети.|
|label\_format|целое число|Необходимо ли активировать расширенные подписи.<br><br>Возможные значения:<br>0 - *(по умолчанию)* расширенные подписи отключены;<br>1 - расширенные подписи включены.|
|label\_location|целое число|Размещение подписи к элементу карты.<br><br>Возможные значения:<br>0 - *(по умолчанию)* снизу;<br>1 - слева;<br>2 - справа;<br>3 - сверху.|
|label\_string\_host|строка|Пользовательская подпись к элементам узлов сети.<br><br>Требуется для карт сетей с пользовательским типом подписей к узлам сети.|
|label\_string\_hostgroup|строка|Пользовательская подпись к элементам групп узлов сети.<br><br>Требуется для карт сетей с пользовательским типом подписей к группам узлов сетей.|
|label\_string\_image|строка|Пользовательская подпись к элементам изображений.<br><br>Требуется для карт сетей с пользовательским типом подписей к изображениям.|
|label\_string\_map|строка|Пользовательская подпись к элементам карт.<br><br>Требуется для карт сетей с пользовательским типом подписей к картам.|
|label\_string\_trigger|строка|Пользовательская подпись к элементам триггеров.<br><br>Требуется для карт сетей с пользовательским типом подписей к триггерам.|
|label\_type|целое число|Тип подписи к элементам карт сетей.<br><br>Возможные значения:<br>0 - подпись;<br>1 - IP адрес;<br>2 - *(по умолчанию)* имя элемента;<br>3 - только состояние;<br>4 - ничего.|
|label\_type\_host|целое число|Тип подписи к элементам узлов сетей.<br><br>Возможные значения:<br>0 - подпись;<br>1 - IP адрес;<br>2 - *(по умолчанию)* имя элемента;<br>3 - только состояние;<br>4 - ничего;<br>5 - пользовательский.|
|label\_type\_hostgroup|целое число|Тип подписи к элементам групп узлов сетей.<br><br>Возможные значения:<br>0 - подпись;<br>2 - *(по умолчанию)* имя элемента;<br>3 - только состояние;<br>4 - ничего;<br>5 - пользовательский.|
|label\_type\_image|целое число|Тип подписи к элементам изображений.<br><br>Возможные значения:<br>0 - подпись;<br>2 - *(по умолчанию)* имя элемента;<br>4 - ничего;<br>5 - пользовательский.|
|label\_type\_map|целое число|Тип подписи к элементам карт сетей.<br><br>Возможные значения:<br>0 - подпись;<br>2 - *(по умолчанию)* имя элемента;<br>3 - только состояние;<br>4 - ничего;<br>5 - пользовательский.|
|label\_type\_trigger|целое число|Тип подписи к элементам триггеров.<br><br>Возможные значения:<br>0 - подпись;<br>2 - *(по умолчанию)* имя элемента;<br>3 - только состояние;<br>4 - ничего;<br>5 - пользовательский.|
|markelements|целое число|Требуется ли подсвечивать элементы карты сети, которые недавно изменили свое состояние.<br><br>Возможные значения:<br>0 - *(по умолчанию)* не подсвечивать элементы;<br>1 - подсвечивать элементы.|
|severity\_min|целое число|Минимальная важность триггеров, которые будут отображаться на карте сети.<br><br>Обратитесь к [свойству "severity" триггера](/ru/manual/api/reference/trigger/object#триггер) для получения списка поддерживаемых важностей триггера.|
|show\_unack|целое число|Каким образом отображать проблемы.<br><br>Возможные значения:<br>0 - *(по умолчанию)* отображать количество всех проблем;<br>1 - отображать только количество неподтвержденных проблем;<br>2 - отображать количество подтвержденных и неподтвержденных проблем раздельно.|
|userid|строка|ID пользователя владельца карты сети.|
|private|целое число|Тип общего доступа карты сети.<br><br>Возможные значения:<br>0 - публичная карта сети;<br>1 - *(по умолчанию)* приватная карта сети.|

### Элемент карты

Объект элемента карты определяет отображаемый объект на карте сети. Этот
объект имеет следующие свойства.

|Свойство|Тип|Описание|
|----------------|------|----------------|
|selementid|строка|*(только чтение)* ID элемента карты.|
|**elements**<br>(требуется)|массив|Объект данных элементов. Требуется для типов элементов узла сети, группы узлов сети, триггера и карты сети.|
|**elementtype**<br>(требуется)|целое число|Тип элемента карты.<br><br>Возможные значения:<br>0 - узел сети;<br>1 - карта сети;<br>2 - триггер;<br>3 - группа узлов сети;<br>4 - изображение.|
|**iconid\_off**<br>(требуется)|строка|ID изображения, которое используется для отображения элемента в состоянии по умолчанию.|
|areatype|целое число|Каким образом необходимо отображать разделение узлов сети групп узлов сети.<br><br>Возможные значения:<br>0 - *(по умолчанию)* элемент группы узлов сети будет занимать всю карту сети;<br>1 - элемент группы узлов сети будет занимать фиксированный размер.|
|application|строка|Имя группы элементов данных из которой необходимо отображать проблемы. Используется только для элементов карты узла сети и группы узлов сети.|
|elementsubtype|целое число|Каким образом отображать элемент группы узлов сети на карте сети.<br><br>Возможные значения:<br>0 - *(по умолчанию)* отображать группу узлов сети одним элементом;<br>1 - отображать каждый узел сети группы отдельно.|
|height|целое число|Высота фиксированного размера элемента группы узлов сети в пикселях.<br><br>По умолчанию: 200.|
|iconid\_disabled|строка|ID изображения, которое используется для отображения элемента в деактивированном состоянии. Не используется для элементов изображений.|
|iconid\_maintenance|строка|ID изображения, которое используется для отображения элемента в состоянии обслуживания. Не используется для элементов изображений.|
|iconid\_on|строка|ID изображения, которое используется для отображения элемента карты сети с имеющимися проблемами. Не используется для элементов изображений.|
|label|строка|Подпись к элементу.|
|label\_location|целое число|Размещение подписи к элементу карты сети.<br><br>Возможные значения:<br>-1 - *(по умолчанию)* размещение по умолчанию;<br>0 - снизу;<br>1 - слева;<br>2 - справа;<br>3 - сверху.|
|permission|целое число|Тип уровня прав доступа.<br><br>Возможные значения:<br>-1 - отсутствуют;<br>2 - только чтение;<br>3 - чтение-запись.|
|sysmapid|строка|*(только чтение)* ID карты сети, которой принадлежит элемент.|
|urls|array|URL'ы элемента карты.<br><br>Объект URL элемента карты [детально описан ниже](object#url_элемента_карты).|
|use\_iconmap|целое число|Необходимо ли использовать соответствие иконок для элементов узлов сети.<br><br>Возможные значения:<br>0 - не использовать соответствие иконок;<br>1 - *(по умолчанию)* использовать соответствие иконок.|
|viewtype|целое число|Алгоритм размещения элемента группы узлов сети.<br><br>Возможные значения:<br>0 - *(по умолчанию)* сетка.|
|width|целое число|Ширина фиксированного размера элемента группы узлов сети в пикселях.<br><br>По умолчанию: 200.|
|x|целое число|X-координата элемента в пикселях.<br><br>По умолчанию: 0.|
|y|целое число|Y-координата элемента в пикселях.<br><br>По умолчанию: 0.|

#### Элемент карты Узел сети

Объект элемента карты Узел сети задает один элемент узла сети.

|Свойство|Тип|Описание|
|----------------|------|----------------|
|hostid|строка|ID узла сети|

#### Элемент карты Группа узлов сети

Объект элемента карты Группы узлов сети задает один элемент группы узлов
сети.

|Свойство|Тип|Описание|
|----------------|------|----------------|
|groupid|строка|ID группы узлов сети|

#### Элемент карты Карта сети

Объект элемента карты Карты сети задает один элемент карты сети.

|Свойство|Тип|Описание|
|----------------|------|----------------|
|sysmapid|строка|ID карты сети|

#### Элемент карты URL

Объект URL элемента карты задает нажимаемую ссылку, которая будет
доступна определенному элементу карты сети. Этот объект имеет следующие
свойства:

|Свойство|Тип|Описание|
|----------------|------|----------------|
|sysmapelementurlid|строка|*(только чтение)* ID URL элемента карты.|
|**name**<br>(требуется)|строка|Подпись к ссылке.|
|**url**<br>(требуется)|строка|URL ссылки.|
|selementid|строка|ID элемента карты, которому принадлежит URL.|

### Связь карты

Объект связи карты задает связь между двумя элементами карты сети. Этот
объект имеет следующие свойства.

|Свойство|Тип|Описание|
|----------------|------|----------------|
|linkid|строка|*(только чтение)* ID связи карты.|
|**selementid1**<br>(требуется)|строка|ID первого элемента карты сети, присоединенного с одного конца.|
|**selementid2**<br>(требуется)|строка|ID второго элемента карты сети, присоединенного с другого конца.|
|color|строка|Цвет линии в виде шестнадцатеричного кода цвета.<br><br>По умолчанию: `000000`.|
|drawtype|целое число|Стиль отрисовки линии связи.<br><br>Возможные значения:<br>0 - *(по умолчанию)* линия;<br>2 - жирная линия;<br>3 - точечная линия;<br>4 - пунктирная линия.|
|label|строка|Подпись к связи.|
|linktriggers|массив|Триггеры связи на карте сети, которые используются в качестве индикатров состояния связи.<br><br>Объект триггеров связи на карте сети [детально описан ниже](object#триггера_связи_на_карте).|
|permission|целое число|Тип уровня прав доступа.<br><br>Возможные значения:<br>-1 - отсутствуют;<br>2 - только чтение;<br>3 - чтение-запись.|
|sysmapid|строка|ID карты сети, которой принадлежит связь.|

#### Триггера связи на карте

Объект триггера связи на карте задаёт индикатор состояния связи карты,
основываясь на состоянии триггера. Этот объект имеет следующие свойства:

|Свойство|Тип|Описание|
|----------------|------|----------------|
|linktriggerid|строка|*(только чтение)* ID триггера связи на карте.|
|**triggerid**<br>(требуется)|строка|ID триггера, который используется индикатором связи.|
|color|строка|Цвет индикатора в виде шестнадцатеричного кода цвета.<br><br>По умолчанию: `DD0000`.|
|drawtype|целое число|Стиль отрисовки индикатора.<br><br>Возможные значения:<br>0 - *(по умолчанию)* линия;<br>2 - жирная линия;<br>3 - точечная линия;<br>4 - пунктирная линия.|
|linkid|строка|ID связи карты сети, которой принадлежит триггер связи.|

### URL карты

Объект URL карты задает нажимаемую ссылку, которая становится доступной
всем элементам определенного типа карты сети. Этот объект имеет
следующие свойства:

|Свойство|Тип|Описание|
|----------------|------|----------------|
|sysmapurlid|строка|*(только чтение)* ID URL карты.|
|**name**<br>(требуется)|строка|Подпись к ссылке.|
|**url**<br>(требуется)|строка|URL ссылки.|
|elementtype|целое число|Тип элемента карты сети, которому будет доступен URL.<br><br>Обратитесь к [свойству "type" элемента карты](object#элемент_карты) для получения списка поддерживаемых типов.<br><br>По умолчанию: 0.|
|sysmapid|строка|ID карты сети, которой принадлежит URL.|

### Пользователь карты

Список прав доступа к карте сети основанный на пользователях. Этот
объект имеет следующие свойства:

|Свойство|Тип|Описание|
|----------------|------|----------------|
|sysmapuserid|строка|*(только чтение)* ID пользователя карты.|
|**userid**<br>(требуется)|строка|ID пользователя.|
|**permission**<br>(требуется)|целое число|Тип уровня прав доступа.<br><br>Возможные значения:<br>2 - только чтение;<br>3 - чтение-запись;|

### Группа пользователей карты

Список прав доступа к карте сети основанный на группах пользователей.
Этот объект имеет следующие свойства:

|Свойство|Тип|Описание|
|----------------|------|----------------|
|sysmapusrgrpid|строка|*(только чтение)* ID группы пользователей карты.|
|**usrgrpid**<br>(требуется)|строка|ID группы пользователей.|
|**permission**<br>(требуется)|целое число|Тип уровня прав доступа.<br><br>Возможные значения:<br>2 - только чтение;<br>3 - чтение-запись;|

### Фигуры карты

Объект фигуры карты задает геометрическую фигуру (с или без текста),
которая отображается на карте сети. Этот объект имеет следующие
свойства:

|Свойство|Тип|Описание|
|----------------|------|----------------|
|sysmap\_shapeid|строка|*(только чтение)* ID элемента фигуры карты.|
|**type** (требуется)|целое число|Тип элемента фигуры карты.<br><br>Возможные значения:<br>0 - прямоугольник;<br>1 - эллипс.<br><br>Свойство требуется указывать при создании новых фигур.|
|x|целое число|X-координата фигуры в пикселях.<br><br>По умолчанию: 0.|
|y|целое число|Y-координата фигуры в пикселях.<br><br>По умолчанию: 0.|
|width|целое число|Ширина фигуры в пикселях.<br><br>По умолчанию: 200.|
|height|целое число|Высота фигуры в пикселях.<br><br>По умолчанию: 200.|
|text|строка|Текст к фигуре.|
|font|целое число|Шрифт текста внутри фигуры.<br><br>Возможные значения:<br>0 - Georgia, serif<br>1 - “Palatino Linotype”, “Book Antiqua”, Palatino, serif<br>2 - “Times New Roman”, Times, serif<br>3 - Arial, Helvetica, sans-serif<br>4 - “Arial Black”, Gadget, sans-serif<br>5 - “Comic Sans MS”, cursive, sans-serif<br>6 - Impact, Charcoal, sans-serif<br>7 - “Lucida Sans Unicode”, “Lucida Grande”, sans-serif<br>8 - Tahoma, Geneva, sans-serif<br>9 - “Trebuchet MS”, Helvetica, sans-serif<br>10 - Verdana, Geneva, sans-serif<br>11 - “Courier New”, Courier, monospace<br>12 - “Lucida Console”, Monaco, monospace<br><br>По умолчанию: 9.|
|font\_size|целое число|Размер шрифта в пикселях.<br><br>По умолчанию: 11.|
|font\_color|строка|Цвет шрифта.<br><br>По умолчанию: '000000'.|
|text\_halign|целое число|Выравнивание текста по горизонтали.<br><br>Возможные значения:<br>0 - по центру;<br>1 - слева;<br>2 - справа.<br><br>По умолчанию: 0.|
|text\_valign|целое число|Выравнивание текста по вертикали.<br><br>Возможные значения:<br>0 - по центру;<br>1 - сверху;<br>2 - снизу.<br><br>По умолчанию: 0.|
|border\_type|целое число|Тип рамки.<br><br>Возможные значения:<br>0 - нет;<br>1 - `—————`;<br>2 - `·····`;<br>3 - `- - -`.<br><br>По умолчанию: 0.|
|border\_width|целое число|Ширина рамки в пикселях.<br><br>По умолчанию: 0.|
|border\_color|строка|Цвет рамки.<br><br>По умолчанию: '000000'.|
|background\_color|строка|Цвет фона (заполнение цветом).<br><br>По умолчанию: `(пусто)`.|
|zindex|целое число|Значение, используемое для упорядочивания фигур (z-index).<br><br>По умолчанию: 0.|

### Линии карты

Объект линии карты задает линию, которая отображается на карте сети.
Этот объект имеет следующие свойства:

|Свойство|Тип|Описание|
|----------------|------|----------------|
|sysmap\_shapeid|строка|*(только чтение)* ID элемента линии карты.|
|x1|целое число|X-координата 1 точки линии в пикселях.<br><br>По умолчанию: 0.|
|y1|целое число|Y-координата 1 точки линии в пикселях.<br><br>По умолчанию: 0.|
|x2|целое число|X-координата 2 точки линии в пикселях.<br><br>По умолчанию: 200.|
|y2|целое число|Y-координата 2 точки линии в пикселях.<br><br>По умолчанию: 200.|
|line\_type|целое число|Тип рамки.<br><br>Возможные значения:<br>0 - none;<br>1 - `—————`;<br>2 - `·····`;<br>3 - `- - -`.<br><br>По умолчанию: 0.|
|line\_width|целое число|Ширина рамки в пикселях.<br><br>По умолчанию: 0.|
|line\_color|строка|Цвет рамки.<br><br>По умолчанию: '000000'.|
|zindex|целое число|Значение, используемое для упорядочивания фигур (z-index).<br><br>По умолчанию: 0.|
