Obtenir une légende pour une carte nommée

Description

Renvoie la légende complète d'une carte nommée en précisant la carte nommée, la taille de pavé et le type Mime des légendes. La légende est renvoyée sous forme de lignes de pavés, avec un image (ou URL) codée au format Base64 et une description textuelle, pour former une légende complète. Pour chaque couche de la carte nommée, zéro, une ou plusieurs entrées de légende sont renvoyées.

Flux d'autorisation ACL

Pour obtenir la légende complète d'une carte nommée, l'utilisateur (ou les rôles auxquels il appartient) aura besoin de l'autorisation Execute sur la carte nommée de la manière suivante :

« EXECUTE » pour le type d'entité « Location Intelligence.Named Resources »

Format d'URL GET HTTP

Les requêtes GET HTTP se présentent au format suivant :


HTTP GET /maps/map name/legend.type;w=width;h=height;t=image type;
[r=resolution]?[inlineSwatch=boolean]&[ignoreLegendRowOverrideVisibility=boolean]

Paramètres

Pour plus d'informations sur les types de paramètres répertoriés ci-dessous, reportez-vous à la section Types de données d'URL de requête.

Paramètre	Type	Obligatoire	Description
`map name`	Chaîne	oui	Nom de la carte dont renvoyer la légende. La carte est définie par une balise RegEx pour la carte nommée à afficher basée sur l'emplacement de la carte nommée dans le référentiel. Le nom de la carte nommée est défini entre la portion /maps de l'URL et la portion /legend.`legend type` de l'URL. Par exemple, pour afficher une carte nommée se trouvant à l'emplacement /earth/Europe du référentiel, l'URL suivante est utilisée : http://www.pbbi.com/rest/Spatial/Nom de la carte dont renvoyer la légende.MappingService /maps/earth/Europe/legend.png;...
`type`	Chaîne	oui	Type d'informations en fonction desquelles renvoyer la légende (par exemple, JSON)
w=`width`	Entier	oui	Largeur du pavé de légende individuel en pixels.
h=`height`	Entier	oui	Hauteur du pavé de légende individuel en pixels.
t=`image type`	Chaîne	oui	Type d'images à renvoyer pour les pavés de légende (par exemple, gif, png)
r=`resolution`	Entier	non	Résolution PPP des pavés de légende sous forme d'entier. PPP mesure la résolution des images en points par pouce (nombre de points individuels qui peuvent être placés sur un pouce linéaire). Si ces paramètres ne sont pas précisés, les paramètres du serveur par défaut sont utilisés.
inlineSwatch=`boolean`	Booléen	non	Détermine si les images de pavé sont renvoyées sous forme de données ou d'URL à l'emplacement des images sur le serveur. Par défaut, toutes les images de pavé sont renvoyées sous forme d'images codées au format Base64 dans la réponse JSON (inlineSwatch=true). Pour renvoyer des URL d'image de pavé aux images qui se trouvent sur le serveur, précisez inlineSwatch=false.
ignoreLegendRowOverrideVisibility=`boolean`	Booléen	non	Ignore le paramètre de visibilité LegendRowOverride d'une ressource nommée et renvoie toutes les légendes.

Résultat

Renvoie une série de valeurs de chaîne renvoyées par un objet de réponse JSON qui représentent tous les pavés de légende de la carte nommée. Pour chaque couche de la carte nommée, zéro, une ou plusieurs entrées de légende sont renvoyées.

La réponse suivante correspond à la description d'un pavé pour une seule couche de la carte nommée. L'image est renvoyée sous forme d'image codée au format Base64 par défaut.


{
    "LegendResponse": [
        {
      "layerName": "World Capitals",
      "rows": [      {
        "description": "Point",
        "swatch": "data:image/png,iVBORw0KGgoAAAANS...Y7+FTjG4YRZmUapmYLgAAnL52mL+8YEIAAAAASUVORK5CYII="
      }],
      "title": "World Capitals",
      "type": "CARTOGRAPHIC"
		}
	]
}

La réponse suivante correspond au même pavé que le précédent, à l'exception près que c'est l'URL de l'image de pavé générée qui est renvoyée (en définissant le paramètre inlineSwatch sur false).


{
    "LegendResponse": [
        {
      "layerName": "World Capitals",
      "rows": [      {
        "description": "Point",
        "swatch": "http://www.pbbi.com/MappingService/services/rest/maps/Samples/NamedMaps/MapWithLayer/
        legends/0/rows/0/swatch/16x32.png"
      }],
      "title": "World Capitals",
      "type": "CARTOGRAPHIC"
		}
	]
}

Exemple

Renvoie la légende (pavés et informations) de la carte nommée MapWithLayer, qui se trouve dans le répertoire /Samples/NamedMaps du référentiel, au format JSON. Les pavés mesurent 32 x 16 pixels, ils sont au format PNG et renvoyés sous forme d'images codées au format Base64.


http://www.pbbi.com/rest/Spatial/MappingService/maps/Samples/NamedMaps/MapWithLayer/
legends.json;w=16;h=32;t=png

Renvoie la légende (pavés et informations) de la carte nommée MapWithLayer, qui se trouve dans le répertoire /Samples/NamedMaps du référentiel, au format JSON. Les pavés mesurent 32 x 32 pixels, ils sont au format GIF et renvoyés sous forme d'URL pointant vers les images qui se trouvent sur le serveur.


http://www.pbbi.com/rest/Spatial/MappingService/maps/Samples/NamedMaps/MapWithLayer/
legends.json;w=32;h=32;t=gif?inlineSwatch=false