The map card that allows you to display entities on a map
Screenshot of the map card.
To add the map card to your user interface:
- In the top right of the screen, select the three dots menu and then select Edit dashboard.
- By editing the dashboard, you are taking over control of this dashboard. This means that it is no longer automatically updated when new dashboard elements become available. To continue, in the dialog, select Take control.
- In the bottom right corner, select the Add card button and select from the card picker.
All options for this card can be configured via the user interface.
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
List of entity IDs or
entity objects (see below). Either this or the
geo_location_sources configuration option is required.
List of geolocation sources. All current entities with that source will be displayed on the map. See Geolocation platform for valid sources. Set to
all to use all available sources. Either this or the
entities configuration option is required.
The map will follow moving
entities by adjusting the viewport of the map each time an entity is updated.
Whether the map should consider the zones in the list of specified entities when fitting its viewport.
Forces the height of the image to be a ratio of the width. Valid formats: Height percentage value (
23%) or ratio expressed with colon or “x” separator (
16x9). For a ratio, the second element can be omitted and will default to “1” (
The default zoom level of the map.
14 (or whatever zoom level is required to fit all visible markers)
default_zoom value will be ignored if it is set higher than the current zoom level
after fitting all visible entity markers in the map window. In other words, this can only
be used to zoom the map out by default.
If you define entities as objects instead of strings (by adding
entity: before entity ID), you can add more customization and configuration.
When set to
state, renders the entity’s state as the label for the map marker instead of the entity’s name. This option doesn’t apply to zone entities because they don’t use a label but an icon.
- entity: sensor.gas_station_gas_price