Class UnitContextMenu

The UnitContextMenu is shown when the user rightclicks on a unit. It dynamically presents the user with possible actions to perform on the unit.

Hierarchy

ContextMenu
- UnitContextMenu

Index

Constructors

Properties

#container #latlng #visibleSubMenu #x #y

Methods

clip getContainer getLatLng getVisibleSubMenu getX getY hide setOptions setVisibleSubMenu show

Constructors

constructor

new UnitContextMenu(ID): UnitContextMenu
Parameters
- ID: string
  
  the ID of the HTML element which will contain the context menu
Returns UnitContextMenu
Overrides ContextMenu.constructor
- Defined in src/contextmenus/unitcontextmenu.ts:10

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
Inherited from ContextMenu.clip
- Defined in src/contextmenus/contextmenu.ts:76

getContainer

getContainer(): null | HTMLElement
Returns null | HTMLElement
The HTMLElement that contains the contextmenu
Inherited from ContextMenu.getContainer
- 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
Inherited from ContextMenu.getLatLng
- Defined in src/contextmenus/contextmenu.ts:53

getVisibleSubMenu

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

getX

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

getY

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

hide

hide(): void
Hide the contextmenu

Returns void
Inherited from ContextMenu.hide
- Defined in src/contextmenus/contextmenu.ts:37

setOptions

setOptions(options, callback): void
Set the options that will be presented to the user in the contextmenu
Parameters
- options: {
      [key: string]: {
          text: string;
          tooltip: string;
      };
  }
  
  Dictionary element containing the text and tooltip of the options shown in the menu
  - [key: string]: {
    text: string;
    tooltip: string;
    }
    - text: string
    - tooltip: string
- callback: CallableFunction
  
  Callback that will be called when the user clicks on one of the options
Returns void
- Defined in src/contextmenus/unitcontextmenu.ts:19

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
Inherited from ContextMenu.setVisibleSubMenu
- 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
Inherited from ContextMenu.show
- Defined in src/contextmenus/contextmenu.ts:26

Generated using TypeDoc