Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReverseGeocodeArgs

Represents a container for the arguments passed to a reverse geocoder.

Hierarchy

  • ReverseGeocodeArgs

Index

Constructors

constructor

Properties

alignSearchLimitDistance

alignSearchLimitDistance: Distance

The distance (in meters) after which vehicle alignment is not considered. Defaults to 30.

heading

heading: number

The direction the vehicle is heading into; in degrees. Defaults to 0.

location

location: LatLon

The location to find the nearest address for; as a LatLon object.

maxCrossStreetDistance

maxCrossStreetDistance: Distance

The maximum distance to search for a cross street; in meters. Defaults to 0.01.

maxDistance

maxDistance: Distance

The maximum distance (in meters) to use when attempting to reverse geocode a location. The reverse geocoder will return null if there are no results within MaxDistance degrees of the input location. Defaults to 1.

reverseGeocodeMode

reverseGeocodeMode: ReverseGeocodeMode

The mode to use for reverse geocoding. One of AllLinks, MustHaveName, RealLinksOnly, or VehiclesAllowedOnly.

speed

speed: Speed

The speed that the vehicle is travelling as it passes the specified location; in miles per hour.

streetNames

streetNames: string[]

An array of street names for the last known location. Defaults to null (unused).

useGlobalFallback

useGlobalFallback: boolean

Whether or not to execute a fallback query if the initial query cannot resolve the LatLon to a street address. If useGlobalFallback is true, the reverse geocoder returns the nearest city within MaxDistance degrees. If useGlobalFallback is false, no fallback query is executed, and the reverse geocoder returns null. Defaults to true.

useRoadWidth

useRoadWidth: boolean

Whether or not to consider road width when reverse geocoding. Defaults to false.

Static ASSEMBLY_NAME

ASSEMBLY_NAME: string = GEOBASE_ASSEMBLY_NAME

Static CLASS_NAME

CLASS_NAME: string = "Telogis.GeoBase.ReverseGeoCodeArgs"

Generated using TypeDoc