write_xlsx 1.02.0 → 1.04.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd25c9e7242d84cbaa3f58304d292275f56e89353b61f151e9beb2bf9e740e46
-  data.tar.gz: 6ac71db1cf2089932e2381cb6c20d2b1fa0a82493bc00bafc307d4efbd2da048
+  metadata.gz: 9c3893d317a3ab9f246b62c9d6b6b3a727abd9ab539da4edf52c4029f076d566
+  data.tar.gz: 64861b9ce57ebd55ce67508b33be19705049a8db520edfacc1fd40d8547c2b9c
 SHA512:
-  metadata.gz: aada5fa6d8a1034743af39bcc352b2e15120493c47c4f048006f6db3869c3f1eb8652e437ffb4bdf441b0280596f314bc06d436178c4bd82ea39e8e9dafcc5b8
-  data.tar.gz: db54ce603031240fe4e5081603042f804a9dd4566e6bd4e5d1b7124fd9f064748654552bb7297881cfc72915e959f26c7459777fd4cceddaee27aeb726aec798
+  metadata.gz: c3870b13ed05dca60597ecc86662d15d2ec143667e6ff29349c4409d2dd7966eb9f7246f14071a06524a15f5039cb8ec2d4c6c4fb99206b1377f452abe94eddc
+  data.tar.gz: b776541fecba7724e59e5742939e331944ea9a08d87eba2528d29404f9f34bbab8a8abe548fd52735a15c72e42e54c54cc73ad5c06765521647771178229fab0

data/Changes

@@ -1,5 +1,27 @@
 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.

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.04](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.04)
 
 ## Description
 

data/examples/chart_line.rb

@@ -18,9 +18,9 @@
 # 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 @@
 
 # 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 @@
   :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

data/examples/tables.rb

@@ -28,6 +28,7 @@
 worksheet10 = workbook.add_worksheet
 worksheet11 = workbook.add_worksheet
 worksheet12 = workbook.add_worksheet
+worksheet13 = workbook.add_worksheet
 
 currency_format = workbook.add_format(:num_format => '$#,##0')
 
@@ -60,7 +61,7 @@
 #
 # Example 2.
 #
-caption = 'Default table with data.';
+caption = 'Default table with data.'
 
 # Set the columns widths.
 worksheet2.set_column('B:G', 12)
@@ -130,7 +131,7 @@
 #
 # Example 6.
 #
-caption = 'Table with banded columns but without default banded rows.';
+caption = 'Table with banded columns but without default banded rows.'
 
 # Set the columns widths.
 worksheet6.set_column('B:G', 12)
@@ -149,7 +150,7 @@
 #
 # Example 7.
 #
-caption = 'Table with user defined column headers';
+caption = 'Table with user defined column headers'
 
 # Set the columns widths.
 worksheet7.set_column('B:G', 12)
@@ -176,7 +177,7 @@
 #
 # Example 8.
 #
-caption = 'Table with user defined column headers';
+caption = 'Table with user defined column headers'
 
 # Set the columns widths.
 worksheet8.set_column('B:G', 12)
@@ -208,7 +209,7 @@
 #
 # Example 9.
 #
-caption = 'Table with totals row (but no caption or totals).';
+caption = 'Table with totals row (but no caption or totals).'
 
 # Set the columns widths.
 worksheet9.set_column('B:G', 12)
@@ -241,7 +242,7 @@
 #
 # Example 10.
 #
-caption = 'Table with totals row with user captions and functions.';
+caption = 'Table with totals row with user captions and functions.'
 
 # Set the columns widths.
 worksheet10.set_column('B:G', 12)
@@ -275,7 +276,7 @@
 #
 # Example 11.
 #
-caption = 'Table with alternative Excel style.';
+caption = 'Table with alternative Excel style.'
 
 # Set the columns widths.
 worksheet11.set_column('B:G', 12)
@@ -310,7 +311,7 @@
 #
 # Example 12.
 #
