277448d9c0
Payload is designed with performance in mind, but its customizability means that there are many ways to configure your app that can impact performance. While Payload provides several features and best practices to help you optimize your app's specific performance needs, these are not currently well surfaced and can be obscure. Now: - A high-level performance doc now exists at `/docs/performance` - There's a new section on performance within the `/docs/queries` doc - There's a new section on performance within the `/docs/hooks` doc - There's a new section on performance within the `/docs/custom-components` doc This PR also: - Restructures and elaborates on the `/docs/queries/pagination` docs - Adds a new `/docs/database/indexing` doc - More --- - To see the specific tasks where the Asana app for GitHub is being used, see below: - https://app.asana.com/0/0/1210743577153856
218 lines
10 KiB
Plaintext
218 lines
10 KiB
Plaintext
---
|
|
title: Point Field
|
|
label: Point
|
|
order: 110
|
|
desc: The Point field type stores coordinates in the database. Learn how to use Point field for geolocation and geometry.
|
|
keywords: point, geolocation, geospatial, geojson, 2dsphere, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
|
|
---
|
|
|
|
The Point Field saves a pair of coordinates in the database and assigns an index for location related queries. The data structure in the database matches the GeoJSON structure to represent point. The Payload API simplifies the object data to only the [longitude, latitude] location.
|
|
|
|
<LightDarkImage
|
|
srcLight="https://payloadcms.com/images/docs/fields/point.png"
|
|
srcDark="https://payloadcms.com/images/docs/fields/point-dark.png"
|
|
alt="Shows a Point field in the Payload Admin Panel"
|
|
caption="Admin Panel screenshot of a Point field"
|
|
/>
|
|
|
|
To add a Point Field, set the `type` to `point` in your [Field Config](./overview):
|
|
|
|
```ts
|
|
import type { Field } from 'payload'
|
|
|
|
export const MyPointField: Field = {
|
|
// ...
|
|
type: 'point', // highlight-line
|
|
}
|
|
```
|
|
|
|
<Banner type="warning">
|
|
**Important:** The Point Field currently is not supported in SQLite.
|
|
</Banner>
|
|
|
|
## Config
|
|
|
|
| Option | Description |
|
|
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More details](/docs/fields/overview#field-names). |
|
|
| **`label`** | Used as a field label in the Admin Panel and to name the generated GraphQL type. |
|
|
| **`unique`** | Enforce that each entry in the Collection has a unique value for this field. |
|
|
| **`index`** | Build an [index](../database/indexes) for this field to produce faster queries. To support location queries, point index defaults to `2dsphere`, to disable the index set to `false`. |
|
|
| **`validate`** | Provide a custom validation function that will be executed on both the Admin Panel and the backend. [More details](/docs/fields/overview#validation). |
|
|
| **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT. |
|
|
| **`hooks`** | Provide Field Hooks to control logic for this field. [More details](../hooks/fields). |
|
|
| **`access`** | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields). |
|
|
| **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel. |
|
|
| **`defaultValue`** | Provide data to be used for this field's default value. [More details](/docs/fields/overview#default-values). |
|
|
| **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
|
|
| **`required`** | Require this field to have a value. |
|
|
| **`admin`** | Admin-specific configuration. [More details](./overview#admin-options). |
|
|
| **`custom`** | Extension point for adding custom data (e.g. for plugins) |
|
|
| **`typescriptSchema`** | Override field type generation with providing a JSON schema |
|
|
| **`virtual`** | Provide `true` to disable field in the database, or provide a string path to [link the field with a relationship](/docs/fields/relationship#linking-virtual-fields-with-relationships). See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) |
|
|
|
|
_\* An asterisk denotes that a property is required._
|
|
|
|
## Example
|
|
|
|
`collections/ExampleCollection.ts`
|
|
|
|
```ts
|
|
import type { CollectionConfig } from 'payload'
|
|
|
|
export const ExampleCollection: CollectionConfig = {
|
|
slug: 'example-collection',
|
|
fields: [
|
|
{
|
|
name: 'location',
|
|
type: 'point',
|
|
label: 'Location',
|
|
},
|
|
],
|
|
}
|
|
```
|
|
|
|
## Querying - near
|
|
|
|
In order to do query based on the distance to another point, you can use the `near` operator. When querying using the near operator, the returned documents will be sorted by nearest first.
|
|
|
|
## Querying - within
|
|
|
|
In order to do query based on whether points are within a specific area defined in GeoJSON, you can use the `within` operator.
|
|
Example:
|
|
|
|
```ts
|
|
const polygon: Point[] = [
|
|
[9.0, 19.0], // bottom-left
|
|
[9.0, 21.0], // top-left
|
|
[11.0, 21.0], // top-right
|
|
[11.0, 19.0], // bottom-right
|
|
[9.0, 19.0], // back to starting point to close the polygon
|
|
]
|
|
|
|
payload.find({
|
|
collection: 'points',
|
|
where: {
|
|
point: {
|
|
within: {
|
|
type: 'Polygon',
|
|
coordinates: [polygon],
|
|
},
|
|
},
|
|
},
|
|
})
|
|
```
|
|
|
|
## Querying - intersects
|
|
|
|
In order to do query based on whether points intersect a specific area defined in GeoJSON, you can use the `intersects` operator.
|
|
Example:
|
|
|
|
```ts
|
|
const polygon: Point[] = [
|
|
[9.0, 19.0], // bottom-left
|
|
[9.0, 21.0], // top-left
|
|
[11.0, 21.0], // top-right
|
|
[11.0, 19.0], // bottom-right
|
|
[9.0, 19.0], // back to starting point to close the polygon
|
|
]
|
|
|
|
payload.find({
|
|
collection: 'points',
|
|
where: {
|
|
point: {
|
|
intersects: {
|
|
type: 'Polygon',
|
|
coordinates: [polygon],
|
|
},
|
|
},
|
|
},
|
|
})
|
|
```
|
|
|
|
## Custom Components
|
|
|
|
### Field
|
|
|
|
#### Server Component
|
|
|
|
```tsx
|
|
import type React from 'react'
|
|
import { PointField } from '@payloadcms/ui'
|
|
import type { PointFieldServerComponent } from 'payload'
|
|
|
|
export const CustomPointFieldServer: PointFieldServerComponent = ({
|
|
clientField,
|
|
path,
|
|
schemaPath,
|
|
permissions,
|
|
}) => {
|
|
return (
|
|
<PointField
|
|
field={clientField}
|
|
path={path}
|
|
schemaPath={schemaPath}
|
|
permissions={permissions}
|
|
/>
|
|
)
|
|
}
|
|
```
|
|
|
|
#### Client Component
|
|
|
|
```tsx
|
|
'use client'
|
|
import React from 'react'
|
|
import { PointField } from '@payloadcms/ui'
|
|
import type { PointFieldClientComponent } from 'payload'
|
|
|
|
export const CustomPointFieldClient: PointFieldClientComponent = (props) => {
|
|
return <PointField {...props} />
|
|
}
|
|
```
|
|
|
|
### Label
|
|
|
|
#### Server Component
|
|
|
|
```tsx
|
|
import React from 'react'
|
|
import { FieldLabel } from '@payloadcms/ui'
|
|
import type { PointFieldLabelServerComponent } from 'payload'
|
|
|
|
export const CustomPointFieldLabelServer: PointFieldLabelServerComponent = ({
|
|
clientField,
|
|
path,
|
|
}) => {
|
|
return (
|
|
<FieldLabel
|
|
label={clientField?.label || clientField?.name}
|
|
path={path}
|
|
required={clientField?.required}
|
|
/>
|
|
)
|
|
}
|
|
```
|
|
|
|
#### Client Component
|
|
|
|
```tsx
|
|
'use client'
|
|
import React from 'react'
|
|
import { FieldLabel } from '@payloadcms/ui'
|
|
import type { PointFieldLabelClientComponent } from 'payload'
|
|
|
|
export const CustomPointFieldLabelClient: PointFieldLabelClientComponent = ({
|
|
field,
|
|
path,
|
|
}) => {
|
|
return (
|
|
<FieldLabel
|
|
label={field?.label || field?.name}
|
|
path={path}
|
|
required={field?.required}
|
|
/>
|
|
)
|
|
}
|
|
```
|