名前付きマップの凡例の取得

説明

名前付きマップおよび凡例の見本のサイズと MIME タイプを指定して、名前付きマップの凡例一式を返します。凡例は、見本を表す行一式として返されます。これには、base64 エンコードイメージ (または URL) とテキスト記述も含まれ、それらすべてで凡例全体が構成されます。名前付きマップのレイヤごとに、0 個、1 個、または 2 個以上の凡例エントリが返されます。

HTTP GET URL 形式

HTTP GET リクエストには次の形式を使用します。


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

パラメータ

以下のパラメータのタイプについては、リクエスト URL のデータタイプを参照してください。


パラメータ	タイプ	必須	説明
`map name`	String	はい	凡例を取得するマップの名前。マップは、リポジトリ内の名前付きマップの場所に基づいて、レンダリングする名前付きマップの Regex で指定します。名前付きマップの名前は、URL の /maps 部と URL の /legend.`legend type` 部の間で定義します。例えば、リポジトリ内の /earth/Europe にある名前付きマップをレンダリングするには、次のような URL を使用します。 http://www.pbbi.com/rest/Spatial/ legend.MappingService を返すマップの名前 /maps/earth/Europe/legend.png;...
`type`	String	はい	凡例を取得する情報のタイプ (JSON など)
w=`width`	Integer	はい	各凡例見本の幅 (ピクセル単位)
h=`height`	Integer	はい	各凡例見本の高さ (ピクセル単位)
t=`image type`	String	はい	凡例見本として取得するイメージのタイプ (gif、png など)
r=`resolution`	Integer	いいえ	凡例見本の DPI 解像度を整数として指定します。DPI は、イメージの解像度を 1 インチあたりのドット数 (1 リニアインチ内に含めることのできるドットの数) で測定します。指定しない場合は、サーバーのデフォルトが使用されます。
inlineSwatch=`boolean`	Boolean	いいえ	見本のイメージをデータで返すか、サーバー上のイメージの場所への URL で返すかを指定します。デフォルトでは、JSON レスポンスのすべての見本のイメージは、Base64 エンコードイメージとして返されます (inlineSwatch=true)。サーバー上のイメージの場所を示す見本イメージ URL を返すには、inlineSwatch=false を指定します。
ignoreLegendRowOverrideVisibility=`boolean`	Boolean	いいえ	名前付きリソースの可視性設定 LegendRowOverride を無視して、すべての凡例を返します。

戻り値

JSON レスポンスオブジェクトで、名前付きマップのすべての凡例見本を表す String 値配列を返します。名前付きマップのレイヤごとに、0 個、1 個、または 2 個以上の凡例エントリが返されます。

以下のレスポンスは、名前付きマップ内の単一レイヤの見本記述です。イメージは、デフォルトの Base64 エンコードイメージとして返されています。


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

以下のレスポンスは、上と同じ見本ですが、生成された見本イメージへの URL が返されています (inlineSwatch パラメータを 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"
		}
	]
}

例

リポジトリ内の /Samples/NamedMaps ディレクトリにある MapWithLayer 名前付きマップの凡例 (見本と情報) を JSON 形式で返します。見本は、32 x 16 の PNG 形式で、Base64 エンコードイメージとして返されます。


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

リポジトリ内の /Samples/NamedMaps ディレクトリにある MapWithLayer 名前付きマップの凡例 (見本と情報) を JSON 形式で返します。見本は、32 x 32 の gif 形式で、サーバー上のイメージの場所への URL として返されます。


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