diff --git a/source/_dashboards/map.markdown b/source/_dashboards/map.markdown index 1608dd20535..890e9535a0f 100644 --- a/source/_dashboards/map.markdown +++ b/source/_dashboards/map.markdown @@ -27,7 +27,7 @@ type: type: string entities: required: true - description: List of entity IDs. Either this or the `geo_location_sources` configuration option is required. + description: List of entity IDs or `entity` objects (see below). Either this or the `geo_location_sources` configuration option is required. type: list geo_location_sources: required: true @@ -75,6 +75,31 @@ hours_to_show: +## Options For Entities + +If you define entities as objects instead of strings (by adding `entity:` before entity ID), you can add more customization and configuration. + +{% configuration %} +entity: + required: true + description: Entity ID. + type: string +name: + required: false + description: Replace the default label for the marker. + type: string +label_mode: + required: false + default: name + description: When set to `state`, renders the entity's state as the label for the map marker instead of the entity's name. + type: string +focus: + required: false + default: true + description: When set to `false`, this entity will not be considered for determining the default zoom or fit of the map. + type: boolean +{% endconfiguration %} + ## Examples ```yaml @@ -99,5 +124,8 @@ entities: type: map entities: - device_tracker.demo_paulus + - entity: sensor.gas_station_gas_price + label_mode: state + focus: false hours_to_show: 48 ```