Class ContextMenu

Show a simple context menu when clicking on the map

Index

Constructors

Accessors

enabled visible

Methods

_handleClickEvent _handleContextmenuEvent closeMenu disable enable onClickEntry openMenu updateMenuEntries

Constructors

constructor

new ContextMenu(
    mapComponent: MapComponent,
    menuEntries?: MenuEntry[],
    mouseTrigger?: (evt: MouseEvent) => boolean,
    openCondition?: (evt: MouseEvent, mapCoordinate: Coordinate) => boolean,
): ContextMenu
Parameters
- mapComponent: MapComponent
- menuEntries: MenuEntry[] = []
- mouseTrigger: (evt: MouseEvent) => boolean = alternateMouseClick
- openCondition: (evt: MouseEvent, mapCoordinate: Coordinate) => boolean = ...
Returns ContextMenu
- Defined in src/components/map/tools/contextmenu.ts:30

Accessors

enabled

get enabled(): boolean
Returns boolean
- Defined in src/components/map/tools/contextmenu.ts:67

visible

get visible(): boolean
Returns boolean
- Defined in src/components/map/tools/contextmenu.ts:63

Methods

_handleClickEvent

_handleClickEvent(): void
Returns void
- Defined in src/components/map/tools/contextmenu.ts:105

_handleContextmenuEvent

_handleContextmenuEvent(
    evt: MouseEvent,
    mouseTrigger: (evt: MouseEvent) => boolean,
    openCondition: (evt: MouseEvent, mapCoordinate: Coordinate) => boolean,
): void
Parameters
- evt: MouseEvent
- mouseTrigger: (evt: MouseEvent) => boolean
- openCondition: (evt: MouseEvent, mapCoordinate: Coordinate) => boolean
Returns void
- Defined in src/components/map/tools/contextmenu.ts:83

closeMenu

closeMenu(): void
Returns void
- Defined in src/components/map/tools/contextmenu.ts:131

disable

disable(): void
Returns void
- Defined in src/components/map/tools/contextmenu.ts:77

enable

enable(): void
Returns void
- Defined in src/components/map/tools/contextmenu.ts:71

onClickEntry

onClickEntry(
evt: MouseEvent,
callback: (e: MouseEvent, mapCoordinate: Coordinate) => void,
): void
Parameters
- evt: MouseEvent
- callback: (e: MouseEvent, mapCoordinate: Coordinate) => void
Returns void
- Defined in src/components/map/tools/contextmenu.ts:136

openMenu

openMenu(mapCoordinates: Coordinate): void
Parameters
- mapCoordinates: Coordinate
Returns void
- Defined in src/components/map/tools/contextmenu.ts:126

updateMenuEntries

updateMenuEntries(menuEntries: MenuEntry[]): void
Parameters
- menuEntries: MenuEntry[]
Returns void
- Defined in src/components/map/tools/contextmenu.ts:114