Class: OMF::Web::Widget::DataWidget

Inherits:
AbstractWidget show all
Defined in:
lib/omf-web/widget/data_widget.rb

Overview

Supports widgets which visualize the content of a Table which may also dynamically change.

Instance Attribute Summary collapse

Attributes inherited from AbstractWidget

#widget_id, #widget_type

Instance Method Summary collapse

Methods inherited from AbstractWidget

#layout?, #mime_type, #title, #tools_menu, #widget_info

Constructor Details

#initialize(opts = {}) ⇒ DataWidget

opts

:data_sources .. Either a single table, or a hash of 'name' => table.
:js_class .. Javascript class used for visualizing data
:wopts .. options sent to the javascript instance
:js_url .. URL where +jsVizClass+ can be loaded from
:dynamic .. update the widget when the data_table is changing
  :updateInterval .. if web sockets aren't used, check every :updateInterval sec [3]



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/omf-web/widget/data_widget.rb', line 23

def initialize(opts = {})
  opts = opts.dup # not sure why we may need to this. Is this hash used anywhere wlse?
  unless vizType = opts[:type].split('/')[-1]
    raise "Missing widget option ':viz_type' for widget '#{name}' (#{opts.inspect})"
  end
  name = opts[:name] ||= 'Unknown'
  opts[:js_module] = "graph/#{vizType}"
  opts[:js_url] = "graph/js/#{vizType}.js"
  opts[:js_class] = "OML.#{vizType}"
  opts[:base_el] = "\##{dom_id}"
  super opts

  if (ds = opts.delete(:data_source))
    # single source
    #data_sources = {:default => ds}
    data_sources = [ds]
  end
  unless data_sources ||= opts.delete(:data_sources)
    raise "Missing option ':data_sources' for widget '#{name}'"
  end
  if data_sources.kind_of? Hash
    # turn into array an set stream
    data_sources = data_sources.map do |sname, ds_descr|
      ds_descr[:stream] ||= sname
    end
  end
  unless data_sources.kind_of? Array
    #data_sources = {:default => data_sources}
    raise "Unexpected ':data_sources' for widget '#{name}' - #{data_sources}"
  end
  i = 0
  opts[:data_sources] = data_sources.map do |ds_descr|
    unless ds_descr.is_a? Hash
      ds_descr = {:name => ds_descr}
    end
    ds_descr[:alias] = "#{name}_#{self.object_id}_#{i += 1}"
    #{:stream => ds_descr, :name => name}
    unless OMF::Web::DataSourceProxy.validate_ds_description(ds_descr)
      raise "Unknown data source requested for data widget - #{ds_descr}"
    end
    ds_descr
  end
  #puts "DTA_WIDGTE>>> #{opts[:data_sources].inspect}"
end

Instance Attribute Details

#name ⇒ Object (readonly)

depends_on :css, “/resource/css/graph.css”



12
13
14
 
# File 'lib/omf-web/widget/data_widget.rb', line 12

def name
  @name
end

#opts ⇒ Object (readonly)

depends_on :css, “/resource/css/graph.css”



12
13
14
 
# File 'lib/omf-web/widget/data_widget.rb', line 12

def opts
  @opts
end

Instance Method Details

#collect_data_sources(ds_set) ⇒ Object 



81
82
83
84
85
86
87
 
# File 'lib/omf-web/widget/data_widget.rb', line 81

def collect_data_sources(ds_set)
  @opts[:data_sources].each do |ds|
    #ds_set.add(ds[:id] || ds[:name] || ds[:stream])
    ds_set.add(ds)
  end
  ds_set
end

#content ⇒ Object 



76
77
78
79
 
# File 'lib/omf-web/widget/data_widget.rb', line 76

def content()
  OMF::Web::Theme.require 'data_renderer'
  OMF::Web::Theme::DataRenderer.new(self, @opts)
end

#dom_id ⇒ Object

This is the DOM id which should be used by the renderer for this widget. We need to keep this here as various renderes at various levels may need to get a reference to it to allow for such functionalities as hiding, stacking, …



72
73
74
 
# File 'lib/omf-web/widget/data_widget.rb', line 72

def dom_id
  "w#{object_id.abs}"
end