Class: NavBar

cercaliagl.control/NavBar


Javascript ES5

const control = new cercaliagl.control.NavBar();

Class for nav bar control which offers to search addresses, calculate routes and search points. This class can be obtained via map object.

All autocomplete components element gets addresses by country priority depends where map is centered. It is possible to access to some functionalities by published methods listed in this page.

To access to NavBar control element you can do it:

const map = new cercaliagl.Map({ target: 'map', controls: [cercaliagl.control.MapControls.NAVBAR] });
const navbarControl = map.getControlByName(cercaliagl.control.MapControls.NAVBAR);

new NavBar()

control/NavBar.js, line 96

Extends

Methods

clear()

control/NavBar.js, line 1447

Clear all navbar autocomplete inputs.

getCercaliaMap(){module:cercaliagl/Map~Map} inherited

control/Control.js, line 112

Returns cercalia Map object

Returns:
Cercalia map.

getClass(){string} inherited

control/Control.js, line 85

Get class name.

Returns:
Class name.

getElement(){Element} inherited

control/Control.js, line 103

Get control HTML Element

Returns:
HTML Element

getId(){string} inherited

control/Control.js, line 76

Get control id.

Returns:
Id.

getMap(){module:maplibre-gl~Map} inherited

control/Control.js, line 122

Returns mapboxgl Map object

getName(){string|null} inherited

control/Control.js, line 94

Get control name. Null if control has not defined name.

Returns:
Class name.

getNavBarAutocompleteService(){module:cercaliagl/service/Autocomplete~Autocomplete}

control/NavBar.js, line 470

Get autocomplete search address service object. More details: module:cercaliagl/service/Autocomplete~Autocomplete.

Returns:
Autocomplete service.

getRoutingAutocompleteOptions(){module:cercaliagl/service/Autocomplete~AutocompleteMutableOptions}

control/NavBar.js, line 495

Returns routing widget autocompletes options

Returns:
Routing autocompletes options

hide() inherited

control/Control.js, line 144

Hide control.

hideButton(buttonName)

control/NavBar.js, line 383

Show button form UI element. Buttons available to show/hide are for widgets: search address, calculate route, search POIs. You can access this values via constants. Show buttonName parameter description.

Name Type Description
buttonName string

Button to hide on NavBar control. Possible values:

  • cercaliagl.control.NavBar.Buttons.ADDRESS
  • cercaliagl.control.NavBar.Buttons.POIS
  • cercaliagl.control.NavBar.Buttons.ROUTING

reset()

control/NavBar.js, line 1438

Reset menu to initial state.

setAutocompleteAddressCallback(fn)

control/NavBar.js, line 539

Set custom callback function for address search. Set null to disable custom function and use default. This is useful if user wants to override default behaviour. Unique parameter received is GeEntity.

Example usage:

navBarControl.setAutocompleteAddressCallback(function(data) {
  const country = data.country.value;
  const municipality = data.municipality.value;
  const coordX = parseFloat(data.coord.x);
  const coordY = parseFloat(data.coord.y);
  console.log(country, municipality, coordY + ',' + coordX);
});
Name Type Description
fn function

Callback function. null to use default API behaviour.

setCoordinatesSearchCallback(fn)

control/NavBar.js, line 548

Set custom callback function for coordinates search, same behaviour as customAutocompleteAdressCallback. Set null to disable custom function and use default.

Name Type Description
fn function

Callback function. null to use default API behaviour.

setRoutingAutocompleteOptions(options)

control/NavBar.js, line 479

Sets the options for the routing widget autocompletes

Name Type Description
options

Routing autocompletes options

Name Type Description
searchInsideCountry string | Array.<string> | null
searchInsideRegion string | Array.<string> | null
searchInsideProvince string | Array.<string> | null
searchInsideMunicipality string | Array.<string> | null
searchInsideLocality string | Array.<string> | null
searchFilterEntity string | Array.<string> | undefined
searchPriorityEntity string | Array.<string> | undefined
searchPreferredEntity string | Array.<string> | null
searchCoordinateReference module:cercaliagl/LonLat~LonLat | null
searchInsideRadius number | null
searchFilterType string | Array.<string> | null
poiCategories string | Array.<string> | null
lang string | Array.<string> | undefined
closeSuggestionsIfInputIsEmpty boolean

show() inherited

control/Control.js, line 153

Show control.

showButton(buttonName)

control/NavBar.js, line 396

Show button form UI element. Buttons available to show/hide are for widgets: search address, calculate route, search POIs. You can access this values via constants. Show buttonName parameter description.

Name Type Description
buttonName string

Button to show on NavBar control. Possible values:

  • cercaliagl.control.NavBar.Buttons.ADDRESS
  • cercaliagl.control.NavBar.Buttons.POIS
  • cercaliagl.control.NavBar.Buttons.ROUTING