write_xlsx 0.90.0 → 0.97.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94c163c93be013a57cc4a4edba4cea1ac35f91ecbed56443d535fa1d6e1a464f
-  data.tar.gz: 29fecf270f9b3382e0adae5f9f8ffd3b15ca97a84fc9da8bc24d0402de9a7ce7
+  metadata.gz: d1ecd38fb615885768458a04b082d759437fbaf7fb2e07900cc558d18e400e51
+  data.tar.gz: d1fa5e1696685c9bba199b4ee922c488144f5a2f852644e24fcedd38fed29035
 SHA512:
-  metadata.gz: da03548ba5d54019f9a69b2aa6ca70042b4d27824d784996ebdd7109f8c54626609f007d099acffb8a0d09448d5fdd2ea49e491e729b2b075d2e142fd0b36dc7
-  data.tar.gz: ba23f9b7be254784821b0bae59134bfa53a1cb2afa22e21576a054c718532f34753701d001d46f52871d770db0af4a6027705c22d28c18f658eb082b49172eeb
+  metadata.gz: 1162adaf9f347ef7f9e986b0596877edc9a4e059b1055e5913c576583017af41b78710c44252c2ced77b06dcdd818af269f3c98282e9bc767f211237e8313fac
+  data.tar.gz: cd4eb41156f364e4685487ae32876d8b35d7907f7f7068442fb22d2afc6a24217794bea5e571720d6db14b80b7c7368ac08502071d5290cc696cd80588901cdd

data/Changes

@@ -1,5 +1,42 @@
 Change history of write_xlsx rubygem.
 
+2021-01-02 v0.97.0
+
+   Added Excel 2010 data bar features such as solid fills and control over
+   the display of negative values.
+
+   Added default formatting for hyperlinks if none is specified. The format
+   is the Excel hyperlink style so links change colour after they are
+   clicked.
+
+   Fixed missing plotarea formatting in pie/doughnut charts.
+
+2020-12-31 v0.96.0
+
+   Added icon sets to conditional formatting.
+
+2020-12-30 v0.95.0
+
+   Added workbook set_size() method.
+
+2020-12-30 v0.94.0
+
+   Added font support to chart tables.
+
+2020-12-30 v0.93.0
+
+   Added trendline properties: intercept, display_equation and
+   display_r_squared.
+
+2020-12-30 v0.92.0
+
+   Fix for insert_image issue when handling images with zero dpi.
+
+2020-12-30 v0.91.0
+
+   Add set_custom_property() workbook method to set custom document
+   properties.
+
 2020-12-28 v0.90.0
 
    Added worksheet_by_name() workbook method to retrieve a worksheet

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

data/examples/a_simple.rb

@@ -34,11 +34,6 @@
 worksheet.write(8, 0, '=IF(A5>3,"Yes", "No")')
 
 # Write a hyperlink
-hyperlink_format = workbook.add_format(
-                     :color     => 'blue',
-                     :underline => 1
-                                      )
-
-worksheet.write(10, 0, 'http://www.ruby-lang.org/', hyperlink_format)
+worksheet.write(10, 0, 'http://www.ruby-lang.org/')
 
 workbook.close

data/examples/conditional_format.rb

@@ -26,12 +26,6 @@
     :color    => '#006100'
 )
 
