Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeolocationDTO Abstract

description

A DTO class that consists of the transferable properties of a geolocation. Note this DTO can be used in mongo queries to perform geo-queries as specified in following documentation:

link

https://www.rfc-editor.org/rfc/rfc7946#section-3.1.4

since

v0.3.2

Hierarchy

Index

Constructors

Properties

Constructors

Properties

coordinates: number[] | number[][] | number[][][]

The geolocation coordinates. Depending on the type of this geolocation object, the value of this field may differ as noted in GeolocationDTO.type.

Valid coordinates arrays consist of numbers that are included in the following ranges:

  • Valid longitude values are between -180 and 180, both inclusive.
  • Valid latitude values are between -90 and 90, both inclusive.

    For more precision, it is possible that some values use decimal places.
example

"[39, 56]"

access

public

var

{number[] | number[][] | number[][][]}

type: string

The geolocation object type. Depending on the type of this geolocation object, the value of the field GeolocationDTO.coordinates may differ.

This field may contain the following values:

Type Value Type Description
Point [number] An array of numbers specifying longitude and latitude - in this order.
MultiPoint number[][] An array of positions coordinates.
LineString number[] An array of two or more positions.
MultiLineString number[][] An array of LineString coordinate array.


example

"Point"

access

public

var

{string}

Generated using TypeDoc