> ## 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.

# FilterByAreaGeometryRequest

> FilterByAreaGeometryRequest — Kinetica JavaScript API

interface FilterByAreaGeometryRequest \{\
&#x20;[column\_name](#column_name): string;\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[table\_name](#table_name): string;\
&#x20;[view\_name](#view_name)?: string;\
&#x20;[x\_vector](#x_vector): number\[];\
&#x20;[y\_vector](#y_vector): number\[];\
}

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

##### Index

### Properties

[column\_name](#column_name) [options?](#options) [table\_name](#table_name) [view\_name?](#view_name) [x\_vector](#x_vector) [y\_vector](#y_vector)&#x20;

## Properties

### column\_name

column\_name: string

Name of the geospatial geometry column to be filtered.

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

### `Optional`options

options?: Record\<string, string>

Optional parameters.

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

### table\_name

table\_name: string

Name of the table to filter, in \[schema\_name.]table\_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).

<ul>
  <li>Defined in [src/types.ts:2786](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2786)</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:2788](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2788)</li>
</ul>

### x\_vector

x\_vector: number\[]

List of x coordinates of the vertices of the polygon representing the area to be filtered.

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

### y\_vector

y\_vector: number\[]

List of y coordinates of the vertices of the polygon representing the area to be filtered.

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


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