-# Blue fill with dark blue text.
-format3 = workbook.add_format(
-    :bg_color => '#C6CEFF',
-    :color    => '#0000FF'
-)
-
 # Some sample data to run the conditional formatting against.
 data = [
     [ 34, 72,  38, 30, 75, 48, 75, 66, 84, 86 ],
@@ -226,19 +220,18 @@
 #
 caption = 'Examples of color scales and data bars. Default colors.'
 
-# Use different sample data for examples 7 and 8
-data7 = 1 .. 12
+data = 1 .. 12
 
 worksheet7.write('A1', caption)
 
 worksheet7.write('B2', "2 Color Scale")
-worksheet7.write_col('B3', data7)
+worksheet7.write_col('B3', data)
 
 worksheet7.write('D2', "3 Color Scale")
-worksheet7.write_col('D3', data7)
+worksheet7.write_col('D3', data)
 
 worksheet7.write('F2', "Data Bars")
-worksheet7.write_col('F3', data7)
+worksheet7.write_col('F3', data)
 
 
 worksheet7.conditional_formatting('B3:B14',
@@ -266,16 +259,18 @@
 #
 caption = 'Examples of color scales and data bars. Modified colors.'
 
+data = 1..12
+
 worksheet8.write('A1', caption)
 
 worksheet8.write('B2', "2 Color Scale")
-worksheet8.write_col('B3', data7)
+worksheet8.write_col('B3', data)
 
 worksheet8.write('D2', "3 Color Scale")
-worksheet8.write_col('D3', data7)
+worksheet8.write_col('D3', data)
 
 worksheet8.write('F2', "Data Bars")
-worksheet8.write_col('F3', data7)
+worksheet8.write_col('F3', data)
 
 
 worksheet8.conditional_formatting('B3:B14',
@@ -304,47 +299,79 @@
 
 ###############################################################################
 #
-# Example 9
+# Example 9.
 #
-caption = 'Cells with values >= 100 are always in blue. ' +
-  'Otherwise, cells with values >= 50 are in light red ' +
-  'and values < 50 are in light green.'
+caption = 'Examples of conditional formats with icon sets.'
+
+data = [
+  [1, 2, 3],
+  [1, 2, 3],
+  [1, 2, 3],
+  [1, 2, 3],
+  [1, 2, 3, 4],
+  [1, 2, 3, 4, 5],
+  [1, 2, 3, 4, 5]
+]
 
-# Write the data.
 worksheet9.write('A1', caption)
 worksheet9.write_col('B3', data)
 
-# Write a conditional format over a range.
-# Use stopIfTrue to prevent previous formats from being used
-# if the conditions of this format are met.
-worksheet9.conditional_formatting('B3:K12',
-    {
-        :type         => 'cell',
-        :criteria     => '>=',
-        :value        => 100,
-        :format       => format3,
-        :stop_if_true => 1
-    }
+worksheet9.conditional_formatting(
+  'B3:D3',
+  {
+    :type       => 'icon_set',
+    :icon_style => '3_traffic_lights'
+  }
 )
 
-# Write another conditional format over the same range.
-worksheet9.conditional_formatting('B3:K12',
-    {
-        :type     => 'cell',
-        :criteria => '>=',
-        :value    => 50,
-        :format   => format1
-    }
+worksheet9.conditional_formatting(
+  'B4:D4',
+  {
+    :type          => 'icon_set',
+    :icon_style    => '3_traffic_lights',
+    :reverse_icons => 1
+  }
 )
 
-# Write another conditional format over the same range.
-worksheet9.conditional_formatting('B3:K12',
-    {
-        :type     => 'cell',
-        :criteria => '<',
-        :value    => 50,
-        :format   => format2
-    }
+worksheet9.conditional_formatting(
+  'B5:D5',
+  {
+    :type        => 'icon_set',
+    :icon_style  => '3_traffic_lights',
+    :icons_only  => 1
+  }
+)
+
+worksheet9.conditional_formatting(
+  'B6:D6',
+  {
+    :type        => 'icon_set',
+    :icon_style  => '3_arrows'
+  }
+)
+
+worksheet9.conditional_formatting(
+  'B7:E8',
+  {
+    :type        => 'icon_set',
+    :icon_style  => '4_arrows'
+  }
+)
+
+worksheet9.conditional_formatting(
+  'B8:F8',
+  {
+    :type        => 'icon_set',
+    :icon_style  => '5_arrows'
+  }
+)
+
+worksheet9.conditional_formatting(
+  'B9:F9',
+  {
+    :type        => 'icon_set',
+    :icon_style  => '5_ratings'
+  }
 )
 
 workbook.close

data/examples/demo.rb

@@ -27,11 +27,6 @@
     :align => 'vcenter'
 )
 
-hyperlink_format = workbook.add_format(
-    :color => 'blue',
-    :underline => 1
-)
-
 headings = ['Features of WriteXLSX', '']
 worksheet.write_row('A1', headings, heading)
 
@@ -81,7 +76,7 @@
 # Hyperlinks
 #
 worksheet.write('A9', "Hyperlinks")
-worksheet.write('B9', 'http://www.ruby-lang.org/', hyperlink_format)
+worksheet.write('B9', 'http://www.ruby-lang.org/')
 
 #######################################################################
 #
@@ -99,4 +94,3 @@
 worksheet.write('A19', "Multiple worksheets")
 
 workbook.close
-

data/examples/hyperlink1.rb

@@ -22,13 +22,6 @@
 worksheet.set_column('A:A', 30)
 worksheet.set_selection('B1')
 
-
-# Add the standard url link format.
-url_format = workbook.add_format(
-    :color     => 'blue',
-    :underline => 1
-)
-
 # Add a sample format.
 red_format = workbook.add_format(
     :color     => 'red',
@@ -45,11 +38,11 @@
 
 
 # Write some hyperlinks
-worksheet.write('A1', 'http://www.perl.com/', url_format)
-worksheet.write('A3', 'http://www.perl.com/', url_format, str)
-worksheet.write('A5', 'http://www.perl.com/', url_format, str, tip)
+worksheet.write('A1', 'http://www.perl.com/')
+worksheet.write('A3', 'http://www.perl.com/', nil, str)
+worksheet.write('A5', 'http://www.perl.com/', nil, str, tip)
 worksheet.write('A7', 'http://www.perl.com/', red_format)
-worksheet.write('A9', 'mailto:jmcnamara@cpan.org', url_format, 'Mail me')
+worksheet.write('A9', 'mailto:jmcnamara@cpan.org', nil, 'Mail me')
 
 # Write a URL that isn't a hyperlink
 worksheet.write_string('A11', 'http://www.perl.com/')

data/lib/write_xlsx/chart.rb

@@ -10,7 +10,7 @@ module Writexlsx
   class Table
     include Writexlsx::Utility
 
-    attr_reader :horizontal, :vertical, :outline, :show_keys
+    attr_reader :horizontal, :vertical, :outline, :show_keys, :font
 
     def initialize(params = {})
       @horizontal, @vertical, @outline, @show_keys = true, true, true, false
@@ -18,14 +18,22 @@ def initialize(params = {})
       @vertical   = params[:vertical]   if params.has_key?(:vertical)
       @outline    = params[:outline]    if params.has_key?(:outline)
       @show_keys  = params[:show_keys]  if params.has_key?(:show_keys)
+      @font       = convert_font_args(params[:font])
+    end
+
+    def palette=(palette)
+      @palette = palette
     end
 
     def write_d_table(writer)
-      writer.tag_elements('c:dTable') do
-        writer.empty_tag('c:showHorzBorder', attributes) if ptrue?(horizontal)
-        writer.empty_tag('c:showVertBorder', attributes) if ptrue?(vertical)
-        writer.empty_tag('c:showOutline',    attributes) if ptrue?(outline)
-        writer.empty_tag('c:showKeys',       attributes) if ptrue?(show_keys)
+      @writer = writer
+      @writer.tag_elements('c:dTable') do
+        @writer.empty_tag('c:showHorzBorder', attributes) if ptrue?(horizontal)
+        @writer.empty_tag('c:showVertBorder', attributes) if ptrue?(vertical)
+        @writer.empty_tag('c:showOutline',    attributes) if ptrue?(outline)
+        @writer.empty_tag('c:showKeys',       attributes) if ptrue?(show_keys)
+        # Write the table font.
+        write_tx_pr(nil, font)                            if ptrue?(font)
       end
     end
 
@@ -264,6 +272,10 @@ def add_series(params)
         raise  "Must specify ':categories' in add_series for this chart type"
       end
 
+      if @series.size == 255
+        raise "The maximum number of series that can be added to an Excel Chart is 255."
+      end
+
       @series << Series.new(self, params)
 
       # Set the secondary axis properties.
@@ -417,6 +429,7 @@ def set_size(params = {})
     #
     def set_table(params = {})
       @table = Table.new(params)
+      @table.palette = @palette
     end
 
     #
@@ -517,39 +530,6 @@ def write_bar_chart(params)   # :nodoc:
       end
     end
 
-    #
-    # Convert user defined font values into private hash values.
-    #
-    def convert_font_args(params)
-      return unless params
-      font = params_to_font(params)
-
-      # Convert font size units.
-      font[:_size] *= 100 if font[:_size] && font[:_size] != 0
-
-      # Convert rotation into 60,000ths of a degree.
-      if ptrue?(font[:_rotation])
-        font[:_rotation] = 60_000 * font[:_rotation].to_i
-      end
-
-      font
-    end
-
-    def params_to_font(params)
-      {
-        :_name         => params[:name],
-        :_color        => params[:color],
-        :_size         => params[:size],
-        :_bold         => params[:bold],
-        :_italic       => params[:italic],
-        :_underline    => params[:underline],
-        :_pitch_family => params[:pitch_family],
-        :_charset      => params[:charset],
-        :_baseline     => params[:baseline] || 0,
-        :_rotation     => params[:rotation]
-      }
-    end
-
     #
     # Switch name and name_formula parameters if required.
     #
@@ -672,20 +652,6 @@ def get_data_type(data) # :nodoc:
       'num'
     end
 
-    #
-    # Convert the user specified colour index or string to a rgb colour.
-    #
-    def color(color_code) # :nodoc:
-      if color_code and color_code =~ /^#[0-9a-fA-F]{6}$/
-        # Convert a HTML style #RRGGBB color.
-        color_code.sub(/^#/, '').upcase
-      else
-        index = Format.color(color_code)
-        raise "Unknown color '#{color_code}' used in chart formatting." unless index
-        palette_color(index)
-      end
-    end
-
     #
     # Returns series which use the primary axes.
     #
@@ -723,38 +689,6 @@ def ids
       [id1, id2]
     end
 
-    #
-    # Get the font style attributes from a font hash.
-    #
-    def get_font_style_attributes(font)
-      return [] unless font
-
-      attributes = []
-      attributes << ['sz', font[:_size]]      if ptrue?(font[:_size])
-      attributes << ['b',  font[:_bold]]      if font[:_bold]
-      attributes << ['i',  font[:_italic]]    if font[:_italic]
-      attributes << ['u',  'sng']             if font[:_underline]
-
-      # Turn off baseline when testing fonts that don't have it.
-      if font[:_baseline] != -1
-        attributes << ['baseline', font[:_baseline]]
-      end
-      attributes
-    end
-
-    #
-    # Get the font latin attributes from a font hash.
-    #
-    def get_font_latin_attributes(font)
-      return [] unless font
-
-      attributes = []
-      attributes << ['typeface', font[:_name]]            if ptrue?(font[:_name])
-      attributes << ['pitchFamily', font[:_pitch_family]] if font[:_pitch_family]
-      attributes << ['charset', font[:_charset]]          if font[:_charset]
-
-      attributes
-    end
     #
     # Setup the default properties for a chart.
     #
@@ -1938,26 +1872,6 @@ def write_rich(title, horiz) # :nodoc:
         write_a_p_rich(title)
       end
     end
-
-    #
-    # Write the <a:bodyPr> element.
-    #
-    def write_a_body_pr(rot, horiz = nil) # :nodoc:
-      rot = -5400000 if !rot && ptrue?(horiz)
-      attributes = []
-      attributes << ['rot',  rot]   if rot
-      attributes << ['vert', 'horz'] if ptrue?(horiz)
-
-      @writer.empty_tag('a:bodyPr', attributes)
-    end
-
-    #
-    # Write the <a:lstStyle> element.
-    #
-    def write_a_lst_style # :nodoc:
-      @writer.empty_tag('a:lstStyle')
-    end
-
     #
     # Write the <a:p> element for rich string titles.
     #
@@ -1970,18 +1884,6 @@ def write_a_p_rich(title) # :nodoc:
       end
     end
 
-    #
-    # Write the <a:p> element for formula titles.
-    #
-    def write_a_p_formula(font = nil) # :nodoc:
-      @writer.tag_elements('a:p') do
-        # Write the a:pPr element.
-        write_a_p_pr_formula(font)
-        # Write the a:endParaRPr element.
-        write_a_end_para_rpr
-      end
-    end
-
     #
     # Write the <a:pPr> element for rich string titles.
     #
@@ -1989,30 +1891,6 @@ def write_a_p_pr_rich(font) # :nodoc:
       @writer.tag_elements('a:pPr') { write_a_def_rpr(font) }
     end
 
-    #
-    # Write the <a:pPr> element for formula titles.
-    #
-    def write_a_p_pr_formula(font) # :nodoc:
-      @writer.tag_elements('a:pPr') { write_a_def_rpr(font) }
-    end
-
-    #
-    # Write the <a:defRPr> element.
-    #
-    def write_a_def_rpr(font = nil) # :nodoc:
-      write_def_rpr_r_pr_common(
-                                font,
-                                get_font_style_attributes(font),
-                                'a:defRPr')
-    end
-
-    #
-    # Write the <a:endParaRPr> element.
-    #
-    def write_a_end_para_rpr # :nodoc:
-      @writer.empty_tag('a:endParaRPr', [ ['lang', 'en-US'] ])
-    end
-
     #
     # Write the <a:r> element.
     #
@@ -2036,24 +1914,6 @@ def write_a_r_pr(font) # :nodoc:
       write_def_rpr_r_pr_common(font, attributes, 'a:rPr')
     end
 
-    def write_def_rpr_r_pr_common(font, style_attributes, tag)  # :nodoc:
-      latin_attributes = get_font_latin_attributes(font)
-      has_color = ptrue?(font) && ptrue?(font[:_color])
-
-      if !latin_attributes.empty? || has_color
-        @writer.tag_elements(tag, style_attributes) do
-          if has_color
-            write_a_solid_fill(:color => font[:_color])
-          end
-          if !latin_attributes.empty?
-            write_a_latin(latin_attributes)
-          end
-        end
-      else
-        @writer.empty_tag(tag, style_attributes)
-      end
-    end
-
     #
     # Write the <a:t> element.
     #
@@ -2061,24 +1921,6 @@ def write_a_t(title) # :nodoc:
       @writer.data_element('a:t', title)
     end
 
-    #
-    # Write the <c:txPr> element.
-    #
-    def write_tx_pr(horiz, font) # :nodoc:
-      rotation = nil
-      if font && font[:_rotation]
-        rotation = font[:_rotation]
-      end
-      @writer.tag_elements('c:txPr') do
-        # Write the a:bodyPr element.
-        write_a_body_pr(rotation, horiz)
-        # Write the a:lstStyle element.
-        write_a_lst_style
-        # Write the a:p element.
-        write_a_p_formula(font)
-      end
-    end
-
     #
     # Write the <c:marker> element.
     #
@@ -2199,34 +2041,6 @@ def write_a_no_fill # :nodoc:
       @writer.empty_tag('a:noFill')
     end
 
-    #
-    # Write the <a:solidFill> element.
-    #
-    def write_a_solid_fill(fill) # :nodoc:
-      @writer.tag_elements('a:solidFill') do
-        if fill[:color]
-          # Write the a:srgbClr element.
-          write_a_srgb_clr(color(fill[:color]), fill[:transparency])
-        end
-      end
-    end
-
-    #
-    # Write the <a:srgbClr> element.
-    #
-    def write_a_srgb_clr(color, transparency = nil) # :nodoc:
-      tag        = 'a:srgbClr'
-      attributes = [ ['val', color] ]
-
-      if ptrue?(transparency)
-        @writer.tag_elements(tag, attributes) do
-          write_a_alpha(transparency)
-        end
-      else
-        @writer.empty_tag(tag, attributes)
-      end
-     end
-
     #
     # Write the <a:alpha> element.
     #
@@ -2264,6 +2078,20 @@ def write_trendline(trendline) # :nodoc:
         write_forward(trendline.forward)
         # Write the c:backward element.
         write_backward(trendline.backward)
+        if trendline.intercept
+          # Write the c:intercept element.
+          write_intercept(trendline.intercept)
+        end
+        if trendline.display_r_squared
+          # Write the c:dispRSqr element.
+          write_disp_rsqr
+        end
+        if trendline.display_equation
+          # Write the c:dispEq element.
+          write_disp_eq
+          # Write the c:trendlineLbl element.
+          write_trendline_lbl
+        end
       end
     end
 
@@ -2315,6 +2143,54 @@ def write_backward(val) # :nodoc:
       @writer.empty_tag('c:backward', [ ['val', val] ])
     end
 
+    #
+    # Write the <c:intercept> element.
+    #
+    def write_intercept(val)
+      @writer.empty_tag('c:intercept', [ ['val', val] ])
+    end
+
+    #
+    # Write the <c:dispEq> element.
+    #
+    def write_disp_eq
+      @writer.empty_tag('c:dispEq', [ ['val', 1] ])
+    end
+
+    #
+    # Write the <c:dispRSqr> element.
+    #
+    def write_disp_rsqr
+      @writer.empty_tag('c:dispRSqr', [ ['val', 1] ])
+    end
+
+    #
+    # Write the <c:trendlineLbl> element.
+    #
+    def write_trendline_lbl
+      @writer.tag_elements('c:trendlineLbl') do
+        # Write the c:layout element.
+        write_layout
+        # Write the c:numFmt element.
+        write_trendline_num_fmt
+      end
+    end
+
+    #
+    # Write the <c:numFmt> element.
+    #
+    def write_trendline_num_fmt
+      format_code   = 'General'
+      source_linked = 0
+
+      attributes = [
+        ['formatCode',   format_code],
+        ['sourceLinked', source_linked]
+      ]
+
+      @writer.empty_tag('c:numFmt', attributes)
+    end
+
     #
     # Write the <c:hiLowLines> element.
     #