write_xlsx 1.02.0 → 1.08.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd25c9e7242d84cbaa3f58304d292275f56e89353b61f151e9beb2bf9e740e46
-  data.tar.gz: 6ac71db1cf2089932e2381cb6c20d2b1fa0a82493bc00bafc307d4efbd2da048
+  metadata.gz: 9ab3f33d51239105a5d5c8e0765ada850496c199a370e713353c56d0e0764e4b
+  data.tar.gz: 4b379953050d7a9a5c4151742825c7672c66e60b7c37146531f8d0075d32b634
 SHA512:
-  metadata.gz: aada5fa6d8a1034743af39bcc352b2e15120493c47c4f048006f6db3869c3f1eb8652e437ffb4bdf441b0280596f314bc06d436178c4bd82ea39e8e9dafcc5b8
-  data.tar.gz: db54ce603031240fe4e5081603042f804a9dd4566e6bd4e5d1b7124fd9f064748654552bb7297881cfc72915e959f26c7459777fd4cceddaee27aeb726aec798
+  metadata.gz: 128e52ae31ef667b30e8c6649c1747abf75750e48bd1a7a9a95cedd69ab3699f55755c9ef2686da4252642c662ed871b41ebb90cabe6d23e56f319b958db89b9
+  data.tar.gz: 31b68e29186266b216aaf8dc2035619292999146e79a9388c1d46dcbdd4704d17688586733dc8bb2b6284865340a68d62c7de6cd738a1ed9f6e68c83f388e94e

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,77 @@
 Change history of write_xlsx rubygem.
 
+2021-11-19 v1.08.0
+
+    Added ability to add accessibility options "description" and
+    "decorative" to images via insert_image().
+
+    Added the workbook read_only_recommended() method to set the Excel
+    "Read-only Recommended" option that is available when saving a file.
+
+    Added option to set a chart crossing to 'min' as well as the existing
+    'max' option. The 'min' option isn't available in the Excel interface
+    but can be enabled via VBA.
+
+    Added option to unprotect ranges in protected worksheets.
+
+    Added check, and warning, for worksheet tables with no data row.  Either
+    with or without a header row.
+
+    Added ignore_errors() worksheet method to ignore Excel worksheet
+    errors/warnings in user defined ranges.
+
+    Fixed issue where pattern formats without colours where given a default
+    black fill colour.
+
+    Fix issue where custom chart data labels didn't inherit the position for
+    the data labels in the series.
+
+    Fixed issue with relative url links in images.
+
+    Fixed issue where headers/footers were restricted to 254 characters
+    instead of 255.
+
+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.

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

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

data/examples/chart_line.rb

@@ -18,9 +18,9 @@ bold      = workbook.add_format(:bold => 1)
 # Add the worksheet data that the charts will refer to.
 headings = [ 'Number', 'Batch 1', 'Batch 2' ]
 data = [
-    [ 2, 3, 4, 5, 6, 7 ],
-    [ 10, 40, 50, 20, 10, 50 ],
-    [ 30, 60, 70, 50, 40, 30 ]
+  [  2,  3,  4,  5,  6,  7 ],
+  [ 10, 40, 50, 20, 10, 50 ],
+  [ 30, 60, 70, 50, 40, 30 ]
 ]
 
 worksheet.write('A1', headings, bold)
@@ -31,21 +31,21 @@ chart = workbook.add_chart(:type => 'line', :embedded => 1)
 
 # Configure the first series.
 chart.add_series(
-    :name       => '=Sheet1!$B$1',
-    :categories => '=Sheet1!$A$2:$A$7',
-    :values     => '=Sheet1!$B$2:$B$7'
+  :name       => '=Sheet1!$B$1',
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$B$2:$B$7'
 )
 
 # Configure second series. Note alternative use of array ref to define
 # ranges: [ sheetname, row_start, row_end, col_start, col_end ].
 chart.add_series(
-    :name       => '=Sheet1!$C$1',
-    :categories => [ 'Sheet1', 1, 6, 0, 0 ],
-    :values     => [ 'Sheet1', 1, 6, 2, 2 ]
+  :name       => '=Sheet1!$C$1',
+  :categories => [ 'Sheet1', 1, 6, 0, 0 ],
+  :values     => [ 'Sheet1', 1, 6, 2, 2 ]
 )
 
 # Add a chart title and some axis labels.
-chart.set_title(:name => 'Results of sample analysis')
+chart.set_title(:name  => 'Results of sample analysis')
 chart.set_x_axis(:name => 'Test number')
 chart.set_y_axis(:name => 'Sample length (mm)')
 
@@ -58,4 +58,79 @@ worksheet.insert_chart(
   :x_offset => 25, :y_offset => 10
 )
 
+#
+# Create a stacked chart sub-type
+#
+chart2 = workbook.add_chart(
+    :type     => 'line',
+    :embedded => 1,
+    :subtype  => 'stacked'
+)
+
+# Configure the first series.
+chart2.add_series(
+    :name       => '=Sheet1!$B$1',
+    :categories => '=Sheet1!$A$2:$A$7',
+    :values     => '=Sheet1!$B$2:$B$7'
+)
+
+# Configure second series.
+chart2.add_series(
+    :name       => '=Sheet1!$C$1',
+    :categories => [ 'Sheet1', 1, 6, 0, 0 ],
+    :values     => [ 'Sheet1', 1, 6, 2, 2 ]
+)
+
+# Add a chart title and some axis labels.
+chart2.set_title ( :name => 'Stacked Chart' )
+chart2.set_x_axis( :name => 'Test number' )
+chart2.set_y_axis( :name => 'Sample length (mm)' )
+
+# Set an Excel chart style. Blue colors with white outline and shadow.
+chart2.set_style( 12 )
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart(
+  'D18', chart2,
+  { :x_offset => 25, :y_offset => 10 }
+)
+
+
+#
+# Create a percent stacked chart sub-type
+#
+chart3 = workbook.add_chart(
+  :type     => 'line',
+  :embedded => 1,
+  :subtype  => 'percent_stacked'
+)
+
+# Configure the first series.
+chart3.add_series(
+  :name       => '=Sheet1!$B$1',
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$B$2:$B$7'
+)
+
+# Configure second series.
+chart3.add_series(
+  :name       => '=Sheet1!$C$1',
+  :categories => [ 'Sheet1', 1, 6, 0, 0 ],
+  :values     => [ 'Sheet1', 1, 6, 2, 2 ]
+)
+
+# Add a chart title and some axis labels.
+chart3.set_title ( :name => 'Percent Stacked Chart' )
+chart3.set_x_axis( :name => 'Test number' )
+chart3.set_y_axis( :name => 'Sample length (mm)' )
+
+# Set an Excel chart style. Blue colors with white outline and shadow.
+chart3.set_style( 13 )
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart(
+  'D34', chart3,
+  { :x_offset => 25, :y_offset => 10 }
+)
+
 workbook.close