## engine.ShapeField


Field which indexes geometries: LatLon or XY.


Usage

``` python
engine.ShapeField(
    name,
    indexed=True,
    docvalues=False,
)
```


## Methods

| Name | Description |
|----|----|
| [contains()](#contains) | Return shape query with [contains](engine.ShapeField.md#lupyne.engine.ShapeField.contains) relation. |
| [disjoint()](#disjoint) | Return shape query with [disjoint](engine.ShapeField.md#lupyne.engine.ShapeField.disjoint) relation. |
| [distances()](#distances) | Return distance SortField. |
| [intersects()](#intersects) | Return shape query with [intersects](engine.ShapeField.md#lupyne.engine.ShapeField.intersects) relation. |
| [items()](#items) | Generate lucene shape fields from geometries. |
| [within()](#within) | Return shape query with [within](engine.ShapeField.md#lupyne.engine.ShapeField.within) relation. |

------------------------------------------------------------------------


#### contains()


Return shape query with [contains](engine.ShapeField.md#lupyne.engine.ShapeField.contains) relation.


Usage

``` python
contains(*shapes)
```


------------------------------------------------------------------------


#### disjoint()


Return shape query with [disjoint](engine.ShapeField.md#lupyne.engine.ShapeField.disjoint) relation.


Usage

``` python
disjoint(*shapes)
```


------------------------------------------------------------------------


#### distances()


Return distance SortField.


Usage

``` python
distances(point)
```


------------------------------------------------------------------------


#### intersects()


Return shape query with [intersects](engine.ShapeField.md#lupyne.engine.ShapeField.intersects) relation.


Usage

``` python
intersects(*shapes)
```


------------------------------------------------------------------------


#### items()


Generate lucene shape fields from geometries.


Usage

``` python
items(*shapes)
```


------------------------------------------------------------------------


#### within()


Return shape query with [within](engine.ShapeField.md#lupyne.engine.ShapeField.within) relation.


Usage

``` python
within(*shapes)
```