Added export method to export highchart in different formats #94

Prakriti-nith · 2018-05-28T15:42:06Z

Added the methods export_image and export_image_iruby to export the Highchart in four formats: pdf, png, jpg and svg with the default format being pdf. This is working fine in rails app but I can't understand why it is not working in IRuby notebook. Still searching some way to make it work. I will add the example of rails app to demonstrate this feature.

Example:
hchart = Daru::View::Plot.new(data, options)
hchart.export_image('svg')

This example will first generate the chart and then download it in svg format like this:

Prakriti-nith · 2018-05-28T23:38:50Z

I was using JQuery to get the Highchart object and then download it. For this, I was using jquery.min.js dependency. This dependency was not properly loaded in IRuby notebook (maybe conflicting with the existing dependencies of the jupyter notebook) and was creating problems. I have replaced the code to get the instance of HighCharts' object with the pure js code. It is now working fine in both IRuby notebook as well as in web frameworks.

Prakriti-nith · 2018-05-29T22:01:10Z

Now, user along with format of the chart (in which it has to be exported) can provide the file name.
For example,

hchart = Daru::View::Plot.new(data, options)
hchart.export_image('daru', 'png')

This will download the chart as: daru.png

Shekharrajak · 2018-05-30T15:14:35Z

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

+      when 'svg'
+        "\n type: 'image/svg+xml',"
+      else
+        raise 'Invalid format'


It's type error right?

Shekharrajak · 2018-05-30T15:15:37Z

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

+    def extract_export_code_iruby(placeholder=random_canvas_id, file_name='chart', type='pdf')
+      js = ''
+      js << "\n <script>"
+      js << "\n (function() {"


Check alignments of the lines are correct in web page.

Shekharrajak · 2018-05-30T18:59:52Z

lib/daru/view/adapters/highcharts.rb

@@ -64,6 +64,16 @@ def export_html_file(plot, path='./plot.html')
          File.write(path, str)
        end

+        # @see #Daru::View::Plot.export_image
+        def export_image(plot, file_name='chart', type='pdf')


Isn't we can find, if user running in IRuby notebook or console or web app?

Yes, first I thought of creating only the export_image method. I tried to know whether the user is running in web app or IRuby notebook but couldn't do it. So, I created two different methods export_image and export_image_iruby instead

Shekharrajak · 2018-06-04T18:19:20Z

lib/daru/view/adapters/googlecharts.rb

-        end
-
-        def export_image_iruby(plot, file_name, type='pdf')
+        def export_type(plot, type='pdf', file_name='chart')


I was telling def export(plot, export_type='pdf', file_name='chart').

Shekharrajak · 2018-06-04T18:28:26Z

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

+    def append_chart_type(type='pdf')
+      case type
+      when 'pdf'
+        "\n       type: 'application/pdf',"


Isn't tab is easy to read for indentation.

Shekharrajak · 2018-06-04T18:34:50Z

spec/plot_spec.rb

    end
  end # initialize context end
+
+  context '#export_type' do
+    it "should generate the valid script to export the chart" do


It would be better, if you write specs for each export type and check for saved file(png, pdf, ..)

This method generates the JS code in String format (or loads it in IRuby) to download the chart. I have updated the documentation of it. It will export the chart when it will run in web frameworks or IRuby notebook. I will write the specs for each export type. Should I write them in the same way or is there any other way possible?

Prakriti-nith · 2018-06-07T11:02:08Z

I just found that while exporting multiple highcharts simultaneously in web frameworks, it is exporting only the last one. I am trying to find a solution to resolve this issue.

Prakriti-nith · 2018-06-07T14:29:13Z

By using exportChartLocal (useful link), not only the issue has been resolved but also the exporting works offline (export button in highcharts works online). In IRuby notebook, online exporting asks to leave the page and after that that jupyter notebook does not work (try exporting using exporting button) but this method (export) resolves all.

Prakriti-nith · 2018-06-08T19:20:19Z

In IRuby notebook, offline-export supports only the exporting to png, jpeg and svg format. Export to PDF is not working (not even through the exporting button in highchart). Also, in IRuby notebook, online exporting asks to leave the page and after that that jupyter notebook does not work (try exporting using exporting button). Still, I am keeping the online exporting for the IRuby notebook so that at least chart can be exported to all the formats and offline-exporting for the web frameworks.

Shekharrajak · 2018-06-10T06:47:34Z

lib/daru/view/adapters/googlecharts.rb

@@ -65,6 +65,10 @@ def export_html_file(plot, path='./plot.html')
          File.write(path, str)
        end

+        def export(plot, export_type='pdf', file_name='chart')
+          # TODO


