write_xlsx 0.99.0 → 1.07.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8880984e96fe4a8788fe6642220163ff36932dea018a335d00165a7b2d2ae04
-  data.tar.gz: 99153b43aba51974cca58ed8c38d6308814820846b4617444fcd302752843bc5
+  metadata.gz: 677847fdb975ab7253b3a5ed5f6aa779a9bbf2a459e941f5037b7d557e2abfe4
+  data.tar.gz: 4c4b0b03ce3b510a0ad6423c30a76fc778463afe92f992da52b49bbe65c7a1ac
 SHA512:
-  metadata.gz: 1b5c868f6e42846e925282b0eed02064b4541e852e72012e083009dbaa44e6bc419f1ad5b630cfe3ca149b12832732b972f340e6038502e1c8acbce9358702d2
-  data.tar.gz: 8bc6c84b0bb6c5901516441c7a5b1e45044ba5c26d30c92ac773f0de521e8e78785cd8aa4759a0d0db96d629aedd4aaf2a7453cb1f075b36dd1e61fc34cb217d
+  metadata.gz: b3f81d2d54e5f7a7170c34e7666f58c7f4f77b993ff3b95263327b0ff8edff5c9a0b1a6ea825ece5b43c5b1d2b91a6f01764237f22ee6442bd8c747de8e04150
+  data.tar.gz: 3e49064459345dbcc5d97fef0f8154159776e8361cb0709e8a4564f32dd062fe95b6e4f08976df81b5ac478a40287be9a33086726444af3c75d1cbeb5c869dc2

data/.gitignore

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

data/.travis.yml

@@ -63,4 +63,3 @@ rvm:
 - 2.1.1
 - 2.1.0
 - 2.0.0
-- 1.9.3

data/Changes

@@ -1,5 +1,75 @@
 Change history of write_xlsx rubygem.
 
