write_xlsx 0.97.0 → 1.04.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1ecd38fb615885768458a04b082d759437fbaf7fb2e07900cc558d18e400e51
-  data.tar.gz: d1fa5e1696685c9bba199b4ee922c488144f5a2f852644e24fcedd38fed29035
+  metadata.gz: 9c3893d317a3ab9f246b62c9d6b6b3a727abd9ab539da4edf52c4029f076d566
+  data.tar.gz: 64861b9ce57ebd55ce67508b33be19705049a8db520edfacc1fd40d8547c2b9c
 SHA512:
-  metadata.gz: 1162adaf9f347ef7f9e986b0596877edc9a4e059b1055e5913c576583017af41b78710c44252c2ced77b06dcdd818af269f3c98282e9bc767f211237e8313fac
-  data.tar.gz: cd4eb41156f364e4685487ae32876d8b35d7907f7f7068442fb22d2afc6a24217794bea5e571720d6db14b80b7c7368ac08502071d5290cc696cd80588901cdd
+  metadata.gz: c3870b13ed05dca60597ecc86662d15d2ec143667e6ff29349c4409d2dd7966eb9f7246f14071a06524a15f5039cb8ec2d4c6c4fb99206b1377f452abe94eddc
+  data.tar.gz: b776541fecba7724e59e5742939e331944ea9a08d87eba2528d29404f9f34bbab8a8abe548fd52735a15c72e42e54c54cc73ad5c06765521647771178229fab0

data/.gitignore

@@ -6,6 +6,7 @@ GTAGS
 .bundle
 .config
 .yardoc
+.byebug_history
 Gemfile.lock
 InstalledFiles
 _site

data/Changes

@@ -1,5 +1,83 @@
 Change history of write_xlsx rubygem.
 
+2021-02-14 v1.04.0
+
+   Added support for "stacked" and "percent_stacked" Line charts.
+
+   Fix for worksheet objects (charts and images) that are inserted with an
+   offset that starts in a hidden cell.
+
+   Removed error in add_worksheet() for sheet name "History" which is a
+   reserved name in English version of Excel. However, this is an allowed
+   worksheet name in some Excel variants so the warning has been turned into
+   a documentation note instead.
+
+
+2021-02-13 v1.03.0
+
+   Fix for duplicate images being copied to an Excel::Writer::XLSX
+   file. Excel uses an optimization where it only stores one copy of a
+   repeated/duplicate image in a workbook. WriteXLSX didn't do
+   this which meant that the file size would increase when then was a large
+   number of repeated images. This release fixes that issue and replicates
+   Excel's behaviour.
+
+2021-02-12 v1.02.0
+
+   Added support for hyperlinks in worksheet images.
+
+   Increased allowable url length from 255 to 2079 characters, as allowed in
+   more recent versions of Excel.
+
+
+2021-02-08 v1.01.0
+
+   Added support for stacked and East Asian vertical chart fonts.
+
+   Added option to control positioning of charts or images when cells are
+   resized.
+
+   Added support for combining Pie/Doughnut charts.
+
+   Fixed sizing of cell comment boxes when they cross columns/rows that have
+   size changes that occur after the comment is written. Comments should
+   now behave like other worksheet objects such as images and charts.
+
+   Fix for structured reference in chart ranges.
+
+2021-01-23 v1.00.0
+
+   Fixed issue where images that started in hidden rows/columns weren't placed
+   correctly in the worksheet.
+
+
+2021-01-08 v0.99.0
+
+   Added font and font_size parameters to write_comment().
+
+   Allow formulas in date field of data_validation().
+
+   Added top_left chart legend position.
+
+   Added legend formatting options.
+
+   Added set_tab_ratio() method to set the ratio between the worksheet tabs
+   and the horizontal slider.
+
+   Added worksheet hide_row_col_headers() method to turn off worksheet row
+   and column headings.
+
+   Add functionality to align chart category axis labels.
+
+   Fix for issue with special characters in worksheet table functions.
+
+   Fix handling of 'num_format': '0' in duplicate formats.
+
+
+2021-01-03 v0.98.0
+
+   fixed for autofilter rule with blanks plus another filter.
+
 2021-01-02 v0.97.0
 
    Added Excel 2010 data bar features such as solid fills and control over

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2020 Hideo NAKAMURA
+Copyright (c) 2012-2021 Hideo NAKAMURA
 
 MIT License
 

