Skip to Content
EditorSettings

Settings

The Settings panel controls how the map behaves — fullscreen, the hover tooltip, zoom and pan, deeplinking, and the responsive breakpoints below. The underlying keys are listed under Settings in the map data schema.

Options

NameDescription
FullscreenPosition of the fullscreen button (top-leftbottom-right). Click the selected arrow again to disable it.
Hover tooltipDisplay a tooltip when hovering a location.
Hover aboutShow the location’s about text in the hover tooltip.
Hover thumbnailShow the location’s thumbnail in the hover tooltip.
DeeplinkingEnable direct links to map states via URL query parameters — focus a location, activate a group filter, or (with wayfinding on) from/to/fixedfrom routes. See Deeplinking.
PaddingExtra space around the map within the container, in pixels.
Scroll topOffset in pixels for scrolling to the top when a location is focused in portrait mode — ideal for pages with a sticky header.

Zoom and pan

Zooming and panning are controlled by a single master toggle — turn it off for a static map. When enabled, the following options appear:

NameDescription
Max zoomThe map’s maximum zoom level; 1 is the fit scale, where the map fits the container.
Init areaThe area the map focuses on at startup. Defaults to the full map.
Reset buttonPosition of the reset button, or click the selected arrow again to disable it.
Zoom buttonsPosition of the +/− buttons, or click the selected arrow again to disable them.
MousewheelAllow zooming with the mouse wheel. On by default.
Shift keyRequire holding Shift to zoom with the mouse wheel — prevents the map from hijacking the page’s scroll.
Close resetReset the zoom level when a location is unfocused.

Breakpoints

Breakpoints make the map responsive by applying different layout settings at different sizes — directory placement, sidebar width, list vs. grid, column count, and height. They are managed in the Settings panel.

⚠️
Breakpoints are measured against the width of the map component, not the screen or browser width. An embedded map in a narrow column can hit a small breakpoint even on a large screen.

Every map has a default all-screens breakpoint that supplies the base layout; its class cannot be renamed. Add more breakpoints for narrower widths.

Options

PropertyDescription
Class *Unique name, applied as a CSS class for custom styling.
BelowUpper width bound in pixels. Together with the next-lower breakpoint it defines the range these settings apply to.
PortraitPlace the directory below the map instead of in a side sidebar — ideal for narrow screens.
SidebarWidth of the directory sidebar in pixels. Used when Portrait is off.
TypeDirectory layout: list or grid.
ColumnNumber of directory columns (default 1).
ContainerFixed map container height in pixels. Auto by default.
ElementTotal map element height (container plus directory). Useful in portrait mode when a long directory needs to scroll.
* Required fields

Example

A typical setup uses one extra breakpoint for small screens:

  • all-screens — sidebar directory, list layout, 320px sidebar.
  • below 768px — portrait mode on, grid layout, 2 columns.

The narrower the map gets, the lower the breakpoint whose settings take effect.

See the Breakpoint schema and the Responsivity settings, and the Directory guide for the layout options these settings drive.

Last updated on