+2021-02-17 v1.07.0
+
+   Added support for Border, Fill, Pattern and Gradient formatting to chart
+   data labels and chart custom data labels.
+
+
+2021-02-15 v1.06.0
+
+   Fix for issue where array formulas weren't included in the output file
+   for certain ranges/conditions.
+
+
+2021-02-15 v1.05.0
+
+   Added support for custom data labels in charts.
+
+   Remove ruby-1.9.3 travil CI check.
+
+
+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().

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.99](https://github.com/jmcnamara/excel-writer-xlsx) .
+[Excel::Writer::XLSX-1.07](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.07)
 
 ## Description
 

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_labels.rb

@@ -0,0 +1,320 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# A demo of an various Excel chart data label features that are available
+# via an WriteXLSX chart.
+#
+# Copyright 2000-2020, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
+#
+
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('chart_data_labels.xlsx')
+worksheet = workbook.add_worksheet
+bold      = workbook.add_format(:bold => 1)
+
+# Add the worksheet data that the charts will refer to.
+headings = ['Number', 'Data', 'Text']
+data = [
+  [ 2,  3,  4,  5,  6,  7 ],
+  [20, 10, 20, 30, 40, 30 ],
+  ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun']
+]
+
+worksheet.write('A1', headings, bold)
+worksheet.write('A2', data)
+
+
+#######################################################################
+#
+# Example with standard data labels.
+#
+
+# Create a Column chart.
+chart1 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Configure the data series and add the data labels.
+chart1.add_series(
+  :categories  => '=Sheet1!$A$2:$A$7',
+  :values      => '=Sheet1!$B$2:$B$7',
+  :data_labels => { :value => 1 }
+)
+
+# Add a chart title.
+chart1.set_title(:name => 'Chart with standard data labels')
+
+# Turn off the chart legend.
+chart1.set_legend(:none => 1)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D2', chart1, { :x_offset => 25, :y_offset => 10 })
+
+
+#######################################################################
+#
+# Example with value and category data labels.
+#
+
+# Create a Column chart.
+chart2 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Configure the data series and add the data labels.
+chart2.add_series(
+  :categories  => '=Sheet1!$A$2:$A$7',
+  :values      => '=Sheet1!$B$2:$B$7',
+  :data_labels => { :value => 1, :category => 1 }
+)
+
+# Add a chart title.
+chart2.set_title(:name => 'Category and Value data labels')
+
+# Turn off the chart legend.
+chart2.set_legend(:none => 1)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D18', chart2, { :x_offset => 25, :y_offset => 10 })
+
+
+#######################################################################
+#
+# Example with standard data labels with different font.
+#
+
+# Create a Column chart.
+chart3 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Configure the data series and add the data labels.
+chart3.add_series(
+  :categories  => '=Sheet1!$A$2:$A$7',
+  :values      => '=Sheet1!$B$2:$B$7',
+  :data_labels => { :value => 1,
+                    :font => {:bold => 1,
+                              :color => 'red',
+                              :rotation => -30}
+                  }
+)
+
+# Add a chart title.
+chart3.set_title(:name => 'Data labels with user defined font')
+
+# Turn off the chart legend.
+chart3.set_legend(:none => 1)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D34', chart3, { :x_offset => 25, :y_offset => 10 })
+
+
+#######################################################################
+#
+# Example with custom string data labels.
+#
+
+# Create a Column chart.
+chart4 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Configure the data series and add the data labels.
+chart4.add_series(
+  :categories  => '=Sheet1!$A$2:$A$7',
+  :values      => '=Sheet1!$B$2:$B$7',
+  :data_labels => {
+    :value  => 1,
+    :border => {:color => 'red'},
+    :fill   => {:color => 'yellow'}
+  }
+)
+
+# Add a chart title.
+chart4.set_title(:name => 'Data labels with formatting')
+
+# Turn off the chart legend.
+chart4.set_legend(:none => 1)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D50', chart4, { :x_offset => 25, :y_offset => 10 })
+
+
+#######################################################################
+#
+# Example with custom string data labels.
+#
+
+# Create a Column chart.
+chart5 = workbook.add_chart( :type => 'column', :embedded => 1 )
+
+# Some custom labels.
+custom_labels = [
+  { :value => 'Amy' },
+  { :value => 'Bea' },
+  { :value => 'Eva' },
+  { :value => 'Fay' },
+  { :value => 'Liv' },
+  { :value => 'Una' }
+]
+
+# Configure the data series and add the data labels.
+chart5.add_series(
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$B$2:$B$7',
+  :data_labels => { :value => 1, :custom => custom_labels }
+)
+
+# Add a chart title.
+chart5.set_title(:name => 'Chart with custom string data labels')
+
+# Turn off the chart legend.
+chart5.set_legend(:none => 1)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D66', chart5, { :x_offset => 25, :y_offset => 10 })
+
+
+#######################################################################
+#
+# Example with custom data labels from cells.
+#
+
+# Create a Column chart.
+chart6 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Some custom labels.
+custom_labels = [
+  { :value => '=Sheet1!$C$2' },
+  { :value => '=Sheet1!$C$3' },
+  { :value => '=Sheet1!$C$4' },
+  { :value => '=Sheet1!$C$5' },
+  { :value => '=Sheet1!$C$6' },
+  { :value => '=Sheet1!$C$7' }
+]
+
+
+# Configure the data series and add the data labels.
+chart6.add_series(
+  :categories  => '=Sheet1!$A$2:$A$7',
+  :values      => '=Sheet1!$B$2:$B$7',
+  :data_labels => { :value => 1, :custom => custom_labels }
+)
+
+# Add a chart title.
+chart6.set_title(:name => 'Chart with custom data labels from cells')
+
+# Turn off the chart legend.
+chart6.set_legend(:none => 1)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D82', chart6, { :x_offset => 25, :y_offset => 10 })
+
+
+#######################################################################
+#
+# Example with custom and default data labels.
+#
+
+# Create a Column chart.
+chart7 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Some custom labels. The nil items will get the default value.
+# We also set a font for the custom items as an extra example.
+custom_labels = [
+  { :value => '=Sheet1!$C$2', :font => { :color => 'red' } },
+  nil,
+  { :value => '=Sheet1!$C$4', :font => { :color => 'red' } },
+  { :value => '=Sheet1!$C$5', :font => { :color => 'red' } }
+]
+
+
+# Configure the data series and add the data labels.
+chart7.add_series(
+  :categories  => '=Sheet1!$A$2:$A$7',
+  :values      => '=Sheet1!$B$2:$B$7',
+  :data_labels => { :value => 1, :custom => custom_labels }
+)
+
+# Add a chart title.
+chart7.set_title(:name => 'Mixed custom and default data labels')
+
+# Turn off the chart legend.
+chart7.set_legend(:none => 1)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D98', chart7, { :x_offset => 25, :y_offset => 10 })
+
+
+#######################################################################
+#
+# Example with deleted custom data labels.
+#
+
+# Create a Column chart.
+chart8 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Some deleted custom labels and defaults (nil). This allows us to
+# highlight certain values such as the minimum and maximum.
+custom_labels = [
+  { :delete => 1 },
+  nil,
+  { :delete => 1 },
+  { :delete => 1 },
+  nil,
+  { :delete => 1 }
+]
+
+# Configure the data series and add the data labels.
+chart8.add_series(
+  :categories  => '=Sheet1!$A$2:$A$7',
+  :values      => '=Sheet1!$B$2:$B$7',
+  :data_labels => { :value => 1, :custom => custom_labels }
+)
+
+# Add a chart title.
+chart8.set_title(:name => 'Chart with deleted data labels')
+
+# Turn off the chart legend.
+chart8.set_legend(:none => 1)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D114', chart8, { :x_offset => 25, :y_offset => 10 })
+
+#######################################################################
+#
+# Example with custom string data labels and formatting.
+#
+
+# Create a Column chart.
+chart9 = workbook.add_chart( :type => 'column', :embedded => 1 )
+
+# Some custom labels.
+custom_labels = [
+  { :value => 'Amy', :border => {:color => 'blue'} },
+  { :value => 'Bea' },
+  { :value => 'Eva' },
+  { :value => 'Fay' },
+  { :value => 'Liv' },
+  { :value => 'Una', :fill   => {:color => 'green'} }
+]
+
+
+# Configure the data series and add the data labels.
+chart9.add_series(
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$B$2:$B$7',
+  :data_labels => {
+    :value => 1,
+    :custom => custom_labels,
+    :border => {:color => 'red'},
+    :fill   => {:color => 'yellow'}
+  }
+)
+
+# Add a chart title.
+chart9.set_title( :name => 'Chart with custom labels and formatting' )
+
+# Turn off the chart legend.
+chart9.set_legend( :none => 1 )
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart( 'D130', chart9, { :x_offset => 25, :y_offset => 10 } )
+
+workbook.close