Class: OpenHAB::DSL::Sitemaps::LinkableWidgetBuilder

Inherits:

WidgetBuilder

• Object
• WidgetBuilder
• OpenHAB::DSL::Sitemaps::LinkableWidgetBuilder

Defined in:

lib/openhab/dsl/sitemaps/builder.rb

Overview

Parent class for builders of widgets that can contain other widgets.

See Also:

• orgorg.openhaborg.openhab.coreorg.openhab.core.modelorg.openhab.core.model.sitemaporg.openhab.core.model.sitemap.sitemaporg.openhab.core.model.sitemap.sitemap.LinkableWidget

Direct Known Subclasses

ButtongridBuilder, FrameBuilder, GroupBuilder, ImageBuilder, SitemapBuilder, TextBuilder

Instance Attribute Summary

Attributes inherited from WidgetBuilder

#icon, #icon_colors, #item, #label, #label_colors, #static_icon, #value_colors, #visibilities

Instance Method Summary

• #buttongrid(item: nil, label: nil, icon: nil, static_icon: nil, buttons: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ ButtongridBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Buttongrid element.

• #chart(item: nil, label: nil, icon: nil, static_icon: nil, service: nil, refresh: nil, period: nil, legend: nil, group: nil, y_axis_pattern: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ ChartBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Chart element.

• #colorpicker(item: nil, label: nil, icon: nil, static_icon: nil, frequency: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ ColorpickerBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Colorpicker element.

• #colortemperaturepicker(item: nil, label: nil, icon: nil, static_icon: nil, range: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ ColortemperaturepickerBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Colortemperaturepicker element.

• #default(item: nil, label: nil, icon: nil, static_icon: nil, height: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ DefaultBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Default element.

• #frame(item: nil, label: nil, icon: nil, static_icon: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ FrameBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Frame element.

• #group(item: nil, label: nil, icon: nil, static_icon: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ GroupBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Group element.

• #image(item: nil, label: nil, icon: nil, static_icon: nil, url: nil, refresh: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ ImageBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Image element.

• #input(item: nil, label: nil, icon: nil, static_icon: nil, hint: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ InputBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Input element.

• #mapview(item: nil, label: nil, icon: nil, static_icon: nil, height: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ MapviewBuilder

  Create a new Mapview element.

• #selection(item: nil, label: nil, icon: nil, static_icon: nil, mappings: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ SelectionBuilder

  Create a new Selection element.

• #setpoint(item: nil, label: nil, icon: nil, static_icon: nil, range: nil, step: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ SetpointBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Setpoint element.

• #slider(item: nil, label: nil, icon: nil, static_icon: nil, range: nil, step: nil, switch: nil, frequency: nil, release_only: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ SliderBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Slider element.

• #switch(item: nil, label: nil, icon: nil, static_icon: nil, mappings: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ SwitchBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Switch element.

• #text(item: nil, label: nil, icon: nil, static_icon: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ TextBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Text element.

• #video(item: nil, label: nil, icon: nil, static_icon: nil, url: nil, encoding: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ VideoBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Video element.

