GeocodeParameters

A structure that describes a geocode method parameters. Structure holding the parameters to support the geocode operation for a geocoding service or local locator.

Since

200.1.0

Constructors

Link copied to clipboard
constructor()

Creates a new geocode parameters object.

Properties

Link copied to clipboard

Categories. Determines addresses from which the categories should be returned.

Link copied to clipboard

Country code. Determines addresses from which the country should be returned.

Link copied to clipboard

For storage property. Specifies whether the results of the operation will be persisted. The default value is false, which indicates the results of the operation can't be stored. If you store the results, in a database for example, you need to set this parameter to true.

Link copied to clipboard

Max results. Determines the maximum count of candidates which should be returned. By default should be returned all found candidates.

Link copied to clipboard

Min score. Determines addresses the minimal score value (score threshold) 0..100. By default used 0 and get real value from locator properties.

Link copied to clipboard

Output language code. Determines the language of candidate labels which should be returned.

Link copied to clipboard

Output spatial reference. The spatial reference for candidate geometries.

Link copied to clipboard

Preferred search location. Distance specifying with location the preferred area where candidates will be searched. Supported value from interval 1000..50000, 50000 by default.

Link copied to clipboard

Attribute names. Array of candidate attribute names indicating which attributes should be returned for every candidate. For empty array return only default attributes, "*" means all attributes will be returned.

Link copied to clipboard

Search area. Envelope specifying the area where candidates will be searched.