Map

class foxglove.layouts.MapPanel

Display points on a map.

For more information, see [the documentation](https://docs.foxglove.dev/docs/visualization/panels/map).

config: MapConfig

title: str | None = None

The title of the panel.

class foxglove.layouts.MapConfig

Configuration for the Map panel.

custom_tile_url: str | None = None

URL to your custom map tiles following the Tile Map Service specs, e.g. https://my.custom.url/{x}/{y}/{z}.png

disabled_topics: list[str] | None = None

Topics to disable from being displayed on the map

follow_frame: str | None = None

The location fix to follow

follow_topic: str | None = None

Topic to follow in the panel viewport

layer: Optional[Literal['map', 'satellite', 'custom', 'shaded-relief']] = None

Type of map to display

layers: list[MapLayerConfig] | None = None

Additional layers displayed on top of the base map layer

max_native_zoom: float | None = None

Highest zoom supported by the custom map source

topic_colors: dict[str, str] | None = None

Colors for topics on the map

topic_config: dict[str, MapTopicSettings] | None = None

Configuration for topics on the map

zoom_level: float | None = None

Zoom level of the map

class foxglove.layouts.MapLayerConfig

Configuration for a map layer displayed on top of the base map.

custom_tile_url: str | None = None

URL to custom map tiles when type is ‘custom’, following Tile Map Service specs

enabled: bool | None = True

Whether this layer is visible

opacity: float | None = 1

Opacity of the layer (0 to 1)

type: Literal['street', 'satellite', 'custom', 'shaded-relief', 'seamark', 'isobaths']

Type of map layer to display.

class foxglove.layouts.MapTopicSettings

Settings for a topic displayed on the map.

history_mode: Optional[Literal['all', 'none', 'previous']] = None

Which messages to display when history (or future data via preloading) is available.

point_display_mode: Optional[Literal['dot', 'pin']] = None

Configure GPS location display

point_size: float | None = None

Sets the diameter of points rendered on the map for this topic, in pixels

time_window_seconds: float | None = None

Time window in seconds for ‘previous’ mode sliding window. When left blank, shows all data from the beginning up to current playback time. When set, shows only the last N seconds of data.