Class CoalitionAreaContextMenu

This context menu allows the user to edit or delete a CoalitionArea. Moreover, it allows the user to create a IADS automatically using the CoalitionArea as bounds.

Hierarchy

ContextMenu
- CoalitionAreaContextMenu

Constructors

constructor

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

Properties

`Private` #coalitionArea

#coalitionArea: null | CoalitionArea = null

`Private` #coalitionSwitch

#coalitionSwitch: Switch

`Private` #container

#container: null | HTMLElement

`Private` #iadsDensitySlider

#iadsDensitySlider: Slider

`Private` #iadsDistributionSlider

#iadsDistributionSlider: Slider

`Private` #iadsErasDropdown

#iadsErasDropdown: Dropdown

`Private` #iadsRangesDropdown

#iadsRangesDropdown: Dropdown

`Private` #iadsTypesDropdown

#iadsTypesDropdown: Dropdown

`Private` #latlng

#latlng: LatLng = ...

`Private` #visibleSubMenu

#visibleSubMenu: null | string = null

`Private` #x

#x: number = 0

`Private` #y

#y: number = 0

Methods

`Private` #hideSubMenus

#hideSubMenus(): void
Hide all submenus

Returns void
- Defined in src/contextmenus/coalitionareacontextmenu.ts:139

`Private` #onSwitchClick

#onSwitchClick(value): void
Callback event called when the coalition switch is clicked to change the coalition of the CoalitionArea
Parameters
- value: boolean
  
  Switch position (false: blue, true: red)
Returns void
- Defined in src/contextmenus/coalitionareacontextmenu.ts:151

`Private` #showSubMenu

#showSubMenu(type): void
Show a submenu of the contextmenu
Parameters
- type: string
  
  The submenu type, currently only "iads"
Returns void
- Defined in src/contextmenus/coalitionareacontextmenu.ts:128

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

getCoalitionArea

getCoalitionArea(): null | CoalitionArea
Get the CoalitionArea object the contextmenu is editing

Returns null | CoalitionArea
The CoalitionArea the contextmenu is editing
- Defined in src/contextmenus/coalitionareacontextmenu.ts:120

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

setCoalitionArea

setCoalitionArea(coalitionArea): void
Set the CoalitionArea object the user will be able to edit using this menu
Parameters
- coalitionArea: CoalitionArea
  
  The CoalitionArea object to edit
Returns void
- Defined in src/contextmenus/coalitionareacontextmenu.ts:108

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
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
Overrides ContextMenu.show
- Defined in src/contextmenus/coalitionareacontextmenu.ts:81

Class CoalitionAreaContextMenu

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ID: string

Returns CoalitionAreaContextMenu

Properties

Private #coalitionArea

Private #coalitionSwitch

Private #container

Private #iadsDensitySlider

Private #iadsDistributionSlider

Private #iadsErasDropdown

Private #iadsRangesDropdown

Private #iadsTypesDropdown

Private #latlng

Private #visibleSubMenu

Private #x

Private #y

Methods

Private #hideSubMenus

Returns void

Private #onSwitchClick

Parameters

value: boolean

Returns void

Private #showSubMenu

Parameters

type: string

Returns void

clip

Returns void

getCoalitionArea

Returns null | CoalitionArea

getContainer

Returns null | HTMLElement

getLatLng

Returns LatLng

getVisibleSubMenu

Returns null | string

getX

Returns number

getY

Returns number

hide

Returns void

setCoalitionArea

Parameters

coalitionArea: CoalitionArea

Returns void

setVisibleSubMenu

Parameters

menu: null | string

Returns void

show

Parameters

x: number

y: number

latlng: LatLng

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` #coalitionArea

`Private` #coalitionSwitch

`Private` #container

`Private` #iadsDensitySlider

`Private` #iadsDistributionSlider

`Private` #iadsErasDropdown

`Private` #iadsRangesDropdown

`Private` #iadsTypesDropdown

`Private` #latlng

`Private` #visibleSubMenu

`Private` #x

`Private` #y

`Private` #hideSubMenus

`Private` #onSwitchClick

`Private` #showSubMenu