> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# FilterByRadiusRequest

> FilterByRadiusRequest — Kinetica JavaScript API

interface FilterByRadiusRequest \{\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[radius](#radius): number;\
&#x20;[table\_name](#table_name): string;\
&#x20;[view\_name](#view_name)?: string;\
&#x20;[x\_center](#x_center): number;\
&#x20;[x\_column\_name](#x_column_name): string;\
&#x20;[y\_center](#y_center): number;\
&#x20;[y\_column\_name](#y_column_name): string;\
}

<ul>
  <li>Defined in [src/types.ts:2910](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2910)</li>
</ul>

##### Index

### Properties

[options?](#options) [radius](#radius) [table\_name](#table_name) [view\_name?](#view_name) [x\_center](#x_center) [x\_column\_name](#x_column_name) [y\_center](#y_center) [y\_column\_name](#y_column_name)&#x20;

## Properties

### `Optional`options

options?: Record\<string, string>

Optional parameters.

<ul>
  <li>Defined in [src/types.ts:2926](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2926)</li>
</ul>

### radius

radius: number

The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km.

<ul>
  <li>Defined in [src/types.ts:2924](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2924)</li>
</ul>

### table\_name

table\_name: string

Name of the table on which the filter by radius operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.

<ul>
  <li>Defined in [src/types.ts:2912](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2912)</li>
</ul>

### `Optional`view\_name

view\_name?: string

If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view.

<ul>
  <li>Defined in [src/types.ts:2914](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2914)</li>
</ul>

### x\_center

x\_center: number

Value of the longitude of the center. Must be within \[-180.0, 180.0].

<ul>
  <li>Defined in [src/types.ts:2918](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2918)</li>
</ul>

### x\_column\_name

x\_column\_name: string

Name of the column to be used for the x-coordinate (the longitude) of the center.

<ul>
  <li>Defined in [src/types.ts:2916](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2916)</li>
</ul>

### y\_center

y\_center: number

Value of the latitude of the center. Must be within \[-90.0, 90.0].

<ul>
  <li>Defined in [src/types.ts:2922](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2922)</li>
</ul>

### y\_column\_name

y\_column\_name: string

Name of the column to be used for the y-coordinate-the latitude-of the center.

<ul>
  <li>Defined in [src/types.ts:2920](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2920)</li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.