4.4 KiB
type, title, sidebar_label, description, related
| type | title | sidebar_label | description | related | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| card | Statistics graph card | Statistics graph | The statistics graph card allows you to display a graph with statistics data for each of the entities listed. |
|
The statistics graph card allows you to display a graph of statistics data for each of the entities listed.
Screenshot of the statistics graph card with none metered entities and `chart_type` `line`.
Screenshot of the statistics graph card with a metered entity and `chart_type` `bar`.
Statistics are gathered every 5 minutes and also hourly for sensors that support it. The 5-minute statistics will be retained for the duration set in the recorder configuration, and hourly statistics will be retained indefinitely. It will either keep the min, max, and mean of a sensor's value for a specific hour or the sum for a metered entity.
If your sensor doesn't work with statistics, check this.
{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
YAML configuration
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
required: true
description: statistics-graph
type: string
entities:
required: true
description: "A list of entity IDs or entity objects (see below), or an external statistic id"
type: list
days_to_show:
required: false
description: Days to show in graph. Minimum is 1 day.
type: integer
default: 30
chart_type:
required: false
description: If the graph should be rendered as a bar or a line chart.
type: string
stat_types:
required: false
description: The statistics types to render. min, max, mean, sum, state, change
type: list
title:
required: false
description: The card title.
type: string
period:
required: false
description: The period of the rendered graph. 5minute, hour, day, week or month. If energy_date_selection is true, and period is not defined, the chart period will auto-select between month/day/hour based on the selected date range.
type: string
hide_legend:
required: false
description: If true, the legend will be hidden.
type: boolean
default: false
logarithmic_scale:
required: false
description: If true, numerical values on the Y-axis will be displayed with a logarithmic scale.
type: boolean
default: false
min_y_axis:
required: false
description: Lower bound for the Y-axis range.
type: float
max_y_axis:
required: false
description: Upper bound for the Y-axis range.
type: float
fit_y_data:
required: false
description: If true, configured Y-axis bounds would automatically extend (but not shrink) to fit the data.
type: boolean
default: false
expand_legend:
required: false
description: If true, the legend will show all items initially
type: boolean
default: false
energy_date_selection:
required: false
description: If true, chart date range will follow the date selected on an energy-date-selection card on the same view, similar to energy cards.
type: boolean
default: false
collection_key:
required: false
description: If using energy_date_selection, you can set a custom key to match the optional key of an energy-date-selection card. This is not typically required, but can be useful if multiple date selection cards are used on the same view.
type: string
{% endconfiguration %}
Options for entities
If you define entities as objects instead of strings, you can add more customization and configuration:
{% configuration %} entity: required: true description: Entity ID. type: string name: required: false description: Overwrites friendly name. type: string {% endconfiguration %}
Example
type: statistics-graph
title: 'My Graph'
entities:
- sensor.outside_temperature
- entity: sensor.inside_temperature
name: Inside