Namespace: widget

Type Definitions

cercaliax.widget.GeocodingOptions{Object}

Properties:

Name	Type	Description
div	string	Widget DIV container ID.
type	string	Geocoding type to create. Default value 'cp'.
complete	function	Call function when search is OK.
error	function	Call function when search is KO.

cercaliax.widget.GeocodingSuggestOptions{Object}

Properties:

Name	Type	Argument	Description
div	string		Widget DIV container ID.
hnrt	boolean | undefined	<optional>	Apply a tolerance in house number ranges. Cercalia suggest search prioritize address that contains the house numbers searched. This parameters lets you apply a tolerance in the house numbers ranges available in the database (+/-50 numbers in general, and +/- 500 in USA), in order to avoid some gaps in this database. Values: false: don’t apply. Default value true: apply
complete	function		Call function when search is OK.
filterType	boolean		If true it enables radio box to select suggest search by types (streets, city and POIs).
defaultCountry	string		Default selected country in select input. Values must be in ISO 3166 alpha-3. If not specified it must be ALL. Examples ESP or FRA.
searchClosestHouseNumber	boolean | undefined	<optional>	Search closest real house number in suggest. Default: false.

cercaliax.widget.LoadingOverlayOptions{Object}

Properties:

Name	Type	Description
div	string	DIV ID that wants to be hided with the widget.
defaultText	string	Default text to show. OVERLAY_DEFAULT_TEXT = key definited in the language file.

cercaliax.widget.MainMenuOptions{Object}

Properties:

Name	Type	Description
div	string	Container DIV ID or body for all the page. Default value: "body".
position	string	Menu position. Default value "west". Admitted values: "west" or "east".
openSize	number	Lateral menu width when opened, in pixels. Default value: 336.
closeSize	number	Lateral menu width when closed, in pixels. Default value: 112.
resizeCallbackFunction	function	Custom function launched when close or open menu
defaultCountry	string	Default selected country in select input. Values must be in ISO 3166 alpha-3. If not specified it must be ALL. Examples ESP or FRA.
initalState	string	Lateral menu initial status. Default value: "open". Admitted values: "open" or "close".
mapOptions	cercaliax.MapOptions	Map options.
geocodingOptions	cercaliax.widget.GeocodingOptions	Geocoding widget options.
geocodingSuggestOptions	cercaliax.widget.GeocodingSuggestOptions	Geocoding suggest widget options.
routingOptions	cercaliax.widget.RoutingOptions	Routing widget options.
poiMapOptions	cercaliax.widget.PoiMapOptions	POI Map widget options.
poiProximityOptions	cercaliax.widget.PoiProximityOptions	POI proximity widget options.
poiSuggestOptions	cercaliax.widget.PoiSuggestOptions	POI suggest widget options.
reverseGeocodingOptions	cercaliax.widget.ReverseGeocodingOptions	Reverse geocoding widget options.

cercaliax.widget.PoiListOptions{Object}

Properties:

Name	Type	Description
div	string	Widget DIV container ID.
heightMenu	string	Height menu, number and units. For example: 300px. Default value: 'auto'
clickElementList	function	Call function when click on a submenu element.
categoryList	Array.<string>	List of categories and subcategories to include in the menu.

cercaliax.widget.PoiMapOptions{Object}

Properties:

Name	Type	Description
div	string	Widget DIV container ID.
poiListOptions	cercaliax.widget.PoiListOptions	Menu options.

cercaliax.widget.PoiProximityOptions{Object}

Properties:

Name	Type	Description
div	string	Widget DIV container ID.
height	string | function	DIV height. Default value "auto".
defaultElements	number	Maximum number of candidates in proximity search. Default value: 25.
maxRadius	number	Maximum proximity distance (radius, in Km). Default value: 50.
poiListOptions	cercaliax.widget.PoiListOptions	Menu options.
complete	function	Call function when search is OK.
error	function	Call function when search is KO.
showUI	function	Function to show the widget DIV when route is modified with the map.

cercaliax.widget.PoiSuggestOptions{Object}

Properties:

Name	Type	Description
div	string	Widget DIV container ID.
poiListOptions	cercaliax.widget.PoiListOptions	Menu options.
complete	function	Call function when search is OK.
error	function	Call function when search is KO.

cercaliax.widget.ReverseGeocodingOptions{Object}

Properties:

Name	Type	Description
div	string	Widget DIV container ID.
complete	function	Call function when search is OK.
error	function	Call function when search is KO.

cercaliax.widget.RoutingOptions{Object}

Properties:

Name	Type	Argument	Description
div	string		Widget DIV container ID.
height	string | function		DIV height. Default value "auto".
initialBoxes	number		Initial number of boxes. Default value 2.
maxBoxes	number		Maximum number of boxes (till 10). Default value 10.
showUI	function		Function to show the widget DIV when route is modified with the map.
logistics	string | undefined	<optional>	Indicates if the normal network, logstics network or both are activated
defaultCountry	string		Default selected country in select inputs. Values must be in ISO 3166 alpha-3. If not specified it must be ALL. Examples ESP or FRA.

cercaliax.widget.RoutingReportOptions{Object}

Properties:

Name	Type	Description
div	string	DIV ID where to include the route report.
map	cercalia.Map	Map
routingService	cercalia.service.Routing	Routing service.