-caption = 'Table with column formats.';
+caption = 'Table with no Excel style.'
 
 # Set the columns widths.
 worksheet12.set_column('B:G', 12)
@@ -320,40 +321,74 @@
 
 # Add a table to the worksheet.
 worksheet12.add_table(
-    'B3:G8',
-    {
-        :data      => data,
-        :total_row => 1,
-        :columns   => [
-            { :header => 'Product', :total_string => 'Totals' },
-            {
-                :header         => 'Quarter 1',
-                :total_function => 'sum',
-                :format         => currency_format,
-            },
-            {
-                :header         => 'Quarter 2',
-                :total_function => 'sum',
-                :format         => currency_format,
-            },
-            {
-                :header         => 'Quarter 3',
-                :total_function => 'sum',
-                :format         => currency_format,
-            },
-            {
-                :header         => 'Quarter 4',
-                :total_function => 'sum',
-                :format         => currency_format,
-            },
-            {
-                :header         => 'Year',
-                :formula        => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
-                :total_function => 'sum',
-                :format         => currency_format,
-            }
-        ]
-    }
+  'B3:G8',
+  {
+    :data      => data,
+    :style     => 'None',
+    :total_row => 1,
+    :columns   => [
+      { :header => 'Product',   :total_string   => 'Totals' },
+      { :header => 'Quarter 1', :total_function => 'sum' },
+      { :header => 'Quarter 2', :total_function => 'sum' },
+      { :header => 'Quarter 3', :total_function => 'sum' },
+      { :header => 'Quarter 4', :total_function => 'sum' },
+      {
+        :header         => 'Year',
+        :formula        => '=SUM(Table12[@[Quarter 1]:[Quarter 4]])',
+        :total_function => 'sum'
+      }
+    ]
+  }
+)
+
+###############################################################################
+#
+# Example 13.
+#
+caption = 'Table with column formats.'
+
+# Set the columns widths.
+worksheet13.set_column('B:G', 12)
+
+# Write the caption.
+worksheet13.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet13.add_table(
+  'B3:G8',
+  {
+    :data      => data,
+    :total_row => 1,
+    :columns   => [
+      { :header => 'Product', :total_string => 'Totals' },
+      {
+        :header         => 'Quarter 1',
+        :total_function => 'sum',
+        :format         => currency_format,
+      },
+      {
+        :header         => 'Quarter 2',
+        :total_function => 'sum',
+        :format         => currency_format,
+      },
+      {
+        :header         => 'Quarter 3',
+        :total_function => 'sum',
+        :format         => currency_format,
+      },
+      {
+        :header         => 'Quarter 4',
+        :total_function => 'sum',
+        :format         => currency_format,
+      },
+      {
+        :header         => 'Year',
+        :formula        => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
+        :total_function => 'sum',
+        :format         => currency_format,
+      }
+    ]
+  }
 )
 
 workbook.close

data/lib/write_xlsx/chart/line.rb

@@ -22,9 +22,17 @@ class Line < self
 
       def initialize(subtype)
         super(subtype)
+        @subtype        = @subtype || 'standard'
         @default_marker = Marker.new(:type => 'none')
         @smooth_allowed = 1
 
+        # Override and reset the default axis values.
+        if @subtype == 'percent_stacked'
+          @y_axis.defaults[:num_format] = '0%'
+        end
+
+        set_y_axis
+
         # Set the available data label positions for this chart type.
         @label_position_default = 'right'
         @label_positions = {
@@ -54,9 +62,15 @@ def write_line_chart(params)
         series = axes_series(params)
         return if series.empty?
 
+        if @subtype == 'percent_stacked'
+          subtype = 'percentStacked'
+        else
+          subtype = @subtype
+        end
+
         @writer.tag_elements('c:lineChart') do
           # Write the c:grouping element.
-          write_grouping('standard')
+          write_grouping(subtype)
           # Write the series elements.
           series.each {|s| write_series(s)}
 

data/lib/write_xlsx/format.rb

@@ -248,11 +248,11 @@ def initialize(formats, params = {})   # :nodoc:
     #
     def copy(other)
       reserve = [
-                 :xf_index,
-                 :dxf_index,
-                 :xdf_format_indices,
-                 :palette
-                ]
+        :xf_index,
+        :dxf_index,
+        :xdf_format_indices,
+        :palette
+      ]
       (instance_variables - reserve).each do |v|
         instance_variable_set(v, other.instance_variable_get(v))
       end

