GeofenceGeometry interface

Package:

azure-maps-rest

The geofencing geometry.

Properties

deviceId	ID of the device. NOTE: This property will not be serialized. It can only be populated by the server.
distance	Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border, then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence. NOTE: This property will not be serialized. It can only be populated by the server.
geometryId	The unique id identifies a geometry. NOTE: This property will not be serialized. It can only be populated by the server.
nearestLat	Latitude of the nearest point of the geometry. NOTE: This property will not be serialized. It can only be populated by the server.
nearestLon	Longitude of the nearest point of the geometry. NOTE: This property will not be serialized. It can only be populated by the server.
udId	The unique id returned from Data Upload API after uploading a valid GeoJSON FeatureCollection object. Please refer to RFC 7946 for details. All the feature's properties should contain geometryId, which is used for identifying the geometry and is case-sensitive. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

deviceId

ID of the device. NOTE: This property will not be serialized. It can only be populated by the server.

deviceId?: string

Property Value

string

distance

Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border, then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence. NOTE: This property will not be serialized. It can only be populated by the server.

distance?: number

Property Value

number

geometryId

The unique id identifies a geometry. NOTE: This property will not be serialized. It can only be populated by the server.

geometryId?: string

Property Value

string

nearestLat

Latitude of the nearest point of the geometry. NOTE: This property will not be serialized. It can only be populated by the server.

nearestLat?: number

Property Value

number

nearestLon

Longitude of the nearest point of the geometry. NOTE: This property will not be serialized. It can only be populated by the server.

nearestLon?: number

Property Value

number

udId

The unique id returned from Data Upload API after uploading a valid GeoJSON FeatureCollection object. Please refer to RFC 7946 for details. All the feature's properties should contain geometryId, which is used for identifying the geometry and is case-sensitive. NOTE: This property will not be serialized. It can only be populated by the server.

udId?: string

Property Value

string