Class ContextMenu

Base class for map contextmenus. By default it is empty and requires to be extended.

Hierarchy

ContextMenu

Index

Constructors

Properties

#container #latlng #visibleSubMenu #x #y

Methods

clip getContainer getLatLng getVisibleSubMenu getX getY hide setVisibleSubMenu show

Constructors

constructor

new ContextMenu(ID): ContextMenu
Parameters
- ID: string
  
  the ID of the HTML element which will contain the context menu
Returns ContextMenu
- Defined in src/contextmenus/contextmenu.ts:15

Properties

`Private` #container

#container: null | HTMLElement

`Private` #latlng

#latlng: LatLng = ...

`Private` #visibleSubMenu

#visibleSubMenu: null | string = null

`Private` #x

#x: number = 0

`Private` #y

#y: number = 0

Methods

clip

clip(): void
Clips the contextmenu, meaning it moves it on the screen to make sure it does not overflow the window.

Returns void
- Defined in src/contextmenus/contextmenu.ts:76

getContainer

getContainer(): null | HTMLElement
Returns null | HTMLElement
The HTMLElement that contains the contextmenu
- Defined in src/contextmenus/contextmenu.ts:45

getLatLng

getLatLng(): LatLng
Returns LatLng
The Leaflet latlng object associated to the click that caused the contextmenu to be shown
- Defined in src/contextmenus/contextmenu.ts:53

getVisibleSubMenu

getVisibleSubMenu(): null | string
Returns null | string
The name of the currently visible submenu
- Defined in src/contextmenus/contextmenu.ts:102

getX

getX(): number
Returns number
The x coordinate of the top left corner of the menu
- Defined in src/contextmenus/contextmenu.ts:61

getY

getY(): number
Returns number
The y coordinate of the top left corner of the menu
- Defined in src/contextmenus/contextmenu.ts:69

hide

hide(): void
Hide the contextmenu

Returns void
- Defined in src/contextmenus/contextmenu.ts:37

setVisibleSubMenu

setVisibleSubMenu(menu): void
Sets the currently visible submenu
Parameters
- menu: null | string
  
  The name of the currently visibile submenu, or null if no submenu is visible
Returns void
- Defined in src/contextmenus/contextmenu.ts:94

show

show(x, y, latlng): void
Show the contextmenu on top of the map, usually at the location where the user has clicked on it.
Parameters
- x: number
  
  X screen coordinate of the top left corner of the context menu
- y: number
  
  Y screen coordinate of the top left corner of the context menu
- latlng: LatLng
  
  Leaflet latlng object of the mouse click
Returns void
- Defined in src/contextmenus/contextmenu.ts:26

Generated using TypeDoc