Cercalia API GL

Class: Address

cercaliagl.control/Address

Javascript ES5

const control = new cercaliagl.control.Address();
map.addControl(control);

Class cercaliagl.control.Address is used for internal purposes, but can be accessed through methods. This methods apply actions to Address UI component. By default it appears in bottom-left corner. It shows address summary address and detailed address with all geoentity components

Usage getting address control from map:

const map = new cercaliagl.Map({ target: 'map' });
const address = map.getControlByName(cercaliagl.control.MapControls.ADDRESS);
address.getDirection(new cercaliagl.LonLat(-3.682, 40.43059), false, false, (lonLat, data) => console.log(data));

new Address() control/Address.js, line 60

Extends

module:cercaliagl/control/Control~Control

Methods

clean() control/Address.js, line 393

Clear all painted overlays on the map related to this control

closePopup() control/Address.js, line 404

Closes address UI address element

directionTo() control/Address.js, line 168

Set current address to routing destination. If there is navbar enabled destination route is assigned with current opened address

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.

getCurrentAddress(){module:cercaliagl/servers~GeEntity} control/Address.js, line 474

Return geoentity data module:cercaliagl/servers~GeEntity from current address. Returns null if this control isn't showing any

Returns:

ge GeEntity.

getDirection(lonLat, hideMarker, hidePopUp, callbackFn) control/Address.js, line 245

Get direction giving position and shows response in UI address component. Optionally, you can provide addition callback function.

Name	Type	Description
`lonLat`	module:cercaliagl/LonLat~LonLat	Position
`hideMarker`	boolean	Disables the default option to create a marker on the position
`hidePopUp`	boolean	Disables the default option to show a popup with the position information
`callbackFn`	function	Optional callback function

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.

goToCoordinates(lonLat, panTo) control/Address.js, line 321

Center map to coordinates and draw a marker with a label with position coordinates. It doesn't obtain reverse geocoding data.

Name	Type	Description
`lonLat`	module:cercaliagl/LonLat~LonLat	Position.
`panTo`	boolean	Pan Zoom to position.

goToGeEntity(ge, panTo) control/Address.js, line 204

Open a direction using GeEntity from server response. Then it shows addres UI with filled data about address components

Name	Type	Description
`ge`	module:cercaliagl/servers~GeEntity	GeEntity.
`panTo`	boolean (defaults to true)	Pan Zoom to position.
`ge.article`	string \| null \| undefined
`ge.city`	module:cercaliagl/servers~ObjectJSON \| null \| undefined
`ge.coord`	module:cercaliagl/servers~Coord \| null \| undefined
`ge.country`	module:cercaliagl/servers~ObjectJSON \| null \| undefined
`ge.dist`	string \| null \| undefined
`ge.frc`	string \| null \| undefined
`ge.housenumber`	module:cercaliagl/servers~ObjectJSON \| null \| undefined
`ge.id`	string \| null \| undefined
`ge.intersection`	module:cercaliagl/servers~Intersection \| null \| undefined
`ge.km`	module:cercaliagl/servers~ObjectJSON \| null \| undefined
`ge.kmh`	string \| null \| undefined
`ge.label`	string \| null \| undefined
`ge.geometry`	module:cercaliagl/servers~GeEntityGeometry \| null \| undefined
`ge.municipality`	module:cercaliagl/servers~ObjectJSON \| null \| undefined
`ge.name`	module:cercaliagl/servers~ObjectJSON \| string \| undefined
`ge.pos`	string \| null \| undefined
`ge.postalcode`	module:cercaliagl/servers~ObjectJSON \| module:cercaliagl/servers~PostalCode \| null \| undefined
`ge.prefix`	string \| null \| undefined
`ge.region`	module:cercaliagl/servers~ObjectJSON \| null \| undefined
`ge.sname`	module:cercaliagl/servers~ObjectJSON \| string \| null \| undefined
`ge.subcategory_id`	module:cercaliagl/servers~ObjectJSON \| string \| null \| undefined
`ge.subregion`	module:cercaliagl/servers~ObjectJSON \| null \| undefined
`ge.type`	string \| null \| undefined
`ge.zonename`	string \| null \| undefined
`ge.zonetype`	string \| null \| undefined
`ge.height`	string \| null \| undefined
`ge.pc2`	string \| null \| undefined
`ge.poi_data`	module:cercaliagl/servers~PoiData \| undefined

goToPostalcode(countryId, pcode, panTo) control/Address.js, line 341

Make a geocoding request to obtain postal code by country. It shows a marker and draw a polygon with its extension. Once postal code data is returned this function pan to postal code centroid. Optionally is possible to disable this pan.

Name	Type	Description
`countryId`	string	Country Id. For example: `ESP` or `FRA`.
`pcode`	string	Postal code.
`panTo`	boolean (defaults to true)	Optional pan to location.

hide() inherited control/Control.js, line 144

Hide control.

setSearchAddressCallbackFunction(callbackFn) control/Address.js, line 273

Add a custom callback function called when a address is searched via context menu map. This function will receive LonLat and ProximityResult

Name	Type	Description
`callbackFn`	function \| null	Callback function

show() inherited control/Control.js, line 153

Show control.