Circle.md

redis-om / Circle

Class: Circle

A builder that defines a circle.

Table of contents

Constructors

• constructor

Accessors

• feet
• foot
• ft
• kilometer
• kilometers
• km
• m
• meter
• meters
• mi
• mile
• miles

Methods

• latitude
• longitude
• origin
• radius

Constructors

constructor

• new Circle()

Accessors

feet

• get feet(): this

Sets the units to feet.

Returns

this

This instance.

Defined in

lib/search/where-point.ts:149

---

foot

• get foot(): this

Sets the units to feet.

Returns

this

This instance.

Defined in

lib/search/where-point.ts:143

---

ft

• get ft(): this

Sets the units to feet.

Returns

this

This instance.

Defined in

lib/search/where-point.ts:137

---

kilometer

• get kilometer(): this

Sets the units to kilometers.

Returns

this

This instance.

Defined in

lib/search/where-point.ts:122

---

kilometers

• get kilometers(): this

Sets the units to kilometers.

Returns

this

This instance.

Defined in

lib/search/where-point.ts:128

---

km

• get km(): this

Sets the units to kilometers.

Returns

this

This instance.

Defined in

lib/search/where-point.ts:116

---

m

• get m(): this

Sets the units to meters.

Returns

this

This instance.

Defined in

lib/search/where-point.ts:95

---

meter

• get meter(): this

Sets the units to meters.

Returns

this

This instance.

Defined in

lib/search/where-point.ts:101

---

meters

• get meters(): this

Sets the units to meters.

Returns

this

This instance.

Defined in

lib/search/where-point.ts:107

---

mi

• get mi(): this

Sets the units to miles.

Returns

this

This instance.

Defined in

lib/search/where-point.ts:158

---

mile

• get mile(): this

Sets the units to miles.

Returns

this

This instance.

Defined in

lib/search/where-point.ts:164

---

miles

• get miles(): this

Sets the units to miles.

Returns

this

This instance.

Defined in

lib/search/where-point.ts:170

Methods

latitude

▸ latitude(value): Circle

Sets the latitude. If not set, defaults to 0.0.

Parameters

Name	Type	Description
value	number	The latitude.

Returns

Circle

This instance.

Defined in

lib/search/where-point.ts:42

---

longitude

▸ longitude(value): Circle

Sets the longitude. If not set, defaults to 0.0.

Parameters

Name	Type	Description
value	number	The longitude.

Returns

Circle

This instance.

Defined in

lib/search/where-point.ts:31

---

origin

▸ origin(point): Circle

Sets the origin of the circle using a Point. If not set, defaults to Null Island.

Parameters

Name	Type	Description
point	Point	A Point containing the longitude and latitude of the origin.

Returns

Circle

This instance.

Defined in

lib/search/where-point.ts:54

▸ origin(longitude, latitude): Circle

Sets the origin of the circle. If not set, defaults to Null Island.

Parameters

Name	Type	Description
longitude	number	The longitude.
latitude	number	The latitude.

Returns

Circle

This instance.

Defined in

lib/search/where-point.ts:64

---

radius

▸ radius(size): Circle

Sets the radius of the Circle. Defaults to 1. If units are not specified, defaults to meters.

Parameters

Name	Type	Description
size	number	The radius of the circle.

Returns

Circle

This instance.

Defined in

lib/search/where-point.ts:86