@fairfleet/geotab / Zone
Sometimes referred to as a "Geofence", a zone is a virtual geographic boundary, defined by its points representing a real-world geographic area.
-
↳
Zone
- activeFrom
- activeTo
- centroidLatitude
- centroidLongitude
- comment
- displayed
- extent
- externalReference
- fillColor
- groups
- id
- mustIdentifyStops
- name
- points
- version
- zoneTypes
• activeFrom: Date
Gets or sets the date indicating when this zone begins it's active lifespan. Default [UtcNow].
src/types/Checkmate/ObjectModel/Zone.ts:13
• activeTo: Date
Gets or sets the date indicating when this zone finishes it's active lifespan. Default [MaxDate].
src/types/Checkmate/ObjectModel/Zone.ts:15
• centroidLatitude: number
Gets the latitude coordinate of the zone's centroid.
src/types/Checkmate/ObjectModel/Zone.ts:17
• centroidLongitude: number
Gets the longitude coordinate of the zone's centroid.
src/types/Checkmate/ObjectModel/Zone.ts:19
• comment: string
Gets or sets a free text field where any user information can be stored and referenced for this entity. Default [""].
src/types/Checkmate/ObjectModel/Zone.ts:21
• displayed: boolean
Gets or sets a value indicating whether this zone must be displayed when viewing a map or it should be hidden. Default [true].
src/types/Checkmate/ObjectModel/Zone.ts:23
• extent: unknown[]
Gets the zone's extent.
src/types/Checkmate/ObjectModel/Zone.ts:25
• externalReference: string
Gets or sets external Reference. Any type of external reference you would like to attach to the zone. For example; an ID from another data source referenced when exporting zone data into another program. Maximum length [255] Default [""].
src/types/Checkmate/ObjectModel/Zone.ts:27
• fillColor: Color
Gets or sets the Color of the fill for this zone when showing on a map. Default [based on zone type; Customer: Orange, Office: Light Orange, Home: Green, Other: Blue].
src/types/Checkmate/ObjectModel/Zone.ts:29
• groups: Group[]
Gets or sets the group(s) this zone belongs to.
src/types/Checkmate/ObjectModel/Zone.ts:31
• id: string
Gets or sets the unique identifier for this entity. See Id.
src/types/Checkmate/ObjectModel/Zone.ts:33
• mustIdentifyStops: boolean
Gets or sets whether this zone name must be shown when devices stop in this zone. If [true] a "zone stop rule" (Rule with BaseType: ZoneStop) will automatically be created for this zone. This is to facilitate reporting on zone stops. The rule is not visible via the UI. Default [true].
src/types/Checkmate/ObjectModel/Zone.ts:35
• name: string
Gets or sets the name of this entity that uniquely identifies it and is used when displaying this entity.
src/types/Checkmate/ObjectModel/Zone.ts:37
• points: unknown[]
Gets or sets the list of points (see Coordinate) that make up this zone. A zone should be closed, the first point is the same coordinate as the last point.
Remarks
It is possible to add a zone with an unclosed set of points but the points will be closed by the system.
src/types/Checkmate/ObjectModel/Zone.ts:43
• version: number
Gets or sets the version of the entity.
src/types/Checkmate/ObjectModel/NameEntityWithVersion.ts:10
• zoneTypes: ZoneType[]
Gets or sets the list of ZoneType(s) this zone belongs to. Default [Customer].