Skip to content

Commit 17e523a

Browse files
authored
Document title options for energy graphs (#42501)
1 parent ce70692 commit 17e523a

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

source/_dashboards/energy.markdown

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,26 @@ type: energy-date-selection
4040
The energy usage graph card shows the amount of energy your house has consumed, and from what source this energy came.
4141
It will also show the amount of energy your have returned to the grid.
4242
43+
### YAML configuration
44+
45+
The following YAML options are available
46+
47+
{% configuration %}
48+
type:
49+
required: true
50+
description: "`energy-usage-graph`"
51+
type: string
52+
collection_key:
53+
required: false
54+
description: "Collection key to use for the card. This links the card to a specific energy dashboard collection. Defaults to `energy_dashboard`."
55+
type: string
56+
default: energy_dashboard
57+
title:
58+
required: false
59+
description: When defined, shows a card header with the title string and total energy consumed chip.
60+
type: string
61+
{% endconfiguration %}
62+
4363
### Example
4464

4565
```yaml
@@ -55,6 +75,26 @@ type: energy-usage-graph
5575

5676
The solar production graph card shows the amount of energy your solar panels have produced per source, and if setup and available the forecast of the solar production.
5777

78+
### YAML configuration
79+
80+
The following YAML options are available
81+
82+
{% configuration %}
83+
type:
84+
required: true
85+
description: "`energy-solar-graph`"
86+
type: string
87+
collection_key:
88+
required: false
89+
description: "Collection key to use for the card. This links the card to a specific energy dashboard collection. Defaults to `energy_dashboard`."
90+
type: string
91+
default: energy_dashboard
92+
title:
93+
required: false
94+
description: When defined, shows a card header with the title string and total solar produced chip.
95+
type: string
96+
{% endconfiguration %}
97+
5898
### Example
5999

60100
```yaml
@@ -70,6 +110,22 @@ type: energy-solar-graph
70110

71111
The gas consumption graph card shows the amount of gas consumed per source.
72112

113+
{% configuration %}
114+
type:
115+
required: true
116+
description: "`energy-gas-graph`"
117+
type: string
118+
collection_key:
119+
required: false
120+
description: "Collection key to use for the card. This links the card to a specific energy dashboard collection. Defaults to `energy_dashboard`."
121+
type: string
122+
default: energy_dashboard
123+
title:
124+
required: false
125+
description: When defined, shows a card header with the title string and total gas consumed chip.
126+
type: string
127+
{% endconfiguration %}
128+
73129
### Example
74130

75131
```yaml
@@ -85,6 +141,26 @@ type: energy-gas-graph
85141

86142
The water consumption graph card shows the amount of water consumed per source.
87143

144+
### YAML configuration
145+
146+
The following YAML options are available
147+
148+
{% configuration %}
149+
type:
150+
required: true
151+
description: "`energy-water-graph`"
152+
type: string
153+
collection_key:
154+
required: false
155+
description: "Collection key to use for the card. This links the card to a specific energy dashboard collection. Defaults to `energy_dashboard`."
156+
type: string
157+
default: energy_dashboard
158+
title:
159+
required: false
160+
description: When defined, shows a card header with the title string and total water consumed chip.
161+
type: string
162+
{% endconfiguration %}
163+
88164
### Example
89165

90166
```yaml

0 commit comments

Comments
 (0)