Describe Named Label Sources

Description

Cette opération prend une source de libellés nommée ou une liste de sources de libellés nommées en entrée dans la requête et renvoie la description de ses sources de libellés. Les portions de source de libellé de la réponse à cette description peuvent être incorporées à la section de couches de libellés de la définition de la carte, qui peut ensuite être utilisée dans une requête REST Render Map ou Render Map Legend, par exemple, pour aider à déterminer la visibilité de ses libellés.

Flux d'autorisation ACL

Pour répertorier la description des sources d'étiquettes, l'utilisateur (ou les rôles auxquels il appartient) aura besoin de l'autorisation Execute sur les couches nommées de la manière suivante :

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

Format d'URL GET HTTP

Utilisez une requête GET pour une seule source de libellés nommée :

GET http://<server>:<port>/rest/Spatial/MappingService/labelSources/labelSourcePath.json

Format d'URL POST HTTP

Utilisez une requête POST pour plusieurs sources de libellés nommées :


POST http://<server>:<port>/rest/Spatial/MappingService/labelSources.json
	{
            "namedLabelSourcesList":[
		"labelSourcePath1",
		"labelSourcePath2"]
       }

Résultat

Renvoie la description JSON d’une ou de plusieurs sources de libellés nommées.

Exemple - requête GET

Remarque : La sources de libellés nommée de cet exemple est fournie dans le dossier /Samples dans le cadre de la publication de la version 12.0 de Spectrum™ Technology Platform. Pour la version 11.1, utilisez WebDAV pour copier les échantillons du fichier zip ou tar du correctif 11.1 dans votre référentiel.
Requête GET décrivant une seule source de libellés nommée :
http://<server>:<port>/rest/Spatial/MappingService/labelSources/Samples/NamedLabelSources/WorldCountriesLabelSource.json

Réponse :

{
  "labelSourceDescription": {
    "name": "/Samples/NamedLabelSources/WorldCountriesLabelSource",
    "labelSource": {
      "table": {
        "type": "NamedTable",
        "name": "/Samples/NamedTables/WorldcapTable"
      },
      "themeList": null,
      "labelProperties": {
        "style": {
          "type": "MapBasicTextStyle",
          "MapBasicFontStyle": {
            "type": "MapBasicFontStyle",
            "fontName": "Microsoft Sans Serif",
            "style": 0,
            "size": 12,
            "foregroundColor": "0",
            "backgroundColor": "16777215"
          }
        },
        "angle": {
          "value": 0,
          "uom": "DEGREE"
        },
        "expression": null,
        "horizontalAlignment": "CENTER",
        "verticalAlignment": "MIDDLE",
        "xOffset": null,
        "yOffset": null,
        "allowOverlap": true,
        "allowOutOfView": false,
        "allowDuplicate": "ALL",
        "recalculationType": "OUT_OF_VIEW",
        "labelRelativeOrientation": null,
        "justification": "CENTER",
        "referenceGeometry": null
      },
      "visibilityConstraintList": {
        "visibilityConstraint": [
          {
            "type": "ZoomVisibilityConstraint",
            "maxZoom": {
              "value": 6000,
              "uom": "MILE"
            },
            "minZoom": {
              "value": 0,
              "uom": "MILE"
            }
          }
        ]
      },
      "name": "World Countries",
      "renderable": true
    }
  }
}

Exemple - requête POST

Remarque : Les sources de libellés nommées de cet exemple sont fournies dans le dossier /Samples dans le cadre de la publication de la version 12.0 de Spectrum™ Technology Platform. Pour la version 11.1, utilisez WebDAV pour copier les échantillons du fichier zip du correctif 11.1 dans votre référentiel.

Requête POST décrivant plusieurs sources de libellés nommées :


http://<server>:<port>rest/Spatial/MappingService/labelSources.json

{
       "namedLabelSourcesList":[
               "/Samples/NamedLabelSources/WorldCountriesLabelSource",
              "/Samples/NamedLabelSources/DCCitiesLabelSource"
       ]
}

Réponse :


        {
          "labelSourceDescriptions": [
            {
              "name": "/Samples/NamedLabelSources/WorldCountriesLabelSource",
              "labelSource": {
                "table": {
                  "type": "NamedTable",
                  "name": "/Samples/NamedTables/WorldcapTable"
                },
                "themeList": null,
                "labelProperties": {
                  "style": {
                    "type": "MapBasicTextStyle",
                    "MapBasicFontStyle": {
                      "type": "MapBasicFontStyle",
                      "fontName": "Microsoft Sans Serif",
                      "style": 0,
                      "size": 12,
                      "foregroundColor": "0",
                      "backgroundColor": "16777215"
                    }
                  },
                  "angle": {
                    "value": 0,
                    "uom": "DEGREE"
                  },
                  "expression": null,
                  "horizontalAlignment": "CENTER",
                  "verticalAlignment": "MIDDLE",
                  "xOffset": null,
                  "yOffset": null,
                  "allowOverlap": true,
                  "allowOutOfView": false,
                  "allowDuplicate": "ALL",
                  "recalculationType": "OUT_OF_VIEW",
                  "labelRelativeOrientation": null,
                  "justification": "CENTER",
                  "referenceGeometry": null
                },
                "visibilityConstraintList": {
                  "visibilityConstraint": [
                    {
                      "type": "ZoomVisibilityConstraint",
                      "maxZoom": {
                        "value": 6000,
                        "uom": "MILE"
                      },
                      "minZoom": {
                        "value": 0,
                        "uom": "MILE"
                      }
                    }
                  ]
                },
                "name": "World Countries",
                "renderable": true
              }
            },
            {
              "name": "/Samples/NamedLabelSources/DCCitiesLabelSource",
              "labelSource": {
                "table": {
                  "type": "NamedTable",
                  "name": "/Samples/NamedTables/dcwashcities"
                },
                "themeList": null,
                "labelProperties": {
                  "style": {
                    "type": "MapBasicTextStyle",
                    "MapBasicFontStyle": {
                      "type": "MapBasicFontStyle",
                      "fontName": "Verdana",
                      "style": 0,
                      "size": 7,
                      "foregroundColor": "0",
                      "backgroundColor": "15657438"
                    }
                  },
                  "angle": null,
                  "expression": null,
                  "horizontalAlignment": "CENTER",
                  "verticalAlignment": "MIDDLE",
                  "xOffset": null,
                  "yOffset": null,
                  "allowOverlap": false,
                  "allowOutOfView": false,
                  "allowDuplicate": "INTERLAYER",
                  "recalculationType": "OUT_OF_VIEW",
                  "labelRelativeOrientation": "PARALLEL",
                  "justification": "CENTER",
                  "referenceGeometry": null
                },
                "visibilityConstraintList": {
                  "visibilityConstraint": [
                    {
                      "type": "ZoomVisibilityConstraint",
                      "maxZoom": {
                        "value": 50,
                        "uom": "MILE"
                      },
                      "minZoom": {
                        "value": 0,
                        "uom": "MILE"
                      }
                    }
                  ]
                },
                "name": "dcwash~cities",
                "renderable": true
              }
            }
          ]
        }