<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "Snapshots",
  "identifier" : "/documentation/Snapshots/Overlay",
  "metadataVersion" : "0.1.0",
  "role" : "Object",
  "symbol" : {
    "kind" : "Object",
    "modules" : [
      "Maps Web Snapshots"
    ],
    "preciseIdentifier" : "data:snapshots:Overlay"
  },
  "title" : "Overlay"
}
-->

# Overlay

A JSON object for a Snapshot URL that describes overlay shape characteristics, including points for the overlay and styles such as width, color, and dash pattern.

```
object Overlay
```

## Topics

### Objects

[`Overlay.LineGradient`](/documentation/Snapshots/Overlay/LineGradient-data.dictionary)

A property that sets the color stops for the gradient, positioned by offsets between 0 and 1.

[`Overlay.LineGradientIndexes`](/documentation/Snapshots/Overlay/LineGradientIndexes-data.dictionary)

A property that sets the color stops for the gradient, positioned by indexes of points on the polyline.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)