Sign in
Map Legends

Get Interval Legend

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

Args: trim_start (int, optional): Number of items to trim from the start of the cmap trim_end (int, optional): Number of items to trim from the end of the cmap

get/data/legend/interval/{classmapName}

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