sdrangel/sdrbase/resources/webapi/doc/swagger/include/Map.yaml

MapSettings:
  description: Map
  properties:
    displayNames:
      description: Display object names on the map (1 for yes, 0 for no)
      type: integer
    title:
      type: string
    rgbColor:
      type: integer
    useReverseAPI:
      description: Synchronize with reverse API (1 for yes, 0 for no)
      type: integer
    reverseAPIAddress:
      type: string
    reverseAPIPort:
      type: integer
    reverseAPIFeatureSetIndex:
      type: integer
    reverseAPIFeatureIndex:
      type: integer
    rollupState:
      $ref: "/doc/swagger/include/RollupState.yaml#/RollupState"

MapActions:
  description: Map
  properties:
    find:
      description: "The name of the item or the location to centre the map on"
      type: string

MapItem:
  description: "An item to draw on the map. Set image to an empty string to remove item from the map."
  required:
    - name
  properties:
    name:
      description: "A name for the item"
      type: string
    image:
      description: "Filename or URL of image to draw on the map"
      type: string
    imageRotation:
      description: "Angle to rotate the image by"
      type: integer
      default: 0
    imageMinZoom:
      description: "Minimim zoom value"
      type: integer
      default: 11
    text:
      descrption: "Text to draw on the map when item is selected"
      type: string
    latitude:
      description: "Latitude in decimal degrees, positive to the north"
      type: number
      format: float
    longitude:
      description: "Longitude in decimal degrees, positive to the east"
      type: number
      format: float
    altitude:
      description: "Altitude / height above sea level in metres"
      type: number
      format: float
    track:
      description: "Track/path the item has taken"
      type: array
      items:
        $ref: "/doc/swagger/include/Map.yaml#/MapCoordinate"
    predictedTrack:
      description: "Track/path the item is predicted to take"
      type: array
      items:
        $ref: "/doc/swagger/include/Map.yaml#/MapCoordinate"

MapCoordinate:
  description: "A map coordinate"
  properties:
    latitude:
      type: number
      format: float
    longitude:
      type: number
      format: float
    altitude:
      type: number
      format: float