Abrufen einer Legende für eine benannte Karte

Beschreibung

Gibt die vollständige Legende einer benannten Karte zurück, indem die benannte Karte, die Mustergröße und der MIME-Typ der Legenden angegeben werden. Die Legende wird als einzelne Musterzeilen einschließlich eines Base64-verschlüsselten Bildes (oder URL) und einer Textbeschreibung zurückgegeben, die eine vollständige Legende ausmachen. Für jeden Layer in der benannten Karte werden null, einer oder mehrere Legendeneinträge zurückgegeben.

ACL-Autorisierungsfluss

Um die vollständige Legende einer benannten Karte zu erhalten, benötigt der Benutzer (oder alle Rollen, zu denen er gehört) wie folgt die Ausführungsberechtigung für die benannte Karte:

  • „EXECUTE“ für den Entitätstyp „Location Intelligence.Named Resources“

URL-Format von HTTP-GET-Anforderungen

Das folgende Format wird für HTTP-GET-Anforderungen verwendet:


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

Parameter

Weitere Informationen über die unten aufgeführten Parametertypen finden Sie unter URL-Anforderungsdatentypen.

Parameter Typ Erforderlich Beschreibung
map name Zeichenfolge ja Der Name der Karte, die die Legende zurückgeben soll. Die Karte wird durch einen Regex für die benannte Karte angegeben, um basierend auf dem Speicherort der benannten Karte in der Datenbank zu rendern. Der Name der benannten Karte wird zwischen dem „/maps“-Teil und dem „/legend.legend type“-Teil der URL definiert. Zum Rendern einer benannten Karte, die sich z. B. unter „earth/Europe“ in der Datenbank befindet, würde die folgende URL verwendet werden: 
http://www.pbbi.com/rest/Spatial/Der Name der Karte, die die Legende zurückgeben soll.MappingService
/maps/earth/Europe/legend.png;...
Typ Zeichenfolge ja Der Typ der Informationen, die die Legende zurückgeben sollen (z. B. JSON)
w=Breite Ganze Zahl ja Breite des einzelnen Legendenmusters in Pixeln
h=Höhe Ganze Zahl ja Höhe des einzelnen Legendenmusters in Pixeln
t = Bildtyp Zeichenfolge ja Der Typ der Bilder, die für Legendenmuster zurückgegeben werden sollen (z. B. gif oder png)
r=Auflösung Ganze Zahl no Die DPI-Auflösung der Legendenmuster als ganze Zahl. DPI misst die Auflösung der Bilder in Punkten pro Zoll (die Anzahl der einzelnen Punkte, die im Bereich von einem linearen Zoll angeordnet werden können). Ist dieser Wert nicht angegeben, wird der Serverstandard verwendet.
inlineSwatch = Bool'scher Wert Boolean no Bestimmt, ob die Musterbilder als Daten oder URL zum Bildspeicherort auf dem Server zurückgegeben werden sollen. Standardmäßig werden alle Musterbilder als Base64-verschlüsselte Bilder in der JSON-Antwort zurückgegeben (inlineSwatch=true). Geben Sie „inlineSwatch=false“ an, um Musterbild-URLs für die Bilder auf dem Server zurückzugeben.
ignoreLegendRowOverrideVisibility=boolean Boolean no Ignoriert die Sichtbarkeitseinstellung von LegendRowOverride in einer benannten Ressource und gibt alle Legenden zurück.

Gibt zurück:

Gibt ein Array von Zeichenfolgenwerten in einem JSON-Antwortobjekt zurück, das alle Legendenmuster für die benannte Karte darstellt. Für jeden Layer in der benannten Karte werden null, einer oder mehrere Legendeneinträge zurückgegeben.

Die folgende Antwort ist eine Musterbeschreibung für einen einzelnen Layer in der benannten Karte. Das Bild wird als standardmäßige Base64-verschlüsseltes Bild zurückgegeben.


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

Die folgende Antwort ist das gleiche Muster wie oben. Es wird jedoch eine URL zum generierten Musterbild zurückgegeben (Einstellung des inlineSwatch-Parameters auf „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"
		}
	]
}

Beispiel

Geben Sie die Legende (Muster und Informationen) für die benannte MapWithLayer-Karte zurück, die sich im JSON-Format im Datenbankverzeichnis „/Samples/NamedMaps“ befindet. Die Muster sind 32 × 16 groß, im PNG-Format und werden als Base64-verschlüsselte Bilder zurückgegeben.


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

Geben Sie die Legende (Muster und Informationen) für die benannte MapWithLayer-Karte zurück, die sich im JSON-Format im Datenbankverzeichnis „/Samples/NamedMaps“ befindet. Die Muster sind 32 × 32 groß, im GIF-Format und werden als URLs zu den Bildern auf dem Server zurückgegeben.


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