Skip To Content ArcGIS for Developers Sign In Dashboard

LocatorInfo QML Type

Information about an Address Locator. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Properties

Detailed Description

The LocatorInfo can be used to determine if certain capabilities are supported, such as whether the Locator supports suggestions or searching by intersection. The LocatorInfo also holds key bits of information, such as its SpatialReference, the search attributes it uses, and the version of locator it is. Check the LocatorInfo properties before performing certain LocatorTask operations, to ensure the operation is supported.

Note: You cannot declare or create a component of this type in QML code.

Property Documentation

description : string

Returns the description of the Locator (read-only).


intersectionResultAttributes : list<LocatorAttribute>

Returns the list of LocatorAttribute that will be returned in the GeocodeResult (read-only).


name : string

Returns the name of the Locator (read-only).


properties : jsobject

Returns the properties of the Locator (read-only).

Properties are defined within the locator during creation in ArcMap or ArcGIS Pro. Properties might include MinimumMatchScore, MinimumCandidateScore, or DataSourcePath. These properties can only be viewed in ArcGIS Runtime.


resultAttributes : list<LocatorAttribute>

Returns the list of LocatorAttribute that will be returned in the GeocodeResult (read-only).


searchAttributes : list<LocatorAttribute>

Returns the list of LocatorAttribute that will be used in the search (read-only).

Use this property to determine the attributes that can be used for geocoding with the LocatorTask::geocodeWithSearchValues or LocatorTask::geocodeWithSearchValuesAndParameters


spatialReference : SpatialReference

Returns the SpatialReference of the Locator (read-only).

Optionally, a different output spatial reference for a Geocode or Reverse Geocode operation can be set in GeocodeParameters and ReverseGeocodeParameters, respectively.


supportsAddresses : bool

Returns whether the Locator supports geocoding by a point or street address (read-only).

A point address differs from a street address, as it represents an exact location of a rooftop, versus an interpolated location along a line. If supported, the input search text can be specified as x/y-coordinate pairs, where the spatial reference of the coordinates is WGS84.


supportsIntersections : bool

Returns whether the Locator supports geocoding by intersection (read-only).

Intersection addresses contain an intersection connector, such as Union St & Carson Rd.


supportsPoi : bool

Returns whether the Locator supports geocoding by a place of interest (POI) or landmark (read-only).


supportsSuggestions : bool

Returns whether the Locator supports generating suggestions for user-input (read-only).


version : string

Returns the version of the Locator (read-only).

This is the version of the locator itself, and is independent of ArcGIS Runtime, Desktop, and Server.



Feedback on this topic?