Class GeoPoint (4.15.1)

An immutable object representing a geographic location in Firestore. The location is represented as a latitude/longitude pair.

Package

@google-cloud/firestore

Constructors

(constructor)(latitude, longitude)

  constructor 
 ( 
 latitude 
 : 
  
 number 
 , 
  
 longitude 
 : 
  
 number 
 ); 
 

Creates a [GeoPoint] GeoPoint .

Parameters
Name Description
latitude number

The latitude as a number between -90 and 90.

longitude number

The longitude as a number between -180 and 180.

Example

let data = { google: new Firestore.GeoPoint(37.422, 122.084) };

firestore.doc('col/doc').set(data).then(() => { console.log( Location is ${data.google.latitude}, + ${data.google.longitude} ); });

Properties

latitude

  get 
  
 latitude 
 () 
 : 
  
 number 
 ; 
 

The latitude as a number between -90 and 90.

{number} GeoPoint#latitude

Property Value
Type Description
number

longitude

  get 
  
 longitude 
 () 
 : 
  
 number 
 ; 
 

The longitude as a number between -180 and 180.

{number} GeoPoint#longitude

Property Value
Type Description
number

Methods

isEqual(other)

  isEqual 
 ( 
 other 
 : 
  
 firestore 
 . 
 GeoPoint 
 ) 
 : 
  
 boolean 
 ; 
 

Returns true if this GeoPoint is equal to the provided value.

Parameter
Name Description
other firestore.GeoPoint

The value to compare against. {boolean} true if this GeoPoint is equal to the provided value.

Returns
Type Description
boolean
Create a Mobile Website
View Site in Mobile | Classic
Share by: