write_xlsx 1.07.0 → 1.09.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 677847fdb975ab7253b3a5ed5f6aa779a9bbf2a459e941f5037b7d557e2abfe4
-  data.tar.gz: 4c4b0b03ce3b510a0ad6423c30a76fc778463afe92f992da52b49bbe65c7a1ac
+  metadata.gz: c6e34fc6f5c19637ceda0a196039c186fea4e0b6959c1d99d6d13260854cf0fd
+  data.tar.gz: c582b95f3b8e9851015bd8555a8d6b5a1e9d9d9f4cec1e66357ea328963b765e
 SHA512:
-  metadata.gz: b3f81d2d54e5f7a7170c34e7666f58c7f4f77b993ff3b95263327b0ff8edff5c9a0b1a6ea825ece5b43c5b1d2b91a6f01764237f22ee6442bd8c747de8e04150
-  data.tar.gz: 3e49064459345dbcc5d97fef0f8154159776e8361cb0709e8a4564f32dd062fe95b6e4f08976df81b5ac478a40287be9a33086726444af3c75d1cbeb5c869dc2
+  metadata.gz: 00a16bb85b40a0e8ca072e1afaac2723f9bd845d28c4ea495c8c9fab0e4bad40c2f2b6cbe2875cdec97fcb8a0ad0a1f53a357c479e838bb873debba49e8de8f5
+  data.tar.gz: ae74b4e1506d658d770c3667f45043e3f999d10bce0700e48a40c0cfcc1d07ce7d40e4a77e8b51ea7b65dbaecc2b131a9793b124e064c9e5448ee50e5c16808e

data/Changes

@@ -1,5 +1,45 @@
 Change history of write_xlsx rubygem.
 
+2021-11-26 v1.09.0
+
+    Added support for background images in worksheets. See set_background().
+
+    Added support for GIF image files (and in Excel 365, animated GIF files).
+
+    Added support for pixel sizing in set_row() and set_column() via new
+    functions called set_row_pixels() and set_column_pixels().
+
+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/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.07](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.07)
+[Excel::Writer::XLSX-1.09](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.09)
 
 ## Description
 

data/examples/background.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# An example of setting a worksheet background image with Excel::Writer::XLSX.
+#
+# Copyright 2000-2021, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
+#
+
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('background.xlsx')
+worksheet = workbook.add_worksheet
+
+worksheet.set_background('republic.png')
+
+workbook.close

data/examples/ignore_errors.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+##############################################################################
+#
+# An example of turning off worksheet cells errors/warnings using the
+# Excel::Writer::XLSX module.
+#
+# Copyright 2000-2021, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
+#
+
+require 'write_xlsx'
+
+workbook = WriteXLSX.new('ignore_errors.xlsx')
+worksheet = workbook.add_worksheet
+
+# Write strings that looks like numbers. This will cause an Excel warning.
+worksheet.write_string('C2', '123')
+worksheet.write_string('C3', '123')
+
+# Write a divide by zero formula. This will also cause an Excel warning.
+worksheet.write_formula('C5', '=1/0')
+worksheet.write_formula('C6', '=1/0')
+
+# Turn off some of the warnings:
+worksheet.ignore_errors(
+  :number_stored_as_text => 'C3',
+  :eval_error => 'C6'
+)
+
+# Write some descriptions for the cells and make the column wider for clarity.
+worksheet.set_column('B:B', 16)
+worksheet.write('B2', 'Warning:')
+worksheet.write('B3', 'Warning turned off:')
+worksheet.write('B5', 'Warning:')
+worksheet.write('B6', 'Warning turned off:')
+
+workbook.close

data/lib/write_xlsx/chart/axis.rb

@@ -87,8 +87,8 @@ module Writexlsx
 
       def num_fmt_attributes
         [
-         ['formatCode',   @num_format],
-         ['sourceLinked', source_linked]
+          ['formatCode',   @num_format],
+          ['sourceLinked', source_linked]
         ]
       end
 
@@ -175,7 +175,7 @@ module Writexlsx
           if @position_axis == 'on_tick'
             @position_axis = 'midCat'
           elsif @position_axis == 'between'
-            # Doesn't neet to be modified.
+          # Doesn't neet to be modified.
           else
             # Otherwise use the default value.
             @position_axis = nil

data/lib/write_xlsx/chart/scatter.rb

@@ -17,21 +17,6 @@ require 'write_xlsx/utility'
 
 module Writexlsx
   class Chart
-    # The Scatter chart module also supports the following sub-types:
-    #
-    #     markers_only (the default)
-    #     straight_with_markers
-    #     straight
-    #     smooth_with_markers
-    #     smooth
-    # These can be specified at creation time via the add_chart() Worksheet
-    # method:
-    #
-    #     chart = workbook.add_chart(
-    #         :type    => 'scatter',
-    #         :subtype => 'straight_with_markers'
-    #     )
-    #
     class Scatter < self
       include Writexlsx::Utility
       include Writexlsx::WriteDPtPoint

data/lib/write_xlsx/chart/series.rb

@@ -192,7 +192,7 @@ module Writexlsx
         @values     = aref_to_formula(params[:values])
         @categories = aref_to_formula(params[:categories])
         @name, @name_formula =
-          chart.process_names(params[:name], params[:name_formula])
+               chart.process_names(params[:name], params[:name_formula])
 
         set_data_ids(params)
 

data/lib/write_xlsx/chart.rb

@@ -165,16 +165,16 @@ module Writexlsx
     include Writexlsx::Utility
     include Writexlsx::Gradient
 
-    attr_accessor :id, :name   # :nodoc:
-    attr_writer :index, :palette, :protection   # :nodoc:
-    attr_reader :embedded, :formula_ids, :formula_data   # :nodoc:
-    attr_reader :x_scale, :y_scale, :x_offset, :y_offset # :nodoc:
-    attr_reader :width, :height  # :nodoc:
+    attr_accessor :id, :name                                         # :nodoc:
+    attr_writer :index, :palette, :protection                        # :nodoc:
+    attr_reader :embedded, :formula_ids, :formula_data               # :nodoc:
+    attr_reader :x_scale, :y_scale, :x_offset, :y_offset             # :nodoc:
+    attr_reader :width, :height                                      # :nodoc:
     attr_reader :label_positions, :label_position_default, :combined # :nodoc:
-    attr_writer :date_category, :already_inserted
-    attr_writer :series_index
-    attr_writer :writer
-    attr_reader :x2_axis, :y2_axis, :axis2_ids
+    attr_writer :date_category, :already_inserted                    # :nodoc:
+    attr_writer :series_index                                        # :nodoc:
+    attr_writer :writer                                              # :nodoc:
+    attr_reader :x2_axis, :y2_axis, :axis2_ids                       # :nodoc:
 
     #
     # Factory method for returning chart objects based on their class type.
@@ -1057,7 +1057,7 @@ module Writexlsx
     end
 
     def write_val_base(formula, data_id, tag) # :nodoc:
-      data    = @formula_data[data_id]
+      data = @formula_data[data_id]
 
       @writer.tag_elements(tag) do
         # Unlike Cat axes data should only be numeric.
@@ -1397,7 +1397,7 @@ module Writexlsx
 
     def write_crossing(crossing)
       # Note, the category crossing comes from the value axis.
-      if nil_or_max?(crossing)
+      if [nil, 'max', 'min'].include?(crossing)
         # Write the c:crosses element.
         write_crosses(crossing)
       else
@@ -1408,11 +1408,11 @@ module Writexlsx
 
     def write_scaling_with_param(param)
       write_scaling(
-                    param.reverse,
-                    param.min,
-                    param.max,
-                    param.log_base
-                    )
+        param.reverse,
+        param.min,
+        param.max,
+        param.log_base
+      )
     end
     #
     # Write the <c:scaling> element.
@@ -1443,7 +1443,7 @@ module Writexlsx
     # Write the <c:orientation> element.
     #
     def write_orientation(reverse = nil) # :nodoc:
-      val     = ptrue?(reverse) ? 'maxMin' : 'minMax'
+      val = ptrue?(reverse) ? 'maxMin' : 'minMax'
 
       @writer.empty_tag('c:orientation', [ ['val', val] ])
     end
@@ -1499,9 +1499,9 @@ module Writexlsx
       source_linked = 0
 
       attributes = [
-                    ['formatCode',   format_code],
-                    ['sourceLinked', source_linked]
-                   ]
+        ['formatCode',   format_code],
+        ['sourceLinked', source_linked]
+      ]
 
       @writer.empty_tag('c:numFmt', attributes)
     end
@@ -1778,13 +1778,13 @@ module Writexlsx
       footer = 0.3
 
       attributes = [
-                    ['b',      b],
-                    ['l',      l],
-                    ['r',      r],
-                    ['t',      t],
-                    ['header', header],
-                    ['footer', footer]
-                   ]
+        ['b',      b],
+        ['l',      l],
+        ['r',      r],
+        ['t',      t],
+        ['header', header],
+        ['footer', footer]
+      ]
 
       @writer.empty_tag('c:pageMargins', attributes)
     end
