Interface GeocodeOptions

Options that can be passed into geocode operations.

interface GeocodeOptions {
    cancelToken?: CancelToken;
    maxResults?: number;
    outFields?: string[];
    outSpatialReference?: SpatialReference;
    searchArea?: Geometry;
    searchPoint?: Point;
}

Properties

cancelToken? maxResults? outFields? outSpatialReference? searchArea? searchPoint?

Properties

OptionalcancelToken

cancelToken?: CancelToken

An optional cancel token from a support/Cancellable!Cancellable that can be used to cancel the geocode operation.

OptionalmaxResults

maxResults?: number

The maximum number of results to return. This cannot exceed the maximum supported by the geocoder (see tasks/geocoding/Geocoder!Geocoder.capabilities).

OptionaloutFields

outFields?: string[]

Fields that should be returned for each feature.

OptionaloutSpatialReference

outSpatialReference?: SpatialReference

The spatial reference of the results.

OptionalsearchArea

searchArea?: Geometry

If specified, results will be limited to those that intersect the given geometry. No effect for reverse geocoding.

OptionalsearchPoint

searchPoint?: Point

If specified, results will be weighted for the specified point. No effect for reverse geocoding.

Settings

Member Visibility

On This Page

Properties