LocatorInfo Class

  • LocatorInfo
  • class Esri::ArcGISRuntime::LocatorInfo

    Information about an Address Locator. More...

    Header: #include <LocatorInfo.h>
    Since: Esri::ArcGISRuntime 100.0

    Public Functions

    LocatorInfo(const Esri::ArcGISRuntime::LocatorInfo &other)
    LocatorInfo(Esri::ArcGISRuntime::LocatorInfo &&other)
    QString description() const
    QList<Esri::ArcGISRuntime::LocatorAttribute> intersectionResultAttributes() const
    bool isEmpty() const
    bool isSupportsAddresses() const
    bool isSupportsIntersections() const
    bool isSupportsPoi() const
    bool isSupportsSuggestions() const
    QString name() const
    QVariantMap properties() const
    QList<Esri::ArcGISRuntime::LocatorAttribute> resultAttributes() const
    QList<Esri::ArcGISRuntime::LocatorAttribute> searchAttributes() const
    Esri::ArcGISRuntime::SpatialReference spatialReference() const
    QString version() const
    Esri::ArcGISRuntime::LocatorInfo &operator=(const Esri::ArcGISRuntime::LocatorInfo &other)
    Esri::ArcGISRuntime::LocatorInfo &operator=(Esri::ArcGISRuntime::LocatorInfo &&other)

    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.

    Member Function Documentation


    Default constructor.

    LocatorInfo::LocatorInfo(const Esri::ArcGISRuntime::LocatorInfo &other)

    Copy constructor from other LocatorInfo.

    LocatorInfo::LocatorInfo(Esri::ArcGISRuntime::LocatorInfo &&other)

    Move constructor from other LocatorInfo.



    QString LocatorInfo::description() const

    Returns the description of the Locator.

    QList<Esri::ArcGISRuntime::LocatorAttribute> LocatorInfo::intersectionResultAttributes() const

    Returns the list of LocatorAttribute that will be returned in the GeocodeResult.

    bool LocatorInfo::isEmpty() const

    Returns whether the Locator is empty.

    bool LocatorInfo::isSupportsAddresses() const

    Returns whether the Locator supports geocoding by a point or street address.

    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.

    bool LocatorInfo::isSupportsIntersections() const

    Returns whether the Locator supports geocoding by intersection.

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

    bool LocatorInfo::isSupportsPoi() const

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

    bool LocatorInfo::isSupportsSuggestions() const

    Returns whether the Locator supports generating suggestions for user-input.

    QString LocatorInfo::name() const

    Returns the name of the Locator.

    QVariantMap LocatorInfo::properties() const

    Returns the properties of the Locator.

    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 this API.

    QList<Esri::ArcGISRuntime::LocatorAttribute> LocatorInfo::resultAttributes() const

    Returns the list of LocatorAttribute that will be returned in the GeocodeResult.

    QList<Esri::ArcGISRuntime::LocatorAttribute> LocatorInfo::searchAttributes() const

    Returns the list of LocatorAttribute that will be used in the search.

    Use this function to determine the attributes that can be used for geocoding with the LocatorTask::geocodeWithSearchValuesAsync or LocatorTask::geocodeWithSearchValuesAndParametersAsync

    Esri::ArcGISRuntime::SpatialReference LocatorInfo::spatialReference() const

    Returns the SpatialReference of the Locator.

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

    QString LocatorInfo::version() const

    Returns the version of the Locator.

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

    Esri::ArcGISRuntime::LocatorInfo &LocatorInfo::operator=(const Esri::ArcGISRuntime::LocatorInfo &other)

    Assignment operator from other LocatorInfo.

    Esri::ArcGISRuntime::LocatorInfo &LocatorInfo::operator=(Esri::ArcGISRuntime::LocatorInfo &&other)

    Move operator from other LocatorInfo.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.