Map Legends

Get Interval Legend

Changed on

Generate values and color swatches mapping for a given interval classmap.

Returns a color map for intervals, where each interval is defined by a numeric range [min, max] representing the interval boundaries and an RGBA color [red, green, blue, alpha] associated with the interval.

The response is a 2D array of interval definitions, where each element is a pair: the first element is an array of two numbers [min, max] defining the interval, and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color.

Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]]. This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow.

get/data/legend/interval/{classmapName}

Request

  • Base URL
    {endpoint}
  • URL
    {endpoint}/data/legend/interval/{classmapName}
  • Auth
    OAuth 2
    Implicit: https://login.microsoftonline.com/common/oauth2/authorize
    Scopes: https://geocatalog.spatio.azure.com/.default

Path parameters

classmapNamestring required

classmap name

Query parameters

api-versionstring required

The API version to use for this operation.

trim_startinteger

Number of items to trim from the start of the cmap

trim_endinteger

Number of items to trim from the end of the cmap

Response

Interval legend response model.

Represents a color map for intervals, where each interval is defined by:

  • A numeric range [min, max] representing the interval boundaries.
  • An RGBA color [red, green, blue, alpha] associated with the interval.

The response is a 2D array of interval definitions, where each element is a pair:

  • The first element is an array of two numbers [min, max] defining the interval.
  • The second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color.

Example:

[
  [
    [-2, 0], [0, 0, 0, 0]
  ],
  [
    [1, 32], [255, 255, 178, 255]
  ]
]

This example defines two intervals:

  • The interval [-2, 0] is mapped to the color [0, 0, 0, 0] (transparent black).
  • The interval [1, 32] is mapped to the color [255, 255, 178, 255] (opaque yellow).

Changes

  • 2025-04-30-preview28e8cb365289Revision changes
    • breaking

      removed the success response with the status

    • info

      api operation id MapsIntervalLegends_GetByClassmapName removed and replaced with MapsIntervalLegends_GetByClassMapName

  • 2025-04-30-preview00cbc3d6d8e0Revision changes
    • info

      api operation id MapsIntervalLegends_GetByClassMapName removed and replaced with MapsIntervalLegends_GetByClassmapName

    • info

      added the success response with the status