Should throw error saying not implemented yet.

Shekharrajak · 2018-06-10T06:49:26Z

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

+      js = ''
+      js << "\n <script>"
+      js << "\n (function() {"
+      js << "\n 	var onload = window.onload;"


Isn't it tab is better than space to understand the alignment?

Shekharrajak · 2018-06-10T06:53:38Z

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

@@ -10,8 +10,7 @@ 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',
-                  'modules/offline-exporting.js']


So it will not work without internet ? Please document it.

Shekharrajak · 2018-06-10T06:59:36Z

lib/daru/view/plot.rb

+      # @param file_name [String] The name of the file after exporting the chart
+      # @return [String, void] js code of chart along with the code to export it
+      #   and loads the js code to export it in IRuby.
+      def export(export_type='pdf', file_name='chart')


Please write few examples in documentation.

Shekharrajak · 2018-06-10T07:00:27Z

IRuby notebook example link ? Also along with documenting the method, write few example for user to understand the API.

Prakriti-nith · 2018-06-13T01:13:27Z

I have commented out the export method in the examples here.
I also tried running it in console, it is generating the correct script to download the chart.

Prakriti-nith · 2018-06-16T21:10:38Z

@Shekharrajak The tests of updating the js files runs sometimes perfectly and sometimes doesn't (maybe because the highcharts js doesn't get loaded fully and network error occurs). I don't understand the exact reason. Can you please check this?

Added compatibility for IRuby notebook Added file_name Corrected alignment of lines on web page Remove export_image_iruby from plot.rb Updated method name to export Updated documentation Added more specs Use exportChartLocal instead of exportChart Online exporting in IRuby notebook Added documentation Updated examples accordingly Change default type to png

coveralls · 2018-07-07T00:54:04Z

Pull Request Test Coverage Report for Build 602

179 of 183 (97.81%) changed or added relevant lines in 9 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.6%) to 97.126%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
lib/daru/view/adapters/googlecharts.rb	1	2	50.0%
lib/daru/view/adapters/nyaplot.rb	1	2	50.0%
lib/daru/view/adapters/highcharts/display.rb	48	50	96.0%

Totals
Change from base Build 601:	0.6%
Covered Lines:	1690
Relevant Lines:	1740

💛 - Coveralls

coveralls · 2018-07-07T00:54:04Z

Pull Request Test Coverage Report for Build 583

181 of 183 (98.91%) changed or added relevant lines in 9 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.2%) to 96.332%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
lib/daru/view/adapters/googlecharts.rb	1	2	50.0%
lib/daru/view/adapters/nyaplot.rb	1	2	50.0%

Totals
Change from base Build 578:	0.2%
Covered Lines:	2127
Relevant Lines:	2208

💛 - Coveralls

coveralls · 2018-07-07T00:54:04Z

Pull Request Test Coverage Report for Build 583

181 of 183 (98.91%) changed or added relevant lines in 9 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.2%) to 96.332%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
lib/daru/view/adapters/googlecharts.rb	1	2	50.0%
lib/daru/view/adapters/nyaplot.rb	1	2	50.0%

Totals
Change from base Build 578:	0.2%
Covered Lines:	2127
Relevant Lines:	2208

💛 - Coveralls

coveralls · 2018-07-07T00:54:04Z

Pull Request Test Coverage Report for Build 583

181 of 183 (98.91%) changed or added relevant lines in 9 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.2%) to 96.332%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
lib/daru/view/adapters/googlecharts.rb	1	2	50.0%
lib/daru/view/adapters/nyaplot.rb	1	2	50.0%

Totals
Change from base Build 578:	0.2%
Covered Lines:	2127
Relevant Lines:	2208

💛 - Coveralls

Prakriti-nith · 2018-07-12T00:00:57Z

@Shekharrajak can you please review the changes?

Shekharrajak

Please document the usage in separate Wiki page as well.
It looks good to go after minor modification as per the comment. 🎊

Shekharrajak · 2018-07-12T12:16:40Z

lib/daru/view/adapters/highcharts.rb

@@ -70,6 +70,21 @@ def export_html_file(plot, path='./plot.html')
          File.write(path, str)
        end

+        # Expoting in web frameforks is completely offline. In IRuby notebook,


Expoting -> Exporting
frameforks -> frameworks

Shekharrajak · 2018-07-12T12:17:50Z

lib/daru/view/adapters/highcharts.rb

+        # Expoting in web frameforks is completely offline. In IRuby notebook,
+        #   offline-export supports only the exporting to png, jpeg and svg format.
+        #   Export to PDF is not working (not even through the exporting button in
+        #   highchart). So, online exporting is done in IRuby notebook. There is a