• #webview(item: nil, label: nil, icon: nil, static_icon: nil, url: nil, height: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ WebviewBuilder

  One or more visibility rules (see WidgetBuilder#visibility) Create a new Webview element.

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 Method Details

#buttongrid(item: nil, label: nil, icon: nil, static_icon: nil, buttons: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ ButtongridBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Buttongrid element.

Examples:

Create a buttongrid with buttons as an argument

# This creates a buttongrid to emulate a TV remote control
sitemaps.build do
  sitemap "remote", label: "TV Remote Control" do
    buttongrid item: LivingRoom_TV_RCButton, buttons: [
      [1, 1, "BACK", "Back", "f7:return"],
      [1, 2, "HOME", "Menu", "material:apps"],
      [1, 3, "YELLOW", "Search", "f7:search"],
      [2, 2, "UP", "Up", "f7:arrowtriangle_up"],
      [4, 2, "DOWN", "Down", "f7:arrowtriangle_down"],
      [3, 1, "LEFT", "Left", "f7:arrowtriangle_left"],
      [3, 3, "RIGHT", "Right", "f7:arrowtriangle_right"],

      # Using keyword arguments:
      {row: 3, column: 2, click: "ENTER", label: "Enter", icon: "material:adjust" }
    ]
  end
end

Create a buttongrid with button widgets

sitemaps.build do
  sitemap "remote", label: "TV Remote Control" do
    buttongrid item: LivingRoom_TV_RCButton do
      button 1, 1, click: "BACK", icon: "f7:return"
      button 1, 2, click: "HOME", icon: "material:apps"
      button 1, 3, click: "YELLOW", icon: "f7:search"
      button 2, 2, click: "UP", icon: "f7:arrowtriangle_up"
      button 4, 2, click: "DOWN", icon: "f7:arrowtriangle_down"
      button 3, 1, click: "LEFT", icon: "f7:arrowtriangle_left"
      button 3, 3, click: "RIGHT", icon: "f7:arrowtriangle_right"
      button 3, 2, click: "ENTER", icon: "material:adjust"
    end

    # The following buttons use widget features introduced in openHAB 4.2+
    buttongrid item: LivingRoom_Curtain do
      button 1, 1, click: "up", release: "stop", icon: "f7:arrowtriangle_up"
      button 2, 1, click: "down", release: "stop", icon: "f7:arrowtriangle_up"
    end
  end
end

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)
• buttons (Array<Array<int, int, Command, String, String>>) (defaults to: nil) —

  An array of buttons to display. Each element can be a hash with keyword arguments (see ButtongridBuilder#button), or an array with the following elements:

  • row: 1-12
  • column: 1-12
  • click: The command to send when the button is pressed
  • label: The label to display on the button (optional)
  • icon: The icon to display on the button (optional)

Yields:

• Block executed in the context of an ButtongridBuilder

Returns:

• (ButtongridBuilder)

See Also:

• https://www.openhab.org/docs/ui/sitemaps.html#element-type-buttongrid

Since:

• openHAB 4.1

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#chart(item: nil, label: nil, icon: nil, static_icon: nil, service: nil, refresh: nil, period: nil, legend: nil, group: nil, y_axis_pattern: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ ChartBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Chart element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)
• service (String, nil) (defaults to: nil) —

  The persistence service to use (see ChartBuilder#service)

• refresh (Numeric, nil) (defaults to: nil) —

  ] How often to refresh the chart (in seconds) (see ChartBuilder#refresh)

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

  Time axis scale (see ChartBuilder#period)

• legend (true, false, nil) (defaults to: nil) —

  Always show the legend (see ChartBuilder#legend=)

• group (true, false, nil) (defaults to: nil) —

  Show the value of a group item, instead of its members (see ChartBuilder#group=)

• y_axis_pattern (String, nil) (defaults to: nil) —

  Formatting string for values on the y axis (see ChartBuilder#y_axis_pattern)

Yields:

• Block executed in the context of a ChartBuilder

Returns:

• (ChartBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#colorpicker(item: nil, label: nil, icon: nil, static_icon: nil, frequency: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ ColorpickerBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Colorpicker element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)
• frequency (Numeric, nil) (defaults to: nil) —

  How often to send requests (see ColorpickerBuilder#frequency)

Yields:

• Block executed in the context of a ColorpickerBuilder

Returns:

• (ColorpickerBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#colortemperaturepicker(item: nil, label: nil, icon: nil, static_icon: nil, range: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ ColortemperaturepickerBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Colortemperaturepicker element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)
• range (Range, nil) (defaults to: nil) —

  Allowed range of the value (see ColortemperaturepickerBuilder#range)

Yields:

• Block executed in the context of a ColortemperaturepickerBuilder

Returns:

• (ColortemperaturepickerBuilder)

Since:

• openHAB 4.3

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#default(item: nil, label: nil, icon: nil, static_icon: nil, height: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ DefaultBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Default element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)
• height (Integer) (defaults to: nil) —

  The number of element rows to fill (see DefaultBuilder#height)

Yields:

• Block executed in the context of a DefaultBuilder

Returns:

• (DefaultBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#frame(item: nil, label: nil, icon: nil, static_icon: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ FrameBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Frame element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)

Yields:

• Block executed in the context of a FrameBuilder

Returns:

• (FrameBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#group(item: nil, label: nil, icon: nil, static_icon: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ GroupBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Group element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)

Yields:

• Block executed in the context of a GroupBuilder

Returns:

• (GroupBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#image(item: nil, label: nil, icon: nil, static_icon: nil, url: nil, refresh: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ ImageBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Image element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)
• url (String, nil) (defaults to: nil) —

  The URL for the image (see ImageBuilder#url)

• refresh (Numeric, nil) (defaults to: nil) —

  How often to refresh the image (see ImageBuilder#refresh)

Yields:

• Block executed in the context of an ImageBuilder

Returns:

• (ImageBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#input(item: nil, label: nil, icon: nil, static_icon: nil, hint: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ InputBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Input element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)
• hint (:text, :number, :date, :time, :datetime, nil) (defaults to: nil) —

  Gives a hint to the user interface to use a widget adapted to a specific use (see InputBuilder#hint)

Yields:

• Block executed in the context of an InputBuilder

Returns:

• (InputBuilder)

Since:

• openHAB 4.0

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#mapview(item: nil, label: nil, icon: nil, static_icon: nil, height: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ MapviewBuilder

Create a new Mapview element.

Yields:

• Block executed in the context of a MapviewBuilder

Returns:

• (MapviewBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#selection(item: nil, label: nil, icon: nil, static_icon: nil, mappings: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ SelectionBuilder

Create a new Selection element.

Yields:

• Block executed in the context of a SelectionBuilder

Returns:

• (SelectionBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#setpoint(item: nil, label: nil, icon: nil, static_icon: nil, range: nil, step: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ SetpointBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Setpoint element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)
• range (Range, nil) (defaults to: nil) —

  Allowed range of the value (see SetpointBuilder#range)

• step (Numeric, nil) (defaults to: nil) —

  How far the value will change with each button press (see SetpointBuilder#step)

Yields:

• Block executed in the context of a SetpointBuilder

Returns:

• (SetpointBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#slider(item: nil, label: nil, icon: nil, static_icon: nil, range: nil, step: nil, switch: nil, frequency: nil, release_only: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ SliderBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Slider element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)
• range (Range, nil) (defaults to: nil) —

  Allowed range of the value (see SetpointBuilder#range)

• step (Numeric, nil) (defaults to: nil) —

  How far the value will change with each button press (see SetpointBuilder#step)

• switch (true, false, nil) (defaults to: nil) —

  A short press on the item toggles the item on or off (see SliderBuilder#switch=)

• frequency (Numeric, nil) (defaults to: nil) —

  How often to send requests (in seconds) (see SliderBuilder#frequency)

• release_only (true, false, nil) (defaults to: nil) —

  Only send the command when the slider is released (see SliderBuilder#release_only=)

Yields:

• Block executed in the context of a SliderBuilder

Returns:

• (SliderBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#switch(item: nil, label: nil, icon: nil, static_icon: nil, mappings: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ SwitchBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Switch element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)
• mappings (Hash, Array, nil) (defaults to: nil) —

  Mappings from command to label (see SwitchBuilder#mappings)

Yields:

• Block executed in the context of a SwitchBuilder

Returns:

• (SwitchBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#text(item: nil, label: nil, icon: nil, static_icon: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ TextBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Text element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)

Yields:

• Block executed in the context of a TextBuilder

Returns:

• (TextBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#video(item: nil, label: nil, icon: nil, static_icon: nil, url: nil, encoding: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ VideoBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Video element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)
• url (String, nil) (defaults to: nil) —

  (see VideoBuilder#url)

• encoding (:mjpeg, :hls, nil) (defaults to: nil) —

  (see VideoBuilder#encoding)

Yields:

• Block executed in the context of a VideoBuilder

Returns:

• (VideoBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end

#webview(item: nil, label: nil, icon: nil, static_icon: nil, url: nil, height: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil) { ... } ⇒ WebviewBuilder

One or more visibility rules (see WidgetBuilder#visibility) Create a new Webview element.

Parameters:

• item (String, Core::Items::Item, nil) (defaults to: nil) —

  The item whose state to show (see WidgetBuilder#item)

• label (String, nil) (defaults to: nil) —

  (see WidgetBuilder#label)

• icon (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  (see WidgetBuilder#icon)

• static_icon (String, nil) (defaults to: nil) —

  (see WidgetBuilder#static_icon)

• label_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more label color rules (see WidgetBuilder#label_color)

• value_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more value color rules (see WidgetBuilder#value_color)

• icon_color (String, Hash<String, String>, Hash<Array<String>, String>, nil) (defaults to: nil) —

  One or more icon color rules (see WidgetBuilder#icon_color)

• visibility (String, Core::Types::State, Array<String>, Array<Core::Types::State>, Array<Array<String>>, nil) (defaults to: nil)
• height (Integer) (defaults to: nil) —

  The number of element rows to fill (see DefaultBuilder#height)

• url (String, nil) (defaults to: nil) —

  (see WebviewBuilder#url)

Yields:

• Block executed in the context of a WebviewBuilder

Returns:

• (WebviewBuilder)

# File 'lib/openhab/dsl/sitemaps/builder.rb', line 1129

%i[frame
   text
   group
   image
   video
   chart
   webview
   switch
   mapview
   slider
   selection
   input
   buttongrid
   setpoint
   colorpicker
   colortemperaturepicker
   default].each do |method|
  class_eval <<~RUBY, __FILE__, __LINE__ + 1
    def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
      widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
                                               @builder_proxy,     #                             @builder_proxy,
                                               *args,              #                             *args,
                                               **kwargs,           #                             **kwargs,
                                               &block)             #                             &block)
      children << widget                                           #   children << widget
      widget                                                       #   widget
    end                                                            # end
  RUBY
end