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

# FilterByAreaRequest

> FilterByAreaRequest — Kinetica Node.js API

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

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

##### Index

### Properties

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

## Properties

### `Optional`options

options?: Record\<string, string>

Optional parameters.

<ul>
  <li>Defined in [src/types.ts:2772](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2772)</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:2760](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2760)</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:2762](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2762)</li>
</ul>

### x\_column\_name

x\_column\_name: string

Name of the column containing the x values to be filtered.

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

### y\_column\_name

y\_column\_name: string

Name of the column containing the y values to be filtered.

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


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