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

# FilterByBoxGeometryRequest

> FilterByBoxGeometryRequest — Kinetica Node.js API

interface FilterByBoxGeometryRequest \{\
&#x20;[column\_name](#column_name): string;\
&#x20;[max\_x](#max_x): number;\
&#x20;[max\_y](#max_y): number;\
&#x20;[min\_x](#min_x): number;\
&#x20;[min\_y](#min_y): number;\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[table\_name](#table_name): string;\
&#x20;[view\_name](#view_name)?: string;\
}

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

##### Index

### Properties

[column\_name](#column_name) [max\_x](#max_x) [max\_y](#max_y) [min\_x](#min_x) [min\_y](#min_y) [options?](#options) [table\_name](#table_name) [view\_name?](#view_name)&#x20;

## Properties

### column\_name

column\_name: string

Name of the geospatial geometry column to be filtered.

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

### max\_x

max\_x: number

Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to `min_x`.

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

### max\_y

max\_y: number

Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to `min_y`.

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

### min\_x

min\_x: number

Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to `max_x`.

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

### min\_y

min\_y: number

Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to `max_y`.

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

### `Optional`options

options?: Record\<string, string>

Optional parameters.

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

### table\_name

table\_name: string

Name of the table on which the bounding box 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:2840](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2840)</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:2842](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2842)</li>
</ul>


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