@@ -2272,7 +2272,7 @@ module Writexlsx
         data.each_with_index do |token, i|
           # Write non-numeric data as 0.
           if token &&
-              !(token.to_s =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/)
+             !(token.to_s =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/)
             token = 0
           end
 
@@ -2418,12 +2418,14 @@ module Writexlsx
           elsif label[:formula]
             write_custom_label_formula(label)
 
+            write_d_lbl_pos(parent[:position]) if parent[:position]
             write_show_val      if parent[:value]
             write_show_cat_name if parent[:category]
             write_show_ser_name if parent[:series_name]
           elsif label[:value]
             write_custom_label_str(label)
 
+            write_d_lbl_pos(parent[:position]) if parent[:position]
             write_show_val      if parent[:value]
             write_show_cat_name if parent[:category]
             write_show_ser_name if parent[:series_name]
@@ -2701,7 +2703,7 @@ module Writexlsx
     end
 
     def write_num_ref_or_lit(values, data)
-      if values.to_s =~ /^=/                     # '=Sheet1!$A$1:$A$5'
+      if values.to_s =~ /^=/                # '=Sheet1!$A$1:$A$5'
         write_num_ref(values, data, 'num')
       else                                  # [1, 2, 3]
         write_num_lit(values)
@@ -2926,9 +2928,5 @@ module Writexlsx
         @writer.empty_tag(tag)
       end
     end
-
-    def nil_or_max?(val)  # :nodoc:
-      val.nil? || val == 'max'
-    end
   end
 end

data/lib/write_xlsx/chartsheet.rb

@@ -204,9 +204,9 @@ module Writexlsx
       mc_preserve_attributes = 'mv:*'
 
       attributes = [
-                    ['xmlns',   xmlns],
-                    ['xmlns:r', xmlns_r]
-                   ]
+        ['xmlns',   xmlns],
+        ['xmlns:r', xmlns_r]
+      ]
 
       @writer.tag_elements('chartsheet', attributes) do
         yield

data/lib/write_xlsx/drawing.rb

@@ -5,11 +5,11 @@ require 'write_xlsx/utility'
 module Writexlsx
   class Drawing
     attr_accessor :type, :dimensions, :width, :height, :description, :shape, :anchor, :rel_index, :url_rel_index
-    attr_reader :tip
+    attr_reader :tip, :decorative
 
-    def initialize(type, dimensions, width, height, description, shape, anchor, rel_index = nil, url_rel_index = nil, tip = nil)
-      @type, @dimensions, @width, @height, @description, @shape, @anchor, @rel_index, @url_rel_index, @tip =
-        type, dimensions, width, height, description, shape, anchor, rel_index, url_rel_index, tip
+    def initialize(type, dimensions, width, height, description, shape, anchor, rel_index = nil, url_rel_index = nil, tip = nil, decorative = nil)
+      @type, @dimensions, @width, @height, @description, @shape, @anchor, @rel_index, @url_rel_index, @tip, @decorative =
+                                                                                                            type, dimensions, width, height, description, shape, anchor, rel_index, url_rel_index, tip, decorative
     end
   end
 
@@ -70,8 +70,8 @@ module Writexlsx
     def write_drawing_workspace
       schema    = 'http://schemas.openxmlformats.org/drawingml/'
       attributes = [
-          ['xmlns:xdr', "#{schema}2006/spreadsheetDrawing"],
-          ['xmlns:a',    "#{schema}2006/main"]
+        ['xmlns:xdr', "#{schema}2006/spreadsheetDrawing"],
+        ['xmlns:a',    "#{schema}2006/main"]
       ]
 
       @writer.tag_elements('xdr:wsDr', attributes) { yield }
@@ -92,6 +92,7 @@ module Writexlsx
       rel_index     = drawing.rel_index
       url_rel_index = drawing.url_rel_index
       tip           = drawing.tip
+      decorative    = drawing.decorative
 
       col_from, row_from, col_from_offset, row_from_offset,
       col_to, row_to, col_to_offset, row_to_offset, col_absolute, row_absolute = drawing.dimensions
@@ -124,7 +125,7 @@ module Writexlsx
           write_pic(
             index,        rel_index,      col_absolute,
             row_absolute, width,          height,
-            description,  url_rel_index , tip
+            description,  url_rel_index , tip, decorative
           )
         else
           # Write the xdr:sp element for shapes.
@@ -148,13 +149,13 @@ module Writexlsx
           write_pos(0, 0)
 
           # Write the xdr:ext element.
