[comment]: # ({7bfc83a8-cdacabd4})
# Objecte mapa
Els següents objectes són relacionats amb l'API `map`.
[comment]: # ({/7bfc83a8-cdacabd4})
[comment]: # ({29fc1f83-62f73225})
### Mapa
L'objecte mapa té les següents propietats.
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|sysmapid|string|*(només lectura)* ID del mapa.|
|**height**
(obligatori)|integer|Alçada del mapa en píxels.|
|**name**
(obligatori)|string|Nom de la tarja.|
|**width**
(obligatori)|integer|Amplada del mapa en píxels.|
|backgroundid|string|ID de la imatge emprada com a fons del mapa.|
|expand\_macros|integer|Indica si s'han d'ampliar les macros a les etiquetes quan es configura el mapa.
Valors possibles:
0 - *(per defecte)* no s'amplien;
1 - ampliar macros.|
|expandproblem|integer|Indica si el trigger del problema es mostrarà per als elements amb un sol problema.
Valors possibles:
0 - sempre mostra el nombre de problemes;
1 - *(per defecte) * mostra el trigger del problema si només hi ha un problema.|
|grid\_align|integer|Indica si s'ha d'activar l'alineació de la quadrícula.
Valors possibles:
0 - desactiva l'alineació de la quadrícula;
1 - *(per defecte)* activa l'encaix a la quadrícula.|
|grid\_show|integer|Indica si s'ha de veure la graella al mapa.
Valors possibles:
0 - no mostra la graella;
1 - *(per defecte)* mostra la graella .|
|grid\_size|integer|Mida de la quadrícula del mapa en píxels.
Valors admesos: 20, 40, 50, 75 i 100.
Per defecte: 50.|
|highlight|integer|Indica si el ressaltat de les icones és habilitat.
Valors possibles:
0 - ressaltat desactivat;
1 - *(per defecte)* ressaltat activat.|
|iconmapid|string|ID del mapa d'icones emprat al mapa.|
|label\_format|integer|Indica si s'han d'activar les etiquetes avançades.
Valors possibles:
0 - *(per defecte)* desactiva les etiquetes avançades;
1 - activa-les.|
|label\_location|integer|Ubicació de l'etiqueta de l'element del mapa.
Valors possibles:
0 - *(per defecte)* inferior;
1 - esquerra;
2 - dreta;< br>3 - a dalt.|
|label\_string\_host|string|Etiqueta personalitzada per als elements d'equip.
Requerit per als mapes amb tipus d'etiqueta d'equip personalitzat.|
|label\_string\_hostgroup|string|Etiqueta personalitzada per als elements del grup d'equips.
Requerit per als mapes amb tipus d'etiqueta de grup d'equips personalitzat.|
|label\_string\_image|string|Etiqueta personalitzada per als elements d'imatge.
Requerit per als mapes amb tipus d'etiqueta d'imatge personalitzada.|
|label\_string\_map|string|Etiqueta personalitzada per als elements del mapa.
Requerit per als mapes amb tipus d'etiqueta de mapa personalitzat.|
|label\_string\_trigger|string|Etiqueta personalitzada per als elements trigger.
Obligatori per a targetes amb tipus d'etiqueta trigger personalitzat.|
|label\_type|integer|Tipus d'etiqueta d'element del mapa.
Valors possibles:
0 - etiqueta;
1 - adreça IP;
2 - *(per defecte)* nom de l'element;< br>3 - només estat;
4 - res.|
|label\_type\_host|integer|Tipus d'etiqueta per als elements de l'equip.
Valors possibles:
0 - etiqueta;
1 - adreça IP;
2 - *(per defecte)* nom de l'element;
3 - només estat;
4 - res;
5 - personalitzat.|
|label\_type\_hostgroup|integer|Tipus d'etiqueta per als elements del grup d'equips.
Valors possibles:
0 - etiqueta;
2 - *(per defecte)* nom de l'element;
3 - només estat;
4 - res;
5 - personalitzat.|
|label\_type\_image|integer|Tipus d'etiqueta per als elements de la imatge.
Valors possibles:
0 - etiqueta;
2 - *(per defecte)* nom de l'element;
4 - res;
5 - personalitzat.|
|label\_type\_map|integer|Tipus d'etiqueta per als elements del mapa.
Valors possibles:
0 - etiqueta;
2 - *(per defecte)* nom de l'element;
3 - només estat;
4 - res;
5 - personalitzat.|
|label\_type\_trigger|integer|Tipus d'etiqueta per als triggers.
Valors possibles:
0 - etiqueta;
2 - *(per defecte)* nom de l'element;
3 - només estat;
4 - res;
5 - personalitzat.|
|markelements|integer|Indica si cal ressaltar els elements del mapa que han canviat d'estat recentment.
Valors possibles:
0 - *(per defecte)* no ressalten els elements;
1 - ressalten els elements.|
|severity\_min|integer|Gravetat mínima dels triggers que es mostraran al mapa.
Consulteu la [propietat "gravetat" d'un trigger](/manual/api/reference/trigger/object# trigger ) per obtindre un llistat de les gravetats admeses.|
|show\_unack|integer|Com s'han de veure els problemes.
Valors possibles:
0 - *(per defecte)* ensenya el recompte de tots els problemes;
1 - ensenya només el nombre de problemes no reconeguts;
2 - ensenya el nombre de problemes reconeguts i no reconeguts per separat.|
|userid|string|identificador de l'usuari propietari del mapa.|
|private|integer|Tipus de compartició del mapa.
Valors possibles:
0 - mapa públic;
1 - *(per defecte)* mapa privat.|
|show\_suppressed|integer|Indica si es mostren els problemes suprimits.
Valors possibles:
0 - *(per defecte)* amaga els problemes suprimits;
1 - ensenya els problemes suprimits.|
Tingueu en compte que per a alguns mètodes (actualitzar, esborrar) la combinació de paràmetres obligatoris/opcionals és diferent.
[comment]: # ({/29fc1f83-62f73225})
[comment]: # ({868adba3-c7b92dfc})
### Element de mapa
L'objecte d'element del mapa defineix un objecte que es mostra en un mapa. Té les següents propietats.
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|selementid|string|*(només lectura)* ID de l'element del mapa.|
|**elements**
(obligatori)|array|Objecte de dades de l'element. Necessari per a elements d'equip, grup d'equips, trigger i tipus de mapa.|
|**elementtype**
(obligatori)|integer|Tipus d'element del mapa.
Valors possibles:
0 - equip;
1 - mapa;
2 - trigger;< br>3 - grup d'equips;
4 - imatge.|
|**iconid\_off**
(obligatori)|string|ID de la imatge emprada per ensenyar l'element en estat predeterminat.|
|areatype|integer|Com s'han d'ensenyar diferents equips del grup d'equips.
Valors possibles:
0 - *(per defecte)* l'element del grup d'equips ocuparà tot el mapa;
1 - l'element del grup d'equips tindrà una mida fixa.|
|elementsubtype|integer|Com s'ha d'ensenyar un element del grup d'equips al mapa.
Valors possibles:
0 - *(per defecte)* mostra el grup d'equips com a element únic;
1 - mostra cada equip al grup per separat.|
|evaltype|integer|Mètode per avaluar les condicions del filtre d'etiquetes d'elements del mapa.
Valors possibles:
0 - *(per defecte)* I/O;
2 - O.|
|height|integer|Alçada de l'element del grup d'equips de mida fixa en píxels.
Per defecte: 200.|
|iconid\_disabled|string|ID de la icona emprada per ensenyar els elements del mapa desactivats. No s'empra per a elements de tipus d'imatge.|
|iconid\_maintenance|string|Identificador de la icona que s'empra per ensenyar els elements del mapa en manteniment. No s'empra per a elements de tipus d'imatge.|
|iconid\_on|string|Identificador de la icona que s'empra per ensenyar els elements del mapa amb problemes. No s'empra per a elements de tipus d'imatge.|
|label|string|Etiqueta de l'element.|
|label\_location|integer|Posició de l'etiqueta de l'element del mapa.
Valors possibles:
-1 - *(per defecte)* posició per defecte;
0 - sota;
1 - esquerra;
2 - dreta;
3 - dalt.|
|permission|integer|Tipus de nivell de permís.
Valors possibles:
-1 - cap;
2 - només lectura;
3 - lectura-escriptura.|
|sysmapid|string|*(només lectura)* ID del mapa al qual pertany l'element.|
|urls|array|elements del mapa d'URL.
L'objecte de l'element del mapa d'URL és [descrit en detall a continuació](object#map_element_url).|
|use\_iconmap|integer|Indica si s'ha d'emprar l'assignació d'icones per als elements de l'equip.
Valors possibles:
0 - no empreu pas l'assignació d'icones;
1 - *(per defecte)* empreu la icona cartografia.|
|viewtype|integer|Algorisme d'ubicació d'elements del grup d'equips.
Valors possibles:
0 - *(per defecte)* quadrícula.|
|width|integer|Amplada de l'element del grup d'equips de mida fixa en píxels.
Per defecte: 200.|
|x|integer|Coordenada X de l'element en píxels.
Per defecte: 0.|
|y|integer|Coordenada Y de l'element en píxels.
Per defecte: 0.|
[comment]: # ({/868adba3-c7b92dfc})
[comment]: # ({62e76926-305dd3e0})
#### Element de mapa Equip
L'objecte element de mapa d'equips defineix un o més elements d'equips.
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|hostid|string|ID del grup d'equips.|
[comment]: # ({/62e76926-305dd3e0})
[comment]: # ({95fc77e5-e1118d67})
#### Element de mapa grup d'equips
L'objecte element de mapa de grups d'equips defineix un o més elements de grups d'equips.
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|groupid|string|ID del grup d'equips.|
[comment]: # ({/95fc77e5-e1118d67})
[comment]: # ({b9b86c4e-2d745dcc})
#### Element de mapa Mapa
L'objecte element de mapa Mapa defineix un o més elements de Mapes.
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|sysmapid|string|ID del mapa.|
[comment]: # ({/b9b86c4e-2d745dcc})
[comment]: # ({5bd3a35a-0283fd46})
#### Element de mapa Trigger
L'objecte element de mapa Trigger defineix un o més triggers d'elements.
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|triggerid|string|ID del trigger.|
[comment]: # ({/5bd3a35a-0283fd46})
[comment]: # ({3c7f3c29-a7495119})
#### Element del mapa Etiqueta
L'objecte d'element de mapa Etiqueta té les propietats següents.
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|**tag**
(obligatori)|cadena|Nom d'etiqueta de l'element del mapa.|
|operator|enter|Operador de condició d'etiqueta d'element de mapa.
Valors possibles :
0 - *(per defecte)* Conté;
1 - Iguals;
2 - No en conté;
3 - No és igual;
4 - Existeix;
5 - No existeix.|
|value|cadena|Valor d'etiqueta d'element de mapa.|
[comment]: # ({/3c7f3c29-a7495119})
[comment]: # ({e1f313cb-5a112b10})
#### Element de mapa URL
L'objecte element de mapa URL defineix un enllaç clicable que serà disponible per a un element de mapa concret. Té les propietats següents:
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|sysmapelementurlid|string|*(només lectura)* ID de l'element de mapa URL.|
|**name**
(obligatori)|string|Llegenda d'enllaç.|
|**url**
(obligatori)|string|URL de l'enllaç.|
|selementid|string|ID de l'element de mapa on pertany l'URL.|
[comment]: # ({/e1f313cb-5a112b10})
[comment]: # ({379da81c-1e44fd2a})
### Enllaç de mapa
L'objecte d'enllaç al mapa defineix un enllaç entre dos elements del mapa. Té les següents propietats.
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|linkid|string|*(només ectura)* ID de l'enllaç del mapa.|
|**selementid1**
(obligatori)|string|ID del primer element del mapa enllaçat al final.|
|**selementid2**
(obligatori)|string|ID del primer element del mapa enllaçat a l'altre extrem.|
|color|string|Color de línia com a codi de color hexadecimal.
Per defecte: `000000`.|
|drawtype|integer|Estil de línia d'enllaç.
Valors possibles:
0 - *(per defecte)* línia;
2 - línia en negreta;
3 - línia de punts;
4 - línia amb guions.|
|label|string|Etiqueta d'enllaç.|
|linktriggers|array|L'enllaç del mapa s'activa per emprar-lo com a indicadors d'estat de l'enllaç.
L'objecte trigger de l'enllaç del mapa és [descrit en detall a continuació](objecte#map_link_trigger). |
|permission|integer|Tipus de nivell de permís.
Valors possibles:
-1 - cap;
2 - només lectura;
3 - lectura-escriptura.|
|sysmapid|string|ID del mapa al qual pertany l'enllaç.|
[comment]: # ({/379da81c-1e44fd2a})
[comment]: # ({61bc5baf-219c2bce})
#### Trigger d'enllaç de mapa
L'objecte estableix un indicador d'estat d'enllaç de mapa en funció de l'estat d'un trigger. Té les propietats següents:
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|linktriggerid|string|*(només lectura)* ID del trigger de l'enllaç del mapa.|
|**triggerid**
(obligatori)|string|ID del trigger emprat com a indicador d'enllaç.|
|color|string|Color de l'indicador com a codi de color hexadecimal.
Per defecte: `DD0000`.|
|tipus de dibuix|integer|Estil de dibuix de l'indicador.
Valors possibles:
0 - *(per defecte)* línia;
2 - línia en negreta;
3 - línia puntejada;
4 - línia amb guions.|
|linkid|string|ID de l'enllaç del mapa al qual pertany el trigger de l'enllaç.|
[comment]: # ({/61bc5baf-219c2bce})
[comment]: # ({5b3b42dc-96c2bee0})
### URL de mapa
L'objecte defineix un enllaç on es pot fer clic que serà disponible per a tots els elements d'un tipus específic del mapa. Té les propietats següents:
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|sysmapurlid|string|*(només lectura)* ID de l'URL del mapa.|
|**name**
(obligatori)|string|Títol de l'enllaç.|
|**url**
(obligatori)|string|URL de l'enllaç.|
|elementtype|integer|Tipus d'element de mapa per al qual l'URL serà disponible.
Consulteu [la propietat "elementtype" de l'element de mapa](object#map_element) per obtindre un llistat dels tipus admesos.
Per defecte: 0.|
|sysmapid|string|ID del mapa al qual pertany l'URL.|
[comment]: # ({/5b3b42dc-96c2bee0})
[comment]: # ({e4d740dd-942f03ad})
### Usuari de mapa
Llista dels permisos del mapa en funció dels usuaris. L'objecte té les propietats següents:
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|sysmapuserid|string|*(només lectura)* ID del mapa d'usuari.|
|**userid**
(obligatori)|string|ID d'usuari.|
|**permission**
(obligatori)|integer|Nivell de permisos.
Valors possibles:
2 - només lectura;
3 - lectura i escriptura;|
[comment]: # ({/e4d740dd-942f03ad})
[comment]: # ({423a41e7-f6e63a8f})
### Grup d'usuaris del mapa
Llista dels permisos del mapa en funció del grup d'usuaris. L'objecte té les propietats següents:
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|sysmapusergrpid|string|*(només lectura)* ID del grup d'usuaris del mapa.|
|**usergrpid**
(obligatori)|string|ID del grup d'usuaris.|
|**permission**
(obligatori)|integer|Nivell de permisos.
Valors possibles:
2 - només lectura;
3 - lectura i escriptura;|
[comment]: # ({/423a41e7-f6e63a8f})
[comment]: # ({5e96a3b7-9d0acde7})
### Formes del mapa
L'objecte defineix una forma geomètrica (amb text o sense) que s'ensenya a un mapa. Té les propietats següents:
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|sysmap\_shapeid|string|*(només lectura)* ID de la forma del mapa.|
|**tipus** (obligatori)|integer|Tipus de la forma del mapa.
Valors possibles:
0 - rectangle;
1 - el·lipse.
Aquesta propietat és necessària quan es creen noves formes.|
|x|integer|Coordenada X de la forma en píxels.
Per defecte: 0.|
|y|integer|Coordenada Y de la forma en píxels.
Per defecte: 0.|
|width|integer|Amplada de la forma en píxels.
Per defecte: 200.|
|height|integer|Alçada de la forma en píxels.
Per defecte: 200.|
|text|string|Formulari de text.|
|font|integer|Tipus de lletra del text en forma.
Valors possibles:
0 - Geòrgia, serif
1 - "Palatino Linotype", "Book Antiqua", Palatino, serif
2 - "Times New Roman", Times, serif
3 - Arial, Helvetica, sans-serif
4 - "Arial Black", Gadget, sans-serif
5 - "Comic Sans MS", cursive, sans-serif
6 - Impact, Charcoal, sans-serif
7 - “Lucida Sans Unicode”, “Lucida Grande”, sans-serif
8 - Tahoma, Ginebra, sans-serif
9 - “Trebuchet MS”, Helvetica, sans-serif
10 - Verdana, Ginebra, sans-serif
11 - “Courier New”, Courier, monospace
12 - “Lucida Console”, Mònaco, monospace
Per defecte: 9.|
|font\_size|integer|Mida del tipus de lletra en píxels.
Per defecte: 11.|
|font\_color|string|color de la font.
Per defecte: '000000'.|
|text\_halign|integer|Alineació de text horitzontal.
Valors possibles:
0 - centre;
1 - esquerra;
2 - dreta.
Per defecte: 0 .|
|text\_valign|integer|Alineació vertical del text
Valors possibles:
0 - mig;
1 - superior;
2 - inferior.
Per defecte: 0. |
|border\_type|integer|Tipus de vora.
Valors possibles:
0 - cap;
1 - `—————`;
2 - `···· · ` ;
3 - `- - -`.
Per defecte: 0.|
|border\_width|integer|Amplada de la vora en píxels.
Per defecte: 0.|
|border\_color|string|Color de la vora.
Per defecte: '000000'.|
|background\_color|cadena|Color de fons (color de farcit).
Per defecte: `(buida)`.|
|zindex|integer|Valor emprat per ordenar totes les formes i línies (índex z).
Per defecte: 0.|
[comment]: # ({/5e96a3b7-9d0acde7})
[comment]: # ({8f84cf82-b1536eee})
### Línies de mapes
L'objecte defineix una línia que es mostra en un mapa. Té les propietats següents:
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|sysmap\_shapeid|string|*(només lectura)* ID de la forma del mapa.|
|x1|integer|Coordenada X del punt 1 de la línia en píxels.
Per defecte: 0.|
|y1|integer|Coordenada Y del punt 1 de la línia en píxels.
Per defecte: 0.|
|x2|integer|Coordenada X del punt 2 de la línia en píxels.
Per defecte: 200.|
|y2|integer|Coordenada Y del punt 2 de la línia en píxels.
Per defecte: 200.|
|line\_type|integer|Tipus de línia.
Valors possibles:
0 - cap;
1 - `—————`;
2 - `···· · `;
3 - `- - -`.
Per defecte: 0.|
|line\_width|integer|Amplada de línia en píxels.
Per defecte: 0.|
|line\_color|string|Color de línia.
Per defecte: '000000'.|
|zindex|integer|Valor emprat per ordenar totes les formes i línies (índex z).
Per defecte: 0.|
[comment]: # ({/8f84cf82-b1536eee})