Measure MapAPI
Help CenterGet an API key

Polygon

An area or a line drawn on the map.

Fields

  • typestringrequired
    Always"polygon"
  • idstringrequired
  • parentIdstring
    For a hole or a buffer, the shape it belongs to.
  • groupIdstring
    The group the shape is in.
  • productIdstring
    The first product on the shape (see productIds).
  • productIdsarray of string
    Every product on the shape, in order. Work is often layered.
  • titlestring
  • descriptionstring
  • shapestringrequired
    One ofpolygoncirclerectangle
  • numPointsinteger
    How many corners it has.
  • fillColorstring
    Hex colour.
  • fillOpacitynumber
    0 to 1
  • lineColorstring
    Hex colour.
  • lineWidthnumber
  • totalAreanumber
    Its area in square metres; 0 for a line.
  • totalPerimeternumber
    Its perimeter (or a line's length) in metres.
  • noSurfaceboolean
    true for a line.
  • isBufferboolean
  • isHoleboolean
  • imagesarray of string
  • pointsarray of Point
    Its corners in order. Left out with includePoints=false.