Option Index

Option Index

Find any YAML option alphabetically. Each option links directly to its row in the matching configuration reference.

A · B · C · D · E · F · G · H · I · L · M · N · O · P · R · S · T · U · V · W · X · Y · Z

A

Option	Scope	Section	Type	Default
aggregate_func	Entity	Basic	string	"avg"
align_header	General Settings	Card	string	"default"
align_state	Entity	State Row	string	"left"
animate_graph	General Settings	Chart	boolean	false
annotations	General Settings	Overlay	list	[]
attribute	Entity	Basic	string	null
attribute_list_position	General Settings	Overlay	string	"left"
auto_hide	Entity	General	boolean	false
auto_hide_entities	General Settings	Chart	boolean	false
auto_scale_points	General Settings	Chart	boolean	false
auto_scale_rules	General Settings	Chart	list	null

B

Option	Scope	Section	Type	Default
bar_spacing	General Settings	Chart	number	4
battery_entity	General Settings	Overlay	string	null
battery_low_threshold	General Settings	Overlay	string/number	20
break_on_null	Entity	Graph	boolean	false

C

Option	Scope	Section	Type	Default
card_background_blur	General Settings	Card	number	null
card_background_color	General Settings	Card	color	null
card_background_image	General Settings	Card	string	null
card_border	General Settings	Card	boolean	true
card_border_color	General Settings	Card	color	null
card_border_radius	General Settings	Card	string/number	null
card_border_width	General Settings	Card	string/number	null
card_header	General Settings	Card	string	""
card_header_color	General Settings	Card	color	null
card_header_letter_spacing	General Settings	Card	string/number	null
card_header_size	General Settings	Card	string	null
card_header_weight	General Settings	Card	string/number	null
card_icon	General Settings	Card	string	null
card_icon_color	General Settings	Card	string	null
card_icon_image	General Settings	Card	string	null
card_icon_position	General Settings	Card	string	"left"
card_icon_size	General Settings	Card	string	null
card_padding	General Settings	Card	string/number	null
card_shadow	General Settings	Card	boolean	true
carry_forward_ms	Entity	Graph	number	null
change_ignore_zero	Entity	Basic	boolean	false
chart_align	General Settings	Card	string	"center"
chart_mode	General Settings	Chart	string	"timeline"
color	Entity	Colors	string	"#ff4757"
color_thresholds	Entity	Colors	object	null
compare	Entity	Graph	string/number/object/list	null

D

Option	Scope	Section	Type	Default
damp_reset_boundary	Entity	Basic	boolean	true
data_attribute	Entity	Advanced	string	null
data_labels_font_size	Entity	Graph	number	null
data_time_field	Entity	Advanced	string	"start_time"
data_time_unit	Entity	Advanced	string	"iso"
data_time_year	Entity	Advanced	number	null
drill_down	General Settings	Overlay	boolean	false
data_value_expression	Entity	Advanced	string	null
data_value_field	Entity	Advanced	string	"price_per_kwh"
data_vars	Entity	Advanced	map	null
date_picker_default_mode	General Settings	Calendar	string	null
date_picker_group	General Settings	Calendar	string	null
date_picker_modes	General Settings	Calendar	list	null
date_picker_nav_position	General Settings	Calendar	string	"left"
date_picker_position	General Settings	Calendar	string	top
date_picker_shortcuts_position	General Settings	Calendar	string	"right"
date_picker_step	General Settings	Calendar	number	1
datetime_format	Entity	Advanced	string	"system"
datetime_format	General Settings	X Axis	string	"system"
decimals	Entity	Basic	number	1
duration_unit	General Settings	Y Axis	string	"s"

E

Option	Scope	Section	Type	Default
enabled	Entity	General	boolean	true
energy_date_sync	General Settings	Overlay	boolean	false
entity	Entity	General	string	required
extended_window_multiplier	General Settings	Chart	number	null
extrema_bg_color	Entity	Graph	string	null
extrema_bg_opacity	Entity	Graph	number	1
extrema_color	Entity	Graph	string	null
extrema_font_size	Entity	Graph	number	13
extrema_show_timestamp	Entity	Graph	boolean	true

F

Option	Scope	Section	Type	Default
fixed_value	Entity	Advanced	boolean	false
forecast_horizon	Entity	Advanced	number	null

G

Option	Scope	Section	Type	Default
gauge_columns	General Settings	Chart	number	null
gauge_show_minmax	General Settings	Chart	boolean	false
gauge_span	General Settings	Chart	number	270
gauge_value_position	General Settings	Chart	string	"below"
gauge_value_size	General Settings	Chart	number	null
gradient	Entity	Colors	boolean	true
graph_end_hour	General Settings	Calendar	number / entity	null
graph_start	General Settings	Calendar	string	null
graph_start_hour	General Settings	Calendar	number / entity	null
graph_type	Entity	Graph	string	"line"
group_by	General Settings	Chart	string	"interval"
group_by_picker_group	General Settings	Overlay	string	null
group_by_picker_position	General Settings	Overlay	string	"left"

