getaddress-location
v1.1.1
Published
GetAddress.io - Location plug-in
Downloads
21
Maintainers
Readme
Javascript - Location.
Install
From NPM
npm install getaddress-location
Or CDN
<script src="https://cdn.getaddress.io/scripts/getaddress-location-1.0.0.min.js"></script>
Usage
<input type="text" id="textbox_id" >
<br/>
<label>Longitude</label>
<div><input id="longitude" type="text"></div>
<label>Latitude</label>
<div><input id="latitude" type="text"></div>
<label>Area</label>
<div><input id="area" type="text"></div>
<label>Town or City</label>
<div><input id="town_or_city" type="text"></div>
<label>County</label>
<div><input id="county" type="text"></div>
<label>Country</label>
<div><input id="country" type="text"></div>
<label>Outcode</label>
<div><input id="outcode" type="text"></div>
<label>Postcode</label>
<div><input id="postcode" type="text"></div>
<script>
getAddress.location("textbox_id","API Key");
</script>
Options
The full list of options, and their defaults:
getAddress.location(
'textbox_id',
'API_KEY',
/*options*/{
output_fields:{
latitude:'latitude', /* The id of the element bound to 'latitude' */
longitude:'longitude', /* The id of the element bound to 'longitude' */
area:'area',/* The id of the element bound to 'area' */
town_or_city:'town_or_city',/* The id of the element bound to 'town_or_city' */
county:'county', /* The id of the element bound to 'county' */
country:'country', /* The id of the element bound to 'country' */
postcode:'postcode', /* The id of the element bound to 'postcode' */
outcode:'outcodecode', /* The id of the element bound to 'outcode' */
},
id_prefix:'getAddress-location' , /* The id of the textbox and list container */
css_prefix?:'getAddress_location'", /* The class name prefix */
delay:200, /* millisecond delay between keypress and API call */
minimum_characters:2, /* minimum characters to initiate an API call */
clear_list_on_select:true, /* if true, clears list on suggestion selected */
select_on_focus:true, /* if true, highlights textbox characters on focus*/
alt_location_url:undefined, /* alterative local location URL (when API key is not used) */
alt_get_location_url:undefined, /* alterative local get URL (when API key is not used) */
input_class_names:[], /* textbox class names */
list_class_names:[], /* list class names */
container_class_names:[], /* container class names */
container_focused_class_names:[], /* container focused class names */
suggestion_class_names:[], /* suggestion class names */
highlight_suggestion:true, /* if true, highlights matched suggestion text */
highlight_suggestion_start_tag:'<b>', /* highlighted suggestion text start tag */
highlight_suggestion_end_tag:'</b>', /* highlighted suggestion text end tag */
list_width:undefined, /* if true, set the list width */
suggestion_count:6, /* number of retreived suggestions (max 20) */
suggestion_template:undefined, /* the suggestion template (see Location API)*/
suggestion_template_outcode:undefined, /* the outcode suggestion template (see Location API)*/
suggestion_template_postcode:undefined, /* the postcode suggestion template (see Location API)*/
filter:undefined, /* the suggestion filter (see Location API)*/
bind_output_fields:true, /* if true, bind the output_fields to the location*/
input_focus_on_select:true, /* if true, sets the focus to the textbox after selecting a location*/
debug:false, /* if true, logs behavior */
enable_get_location:true, /* if true, retreives location on select */
set_default_output_field_names:true, /* if true, defaults output field names to JSON field names*/
clear_on_select = false /* if true, clears textbox after selecting a location*/
}
);
Events
document.addEventListener("getaddress-location-suggestions", function(e){
console.log(e.suggestions);
})
document.addEventListener("getaddress-location-suggestions-failed", function(e){
console.log(e.status);
console.log(e.message);
})
document.addEventListener("getaddress-location-selected", function(e){
console.log(e.location);
})
document.addEventListener("getaddress-loction-selected-failed", function(e){
console.log(e.status);
console.log(e.message);
})