Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jacobsamo/buzztrip/llms.txt

Use this file to discover all available pages before exploring further.

Paths let you draw geometric shapes directly onto the map surface. Whether you are tracing a hiking trail, outlining an event venue, or sketching a photo-shoot zone, BuzzTrip calculates live measurements as you draw — giving you instant feedback on distance, area, perimeter, and more. All paths are stored in the paths table and associated with a specific map.

​
Path Types

BuzzTrip supports five path types, defined by the pathTypeEnum:

Line

A polyline connecting two or more points. Useful for trails, roads, or any linear route.

Circle

A circular shape defined by a center point and radius. Good for marking coverage areas or zones.

Rectangle

An axis-aligned rectangle defined by its corner points. Ideal for bounding boxes and venue footprints.

Polygon

A closed shape with any number of vertices. Use it for irregular boundaries, neighborhoods, or custom regions.

Text

A text annotation anchored to a position on the map.

​
Path Properties

​
pathType
string
required
The shape type. One of text, circle, rectangle, polygon, or line.
​
title
string
required
A display name for the path shown in the sidebar.
​
note
string
An optional free-text note describing the path.
​
points
Position | Position[] | Position[][]
required
The geometric data of the shape. The structure varies by shape type — see Position Format below.
​
measurements
object
Auto-calculated measurement data. The fields present depend on the path type — see Measurements below.
​
styles
object
Visual styling options for the path. See Path Styles below.
​
createdBy
ID (users)
required
A reference to the user who created the path. Automatically set to the authenticated user when calling createPath.

​
Position Format

Positions are stored as coordinate tuples. BuzzTrip follows the GeoJSON convention of longitude first, then latitude: 
// 2D position
type Position2D = [longitude: number, latitude: number]

// 3D position (with optional altitude)
type Position3D = [longitude: number, latitude: number, altitude: number]
The points field on a path accepts one of three structures depending on the shape:
StructureUsed for
[lng, lat] or [lng, lat, alt]Single-point shapes (e.g. text, circle center)
Position[]Multi-point lines
Position[][]Closed polygons and complex shapes

​
Measurements

BuzzTrip automatically computes measurements based on the path type. Measurement values are stored in the measurements field.
FieldDescription
perimeterCircumference of the circle
areaArea enclosed by the circle
radiusDistance from center to edge
diameterFull width across the circle (2× radius)

​
Path Styles

Customize the appearance of any path using the styles object:
​
styles.strokeColor
string
required
Hex color for the path outline or line stroke.
​
styles.strokeOpacity
number
Opacity of the stroke, from 0.0 (transparent) to 1.0 (fully opaque).
​
styles.strokeWidth
number
Width of the stroke line in pixels.
​
styles.fillColor
string
Hex fill color for closed shapes (circle, rectangle, polygon). Not applicable to lines.
​
styles.fillOpacity
number
Opacity of the fill, from 0.0 (transparent) to 1.0 (fully opaque).

​
Creating and Editing Paths

  • Create — Call createPath with the path type, title, points, and optional measurements and styles. The createdBy field is automatically set to the authenticated user’s ID.
  • Edit — Call editPath with the path ID and any updated fields. The updatedAt timestamp is refreshed automatically.
  • Delete — Call deletePath with the path ID to permanently remove the path from the map.
Use paths to outline event venues, sketch hiking trails, or mark photo-shoot zones. Combine a polygon path for the boundary with markers inside it for individual points of interest — the polygon’s area measurement gives you instant size context.

Build docs developers (and LLMs) love

Get started for freeTalk to us