<!--
{
  "availability" : [
    "MapKit JS: 5.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "MapKitJS",
  "identifier" : "/documentation/MapKitJS/OverlayOptions",
  "metadataVersion" : "0.1.0",
  "role" : "Interface",
  "symbol" : {
    "kind" : "Interface",
    "modules" : [
      "MapKit JS"
    ],
    "preciseIdentifier" : "struct/mapkit.OverlayOptions"
  },
  "title" : "OverlayOptions"
}
-->

# OverlayOptions

A dictionary of options that determines an overlay’s data, and indicates whether it’s visible, in an enabled state, and in a selected state.

```
interface OverlayOptions
```

## Overview

Use [`OverlayOptions`](/documentation/MapKitJS/OverlayOptions) to set the initial state of your overlay and provide the data MapKit JS uses to render it.

## Topics

### Overlay options

[`data?: object;`](/documentation/MapKitJS/OverlayOptions/data)

Custom data to associate with the overlay.

[`enabled?: boolean;`](/documentation/MapKitJS/OverlayOptions/enabled)

A Boolean value that determines whether the overlay responds to user interaction.

[`selected?: boolean;`](/documentation/MapKitJS/OverlayOptions/selected)

A Boolean value that indicates whether the overlay is in a selected state.

[`visible?: boolean;`](/documentation/MapKitJS/OverlayOptions/visible)

A Boolean value that determines if an overlay is visible.

[`style?: Style;`](/documentation/MapKitJS/OverlayOptions/style)

An object literal of style properties.


---

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)