openHAB

Class: OpenHAB::DSL::Sitemaps::ChartBuilder

Inherits:
WidgetBuilder show all
Defined in:
lib/openhab/dsl/sitemaps/builder.rb

Overview

Builds a Chart element See https://www.openhab.org/docs/ui/sitemaps.html#element-type-chart

See Also:

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

Attributes inherited from WidgetBuilder

#icon, #icon_colors, #item, #label, #label_colors, #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

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).

Returns:

  • (true, false, nil) 


402
403
404
 
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 402

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.

Returns:

  • (true, false, nil) 


398
399
400
 
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 398

def legend=(value)
  @legend = value
end

#period ⇒ :h, ...

Time axis scale

Returns:

  • (:h, :"4h", :"8h", :"12h", :D, :"2D", :"3D", :W, :"2W", :M, :"2M", :"4M", :Y, nil) 


394
395
396
 
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 394

def period
  @period
end

#refresh ⇒ Numeric?

How often to refresh the chart (in seconds)

Returns:



391
392
393
 
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 391

def refresh
  @refresh
end

#service ⇒ String?

The persistence service to use

Returns:

  • (String, nil) 


388
389
390
 
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 388

def service
  @service
end

#y_axis_pattern ⇒ String?

Formatting string for values on the y axis.

Examples:

"#.##" # => formats a number with two decimals.

Returns:

  • (String, nil)

See Also:



408
409
410
 
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 408

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).

Returns:

  • (true, false, nil) 


456
457
458
 
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 456

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.

Returns:

  • (true, false, nil) 


451
452
453
 
# File 'lib/openhab/dsl/sitemaps/builder.rb', line 451

def legend?
  @legend
end