write_xlsx 1.04.0 → 1.08.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c3893d317a3ab9f246b62c9d6b6b3a727abd9ab539da4edf52c4029f076d566
-  data.tar.gz: 64861b9ce57ebd55ce67508b33be19705049a8db520edfacc1fd40d8547c2b9c
+  metadata.gz: 15cfe1d88bbb3b997322aa3d507a8e8960bacd75afd397699a34d71e84162ab8
+  data.tar.gz: 0d5500191ffb1e57645eb6162ae40cfbceddcfe6008704697645a4099da7ba1b
 SHA512:
-  metadata.gz: c3870b13ed05dca60597ecc86662d15d2ec143667e6ff29349c4409d2dd7966eb9f7246f14071a06524a15f5039cb8ec2d4c6c4fb99206b1377f452abe94eddc
-  data.tar.gz: b776541fecba7724e59e5742939e331944ea9a08d87eba2528d29404f9f34bbab8a8abe548fd52735a15c72e42e54c54cc73ad5c06765521647771178229fab0
+  metadata.gz: b5b8b723b22bab86ad2a1fe4527aa94ded8ff95661fc1b23098552774dc6f98cbaf80fdfca5be2e6422810fe9d0fc95748a329aa17770708f40e06112d507fec
+  data.tar.gz: 85f1ee5165c26ddd247b10b19de5ee6e2c07be360211c80316e9259dda928d7ff64052581bbbd8023c2965d8d2449daf1d4a7470c6a7e11d2b4f3f5b67fb4dc1

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,55 @@
 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.

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

@@ -296,10 +296,110 @@ module Writexlsx
           labels[:separator] = separators[separator]
         end
 
+
+        # Set the line properties for the data labels.
+        line = line_properties( labels[:line] )
+
+        # Allow 'border' as a synonym for 'line'.
+        if labels[:border]
+          line = line_properties(labels[:border])
+        end
+
+        # Set the fill properties for the labels.
+        fill = fill_properties(labels[:fill])
+
+        # Set the pattern properties for the labels.
+        pattern = pattern_properties(labels[:pattern])
+
+        # Set the gradient fill properties for the labels.
+        gradient = gradient_properties(labels[:gradient])
+
+        # Pattern fill overrides solid fill.
+        if pattern
+          fill = nil
+        end
+
+        # Gradient fill overrides solid and pattern fills.
+        if gradient
+          pattern = nil
+          fill    = nil
+        end
+
+        labels[:line]     = line
+        labels[:fill]     = fill
+        labels[:pattern]  = pattern
+        labels[:gradient] = gradient
+
         if labels[:font]
           labels[:font] = convert_font_args(labels[:font])
         end
 
+        if labels[:custom]
+          # Duplicate, and modify, the custom label properties.
+          custom = []
+
+          labels[:custom].each do |label|
+            if !label
+              custom << nil
+              next
+            end
+
+            property = label.dup
+
+            # Convert formula.
+            if property[:value] && property[:value] =~ /^=[^!]+!\$/
+              property[:formula] = property[:value]
+            end
+
+            if property[:formula]
+              property[:formula] = property[:formula].sub(/^=/, '')
+
+              data_id = @chart.data_id(property[:formula], property[:data])
+              property[:data_id] = data_id
+            end
+
+            if property[:font]
+              property[:font] = convert_font_args(property[:font])
+            end
+
+            # Allow 'border' as a synonym for 'line'.
+            if property[:border]
+              line = line_properties(property[:border])
+            else
+              # Set the line properties for the data labels.
+              line = line_properties(property[:line])
+            end
+
+            # Set the fill properties for the labels.
+            fill = fill_properties(property[:fill])
+
+            # Set the pattern properties for the labels.
+            pattern = pattern_properties(property[:pattern])
+
+            # Set the gradient fill properties for the labels.
+            gradient = gradient_properties(property[:gradient])
+
+            # Pattern fill overrides solid fill.
+            if pattern
+              fill = nil
+            end
+
+            # Gradient fill overrides solid and pattern fills.
+            if gradient
+              pattern = nil
+              fill    = nil
+            end
+
+            property[:line]     = line
+            property[:fill]     = fill
+            property[:pattern]  = pattern
+            property[:gradient] = gradient
+
+            custom << property
+          end
+          labels[:custom] = custom
+        end
+
         labels
       end
     end