We can open the issue to track it, right?

I'll open it after this PR gets merged.

Prakriti-nith · 2018-07-12T20:22:01Z

@Shekharrajak I have documented the usage in this wiki page.

Shekharrajak · 2018-07-13T09:21:24Z

@Prakriti-nith , please resolve the conflicts and run the examples once.

Prakriti-nith · 2018-07-13T18:47:18Z

@Shekharrajak I tried the examples again both in IRuby notebook and rails, everything is working fine.

Shekharrajak reviewed May 30, 2018

View reviewed changes

Prakriti-nith force-pushed the export_highchart branch from 1efedc4 to 67efe88 Compare June 3, 2018 12:49

Shekharrajak reviewed Jun 4, 2018

View reviewed changes

Shekharrajak reviewed Jun 10, 2018

View reviewed changes

Prakriti-nith force-pushed the export_highchart branch 2 times, most recently from 700f511 to 53d3845 Compare June 16, 2018 20:56

Prakriti-nith force-pushed the export_highchart branch from 7b77ff0 to 69a0715 Compare June 19, 2018 01:12

Prakriti-nith changed the title ~~Added export_image method to export highchart in different formats~~ Added export method to export highchart in different formats Jun 23, 2018

Prakriti-nith added 2 commits July 7, 2018 05:53

Resolve conflicts

6d96906

Prakriti-nith force-pushed the export_highchart branch from 69a0715 to 6d96906 Compare July 7, 2018 00:49

Shekharrajak approved these changes Jul 12, 2018

View reviewed changes

Fixed typos in comment

282be2d

Prakriti-nith force-pushed the export_highchart branch from 0cc2975 to 282be2d Compare July 12, 2018 19:48

Merge branch 'master' into export_highchart

2c4e273

Shekharrajak merged commit 8d4f389 into SciRuby:master Jul 14, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added export method to export highchart in different formats #94

Added export method to export highchart in different formats #94

Prakriti-nith commented May 28, 2018

Prakriti-nith commented May 28, 2018

Prakriti-nith commented May 29, 2018

Shekharrajak May 30, 2018

Shekharrajak May 30, 2018

Shekharrajak May 30, 2018

Prakriti-nith May 31, 2018

Shekharrajak Jun 4, 2018

Shekharrajak Jun 4, 2018

Shekharrajak Jun 4, 2018

Prakriti-nith Jun 5, 2018

Prakriti-nith commented Jun 7, 2018

Prakriti-nith commented Jun 7, 2018

Prakriti-nith commented Jun 8, 2018

Shekharrajak Jun 10, 2018

Shekharrajak Jun 10, 2018

Shekharrajak Jun 10, 2018

Shekharrajak Jun 10, 2018

Shekharrajak commented Jun 10, 2018

Prakriti-nith commented Jun 13, 2018

Prakriti-nith commented Jun 16, 2018

coveralls commented Jul 7, 2018 •

edited

Loading

coveralls commented Jul 7, 2018

coveralls commented Jul 7, 2018

coveralls commented Jul 7, 2018

Prakriti-nith commented Jul 12, 2018

Shekharrajak left a comment

Shekharrajak Jul 12, 2018

Shekharrajak Jul 12, 2018

Prakriti-nith Jul 12, 2018

Prakriti-nith commented Jul 12, 2018

Shekharrajak commented Jul 13, 2018

Prakriti-nith commented Jul 13, 2018

Added export method to export highchart in different formats #94

Added export method to export highchart in different formats #94

Conversation

Prakriti-nith commented May 28, 2018

Prakriti-nith commented May 28, 2018

Prakriti-nith commented May 29, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Prakriti-nith commented Jun 7, 2018

Prakriti-nith commented Jun 7, 2018

Prakriti-nith commented Jun 8, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Shekharrajak commented Jun 10, 2018

Prakriti-nith commented Jun 13, 2018

Prakriti-nith commented Jun 16, 2018

coveralls commented Jul 7, 2018 • edited Loading

Pull Request Test Coverage Report for Build 602

💛 - Coveralls

coveralls commented Jul 7, 2018

Pull Request Test Coverage Report for Build 583

💛 - Coveralls

coveralls commented Jul 7, 2018

Pull Request Test Coverage Report for Build 583

💛 - Coveralls

coveralls commented Jul 7, 2018

Pull Request Test Coverage Report for Build 583

💛 - Coveralls

Prakriti-nith commented Jul 12, 2018

Shekharrajak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Prakriti-nith commented Jul 12, 2018

Shekharrajak commented Jul 13, 2018

Prakriti-nith commented Jul 13, 2018

coveralls commented Jul 7, 2018 •

edited

Loading