data/lib/write_xlsx/package/comments.rb

@@ -155,7 +155,7 @@ def visibility
       #
       def fill_attributes
         [
-         ['color2', '#ffffe1']
+          ['color2', '#ffffe1']
         ]
       end
 
@@ -164,9 +164,9 @@ def fill_attributes
       #
       def write_shadow
         attributes = [
-            ['on',       't'],
-            ['color',    'black'],
-            ['obscured', 't']
+          ['on',       't'],
+          ['color',    'black'],
+          ['obscured', 't']
         ]
 
         @writer.empty_tag('v:shadow', attributes)

data/lib/write_xlsx/package/relationships.rb

@@ -64,8 +64,8 @@ def add_worksheet_relationship(type, target, target_mode = nil)
       #
       def write_relationships
         attributes = [
-                      ['xmlns', Package_schema]
-                     ]
+          ['xmlns', Package_schema]
+        ]
 
         @writer.tag_elements('Relationships', attributes) do
           @rels.each { |rel| write_relationship(*rel) }

data/lib/write_xlsx/package/styles.rb

@@ -20,6 +20,7 @@ def initialize
         @dxf_formats       = []
         @has_hyperlink     = 0
         @hyperlink_font_id = 0
+        @has_comments      = false
       end
 
       def set_xml_writer(filename)
@@ -37,7 +38,7 @@ def assemble_xml_file
       #
       def set_style_properties(
             xf_formats, palette, font_count, num_format_count, border_count,
-            fill_count, custom_colors, dxf_formats
+            fill_count, custom_colors, dxf_formats, has_comments
           )
         @xf_formats       = xf_formats
         @palette          = palette
@@ -47,6 +48,7 @@ def set_style_properties(
         @fill_count       = fill_count
         @custom_colors    = custom_colors
         @dxf_formats      = dxf_formats
+        @has_comments     = has_comments
       end
 
       #
@@ -148,7 +150,14 @@ def write_num_fmt(num_fmt_id, format_code)
       # Write the <fonts> element.
       #
       def write_fonts
-        write_format_elements('fonts', @font_count) do
+        count = @font_count
+
+        if @has_comments
+          # Add an extra font for comments.
+          count += 1
+        end
+
+        write_format_elements('fonts', count) do
           write_font_base
         end
       end
@@ -161,6 +170,21 @@ def write_font_base
             @hyperlink_font_id = format.font_index unless ptrue?(@hyperlink_font_id)
           end
         end
+        if @has_comments
+          write_comment_font
+        end
+      end
+
+      #
+      # Write the <font> element used for comments.
+      #
+      def write_comment_font
+        @writer.tag_elements('font') do
+          @writer.empty_tag('sz', [['val', 8]])
+          write_color('indexed', 81)
+          @writer.empty_tag( 'name',   [['val', 'Tahoma']])
+          @writer.empty_tag( 'family', [['val', 2]])
+        end
       end
 
       #
@@ -394,12 +418,6 @@ def write_cell_style_xfs
       def write_cell_xfs
         formats = @xf_formats
 
-        # Workaround for when the last format is used for the comment font
-        # and shouldn't be used for cellXfs.
-        last_format =   formats[-1]
-
-        formats.pop if last_format && last_format.font_only != 0
-
         attributes = [ ['count', formats.size] ]
 
         @writer.tag_elements('cellXfs', attributes) do