Configuration Geomap Widget

The widget’s configuration schema is defined in src/index.ts. Options and defaults:

  • Station ID:

    • Key: stationId

    • Type: string

    • Example: "s8-1"

  • Endpoint:

    • Key: endpoint

    • Type: TANGO_DB

    • Purpose: Select Tango database endpoint(s). If multiple are selected, the first endpoint is used for polling.

    • Default: uses endpoint "1" when not configured

  • Antenna filter:

    • Key: antennaFilter

    • Type: number[]

    • Purpose: Filter down to specific antenna labels.

  • Masked antennae:

    • Key: maskedAntennae

    • Type: Record<number, boolean>

    • Purpose: Mask out antennae by index.

  • Extra attribute paths:

    • Key: fullNames

    • Type: string[]

    • Purpose: Additional attributes to fetch/overlay.

  • Legend position:

    • Key: legendPosition

    • Type: 'left'|'right'|'top'|'bottom'|'none'

    • Default: "bottom"

  • Title and antenna toggles:

    • Keys: showTitle, showAntennas

    • Type: boolean

    • Default: true

  • Aggregation mode:

    • Key: groupBy

    • Type: 'smartbox' | 'tpm'

    • Default: "smartbox"

    • Purpose: Controls how group outlines are aggregated and labeled on the map.

  • MCCS batch size:

    • Key: mccsBatchSize

    • Type: number

    • Purpose: Attributes per MCCS request; tune for large stations.

    • Default: 5

  • Antenna radii (px):

    • Keys: radiusMinPx, radiusMaxPx

    • Type: number

    • Defaults: 0.3, 1

  • Color scheme:

    • Key: colorScheme

    • Type: SDK palette id from @ska-octopus-widget-sdk/widget-sdk (for example scientificActon10, tableau10)

    • Default: "scientificActon10" when available, otherwise first SDK palette

  • Custom color scale:

    • Key: customColorScale

    • Type: string (JSON array of RGB triplets)

    • Purpose: Override the selected SDK colorScheme with an explicit RGB ramp.

    • Example: "[[0,255,255],[255,0,0]]"

Quick recipe

{
  "stationId": "s8-1",
  "groupBy": "smartbox",
  "legendPosition": "bottom",
  "colorScheme": "scientificActon10",
  "mccsBatchSize": 5
}