write_xlsx 1.09.5 → 1.10.1

data/examples/tables.rb

@@ -30,7 +30,7 @@ worksheet11 = workbook.add_worksheet
 worksheet12 = workbook.add_worksheet
 worksheet13 = workbook.add_worksheet
 
-currency_format = workbook.add_format(:num_format => '$#,##0')
+currency_format = workbook.add_format(num_format: '$#,##0')
 
 # Some sample data for the table.
 data = [
@@ -68,7 +68,7 @@ worksheet2.set_column('B:G', 12)
 worksheet2.write('B1', caption)
 
 # Add a table to the worksheet.
-worksheet2.add_table('B3:F7', { :data => data })
+worksheet2.add_table('B3:F7', { data: data })
 
 ###############################################################################
 #
@@ -83,7 +83,7 @@ worksheet3.set_column('B:G', 12)
 worksheet3.write('B1', caption)
 
 # Add a table to the worksheet.
-worksheet3.add_table('B3:F7', { :autofilter => 0 })
+worksheet3.add_table('B3:F7', { autofilter: 0 })
 
 # Table data can also be written separately, as an array or individual cells.
 worksheet3.write_col('B4', data)
@@ -101,7 +101,7 @@ worksheet4.set_column('B:G', 12)
 worksheet4.write('B1', caption)
 
 # Add a table to the worksheet.
-worksheet4.add_table('B4:F7', { :header_row => 0 })
+worksheet4.add_table('B4:F7', { header_row: 0 })
 
 # Table data can also be written separately, as an array or individual cells.
 worksheet4.write_col('B4', data)
@@ -119,7 +119,7 @@ worksheet5.set_column('B:G', 12)
 worksheet5.write('B1', caption)
 
 # Add a table to the worksheet.
-worksheet5.add_table('B3:F7', { :first_column => 1, :last_column => 1 })
+worksheet5.add_table('B3:F7', { first_column: 1, last_column: 1 })
 
 # Table data can also be written separately, as an array or individual cells.
 worksheet5.write_col('B4', data)
@@ -137,7 +137,7 @@ worksheet6.set_column('B:G', 12)
 worksheet6.write('B1', caption)
 
 # Add a table to the worksheet.
-worksheet6.add_table('B3:F7', { :banded_rows => 0, :banded_columns => 1 })
+worksheet6.add_table('B3:F7', { banded_rows: 0, banded_columns: 1 })
 
 # Table data can also be written separately, as an array or individual cells.
 worksheet6.write_col('B4', data)
@@ -158,13 +158,13 @@ worksheet7.write('B1', caption)
 worksheet7.add_table(
   'B3:F7',
   {
-    :data    => data,
-    :columns => [
-      { :header => 'Product' },
-      { :header => 'Quarter 1' },
-      { :header => 'Quarter 2' },
-      { :header => 'Quarter 3' },
-      { :header => 'Quarter 4' }
+    data:    data,
+    columns: [
+      { header: 'Product' },
+      { header: 'Quarter 1' },
+      { header: 'Quarter 2' },
+      { header: 'Quarter 3' },
+      { header: 'Quarter 4' }
     ]
   }
 )
@@ -185,16 +185,16 @@ worksheet8.write('B1', caption)
 worksheet8.add_table(
   'B3:G7',
   {
-    :data    => data,
-    :columns => [
-      { :header => 'Product' },
-      { :header => 'Quarter 1' },
-      { :header => 'Quarter 2' },
-      { :header => 'Quarter 3' },
-      { :header => 'Quarter 4' },
+    data:    data,
+    columns: [
+      { header: 'Product' },
+      { header: 'Quarter 1' },
+      { header: 'Quarter 2' },
+      { header: 'Quarter 3' },
+      { header: 'Quarter 4' },
       {
-        :header  => 'Year',
-        :formula => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])'
+        header:  'Year',
+        formula: '=SUM(Table8[@[Quarter 1]:[Quarter 4]])'
       }
     ]
   }
@@ -216,17 +216,17 @@ worksheet9.write('B1', caption)
 worksheet9.add_table(
   'B3:G8',
   {
-    :data      => data,
-    :total_row => 1,
-    :columns   => [
-      { :header => 'Product' },
-      { :header => 'Quarter 1' },
-      { :header => 'Quarter 2' },
-      { :header => 'Quarter 3' },
-      { :header => 'Quarter 4' },
+    data:      data,
+    total_row: 1,
+    columns:   [
+      { header: 'Product' },
+      { header: 'Quarter 1' },
+      { header: 'Quarter 2' },
+      { header: 'Quarter 3' },
+      { header: 'Quarter 4' },
       {
-        :header  => 'Year',
-        :formula => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])'
+        header:  'Year',
+        formula: '=SUM(Table8[@[Quarter 1]:[Quarter 4]])'
       }
     ]
   }
@@ -248,18 +248,18 @@ worksheet10.write('B1', caption)
 worksheet10.add_table(
   'B3:G8',
   {
-    :data      => data,
-    :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' },
+    data:      data,
+    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(Table8[@[Quarter 1]:[Quarter 4]])',
-        :total_function => 'sum'
+        header:         'Year',
+        formula:        '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
+        total_function: 'sum'
       }
     ]
   }
@@ -281,19 +281,19 @@ worksheet11.write('B1', caption)
 worksheet11.add_table(
   'B3:G8',
   {
-    :data      => data,
-    :style     => 'Table Style Light 11',
-    :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' },
+    data:      data,
+    style:     'Table Style Light 11',
+    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(Table8[@[Quarter 1]:[Quarter 4]])',
-        :total_function => 'sum'
+        header:         'Year',
+        formula:        '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
+        total_function: 'sum'
       }
     ]
   }
