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.

Labels add descriptive overlays to the map surface to provide context and aid navigation for anyone viewing the map. Unlike markers — which represent specific pinned locations linked to place data — labels are purely visual annotations. They are ideal for naming neighborhoods, identifying regions, marking boundaries, or highlighting areas of interest without pinning a specific geographic coordinate.

​
Label Properties

​
title
string
required
The primary text displayed by the label on the map surface.
​
description
string
required
A supporting description shown when the label is selected or previewed.
​
icon
icon
An optional icon drawn from the iconSchema, displayed alongside the label text. Either icon or color (or both) must be provided — see the note below.
​
color
string
An optional hex color used to style the label’s visual appearance on the map. Either icon or color (or both) must be provided.
​
created_by
ID (users)
required
A reference to the user who created the label. Automatically set to the authenticated user when calling createLabel.
Every label must have either an icon, a color, or both. A label with neither is rejected by schema validation with the message: “Either icon or color must be provided.” This is enforced by a .refine() rule on both labelsSchema and labelsEditSchema.

​
Use Cases

Labels are well-suited for annotating broad areas or providing contextual information that does not belong to a single pinned location:

Neighborhoods & Districts

Name areas of a city map — “Old Town”, “Waterfront District”, “Arts Quarter” — so viewers can orient themselves quickly.

Event Zones

Mark functional areas of an event venue — “Main Stage”, “Food Court”, “Parking”, “VIP Area” — without cluttering the map with individual markers.

Geographic Regions

Identify national parks, nature reserves, or administrative boundaries to provide geographic context alongside your markers and paths.

Photo Shoot Areas

Annotate a location scouting map with zone names like “Golden Hour Spot” or “Wide Angle Setup” to communicate intent to your team.

​
Visual Appearance

Labels appear as floating text or icon+text overlays anchored to a position on the map canvas. They render above the base map layer but do not obstruct interaction with markers or paths. The color field controls the label’s accent color, and the icon field adds a visual glyph next to the title for quick recognition.

​
Creating Labels

1

Open the label tool

In the map toolbar, select the label tool and click the position on the map where you want to anchor the label.
2

Fill in the details

Enter a title and description. Choose an icon, a color, or both — at least one is required.
3

Save

Click Save. BuzzTrip calls the createLabel mutation, which inserts the label record with map_id and created_by set automatically from context.

​
Editing and Deleting Labels

  • Edit — Call editLabel with the label ID and updated fields (title, description, icon, color). The updatedAt timestamp is refreshed automatically.
  • Delete — Call deleteLabel with the label ID to permanently remove the label from the map.

​
Labels vs. Markers

LabelsMarkers
PurposeDescriptive area/region annotationPinned location with place data
Place linkageNoneLinked to places table
POI dataNoYes (address, rating, photos, etc.)
CollectionsNot supportedSupported
Icon + ColorAt least one requiredBoth required
Use labels when you want to name or describe a region or zone. Use markers when you want to pin a specific location that a viewer might want to visit, navigate to, or learn more about.

Build docs developers (and LLMs) love

Get started for freeTalk to us