H

Option	Scope	Section	Type	Default
height	General Settings	Card	number / auto	150
hide_name	Entity	State Row	boolean	false
histogram_bins	General Settings	Chart	number	auto
hours_to_show	General Settings	Chart	number	24

I

Option	Scope	Section	Type	Default
icon	Entity	General	string	null
icon_color	Entity	Colors	string	null
icon_size	Entity	State Row	string	null
include_area_names	General Settings	Chart	boolean	false
include_attribute_name	General Settings	Chart	boolean	false
interval_options	General Settings	Overlay	list	null
interval_picker_group	General Settings	Overlay	string	null
interval_picker_position	General Settings	Overlay	string	"left"
invert	Entity	Advanced	boolean	false

L

Option	Scope	Section	Type	Default
legend_position	General Settings	Chart	string	"center"
legend_stats	Entity	State Row	list	["min","avg","max"]
line_style	Entity	Graph	string	solid
line_width	Entity	Graph	number	2.5
logarithmic	General Settings	Y Axis	boolean	false
lower_bound	Entity	Graph	string/number	null
lower_bound	General Settings	Y Axis	string/number	null
lower_bound_secondary	General Settings	Y Axis	string/number	null

M

Option	Scope	Section	Type	Default
max_visible_interval	General Settings	Chart	number	null
min_bound_range	General Settings	Y Axis	number	null
min_bound_range_secondary	General Settings	Y Axis	number	null
moving_averages	Entity	Graph	list	null

N

Option	Scope	Section	Type	Default
name	Entity	General	string	null
name_position	Entity	State Row	string	null
name_size	Entity	State Row	string	null
needle_color	Entity	Colors	string	null
now_line_color	General Settings	X Axis	string	null
now_line_opacity	General Settings	X Axis	number	null
now_line_style	General Settings	X Axis	string	null
now_line_width	General Settings	X Axis	number	null
number_format	Entity	Basic	string	"system"

O

Option	Scope	Section	Type	Default
offset	Entity	Advanced	string/number	0

P

Option	Scope	Section	Type	Default
period_highlight	General Settings	Chart	boolean	false
period_highlight_color	General Settings	Chart	string	null
pie_3d	General Settings	Chart	boolean	false
pie_center_color	General Settings	Chart	string	null
pie_center_font_size	General Settings	Chart	number	null
pie_label_color	General Settings	Chart	string	null
pie_label_font_size	General Settings	Chart	number	null
pie_label_format	General Settings	Chart	string	"value"
pie_spacing	General Settings	Chart	number	0
pie_style	General Settings	Chart	string	"donut"
point_colors	Entity	Colors	string	null
point_size	Entity	Graph	number	auto
points_per_hour	Entity	Basic	number	null
points_per_hour	General Settings	Chart	number	2
pph_picker_group	General Settings	Overlay	string	null
pph_picker_position	General Settings	Overlay	string	"left"
price_attribute	Entity	Advanced	string	null
price_entity	Entity	Advanced	string	null
primary_state_as	Entity	State Row	string	null

R

Option	Scope	Section	Type	Default
ranking_min_value	General Settings	Chart	number	null
ref_attribute	Entity	Advanced	string	null
ref_entity	Entity	Advanced	string	null
ref_op	Entity	Advanced	string	"subtract"
rise_fall_colors	Entity	Colors	object	null

S