@@ -315,19 +315,19 @@ worksheet12.write('B1', caption)
 worksheet12.add_table(
   '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' },
+    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'
+        header:         'Year',
+        formula:        '=SUM(Table12[@[Quarter 1]:[Quarter 4]])',
+        total_function: 'sum'
       }
     ]
   }
@@ -349,35 +349,35 @@ worksheet13.write('B1', caption)
 worksheet13.add_table(
   'B3:G8',
   {
-    :data      => data,
-    :total_row => 1,
-    :columns   => [
-      { :header => 'Product', :total_string => 'Totals' },
+    data:      data,
+    total_row: 1,
+    columns:   [
+      { header: 'Product', total_string: 'Totals' },
       {
-        :header         => 'Quarter 1',
-        :total_function => 'sum',
-        :format         => currency_format
+        header:         'Quarter 1',
+        total_function: 'sum',
+        format:         currency_format
       },
       {
-        :header         => 'Quarter 2',
-        :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 3',
+        total_function: 'sum',
+        format:         currency_format
       },
       {
-        :header         => 'Quarter 4',
-        :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
+        header:         'Year',
+        formula:        '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
+        total_function: 'sum',
+        format:         currency_format
       }
     ]
   }

data/examples/watermark.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+#######################################################################
+#
+# An example of adding a worksheet watermark image using the WriteXLSX
+# rubygem. This is based on the method of putting an image in the worksheet
+# header as suggested in the Microsoft documentation:
+# https://support.microsoft.com/en-us/office/add-a-watermark-in-excel-a372182a-d733-484e-825c-18ddf3edf009
+#
+# Copyright 2000-2023, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
+#
+
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('watermark.xlsx')
+worksheet = workbook.add_worksheet
+
+# Set a worksheet header with the watermark image.
+dirname = File.dirname(File.expand_path(__FILE__))
+worksheet.set_header(
+  '&C&C&[Picture]', nil,
+  { image_center: File.join(dirname, 'watermark.png') }
+)
+
+workbook.close

data/lib/write_xlsx/chart/bar.rb

@@ -86,14 +86,14 @@ module Writexlsx
 
       def axis_defaults_set
         if @x_axis.defaults
-          @x_axis.defaults[:major_gridlines] = { :visible => 1 }
+          @x_axis.defaults[:major_gridlines] = { visible: 1 }
         else
-          @x_axis.defaults = { :major_gridlines => { :visible => 1 } }
+          @x_axis.defaults = { major_gridlines: { visible: 1 } }
         end
         if @y_axis.defaults
-          @y_axis.defaults[:major_gridlines] = { :visible => 0 }
+          @y_axis.defaults[:major_gridlines] = { visible: 0 }
         else
-          @y_axis.defaults = { :major_gridlines => { :visible => 0 } }
+          @y_axis.defaults = { major_gridlines: { visible: 0 } }
         end
         @x_axis.defaults[:num_format] = '0%' if @subtype == 'percent_stacked'
       end

data/lib/write_xlsx/chart/line.rb

@@ -24,7 +24,7 @@ module Writexlsx
       def initialize(subtype)
         super(subtype)
         @subtype ||= 'standard'
-        @default_marker = Marker.new(:type => 'none')
+        @default_marker = Marker.new(type: 'none')
         @smooth_allowed = 1
 
         # Override and reset the default axis values.

data/lib/write_xlsx/chart/radar.rb

@@ -32,10 +32,10 @@ module Writexlsx
       def initialize(subtype)
         super(subtype)
         @subtype = subtype || 'marker'
-        @default_marker = Marker.new(:type => 'none') if @subtype == 'marker'
+        @default_marker = Marker.new(type: 'none') if @subtype == 'marker'
 
         # Override and reset the default axis values.
-        @x_axis.defaults[:major_gridlines] = { :visible => 1 }
+        @x_axis.defaults[:major_gridlines] = { visible: 1 }
         set_x_axis
 
         # Hardcode major_tick_mark for now untill there is an accessor.

data/lib/write_xlsx/chart/scatter.rb

@@ -123,8 +123,8 @@ module Writexlsx
           write_layout(@plotarea.layout, 'plot')
 
           # Write the subclass chart type elements for primary and secondary axes.
-          write_chart_type(:primary_axes => 1)
-          write_chart_type(:primary_axes => 0)
+          write_chart_type(primary_axes: 1)
+          write_chart_type(primary_axes: 0)
 
           # Write c:catAx and c:valAx elements for series using primary axes.
           write_cat_val_axis(@x_axis, @y_axis, @axis_ids, 'b')
@@ -201,7 +201,7 @@ module Writexlsx
           # Go through each series and define default values.
           @series.each do |series|
             # Set a line type unless there is already a user defined type.
-            series.line = line_properties(:width => 2.25, :none => 1, :_defined => 1) unless series.line_defined?
+            series.line = line_properties(width: 2.25, none: 1, _defined: 1) unless series.line_defined?
           end
         end
 
@@ -210,7 +210,7 @@ module Writexlsx
           # Go through each series and define default values.
           @series.each do |series|
             # Set a marker type unless there is already a user defined type.
-            series.marker = Marker.new(:type => 'none', :_defined => 1) unless ptrue?(series.marker)
+            series.marker = Marker.new(type: 'none', _defined: 1) unless ptrue?(series.marker)
           end
         end
       end

data/lib/write_xlsx/chart/series.rb

@@ -77,12 +77,12 @@ module Writexlsx
 
       def types
         {
-          :exponential    => 'exp',
-          :linear         => 'linear',
-          :log            => 'log',
-          :moving_average => 'movingAvg',
-          :polynomial     => 'poly',
-          :power          => 'power'
+          exponential:    'exp',
+          linear:         'linear',
+          log:            'log',
+          moving_average: 'movingAvg',
+          polynomial:     'poly',
+          power:          'power'
         }
       end
     end
@@ -108,20 +108,20 @@ module Writexlsx
 
       def types
         {
-          :automatic  => 'automatic',
-          :none       => 'none',
-          :square     => 'square',
-          :diamond    => 'diamond',
-          :triangle   => 'triangle',
-          :x          => 'x',
-          :star       => 'star',
-          :dot        => 'dot',
-          :short_dash => 'dot',
-          :dash       => 'dash',
-          :long_dash  => 'dash',
-          :circle     => 'circle',
-          :plus       => 'plus',
-          :picture    => 'picture'
+          automatic:  'automatic',
+          none:       'none',
+          square:     'square',
+          diamond:    'diamond',
+          triangle:   'triangle',
+          x:          'x',
+          star:       'star',
+          dot:        'dot',
+          short_dash: 'dot',
+          dash:       'dash',
+          long_dash:  'dash',
+          circle:     'circle',
+          plus:       'plus',
+          picture:    'picture'
         }
       end
     end
@@ -155,11 +155,11 @@ module Writexlsx
 
       def types
         {
-          :fixed              => 'fixedVal',
-          :percentage         => 'percentage',
-          :standard_deviation => 'stdDev',
-          :standard_error     => 'stdErr',
-          :custom             => 'cust'
+          fixed:              'fixedVal',
+          percentage:         'percentage',
+          standard_deviation: 'stdDev',
+          standard_error:     'stdErr',
+          custom:             'cust'
         }
       end
 
@@ -261,8 +261,8 @@ module Writexlsx
 
       def errorbars(x, y)
         {
-          :_x_error_bars => x ? Errorbars.new(x) : nil,
-          :_y_error_bars => y ? Errorbars.new(y) : nil
+          _x_error_bars: x ? Errorbars.new(x) : nil,
+          _y_error_bars: y ? Errorbars.new(y) : nil
         }
       end
 

data/lib/write_xlsx/chart/stock.rb

@@ -104,17 +104,17 @@ module Writexlsx
           if index % 4 != 3
             unless series.line_defined?
               series.line = {
-                :width    => 2.25,
-                :none     => 1,
-                :_defined => 1
+                width:    2.25,
+                none:     1,
+                _defined: 1
               }
             end
 
             unless ptrue?(series.marker)
               series.marker = if index % 4 == 2
-                                Marker.new(:type => 'dot', :size => 3)
+                                Marker.new(type: 'dot', size: 3)
                               else
-                                Marker.new(:type => 'none')
+                                Marker.new(type: 'none')
                               end
             end
           end

data/lib/write_xlsx/chart.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/gradient'
@@ -69,7 +70,7 @@ module Writexlsx
       @gradient = gradient_properties(params[:gradient])
 
       # Map deprecated Spreadsheet::WriteExcel fill colour.
-      fill = params[:color] ? { :color => params[:color] } : params[:fill]
+      fill = params[:color] ? { color: params[:color] } : params[:fill]
       @fill = fill_properties(fill)
 
       # Pattern fill overrides solid fill.
@@ -89,13 +90,13 @@ module Writexlsx
 
       # Map deprecated Spreadsheet::WriteExcel line_weight.
       border = params[:border]
-      border = { :width => swe_line_weight(line_weight) } if line_weight
+      border = { width: swe_line_weight(line_weight) } if line_weight
 
       # Map deprecated Spreadsheet::WriteExcel line_pattern.
       if params[:line_pattern]
         pattern = swe_line_pattern(params[:line_pattern])
         if pattern == 'none'
-          border = { :none => 1 }
+          border = { none: 1 }
         else
           border[:dash_type] = pattern
         end
@@ -431,8 +432,8 @@ module Writexlsx
 
       # Set the up and down bar properties.
       @up_down_bars = {
-        :_up   => Chartline.new(params[:up]),
-        :_down => Chartline.new(params[:down])
+        _up:   Chartline.new(params[:up]),
+        _down: Chartline.new(params[:down])
       }
     end
 
@@ -694,33 +695,33 @@ module Writexlsx
 
     def x_axis_defaults
       {
-        :num_format      => 'General',
-        :major_gridlines => { :visible => 0 }
+        num_format:      'General',
+        major_gridlines: { visible: 0 }
       }
     end
 
     def y_axis_defaults
       {
-        :num_format      => 'General',
-        :major_gridlines => { :visible => 1 }
+        num_format:      'General',
+        major_gridlines: { visible: 1 }
       }
     end
 
     def x2_axis_defaults
       {
-        :num_format     => 'General',
-        :label_position => 'none',
-        :crossing       => 'max',
-        :visible        => 0
+        num_format:     'General',
+        label_position: 'none',
+        crossing:       'max',
+        visible:        0
       }
     end
 
     def y2_axis_defaults
       {
-        :num_format      => 'General',
-        :major_gridlines => { :visible => 0 },
-        :position        => 'right',
-        :visible         => 1
+        num_format:      'General',
+        major_gridlines: { visible: 0 },
+        position:        'right',
+        visible:         1
       }
     end
 
@@ -802,8 +803,8 @@ module Writexlsx
         # Write the c:layout element.
         write_layout(@plotarea.layout, 'plot')
         # Write the subclass chart type elements for primary and secondary axes.
-        write_chart_type(:primary_axes => 1)
-        write_chart_type(:primary_axes => 0)
+        write_chart_type(primary_axes: 1)
+        write_chart_type(primary_axes: 0)
 
         # Configure a combined chart if present.
         if second_chart
@@ -822,15 +823,15 @@ module Writexlsx
           second_chart.series_index = @series_index
 
           # Write the subclass chart type elements for combined chart.
-          second_chart.write_chart_type(:primary_axes => 1)
-          second_chart.write_chart_type(:primary_axes => 0)
+          second_chart.write_chart_type(primary_axes: 1)
+          second_chart.write_chart_type(primary_axes: 0)
         end
 
         # Write the category and value elements for the primary axes.
         params = {
-          :x_axis   => @x_axis,
-          :y_axis   => @y_axis,
-          :axis_ids => @axis_ids
+          x_axis:   @x_axis,
+          y_axis:   @y_axis,
+          axis_ids: @axis_ids
         }
 
         if @date_category
@@ -843,9 +844,9 @@ module Writexlsx
 
         # Write the category and value elements for the secondary axes.
         params = {
-          :x_axis   => @x2_axis,
-          :y_axis   => @y2_axis,
-          :axis_ids => @axis2_ids
+          x_axis:   @x2_axis,
+          y_axis:   @y2_axis,
+          axis_ids: @axis2_ids
         }
 
         write_val_axis(@x2_axis, @y2_axis, @axis2_ids)
@@ -854,9 +855,9 @@ module Writexlsx
         if second_chart && second_chart.is_secondary?
 
           params = {
-            :x_axis   => second_chart.x2_axis,
-            :y_axis   => second_chart.y2_axis,
-            :axis_ids => second_chart.axis2_ids
+            x_axis:   second_chart.x2_axis,
+            y_axis:   second_chart.y2_axis,
+            axis_ids: second_chart.axis2_ids
           }
 
           second_chart.write_val_axis(

data/lib/write_xlsx/chartsheet.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###############################################################################
 #

data/lib/write_xlsx/col_name.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 require 'singleton'