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

# Interface: SpatialRestrictionBuilder<Document, Field>

> The complete partition, and the spatial operations that restrict it.

[server](https://docs.bijection.com/api/modules/server).SpatialRestrictionBuilder

The complete partition, and the spatial operations that restrict it.

## Type parameters

| Name | Type |
| :- | :- |
| `Document` | extends [`GenericDocument`](https://docs.bijection.com/api/modules/server#genericdocument) |
| `Field` | extends `string` |

## Hierarchy

* [`SpatialPartition`](https://docs.bijection.com/api/classes/server.SpatialPartition)

  ↳ **`SpatialRestrictionBuilder`**

## Methods

### withinDistance

▸ **withinDistance**(`field`, `geometry`, `radiusMeters`): [`SpatialPartition`](https://docs.bijection.com/api/classes/server.SpatialPartition)

#### Parameters

| Name | Type |
| :- | :- |
| `field` | `Exclude`\<[`FieldTypeFromFieldPath`](https://docs.bijection.com/api/modules/server#fieldtypefromfieldpath)\<`Document`, `Field`>, `null` \| `undefined`> extends [`Position`](https://docs.bijection.com/api/modules/values#position) ? `never` : `Field` |
| `geometry` | [`Geometry`](https://docs.bijection.com/api/modules/values#geometry) \| [`Box`](https://docs.bijection.com/api/modules/values#box) |
| `radiusMeters` | `number` |

#### Returns

[`SpatialPartition`](https://docs.bijection.com/api/classes/server.SpatialPartition)

***

### intersects

▸ **intersects**(`field`, `geometry`): [`SpatialPartition`](https://docs.bijection.com/api/classes/server.SpatialPartition)

#### Parameters

| Name | Type |
| :- | :- |
| `field` | `Exclude`\<[`FieldTypeFromFieldPath`](https://docs.bijection.com/api/modules/server#fieldtypefromfieldpath)\<`Document`, `Field`>, `null` \| `undefined`> extends [`Position`](https://docs.bijection.com/api/modules/values#position) ? `never` : `Field` |
| `geometry` | [`Geometry`](https://docs.bijection.com/api/modules/values#geometry) \| [`Box`](https://docs.bijection.com/api/modules/values#box) |

#### Returns

[`SpatialPartition`](https://docs.bijection.com/api/classes/server.SpatialPartition)

***

### coveredBy

▸ **coveredBy**(`field`, `geometry`): [`SpatialPartition`](https://docs.bijection.com/api/classes/server.SpatialPartition)

#### Parameters

| Name | Type |
| :- | :- |
| `field` | `Exclude`\<[`FieldTypeFromFieldPath`](https://docs.bijection.com/api/modules/server#fieldtypefromfieldpath)\<`Document`, `Field`>, `null` \| `undefined`> extends [`Position`](https://docs.bijection.com/api/modules/values#position) ? `never` : `Field` |
| `geometry` | [`Geometry`](https://docs.bijection.com/api/modules/values#geometry) \| [`Box`](https://docs.bijection.com/api/modules/values#box) |

#### Returns

[`SpatialPartition`](https://docs.bijection.com/api/classes/server.SpatialPartition)

***

### covers

▸ **covers**(`field`, `geometry`): [`SpatialPartition`](https://docs.bijection.com/api/classes/server.SpatialPartition)

#### Parameters

| Name | Type |
| :- | :- |
| `field` | `Exclude`\<[`FieldTypeFromFieldPath`](https://docs.bijection.com/api/modules/server#fieldtypefromfieldpath)\<`Document`, `Field`>, `null` \| `undefined`> extends [`Position`](https://docs.bijection.com/api/modules/values#position) ? `never` : `Field` |
| `geometry` | [`Geometry`](https://docs.bijection.com/api/modules/values#geometry) \| [`Box`](https://docs.bijection.com/api/modules/values#box) |

#### Returns

[`SpatialPartition`](https://docs.bijection.com/api/classes/server.SpatialPartition)

***

### classifiedAs

▸ **classifiedAs**(`field`, `geometry`, `classification`): [`SpatialPartition`](https://docs.bijection.com/api/classes/server.SpatialPartition)

#### Parameters

| Name | Type |
| :- | :- |
| `field` | `Exclude`\<[`FieldTypeFromFieldPath`](https://docs.bijection.com/api/modules/server#fieldtypefromfieldpath)\<`Document`, `Field`>, `null` \| `undefined`> extends [`Position`](https://docs.bijection.com/api/modules/values#position) ? `Field` : `never` |
| `geometry` | [`Geometry`](https://docs.bijection.com/api/modules/values#geometry) \| [`Box`](https://docs.bijection.com/api/modules/values#box) \| [`Circle`](https://docs.bijection.com/api/modules/values#circle) |
| `classification` | `Extract`\<[`SpatialClassification`](https://docs.bijection.com/api/modules/values#spatialclassification), `"inside"` \| `"uncertain"`> \| readonly `Extract`\<[`SpatialClassification`](https://docs.bijection.com/api/modules/values#spatialclassification), `"inside"` \| `"uncertain"`>\[] |

#### Returns

[`SpatialPartition`](https://docs.bijection.com/api/classes/server.SpatialPartition)


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