Class AlloyCustomOverlay

an alloy custom overlay allows us to put html elements on top of the map

Hierarchy

AlloyCustomOverlay

Implements

AlloyOverlay

Index

Constructors

constructor

Properties

id

Methods

setPosition

Constructors

constructor

new AlloyCustomOverlay(options: AlloyCustomOverlayOptions): AlloyCustomOverlay

- Defined in src/map/overlays/custom/AlloyCustomOverlay.ts:23
creates a new instance

Parameters
- options: AlloyCustomOverlayOptions
  
  the custom overlay options
Returns AlloyCustomOverlay

Properties

id

id: string

the id of the custom overlay

implements

Methods

setPosition

setPosition(coordinate: AlloyCoordinate | null): void

Implementation of AlloyOverlay.setPosition
- Defined in src/map/overlays/custom/AlloyCustomOverlay.ts:47
implements

Parameters
- coordinate: AlloyCoordinate | null
Returns void

Generated using TypeDoc