Class: OpenHAB::DSL::Sitemaps::ChartBuilder
- Inherits:
-
WidgetBuilder
- Object
- WidgetBuilder
- OpenHAB::DSL::Sitemaps::ChartBuilder
- Defined in:
- lib/openhab/dsl/sitemaps/builder.rb
Overview
Builds a ‘Chart` element See www.openhab.org/docs/ui/sitemaps.html#element-type-chart
Constant Summary collapse
- VALID_PERIODS =
Valid #period values
%i[h 4h 8h 12h D 2D 3D W 2W M 2M 4M Y].freeze
Instance Attribute Summary collapse
-
#group ⇒ true, ...
writeonly
Show the value of a GroupItem instead of showing a graph for each member (which is the default).
-
#legend ⇒ true, ...
writeonly
Always show the legend, never show the legend, or automatically show the legend if there is more than one series in the chart.
-
#period ⇒ :h, ...
Time axis scale.
-
#refresh ⇒ Numeric?
How often to refresh the chart (in seconds).
-
#service ⇒ String?
The persistence service to use.
-
#y_axis_pattern ⇒ String?
Formatting string for values on the y axis.
Attributes inherited from WidgetBuilder
#icon, #icon_colors, #item, #label, #label_colors, #static_icon, #value_colors, #visibilities
Instance Method Summary collapse
-
#group? ⇒ true, ...
Show the value of a GroupItem instead of showing a graph for each member (which is the default).
-
#legend? ⇒ true, ...
Always show the legend, never show the legend, or automatically show the legend if there is more than one series in the chart.
Methods inherited from WidgetBuilder
#icon_color, #label_color, #value_color, #visibility
Methods included from Core::EntityLookup
#items, #method_missing, #things
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class OpenHAB::Core::EntityLookup
Instance Attribute Details
#group=(value) ⇒ true, ... (writeonly)
Show the value of a GroupItem instead of showing a graph for each member (which is the default).
544 545 546 |
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 544 def group=(value) @group = value end |
#legend=(value) ⇒ true, ... (writeonly)
Always show the legend, never show the legend, or automatically show the legend if there is more than one series in the chart.
540 541 542 |
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 540 def legend=(value) @legend = value end |
#period ⇒ :h, ...
Time axis scale
536 537 538 |
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 536 def period @period end |
#refresh ⇒ Numeric?
How often to refresh the chart (in seconds)
533 534 535 |
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 533 def refresh @refresh end |
#service ⇒ String?
The persistence service to use
530 531 532 |
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 530 def service @service end |
#y_axis_pattern ⇒ String?
Formatting string for values on the y axis.
550 551 552 |
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 550 def y_axis_pattern @y_axis_pattern end |
Instance Method Details
#group? ⇒ true, ...
Show the value of a GroupItem instead of showing a graph for each member (which is the default).
600 601 602 |
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 600 def group? @group end |
#legend? ⇒ true, ...
Always show the legend, never show the legend, or automatically show the legend if there is more than one series in the chart.
595 596 597 |
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 595 def legend? @legend end |