Obtener leyenda para un mapa con nombre asignado

Descripción

Arroja la leyenda completa de un mapa con nombre asignado, al especificar el mapa con nombre asignado, el tamaño de muestra y el tipo mime de las leyendas. La leyenda se arroja como filas de muestras únicas, lo que incluye una imagen codificada de base64 (o URL) y una descripción del texto, constituyendo una leyenda completa. Por cada capa en el mapa con nombre asignado, se arrojarán cero, una o más entradas de leyenda.

Formato de dirección URL de HTTP GET

El siguiente formato se utiliza para solicitudes HTTP GET:


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

Parámetros

Consulte Tipos de datos de URL de solicitud, para obtener información acerca de los tipos de parámetros que se indican a continuación.

Parámetro Tipo Requerido Descripción
map name Cadena sí El nombre del mapa para arrojar la leyenda. El mapa se especifica mediante un regex para el mapa con nombre asignado que se va a generar, a partir de la ubicación del mapa con nombre asignado en el repositorio. El nombre del mapa con nombre asignado se define entre la parte /maps de la dirección URL y la parte /legend.legend type de la misma. Por ejemplo, para generar un mapa con nombre asignado que se ubica en /earth/Europe en el repositorio, se usaría la siguiente dirección URL: 
http://www.pbbi.com/rest/Spatial/El nombre del mapa para arrojar la leyenda.MappingService
/maps/earth/Europe/legend.png;...
tipo Cadena sí El tipo de información que se arrojará para la leyenda (por ejemplo, JSON)
w=ancho Integer sí Ancho de la muestra individual de leyenda en píxeles
h=alto Integer sí Altura de la muestra individual de leyenda en píxeles
t=tipo de imagen Cadena sí El tipo de imágenes que se arrojará para las muestras de leyenda (por ejemplo, gif o png)
r=resolución Integer no La resolución DPI de las muestras de leyenda como un entero. Los DPI miden la resolución de las imágenes en puntos por pulgada (la cantidad de puntos que pueden colocarse en lo que abarca una pulgada lineal). Si no se especifica, asume el valor predeterminado del servidor.
inlineSwatch=booleano Boolean no Determina si las imágenes de muestra se arrojan como datos o URL a la ubicación de la imagen en el servidor. De manera predeterminada, todas las imágenes de muestra se arrojan como imágenes codificadas base 64 en la respuesta JSON (inlineSwatch=verdadero). Para arrojar URLs de imagen de muestra a las imágenes ubicadas en el servidor, especifique inlineSwatch=false.
ignoreLegendRowOverrideVisibility=boolean Boolean no Ignora la configuración de visibilidad de LegendRowOverride en un recurso con nombre asignado y arroja todas las leyendas.

Devolución

Arroja una matriz de valores de cadena devueltos en un objeto de respuesta JSON, que representa todas las muestras de leyenda del mapa con nombre asignado. Por cada capa en el mapa con nombre asignado, se arrojarán cero, una o más entradas de leyenda.

La siguiente respuesta es una descripción de muestra de una sola capa en el mapa con nombre asignado. La imagen se arroja como la imagen codificada base 64 predeterminada.


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

La siguiente respuesta es la misma muestra que anteriormente, sin embargo, se devuelve una dirección URL hacia la imagen de muestra generada (configuración del parámetro inlineSwatch en falso).


{
    "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"
		}
	]
}

Ejemplo

Arroje la leyenda (muestras e información) del mapa con nombre asignado MapWithLayer, ubicado en el directorio /Samples/NamedMaps en el repositorio, en formato JSON. Las muestras serán de 32 x 16, en formato PNG, y se arrojarán como imágenes codificadas base 64.


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

Arroje la leyenda (muestras e información) del mapa con nombre asignado MapWithLayer, ubicado en el directorio /Samples/NamedMaps en el repositorio, en formato JSON. Las muestras serán de 32 x 32, en formato gif, y se devolverán como URL hacia las imágenes ubicadas en el servidor.


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