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

# FilterByBoxRequest

> FilterByBoxRequest — Kinetica Node.js API

interface FilterByBoxRequest \{\
&#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;\
&#x20;[x\_column\_name](#x_column_name): string;\
&#x20;[y\_column\_name](#y_column_name): string;\
}

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

##### Index

### Properties

[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) [x\_column\_name](#x_column_name) [y\_column\_name](#y_column_name)&#x20;

## Properties

### max\_x

max\_x: number

Upper bound for `x_column_name`. Must be greater than or equal to `min_x`.

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

### max\_y

max\_y: number

Upper bound for `y_column_name`. Must be greater than or equal to `min_y`.

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

### min\_x

min\_x: number

Lower bound for the column chosen by `x_column_name`. Must be less than or equal to `max_x`.

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

### min\_y

min\_y: number

Lower bound for `y_column_name`. Must be less than or equal to `max_y`.

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

### `Optional`options

options?: Record\<string, string>

Optional parameters.

<ul>
  <li>Defined in [src/types.ts:2826](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2826)</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:2810](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2810)</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:2812](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2812)</li>
</ul>

### x\_column\_name

x\_column\_name: string

Name of the column on which to perform the bounding box query. Must be a valid numeric column.

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

### y\_column\_name

y\_column\_name: string

Name of a column on which to perform the bounding box query. Must be a valid numeric column.

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


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