mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-03 07:26:53 +00:00
94 lines
2.8 KiB
Markdown
94 lines
2.8 KiB
Markdown
---
|
|
type: card
|
|
title: "Map Card"
|
|
sidebar_label: Map
|
|
description: "The Map card that allows you to display entities on a map"
|
|
---
|
|
|
|
The Map card that allows you to display entities on a map
|
|
|
|
<p class='img'>
|
|
<img src='/images/lovelace/lovelace_map_card.png' alt='Screenshot of the map card'>
|
|
Screenshot of the map card.
|
|
</p>
|
|
|
|
To add the Map card to your user interface, click the Lovelace menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the "Add Card" button in the bottom right corner and select **Map** from the card picker. All options for this card can be configured via the user interface.
|
|
|
|
{% configuration %}
|
|
type:
|
|
required: true
|
|
description: "`map`"
|
|
type: string
|
|
entities:
|
|
required: true
|
|
description: List of entity IDs. Either this or the `geo_location_sources` configuration option is required.
|
|
type: list
|
|
geo_location_sources:
|
|
required: true
|
|
description: List of geolocation sources. All current entities with that source will be displayed on the map. See [Geolocation](/integrations/geo_location/) platform for valid sources. Set to `all` to use all available sources. Either this or the `entities` configuration option is required.
|
|
type: list
|
|
title:
|
|
required: false
|
|
description: The card title.
|
|
type: string
|
|
aspect_ratio:
|
|
required: false
|
|
description: '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 (`16:9` or `16x9`). For a ratio, the second element can be omitted and will default to "1" (`1.78` equals `1.78:1`).'
|
|
type: string
|
|
default_zoom:
|
|
required: false
|
|
description: The default zoom level of the map.
|
|
type: integer
|
|
default: 14 (or whatever zoom level is required to fit all visible markers)
|
|
dark_mode:
|
|
required: false
|
|
description: Enable a dark theme for the map.
|
|
type: boolean
|
|
default: false
|
|
hours_to_show:
|
|
required: false
|
|
description: Shows a path of previous locations. Hours to show as path on the map.
|
|
type: integer
|
|
default: 0
|
|
{% endconfiguration %}
|
|
|
|
<div class='note'>
|
|
Only entities that have latitude and longitude attributes will be displayed on the map.
|
|
</div>
|
|
|
|
<div class="note">
|
|
|
|
The `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.
|
|
|
|
</div>
|
|
|
|
## Examples
|
|
|
|
The card can also be configured using YAML, some examples below:
|
|
|
|
```yaml
|
|
type: map
|
|
aspect_ratio: 16:9
|
|
default_zoom: 8
|
|
entities:
|
|
- device_tracker.demo_paulus
|
|
- zone.home
|
|
```
|
|
|
|
```yaml
|
|
type: map
|
|
geo_location_sources:
|
|
- nsw_rural_fire_service_feed
|
|
entities:
|
|
- zone.home
|
|
```
|
|
|
|
```yaml
|
|
type: map
|
|
entities:
|
|
- device_tracker.demo_paulus
|
|
hours_to_show: 48
|
|
```
|