Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

rb.city.searchFlags

Search for specific entries in the city database

Elements

The rb.city.searchFlags struct has 11 elements:

Name Type/Value Range/Length Description
IDnumber  Optional. Return a speicific city record, identified by it's unique ID
countrystring  Optional. The country in which to search. This is case insensitive and wild-cards are allowed.
citystring  Optional. Optional city, which can also include wild cards
longitudenumber  Optional. Longitude represented by this point.
latitudenumber  Optional. Latitude represented by this point.
originCountrystring  Optional. If specified then the 'longitude' and 'latitude' parameters for distance calculations are taken from the location of the specified countries capital site. For example specifying this as 'GB' will calculate distances from London.
distancenumber  Optional. When longitude and latitude are specified this optional parameter restricts the search to a radius of "distance" miles from that location.
sortBystring  Optional, default = name
Sort is by name. If a longitude/latitude pair are specified in the search request then sort by distance from that location.
maxRowsnumber  Optional. Maximum number of rows the application expects to use
firstIndexnumber  Optional, default = 0
Index of the first row to return
allDatanumber  Optional, default = 0
0: return country, city, division, longitude, latitude and distance; 1: also return countryName

Whitebeam release 1.3.36
(loadtime : 117ms)