atlas.service.Models.GeofenceGeometry.yml

### YamlMime:TSType
name: GeofenceGeometry
uid: azure-maps-rest.atlas.service.Models.GeofenceGeometry
package: azure-maps-rest
summary: The geofencing geometry.
fullName: GeofenceGeometry
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: deviceId
    uid: azure-maps-rest.atlas.service.Models.GeofenceGeometry.deviceId
    package: azure-maps-rest
    summary: >-
      ID of the device.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: deviceId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'deviceId?: string'
      return:
        description: ''
        type: string
  - name: distance
    uid: azure-maps-rest.atlas.service.Models.GeofenceGeometry.distance
    package: azure-maps-rest
    summary: >-
      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.**
    fullName: distance
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'distance?: number'
      return:
        description: ''
        type: number
  - name: geometryId
    uid: azure-maps-rest.atlas.service.Models.GeofenceGeometry.geometryId
    package: azure-maps-rest
    summary: >-
      The unique id identifies a geometry.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: geometryId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'geometryId?: string'
      return:
        description: ''
        type: string
  - name: nearestLat
    uid: azure-maps-rest.atlas.service.Models.GeofenceGeometry.nearestLat
    package: azure-maps-rest
    summary: >-
      Latitude of the nearest point of the geometry.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: nearestLat
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'nearestLat?: number'
      return:
        description: ''
        type: number
  - name: nearestLon
    uid: azure-maps-rest.atlas.service.Models.GeofenceGeometry.nearestLon
    package: azure-maps-rest
    summary: >-
      Longitude of the nearest point of the geometry.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: nearestLon
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'nearestLon?: number'
      return:
        description: ''
        type: number
  - name: udId
    uid: azure-maps-rest.atlas.service.Models.GeofenceGeometry.udId
    package: azure-maps-rest
    summary: >-
      The unique id returned from [Data Upload

      API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview)
      after uploading a

      valid GeoJSON FeatureCollection object. Please refer to  [RFC

      7946](https://tools.ietf.org/html/rfc7946#section-3.3) 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.**
    fullName: udId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'udId?: string'
      return:
        description: ''
        type: string