# Pin map card

> Canonical HTML: https://screenrig.ai/docs/cards/pin-map/

Place numbered destinations on your supplied map or floor plan.

Show a project-media map using calibrated image dimensions and supplied relative pin positions, plus an optional “you are here” marker. Nearby pins cluster under stable numbers, with names and notes in a paged legend. Closed destinations remain marked. Primetime adds a spring entrance and slow map-fold linework while the plan and pins stay still.

## Live card

This card is drawn in your browser by the same code the Players run, with sample data.

Category: Public information. Tags: Wayfinding and directories, Lobbies and reception, Events and venues.

## Layouts

This fullscreen card fills the whole screen in landscape or portrait and is not placed as a corner, chip, or strip.

Layouts: full. Forms: landscape, portrait.

[Card layouts, themes and publishing](/docs/cards/). [Browse the cards](/apps/#cards).

## Data and privacy

This card uses its configured properties and live card data.

Venue map and destination information; the location marker is supplied, not tracked.

## Properties

For theme, background, accent and position, see [Common properties](/docs/cards/#common-properties).

Set static properties in `params`. Bind `data` to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in `params`. Nested rows describe the contents of their parent property.

### Static properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `title` | string | `"Find your way"` | maxLength: `100` |  |
| `perPage` | integer | `6` | minimum: `3`; maximum: `8` |  |
| `pageSeconds` | integer | `12` | minimum: `8`; maximum: `120` |  |
| `clusterDistance` | number | `0.035` | minimum: `0`; maximum: `0.1` | Cluster distance as a fraction of the longer plan dimension; positions remain relative to the supplied plan. |

### Dynamic properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `plan` | object, null | `null` | additionalProperties: `false` |  |
| `plan.image` | string |  | maxLength: `2048`; Required |  |
| `plan.width` | integer |  | minimum: `1`; maximum: `32768`; Required |  |
| `plan.height` | integer |  | minimum: `1`; maximum: `32768`; Required |  |
| `plan.name` | string | `""` | maxLength: `120` |  |
| `plan.credit` | string | `""` | maxLength: `160` |  |
| `plan.updatedAt` | string | `""` | maxLength: `64` |  |
| `plan.here` | object, null | `null` | additionalProperties: `false` |  |
| `plan.here.x` | number |  | minimum: `0`; maximum: `1`; Required |  |
| `plan.here.y` | number |  | minimum: `0`; maximum: `1`; Required |  |
| `plan.pins` | array |  | maxItems: `64`; Required |  |
| `plan.pins[].id` | string |  | minLength: `1`; maxLength: `48`; Required |  |
| `plan.pins[].name` | string |  | minLength: `1`; maxLength: `120`; Required |  |
| `plan.pins[].x` | number |  | minimum: `0`; maximum: `1`; Required |  |
| `plan.pins[].y` | number |  | minimum: `0`; maximum: `1`; Required |  |
| `plan.pins[].detail` | string | `""` | maxLength: `200` |  |
| `plan.pins[].status` | string | `"normal"` | `"normal"`, `"attention"`, `"closed"` |  |

## Canvas example

Add this item to a playlist page’s `primitives`. [Publish the playlist and assign a screen](/docs/cards/#publish-a-card-canvas).

```json
{
  "id": "pin-map",
  "primitive": "card",
  "card": "pin-map",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "example-key"
}
```

## Write live data

The canvas example binds its `data` field to `example-key`. That value is a data key: a name this canvas item chooses, not the name of the card. Give each canvas item its own key when items should show different data, or share one key when they should show the same data. Keys are scoped to the project, follow the K/V key grammar, and cannot start with `feed:`.

Create this document before showing the card, then replace it to update the screen without republishing. Writes to a key that live canvas items bind are checked against each bound card’s dynamic properties. Use the same project as the playlist.

Save the document as `card-data.json`. The CLI reads the document itself, with no wrapper:

```json
{
  "plan": null
}
```

```console
screenrig card-data put example-key --file card-data.json
```

Or call the API directly. The API wraps the same document in a `document` field. An agent token already names its project, so no project header is sent; if you send `ScreenRig-Project`, it must match the token’s project. Supply your API authorization through the environment; see [API authentication](/docs/authentication/).

```console
curl --request PUT "https://api.screenrig.ai/api/card-data/example-key" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"plan":null}}'
```