-          write_ext(9308969, 6078325)
+          write_xdr_ext(9308969, 6078325)
         else
           # Write the xdr:pos element.
           write_pos(0, -47625)
 
           # Write the xdr:ext element.
-          write_ext(6162675, 6124575)
+          write_xdr_ext(6162675, 6124575)
         end
 
         # Write the xdr:graphicFrame element.
@@ -165,7 +166,7 @@ module Writexlsx
       end
     end
 
-      #
+    #
     # Write the <xdr:from> element.
     #
     def write_from(col, row, col_offset, row_offset)
@@ -242,7 +243,7 @@ module Writexlsx
     #
     # Write the <xdr:ext> element.
     #
-    def write_ext(cx, cy)
+    def write_xdr_ext(cx, cy)
       attributes = [
         ['cx', cx],
         ['cy', cy]
@@ -286,19 +287,25 @@ module Writexlsx
     #
     # Write the <xdr:cNvPr> element.
     #
-    def write_c_nv_pr(index, name, description = nil, url_rel_index = nil, tip = nil)
+    def write_c_nv_pr(index, name, description = nil, url_rel_index = nil, tip = nil, decorative = nil)
       attributes = [
         ['id',   index],
         ['name', name]
       ]
 
       # Add description attribute for images.
-      attributes << ['descr', description] if description
+      attributes << ['descr', description] if ptrue?(description) && !ptrue?(decorative)
 
-      if ptrue?(url_rel_index)
+      if ptrue?(url_rel_index) || ptrue?(decorative)
         @writer.tag_elements('xdr:cNvPr', attributes) do
-          # Write the a:hlinkClick element.
-          write_a_hlink_click(url_rel_index, tip)
+          if ptrue?(url_rel_index)
+            # Write the a:hlinkClick element.
+            write_a_hlink_click(url_rel_index, tip)
+          end
+          if ptrue?(decorative)
+            # Write the adec:decorative element.
+            write_decorative
+          end
         end
       else
         @writer.empty_tag('xdr:cNvPr', attributes)
@@ -323,6 +330,62 @@ module Writexlsx
       @writer.empty_tag('a:hlinkClick', attributes)
     end
 
+    #
+    # Write the <adec:decorative> element.
+    #
+    def write_decorative
+      @writer.tag_elements('a:extLst') do
+        write_a_uri_ext('{FF2B5EF4-FFF2-40B4-BE49-F238E27FC236}')
+        write_a16_creation_id
+        @writer.end_tag('a:ext')
+
+        write_a_uri_ext('{C183D7F6-B498-43B3-948B-1728B52AA6E4}')
+        write_adec_decorative
+        @writer.end_tag('a:ext')
+      end
+    end
+
+    #
+    # Write the <a:ext> element.
+    #
+    def write_a_uri_ext(uri)
+      attributes = [
+        ['uri', uri]
+      ]
+
+      @writer.start_tag('a:ext', attributes)
+    end
+
+    #
+    # Write the <adec:decorative> element.
+    #
+    def write_adec_decorative
+      xmlns_adec = 'http://schemas.microsoft.com/office/drawing/2017/decorative'
+      val        = 1
+
+      attributes = [
+        ['xmlns:adec', xmlns_adec],
+        ['val',        val]
+      ]
+
+      @writer.empty_tag('adec:decorative', attributes)
+    end
+
+    #
+    # Write the <a16:creationId> element.
+    #
+    def write_a16_creation_id
+      xmlns_a_16 = 'http://schemas.microsoft.com/office/drawing/2014/main'
+      id         = '{00000000-0008-0000-0000-000002000000}'
+
+      attributes = [
+        ['xmlns:a16', xmlns_a_16],
+        ['id',        id]
+      ]
+
+      @writer.empty_tag('a16:creationId', attributes)
+    end
+
     #
     # Write the <xdr:cNvGraphicFramePr> element.
     #
@@ -424,9 +487,9 @@ module Writexlsx
 
 
       attributes = [
-                    ['xmlns:c', xmlns_c],
-                    ['xmlns:r', xmlns_r]
-                   ]
+        ['xmlns:c', xmlns_c],
+        ['xmlns:r', xmlns_r]
+      ]
       attributes << r_id_attributes(id)
 
       @writer.empty_tag('c:chart', attributes)
@@ -456,9 +519,9 @@ module Writexlsx
       else
         # Add attribute for shapes.
         attributes = [
-                      [:macro, ''],
-                      [:textlink, '']
-                     ]
+          [:macro, ''],
+          [:textlink, '']
+        ]
         @writer.tag_elements('xdr:sp', attributes) do
 
           # Write the xdr:nvSpPr element.
