v5 v4

Class: ContextMenu

cercalia.ContextMenu

new cercalia.ContextMenu(opt_options)

temp/jsdocinputdirs/cercalia.contextmenu.js, line 12
Name Type Description
options
Name Type Description
id string | undefined optional

Contex menu identifier. If it isn't defined, will be defined in class.
map cercalia.Map | undefined optional

Map where appears the contex menu. If it isn't defined, will be defined with 'setMap' method.
fixedPosition cercalia.LonLat | undefined optional

If this argument is defined, context menu always will be shown in this position.

Methods

addOption(id, name, callback, position){string}

temp/jsdocinputdirs/cercalia.contextmenu.js, line 102

Add a new option in the context menu at the end or in a specific position. Returns options identifier. If the id options exist removes previous option.

Name Type Description
id string

Option's identifier.
name string

Text will be displayed in option.
callback function

Function will be fired when users click the option.
position number

The position where option will be added.
Returns:
Options identifier.

close()

temp/jsdocinputdirs/cercalia.contextmenu.js, line 133

Close the menu.

existOption(id){Boolean}

temp/jsdocinputdirs/cercalia.contextmenu.js, line 143

Returns true if the option exists.

Name Type Description
id string

Option's identifier.
Returns:
True if exists.

findOptionById(id){Object}

temp/jsdocinputdirs/cercalia.contextmenu.js, line 152

Returns the option if exists.

Name Type Description
id string

Option's identifier.
Returns:
The option or null if not exist.

isVisible(){Boolean}

temp/jsdocinputdirs/cercalia.contextmenu.js, line 89

Returns true if the context menu is visible.

open(coordinates, projection)

temp/jsdocinputdirs/cercalia.contextmenu.js, line 166

Open the menu. If menu isn't position fixed needs a position to be displayed.

Name Type Description
coordinates Array.<number> | cercalia.LonLat | undefined optional

If menu isn't position fixed, menu will be displayed in ths position.
projection string | undefined optional

If menu isn't position fixed, and coordinates are Array of numbers, the projection will be necesary to transform the position.

redraw()

temp/jsdocinputdirs/cercalia.contextmenu.js, line 207

Redraws the context menu.

removeOption(id)

temp/jsdocinputdirs/cercalia.contextmenu.js, line 215

Remove an option from the context menu and redraw it.

Name Type Description
id string

Option's identifier.

setMap(map)

temp/jsdocinputdirs/cercalia.contextmenu.js, line 230

Set map of context menu

Name Type Description
map cercalia.Map

New map.