Merge pull request #92 from Prakriti-nith/highmap

Added HighMaps

lib/daru/view/adapters/highcharts.rb

@@ -29,8 +29,6 @@ module HighchartsAdapter
         # @param [Array/Daru::DataFrame/Daru::Vector] data
         #
         def init(data=[], options={})
-          data_new = guess_data(data)
-          # TODO : for multiple series need some modification
           # Alternate way is using `add_series` method.
           #
           # There are many options present in Highcharts so it is better to use
@@ -42,10 +40,18 @@ def init(data=[], options={})
             # all the options present in `options` and about the
             # series (means name, type, data) used in f.series(..)
             f.options = options.empty? ? LazyHighCharts::HighChart.new.defaults_options : options
-
-            series_type = options[:type] unless options[:type].nil?
-            series_name = options[:name] unless options[:name].nil?
-            f.series(type: series_type, name: series_name, data: data_new)
+            # For multiple series when data is in a series format as in
+            # HighCharts official examples
+            # TODO: Add support for multiple series when data as
+            #   Daru::DataFrame/Daru::Vector
+            if data.is_a?(Array) && data[0].is_a?(Hash)
+              f.series_data = data
+            else
+              data_new = guess_data(data)
+              series_type = options[:type] unless options[:type].nil?
+              series_name = options[:name] unless options[:name].nil?
+              f.series(type: series_type, name: series_name, data: data_new)
+            end
           end
           @chart
         end

lib/daru/view/adapters/highcharts/display.rb

@@ -1,10 +1,10 @@
 require_relative 'layout_helper_iruby'
 require_relative 'iruby_notebook'
+require 'daru/view/constants'
 
 module LazyHighCharts
   def self.init_script(
-    dependent_js=['highstock.js', 'highcharts-more.js', 'modules/exporting.js',
-                  'highcharts-3d.js', 'modules/data.js']
+    dependent_js=HIGHCHARTS_DEPENDENCIES
   )
     # Highstock is based on Highcharts, meaning it has all the core
     # functionality of Highcharts, plus some additional features. So
@@ -33,22 +33,25 @@ class HighChart
     #
     def to_html(placeholder=random_canvas_id)
       chart_hash_must_be_present
+      script = load_dependencies('web_frameworks')
       # Helps to denote either of the three classes.
       chart_class = extract_chart_class
       # When user wants to plot a HighMap
       if chart_class == 'Map'
-        high_map(placeholder, self)
+        script << high_map(placeholder, self)
       # When user wants to plot a HighStock
       elsif chart_class == 'StockChart'
-        high_stock(placeholder, self)
+        script << high_stock(placeholder, self)
       # When user wants to plot a HighChart
       elsif chart_class == 'Chart'
-        high_chart(placeholder, self)
+        script << high_chart(placeholder, self)
       end
+      script
     end
 
     def show_in_iruby(placeholder=random_canvas_id)
       # TODO : placeholder pass, in plot#div
+      load_dependencies('iruby')
       IRuby.html to_html_iruby(placeholder)
     end
 
@@ -61,6 +64,52 @@ def to_html_iruby(placeholder=random_canvas_id)
       high_chart_iruby(extract_chart_class, placeholder, self)
     end
 
+    # Loads the dependent mapdata and dependent modules of the chart
+    #
+    # @param [String] to determine whether to load modules in IRuby or web
+    #   frameworks
+    # @return [void, String] loads the initial script of the modules for IRuby
+    #   notebook and returns initial script of the modules for web frameworks
+    def load_dependencies(type)
+      dep_js = extract_dependencies
+      if type == 'iruby'
+        LazyHighCharts.init_iruby(dep_js) unless dep_js.nil?
+      elsif type == 'web_frameworks'
+        dep_js.nil? ? '' : LazyHighCharts.init_script(dep_js)
+      end
+    end
+
+    # Extracts the required dependencies for the chart. User does not need
+    #   to provide any mapdata requirement explicity in the `options`.
+    #   MapData will be extracted using `options[:chart][:map]` already
+    #   provided by the user. In `modules` user needs to provide the required
+    #   modules (like tilemap in highcharts) in the form of Array. Once the
+    #   dependency is loaded on a page, there is no need to provide it again in
+    #   the `modules` option.
+    #
+    # @return [Array] the required dependencies (mapdata or modules)
+    #   to load the chart
+    def extract_dependencies
+      dep_js = []
+      # Mapdata dependencies
+      get_map_data_dependencies(dep_js)
+      # Dependencies provided in modules option (of highcharts mainly
+      #   like tilemap) by the user
+      dep_js |= options.delete(:modules).map! { |js| "#{js}.js" } unless
+      options[:modules].nil?
+      dep_js
+    end
+
+    # @param dep_js [Array] JS dependencies required for drawing a map(mapdata)
+    # @return [void] Appends the map data in dep_js
+    def get_map_data_dependencies(dep_js)
+      if !options[:chart_class].nil? && options[:chart_class].capitalize == 'Map' &&
+         options[:chart] && options[:chart][:map]
+        dep_js.push(options[:chart][:map].to_s)
+        dep_js.map! { |js| "mapdata/#{js}.js" }
+      end
+    end
+
     # @return [String] the class of the chart
     def extract_chart_class
       # Provided by user and can take two values ('stock' or 'map').

lib/daru/view/adapters/highcharts/iruby_notebook.rb

@@ -1,3 +1,5 @@
+require 'daru/view/constants'
+
 module LazyHighCharts
   # generate initializing code
   def self.generate_init_code(dependent_js)
@@ -9,15 +11,17 @@ def self.generate_init_code(dependent_js)
 
   # Enable to show plots on IRuby notebook
   def self.init_iruby(
-    dependent_js=['highstock.js', 'highcharts-more.js', 'modules/exporting.js',
-                  'highcharts-3d.js', 'modules/data.js']
+    dependent_js=HIGHCHARTS_DEPENDENCIES
   )
     # TODO: include highstock.js for highstock and modules/*.js files for
     # exporting and getting data from various source like csv files etc.
     #
     # Highstock.js includes the highcharts.js, so only one of them required.
     # see: https://www.highcharts.com/errors/16
     #
+    # Using Highmaps as a plugin for HighCharts so using map.js instead of
+    # highmaps.js
+    #
     # , 'modules/exporting.js' : for the exporting button
     # data.js for getting data as csv or html table.
     # 'highcharts-more.js' : for arearange and some other chart type

lib/daru/view/adapters/highcharts/layout_helper_iruby.rb

@@ -8,6 +8,14 @@ def high_chart_iruby(chart_class, placeholder, object, &block)
       ).concat(content_tag('div', '', object.html_options))
     end
 
+    def high_map(placeholder, object, &block)
+      object.html_options[:id] = placeholder
+      object.options[:chart][:renderTo] = placeholder
+      build_html_output(
+        'Map', placeholder, object, &block
+      ).concat(content_tag('div', '', object.html_options))
+    end
+
     private
 
     def build_html_output_iruby(type, placeholder, object, &block)