Point Field

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 APIs simplifies the object data to only the [longitude, latitude] location.

Admin Panel screenshot of a Point field

To add a Point Field, set the type to point in your Field Config:

1import type { Field } from 'payload'
2
3export const MyPointField: Field = {
4  // ...
5  type: 'point', 
6}

Config

Option	Description
`name` *	To be used as the property name when stored and retrieved from the database. More
`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 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
`saveToJWT`	If this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.
`hooks`	Provide Field Hooks to control logic for this field. More details.
`access`	Provide Field Access Control to denote what users can see and do with this field's data. More details.
`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
`localized`	Enable localization for this field. Requires localization to be enabled in the Base config.
`required`	Require this field to have a value.
`admin`	Admin-specific configuration. More details.
`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. See Virtual Fields

* An asterisk denotes that a property is required.

Example

collections/ExampleCollection.ts

1import type { CollectionConfig } from 'payload'
2
3export const ExampleCollection: CollectionConfig = {
4  slug: 'example-collection',
5  fields: [
6    {
7      name: 'location',
8      type: 'point',
9      label: 'Location',
10    },
11  ],
12}

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:

1const 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
7]
8
9payload.find({
collection: "points",
where: {
  point: {
    within: {
      type: 'Polygon',
      coordinates: [polygon],
    },
  },
},
19})

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:

1const 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
7]
8
9payload.find({
collection: "points",
where: {
  point: {
    intersects: {
      type: 'Polygon',
      coordinates: [polygon],
    },
  },
},
19})

1import type React from 'react'
2import { PointField } from '@payloadcms/ui'
3import type { PointFieldServerComponent } from 'payload'
4
5export const CustomPointFieldServer: PointFieldServerComponent = ({
6  clientField,
7  path,
8  schemaPath,
9  permissions,
10}) => {
11  return (
12    <PointField field={clientField} path={path} schemaPath={schemaPath} permissions={permissions} />
13  )
14}

Client Component

1'use client'
2import React from 'react'
3import { PointField } from '@payloadcms/ui'
4import type { PointFieldClientComponent } from 'payload'
5
6export const CustomPointFieldClient: PointFieldClientComponent = (props) => {
7  return <PointField {...props} />
8}

Label

Server Component

1import React from 'react'
2import { FieldLabel } from '@payloadcms/ui'
3import type { PointFieldLabelServerComponent } from 'payload'
4
5export const CustomPointFieldLabelServer: PointFieldLabelServerComponent = ({
6  clientField,
7  path,
8}) => {
9  return (
10    <FieldLabel
11      label={clientField?.label || clientField?.name}
12      path={path}
13      required={clientField?.required}
14    />
15  )
16}

Client Component

1'use client'
2import React from 'react'
3import { FieldLabel } from '@payloadcms/ui'
4import type { PointFieldLabelClientComponent } from 'payload'
5
6export const CustomPointFieldLabelClient: PointFieldLabelClientComponent = ({
7  field,
8  path,
9}) => {
10  return (
11    <FieldLabel
12      label={field?.label || field?.name}
13      path={path}
14      required={field?.required}
15    />
16  )
17}

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Deploy your entire stack in one place with Payload Cloud.

Microsoft chose Payload to tell the world about AI.

Point Field

Config

Example

Querying - near

Querying - within

Querying - intersects

Custom Components

Field

Server Component

Client Component

Label

Server Component

Client Component

Radio Group Field