Class: Ecoportal::API::V2::Page::Component::GaugeStop

Inherits:
Common::Content::DoubleModel show all
Defined in:
lib/ecoportal/api/v2/page/component/gauge_stop.rb

Constant Summary

Constants inherited from Common::Content::DoubleModel

Common::Content::DoubleModel::NOT_USED

Constants included from Common::Content::ClassHelpers

Common::Content::ClassHelpers::NOT_USED

Instance Attribute Summary

Attributes inherited from Common::Content::DoubleModel

#_key, #_parent, #_read_only

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Common::Content::DoubleModel

#_doc_key, #as_json, #as_update, #consolidate!, #dirty?, #doc, embeds_many, embeds_one, enforce!, #initialize, #key, #key=, key?, new_uuid, #original_doc, pass_reader, pass_writer, passarray, passboolean, passdate, passforced, passkey, passthrough, #print_pretty, read_only!, read_only?, #read_only?, #replace_doc, #reset!, #resolved_doc_key, #root, #to_json

Methods included from Common::Content::ClassHelpers

#inheritable_attrs, #inheritable_class_vars, #inherited, #instance_variable_name, #new_class, #resolve_class, #to_constant, #to_time, #uid, #used_param?

Constructor Details

This class inherits a constructor from Ecoportal::API::Common::Content::DoubleModel

Class Method Details

.new_doc ⇒ Object 



9
10
11
12
13
14
15
 
# File 'lib/ecoportal/api/v2/page/component/gauge_stop.rb', line 9

def new_doc
  {
    "id"         => new_uuid,
    "threshold"  => nil,
    "color"      => nil
  }
end

Instance Method Details

#color=(value) ⇒ Object

Note:

These are the available colors:

  • :blue, :blue_greyed, :blue_light
  • :turquoise, :jade, :green, :pistachio, :avocado
  • :yellow, :orange, :pumpkin, :red, :magenta, :fuchsia, :purple, :violet

Assign the color to the stop.

Parameters:

  • value (String, Symbol) —

    you can use a symbol to specify a color



28
29
30
31
 
# File 'lib/ecoportal/api/v2/page/component/gauge_stop.rb', line 28

def color=(value)
  value  = to_color(value) if value.is_a?(Symbol)
  doc["color"] = value
end

#color_sym ⇒ Symbol

Returns to get the color sym code.

Returns:

  • (Symbol) —

    to get the color sym code



34
35
36
37
38
39
 
# File 'lib/ecoportal/api/v2/page/component/gauge_stop.rb', line 34

def color_sym
  color_maps.each do |k, v|
    return k if color == v
  end
  :undefined
end