data/README.md

@@ -5,7 +5,7 @@
 
 gem to create a new file in the Excel 2007+ XLSX format, and you can use the
 same interface as writeexcel gem. write_xlsx is converted from Perl's module
-[Excel::Writer::XLSX-0.97](https://github.com/jmcnamara/excel-writer-xlsx) .
+[Excel::Writer::XLSX-1.04](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.04)
 
 ## Description
 
@@ -85,7 +85,7 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
 Original Perl module was written by John McNamara(jmcnamara@cpan.org).
 
 Converted to ruby by Hideo NAKAMURA(nakamrua.hideo@gmail.com)
-Copyright (c) 2012-2020 Hideo NAKAMURA.
+Copyright (c) 2012-2021 Hideo NAKAMURA.
 
 See LICENSE.txt for further details.
 

data/examples/a_simple.rb

@@ -7,7 +7,7 @@
 # write text and numbers to an Excel xlsx file.
 #
 # reverse(c), March 2001, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/add_vba_project.rb

@@ -10,7 +10,7 @@
 # used to extract the vbaProject.bin file.
 #
 # reverse('(c)'), November 2012, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/array_formula.rb

@@ -7,7 +7,7 @@
 # array formulas.
 #
 # reverse(c), August 2004, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/chart_area.rb

@@ -6,7 +6,7 @@
 # A demo of an Area chart in Excel::Writer::XLSX.
 #
 # reverse('ｩ'), March 2011, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -53,6 +53,9 @@
 chart.set_style(11)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D2', chart, 25, 10)
+worksheet.insert_chart(
+  'D2', chart,
+  :x_offset => 25, :y_offset => 10
+)
 
 workbook.close

data/examples/chart_bar.rb

@@ -6,7 +6,7 @@
 # A demo of an Bar chart in Excel::Writer::XLSX.
 #
 # reverse('c'), March 2011, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -53,6 +53,9 @@
 chart.set_style(11)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D2', chart, 25, 10)
+worksheet.insert_chart(
+  'D2', chart,
+  :x_offset => 25, :y_offset => 10
+)
 
 workbook.close

data/examples/chart_clustered.rb

@@ -5,7 +5,7 @@
 # A demo of a clustered category chart in Excel::Writer::XLSX.
 #
 # reverse ('(c)'), March 2015, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/chart_column.rb

@@ -6,7 +6,7 @@
 # A demo of an Area chart in Excel::Writer::XLSX.
 #
 # reverse('ｩ'), March 2011, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -53,6 +53,9 @@
 chart.set_style(11)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D2', chart, 25, 10)
+worksheet.insert_chart(
+  'D2', chart,
+  :x_offset => 25, :y_offset => 10
+)
 
 workbook.close

data/examples/chart_combined.rb

@@ -6,7 +6,7 @@
 # An example of a Combined chart in WriteXLSX.
 #
 # reverse ('(c)'), March 2015, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/chart_data_table.rb

@@ -7,7 +7,7 @@
 # WriteXLSX.
 #
 # reverse ('(c)'), December 2012, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -54,7 +54,10 @@
 chart1.set_table
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D2', chart1, 25, 10)
+worksheet.insert_chart(
+  'D2', chart1,
+  :x_offset => 25, :y_offset => 10
+)
 
 #
 # Create a second charat.
@@ -88,6 +91,9 @@
 chart2.set_legend(:position => 'none')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D18', chart2, 25, 11)
+worksheet.insert_chart(
+  'D18', chart2,
+  :x_offset => 25, :y_offset => 11
+)
 
 workbook.close

data/examples/chart_data_tools.rb

@@ -10,7 +10,7 @@
 # High-Low Lines and Up-Down Bars.
 #
 # reverse ('(c)'), December 2012, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -62,7 +62,10 @@
 chart1.set_title(:name => 'Chart with Trendlines')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D2', chart1, 25, 10)
+worksheet.insert_chart(
+  'D2', chart1,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #######################################################################
@@ -91,7 +94,10 @@
 chart2.set_title(:name => 'Chart with Data Labels and Markers')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D18', chart2, 25, 10)
+worksheet.insert_chart(
+  'D18', chart2,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #######################################################################
@@ -119,7 +125,10 @@
 chart3.set_title(:name => 'Chart with Error Bars')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D34', chart3, 25, 10)
+worksheet.insert_chart(
+  'D34', chart3,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #######################################################################
@@ -149,7 +158,10 @@
 chart4.set_title(:name => 'Chart with Up-Down Bars')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D50', chart4, 25, 10)
+worksheet.insert_chart(
+  'D50', chart4,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #######################################################################
@@ -179,7 +191,10 @@
 chart5.set_title(:name => 'Chart with High-Low Lines')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D66', chart5, 25, 10)
+worksheet.insert_chart(
+  'D66', chart5,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #######################################################################
@@ -209,6 +224,9 @@
 chart6.set_title(:name => 'Chart with Drop Lines')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D82', chart6, 25, 10)
+worksheet.insert_chart(
+  'D82', chart6,
+  :x_offset => 25, :y_offset => 10
+)
 
 workbook.close

data/examples/chart_doughnut.rb

@@ -12,7 +12,7 @@
 # formatting to each point in the series.
 #
 # reverse ('(c)'), March 2011, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -50,7 +50,10 @@
 chart1.set_style(10)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('C2', chart1, 25, 10)
+worksheet.insert_chart(
+  'C2', chart1,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #
@@ -77,7 +80,10 @@
 
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('C18', chart2, 25, 10)
+worksheet.insert_chart(
+  'C18', chart2,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #
@@ -101,7 +107,10 @@
 chart3.set_rotation(90)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('C34', chart3, 25, 10)
+worksheet.insert_chart(
+  'C34', chart3,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #
@@ -125,6 +134,9 @@
 chart4.set_hole_size(33)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('C50', chart4, 25, 10)
+worksheet.insert_chart(
+  'C50', chart4,
+  :x_offset => 25, :y_offset => 10
+)
 
 workbook.close

data/examples/chart_gauge.rb

@@ -0,0 +1,73 @@
+# #!/usr/bin/env ruby
+
+# #######################################################################
+# #
+# # A demo of an Gauge Chart in WriteXLSX gem.
+# #
+# # A Gauge Chart isn't a native chart type in Excel. It is constructed by
+# # combining a doughnut chart and a pie chart and by using some non-filled
+# # elements. This example follows the following online example of how to create
+# # a Gauge Chart in Excel: https://www.excel-easy.com/examples/gauge-chart.html
+# #
+# # reverse ('(c)'), May 2019, John McNamara, jmcnamara@cpan.org
+# # convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
+# #
+
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('chart_gauge.xlsx')
+worksheet = workbook.add_worksheet
+
+chart_doughnut = workbook.add_chart(:type => 'doughnut', :embedded => 1)
+chart_pie      = workbook.add_chart(:type => 'pie', :embedded => 1)
+
+# Add some data for the Doughnut and Pie charts. This is set up so the
+# gauge goes from 0-100. It is initially set at 75%.
+worksheet.write_col('H2', ['Donut', 25, 50, 25, 100])
+worksheet.write_col('I2', ['Pie', 75, 1, '=200-I4-I3'])
+
+# Configure the doughnut chart as the background for the gauge.
+chart_doughnut.add_series(
+    :name   => '=Sheet1!$H$2',
+    :values => '=Sheet1!$H$3:$H$6',
+    :points => [
+        { :fill => { :color => 'green' } },
+        { :fill => { :color => 'yellow' } },
+        { :fill => { :color => 'red' } },
+        { :fill => { :none  => 1 } }
+    ]
+)
+
+# Rotate chart so the gauge parts are above the horizontal.
+chart_doughnut.set_rotation(270)
+
+# Turn off the chart legend.
+chart_doughnut.set_legend(:none => 1)
+
+# Turn off the chart fill and border.
+chart_doughnut.set_chartarea(
+    :border => { :none  => 1 },
+    :fill   => { :none  => 1 }
+)
+
+# Configure the pie chart as the needle for the gauge.
+chart_pie.add_series(
+    :name   => '=Sheet1!$I$2',
+    :values => '=Sheet1!$I$3:$I$6',
+    :points => [
+        { :fill => { :none  => 1 } },
+        { :fill => { :color => 'black' } },
+        { :fill => { :none  => 1 } }
+    ]
+)
+
+# Rotate the pie chart/needle to align with the doughnut/gauge.
+chart_pie.set_rotation(270)
+
+# Combine the pie and doughnut charts.
+chart_doughnut.combine(chart_pie)
+
+# Insert the chart into the worksheet.
+worksheet.insert_chart('A1', chart_doughnut)
+
+workbook.close