Option	Scope	Section	Type	Default
scroll_mode	General Settings	Chart	string	"scrollbar"
scroll_sync	General Settings	Overlay	boolean	false
scroll_sync_group	General Settings	Overlay	string	null
show_attribute_list	General Settings	Overlay	boolean	false
show_average	Entity	Graph	boolean	false
show_color_dot	Entity	State Row	boolean	true
show_data_labels	Entity	Graph	boolean	false
show_date_picker	General Settings	Calendar	boolean	false
show_export	General Settings	Chart	boolean	false
show_extrema	Entity	Graph	string	"click"
show_extrema_max	Entity	Graph	boolean	true
show_extrema_min	Entity	Graph	boolean	true
show_fill	Entity	Graph	boolean	true
show_full_period	General Settings	Calendar	boolean	false
show_graph	Entity	Graph	boolean	true
show_grid	General Settings	Chart	boolean	true
show_group_by_picker	General Settings	Overlay	boolean	false
show_in_legend	Entity	State Row	boolean	false
show_interval_picker	General Settings	Overlay	boolean	false
show_legend	General Settings	Chart	boolean	false
show_line	Entity	Graph	boolean	true
show_now_line	General Settings	X Axis	boolean	true
show_points	Entity	Graph	boolean	false
show_pph_picker	General Settings	Overlay	boolean	false
show_range_band	Entity	Graph	boolean	false
show_range_values	Entity	State Row	boolean	false
show_second_state_as	Entity	State Row	string	null
show_state	Entity	State Row	string/boolean	true
show_state_last	Entity	State Row	boolean	false
show_timestamp	Entity	State Row	boolean	false
show_tooltip	General Settings	Overlay	boolean	true
show_tooltip_total	General Settings	Overlay	boolean	true
show_trend_icon	Entity	State Row	boolean	true
show_x_axis	General Settings	X Axis	boolean	true
show_x_ticks	General Settings	X Axis	boolean	false
show_y_axis	General Settings	Y Axis	boolean	true
show_y_axis_label	General Settings	Y Axis	boolean	false
show_y_ticks	General Settings	Y Axis	boolean	false
show_y2_axis	General Settings	Y Axis	boolean	false
smooth	Entity	Graph	boolean	true
sparkline	General Settings	Chart	boolean	false
stack_group	Entity	Graph	string	null
stacked	General Settings	Chart	boolean	false
state_adaptive_color	Entity	Colors	boolean	false
state_color	Entity	Colors	string	null
state_layout	General Settings	Card	string	"default"
state_map	Entity	Advanced	list	null
state_size	Entity	State Row	string	null
state_timeline_corner_radius	General Settings	Chart	number	3
state_timeline_label_font_size	General Settings	Chart	number	10 / 11
state_timeline_show_labels	General Settings	Chart	boolean	true
statistic_id	Entity	General	string	null

T

Option	Scope	Section	Type	Default
tap_action	Entity	General	object	null
tooltip_match_axis	General Settings	Overlay	boolean	false
tooltip_name	Entity	General	string	null
tooltip_order	General Settings	Overlay	string	"default"
tooltip_stacked_total	General Settings	Overlay	boolean	true
tooltip_sync	General Settings	Overlay	boolean	false
tooltip_sync_group	General Settings	Overlay	string	null
trend_icon_size	Entity	State Row	string	null
trend_period_hours	Entity	State Row	number	1

U

Option	Scope	Section	Type	Default
unit	Entity	General	string	null
update_interval	General Settings	Chart	number	null
upper_bound	Entity	Graph	string/number	null
upper_bound	General Settings	Y Axis	string/number	null
upper_bound_secondary	General Settings	Y Axis	string/number	null
use_only_attribute_name	General Settings	Chart	boolean	false

V

Option	Scope	Section	Type	Default
value_factor	Entity	Advanced	number	0
value_transform	Entity	Advanced	string	null

W

Option	Scope	Section	Type	Default
waterfall_total	General Settings	Chart	boolean	true

X

Option	Scope	Section	Type	Default
x_axis_color	General Settings	X Axis	string	null
x_axis_date_color	General Settings	X Axis	string	null
x_axis_font_opacity	General Settings	X Axis	number	null
x_axis_font_size	General Settings	X Axis	number	null
x_axis_interval	General Settings	X Axis	string	null
x_grid_color	General Settings	X Axis	string	null
x_grid_opacity	General Settings	X Axis	number	0.15
x_grid_style	General Settings	X Axis	string	"dashed"
x_grid_width	General Settings	X Axis	number	1

Y

Option	Scope	Section	Type	Default
y_axis	Entity	Basic	string	"primary"
y_axis_color	General Settings	Y Axis	string	null
y_axis_decimals	General Settings	Y Axis	number	null
y_axis_font_opacity	General Settings	Y Axis	number	null
y_axis_font_size	General Settings	Y Axis	number	null
y_axis_format	General Settings	Y Axis	string	null
y_axis_label	General Settings	Y Axis	string	null
y_axis_number_format	General Settings	Y Axis	string	"system"
y_axis_round_ticks	General Settings	Y Axis	boolean	true
y_axis_ticks	General Settings	Y Axis	number	4
y_grid_color	General Settings	Y Axis	string	null
y_grid_opacity	General Settings	Y Axis	number	0.15
y_grid_style	General Settings	Y Axis	string	"dashed"
y_grid_width	General Settings	Y Axis	number	1
y2_axis_format	General Settings	Y Axis	string	null
y2_axis_label	General Settings	Y Axis	string	null

Z

Option	Scope	Section	Type	Default
z_index	Entity	Graph	number	0
zoom_sync	General Settings	Overlay	boolean	false
zoom_sync_group	General Settings	Overlay	string	null

---

Related pages

• Configuration overview
• General Settings
• Entity Settings
• Troubleshooting and FAQ
• ↑ Back to top