@@ -491,17 +554,17 @@ module Writexlsx
 
           if shape.start
             attributes = [
-                          ['id', shape.start],
-                          ['idx', shape.start_index]
-                         ]
+              ['id', shape.start],
+              ['idx', shape.start_index]
+            ]
             @writer.empty_tag('a:stCxn', attributes)
           end
 
           if shape.end
             attributes = [
-                          ['id', shape.end],
-                          ['idx', shape.end_index]
-                         ]
+              ['id', shape.end],
+              ['idx', shape.end_index]
+            ]
             @writer.empty_tag('a:endCxn', attributes)
           end
         end
@@ -527,10 +590,10 @@ module Writexlsx
     #
     # Write the <xdr:pic> element.
     #
-    def write_pic(index, rel_index, col_absolute, row_absolute, width, height, description, url_rel_index, tip)
+    def write_pic(index, rel_index, col_absolute, row_absolute, width, height, description, url_rel_index, tip, decorative)
       @writer.tag_elements('xdr:pic') do
         # Write the xdr:nvPicPr element.
-        write_nv_pic_pr(index, rel_index, description, url_rel_index, tip)
+        write_nv_pic_pr(index, rel_index, description, url_rel_index, tip, decorative)
         # Write the xdr:blipFill element.
         write_blip_fill(rel_index)
 
@@ -546,12 +609,12 @@ module Writexlsx
     #
     # Write the <xdr:nvPicPr> element.
     #
-    def write_nv_pic_pr(index, rel_index, description, url_rel_index, tip)
+    def write_nv_pic_pr(index, rel_index, description, url_rel_index, tip, decorative)
       @writer.tag_elements('xdr:nvPicPr') do
         # Write the xdr:cNvPr element.
         write_c_nv_pr(
           index + 1, "Picture #{index}", description,
-          url_rel_index, tip
+          url_rel_index, tip, decorative
         )
         # Write the xdr:cNvPicPr element.
         write_c_nv_pic_pr
@@ -745,9 +808,9 @@ module Writexlsx
             adj_int = (adj * 1000).to_i
 
             attributes = [
-                          [:name, "adj#{suffix}"],
-                          [:fmla, "val #{adj_int}"]
-                         ]
+              [:name, "adj#{suffix}"],
+              [:fmla, "val #{adj_int}"]
+            ]
             @writer.empty_tag('a:gd', attributes)
           end
         end
@@ -804,15 +867,15 @@ module Writexlsx
     #
     def write_tx_body(shape)
       attributes = [
-                    [:vertOverflow, "clip"],
-                    [:wrap,         "square"],
-                    [:lIns,         "27432"],
-                    [:tIns,         "22860"],
-                    [:rIns,         "27432"],
-                    [:bIns,         "22860"],
-                    [:anchor,       shape.valign],
-                    [:upright,      "1"]
-                   ]
+        [:vertOverflow, "clip"],
+        [:wrap,         "square"],
+        [:lIns,         "27432"],
+        [:tIns,         "22860"],
+        [:rIns,         "27432"],
+        [:bIns,         "22860"],
+        [:anchor,       shape.valign],
+        [:upright,      "1"]
+      ]
       @writer.tag_elements('xdr:txBody') do
         @writer.empty_tag('a:bodyPr', attributes)
         @writer.empty_tag('a:lstStyle')
@@ -822,9 +885,9 @@ module Writexlsx
           rotation *= 60000
 
           attributes = [
-                        [:algn, shape.align],
-                        [:rtl, rotation]
-                       ]
+            [:algn, shape.align],
+            [:rtl, rotation]
+          ]
           @writer.tag_elements('a:pPr', attributes) do
             attributes = [ [:sz, "1000"] ]
             @writer.empty_tag('a:defRPr', attributes)
@@ -840,14 +903,14 @@ module Writexlsx
             strike    = ptrue?(shape.format[:font_strikeout]) ? 'Strike' : 'noStrike'
 
             attributes = [
-                          [:lang,     "en-US"],
-                          [:sz,       size],
-                          [:b,        bold],
-                          [:i,        italic],
-                          [:u,        underline],
-                          [:strike,   strike],
-                          [:baseline, 0]
-                         ]
+              [:lang,     "en-US"],
+              [:sz,       size],
+              [:b,        bold],
+              [:i,        italic],
+              [:u,        underline],
+              [:strike,   strike],
+              [:baseline, 0]
+            ]
             @writer.tag_elements('a:rPr', attributes) do
               color = shape.format[:color]
               if color