write_xlsx 1.10.0 → 1.10.1

data/examples/chart_data_tools.rb

@@ -18,7 +18,7 @@ require 'write_xlsx'
 # Create a new workbook called simple.xls and add a worksheet
 workbook  = WriteXLSX.new('chart_data_tools.xlsx')
 worksheet = workbook.add_worksheet
-bold      = workbook.add_format(:bold => 1)
+bold      = workbook.add_format(bold: 1)
 
 # Add the worksheet data that the charts will refer to.
 headings = ['Number', 'Data 1', 'Data 2']
@@ -38,32 +38,32 @@ worksheet.write('A2', data)
 #
 
 # Create a Line chart.
-chart1 = workbook.add_chart(:type => 'line', :embedded => 1)
+chart1 = workbook.add_chart(type: 'line', embedded: 1)
 
 # Configure the first series with a polynomial trendline.
 chart1.add_series(
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$B$2:$B$7',
-  :trendline  => {
-    :type  => 'polynomial',
-    :order => 3
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$B$2:$B$7',
+  trendline:  {
+    type:  'polynomial',
+    order: 3
   }
 )
 
 # Configure the second series with a moving average trendline.
 chart1.add_series(
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$C$2:$C$7',
-  :trendline  => { :type => 'linear' }
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$C$2:$C$7',
+  trendline:  { type: 'linear' }
 )
 
 # Add a chart title. and some axis labels.
-chart1.set_title(:name => 'Chart with Trendlines')
+chart1.set_title(name: 'Chart with Trendlines')
 
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D2', chart1,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 #######################################################################
@@ -72,29 +72,29 @@ worksheet.insert_chart(
 #
 
 # Create a Line chart.
-chart2 = workbook.add_chart(:type => 'line', :embedded => 1)
+chart2 = workbook.add_chart(type: 'line', embedded: 1)
 
 # Configure the first series.
 chart2.add_series(
-  :categories  => '=Sheet1!$A$2:$A$7',
-  :values      => '=Sheet1!$B$2:$B$7',
-  :data_labels => { :value => 1 },
-  :marker      => { :type => 'automatic' }
+  categories:  '=Sheet1!$A$2:$A$7',
+  values:      '=Sheet1!$B$2:$B$7',
+  data_labels: { value: 1 },
+  marker:      { type: 'automatic' }
 )
 
 # Configure the second series.
 chart2.add_series(
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$C$2:$C$7'
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$C$2:$C$7'
 )
 
 # Add a chart title. and some axis labels.
-chart2.set_title(:name => 'Chart with Data Labels and Markers')
+chart2.set_title(name: 'Chart with Data Labels and Markers')
 
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D18', chart2,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 #######################################################################
@@ -103,28 +103,28 @@ worksheet.insert_chart(
 #
 
 # Create a Line chart.
-chart3 = workbook.add_chart(:type => 'line', :embedded => 1)
+chart3 = workbook.add_chart(type: 'line', embedded: 1)
 
 # Configure the first series.
 chart3.add_series(
-  :categories   => '=Sheet1!$A$2:$A$7',
-  :values       => '=Sheet1!$B$2:$B$7',
-  :y_error_bars => { :type => 'standard_error' }
+  categories:   '=Sheet1!$A$2:$A$7',
+  values:       '=Sheet1!$B$2:$B$7',
+  y_error_bars: { type: 'standard_error' }
 )
 
 # Configure the second series.
 chart3.add_series(
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$C$2:$C$7'
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$C$2:$C$7'
 )
 
 # Add a chart title. and some axis labels.
-chart3.set_title(:name => 'Chart with Error Bars')
+chart3.set_title(name: 'Chart with Error Bars')
 
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D34', chart3,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 #######################################################################
@@ -133,30 +133,30 @@ worksheet.insert_chart(
 #
 
 # Create a Line chart.
-chart4 = workbook.add_chart(:type => 'line', :embedded => 1)
+chart4 = workbook.add_chart(type: 'line', embedded: 1)
 
 # Add the Up-Down Bars.
 chart4.set_up_down_bars
 
 # Configure the first series.
 chart4.add_series(
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$B$2:$B$7'
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$B$2:$B$7'
 )
 
 # Configure the second series.
 chart4.add_series(
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$C$2:$C$7'
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$C$2:$C$7'
 )
 
 # Add a chart title. and some axis labels.
-chart4.set_title(:name => 'Chart with Up-Down Bars')
+chart4.set_title(name: 'Chart with Up-Down Bars')
 
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D50', chart4,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 #######################################################################
@@ -165,30 +165,30 @@ worksheet.insert_chart(
 #
 
 # Create a Line chart.
-chart5 = workbook.add_chart(:type => 'line', :embedded => 1)
+chart5 = workbook.add_chart(type: 'line', embedded: 1)
 
 # Add the High-Low lines.
 chart5.set_high_low_lines
 
 # Configure the first series.
 chart5.add_series(
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$B$2:$B$7'
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$B$2:$B$7'
 )
 
 # Configure the second series.
 chart5.add_series(
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$C$2:$C$7'
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$C$2:$C$7'
 )
 
 # Add a chart title. and some axis labels.
-chart5.set_title(:name => 'Chart with High-Low Lines')
+chart5.set_title(name: 'Chart with High-Low Lines')
 
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D66', chart5,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 #######################################################################
@@ -197,30 +197,30 @@ worksheet.insert_chart(
 #
 
 # Create a Line chart.
-chart6 = workbook.add_chart(:type => 'line', :embedded => 1)
+chart6 = workbook.add_chart(type: 'line', embedded: 1)
 
 # Add Drop Lines.
 chart6.set_drop_lines
 
 # Configure the first series.
 chart6.add_series(
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$B$2:$B$7'
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$B$2:$B$7'
 )
 
 # Configure the second series.
 chart6.add_series(
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$C$2:$C$7'
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$C$2:$C$7'
 )
 
 # Add a chart title. and some axis labels.
-chart6.set_title(:name => 'Chart with Drop Lines')
+chart6.set_title(name: 'Chart with Drop Lines')
 
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D82', chart6,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 workbook.close

data/examples/chart_doughnut.rb

@@ -19,7 +19,7 @@ require 'write_xlsx'
 
 workbook  = WriteXLSX.new('chart_doughnut.xlsx')
 worksheet = workbook.add_worksheet
-bold      = workbook.add_format(:bold => 1)
+bold      = workbook.add_format(bold: 1)
 
 # Add the worksheet data that the charts will refer to.
 headings = %w[Category Values]
@@ -32,19 +32,19 @@ worksheet.write('A1', headings, bold)
 worksheet.write('A2', data)
 
 # Create a new chart object. In this case an embedded chart.
-chart1 = workbook.add_chart(:type => 'doughnut', :embedded => 1)
+chart1 = workbook.add_chart(type: 'doughnut', embedded: 1)
 
 # Configure the series. Note the use of the array ref to define ranges:
 # [ $sheetname, $row_start, $row_end, $col_start, $col_end ].
 # See below for an alternative syntax.
 chart1.add_series(
-  :name       => 'Doughnut sales data',
-  :categories => ['Sheet1', 1, 3, 0, 0],
-  :values     => ['Sheet1', 1, 3, 1, 1]
+  name:       'Doughnut sales data',
+  categories: ['Sheet1', 1, 3, 0, 0],
+  values:     ['Sheet1', 1, 3, 1, 1]
 )
 
 # Add a title.
-chart1.set_title(:name => 'Popular Doughnut Types')
+chart1.set_title(name: 'Popular Doughnut Types')
 
 # Set an Excel chart style. Colors with white outline and shadow.
 chart1.set_style(10)
@@ -52,7 +52,7 @@ chart1.set_style(10)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'C2', chart1,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 #
@@ -60,27 +60,27 @@ worksheet.insert_chart(
 #
 
 # Create an example Doughnut chart like above.
-chart2 = workbook.add_chart(:type => 'doughnut', :embedded => 1)
+chart2 = workbook.add_chart(type: 'doughnut', embedded: 1)
 
 # Configure the series and add user defined segment colours.
 chart2.add_series(
-  :name       => 'Doughnut sales data',
-  :categories => '=Sheet1!$A$2:$A$4',
-  :values     => '=Sheet1!$B$2:$B$4',
-  :points     => [
-    { :fill => { :color => '#FA58D0' } },
-    { :fill => { :color => '#61210B' } },
-    { :fill => { :color => '#F5F6CE' } }
+  name:       'Doughnut sales data',
+  categories: '=Sheet1!$A$2:$A$4',
+  values:     '=Sheet1!$B$2:$B$4',
+  points:     [
+    { fill: { color: '#FA58D0' } },
+    { fill: { color: '#61210B' } },
+    { fill: { color: '#F5F6CE' } }
   ]
 )
 
 # Add a title.
-chart2.set_title(:name => 'Doughnut Chart with user defined colors')
+chart2.set_title(name: 'Doughnut Chart with user defined colors')
 
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'C18', chart2,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 #
@@ -88,17 +88,17 @@ worksheet.insert_chart(
 #
 
 # Create an example Doughnut chart like above.
-chart3 = workbook.add_chart(:type => 'doughnut', :embedded => 1)
+chart3 = workbook.add_chart(type: 'doughnut', embedded: 1)
 
 # Configure the series.
 chart3.add_series(
-  :name       => 'Doughnut sales data',
-  :categories => '=Sheet1!$A$2:$A$4',
-  :values     => '=Sheet1!$B$2:$B$4'
+  name:       'Doughnut sales data',
+  categories: '=Sheet1!$A$2:$A$4',
+  values:     '=Sheet1!$B$2:$B$4'
 )
 
 # Add a title.
-chart3.set_title(:name => 'Doughnut Chart with segment rotation')
+chart3.set_title(name: 'Doughnut Chart with segment rotation')
 
 # Change the angle/rotation of the first segment.
 chart3.set_rotation(90)
@@ -106,7 +106,7 @@ chart3.set_rotation(90)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'C34', chart3,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 #
@@ -114,17 +114,17 @@ worksheet.insert_chart(
 #
 
 # Create an example Doughnut chart like above.
-chart4 = workbook.add_chart(:type => 'doughnut', :embedded => 1)
+chart4 = workbook.add_chart(type: 'doughnut', embedded: 1)
 
 # Configure the series.
 chart4.add_series(
-  :name       => 'Doughnut sales data',
-  :categories => '=Sheet1!$A$2:$A$4',
-  :values     => '=Sheet1!$B$2:$B$4'
+  name:       'Doughnut sales data',
+  categories: '=Sheet1!$A$2:$A$4',
+  values:     '=Sheet1!$B$2:$B$4'
 )
 
 # Add a title.
-chart4.set_title(:name => 'Doughnut Chart with user defined hole size')
+chart4.set_title(name: 'Doughnut Chart with user defined hole size')
 
 # Change the hole size.
 chart4.set_hole_size(33)
@@ -132,7 +132,7 @@ chart4.set_hole_size(33)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'C50', chart4,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 workbook.close

data/examples/chart_gauge.rb

@@ -18,8 +18,8 @@ require 'write_xlsx'
 workbook  = WriteXLSX.new('chart_gauge.xlsx')
 worksheet = workbook.add_worksheet
 
-chart_doughnut = workbook.add_chart(:type => 'doughnut', :embedded => 1)
-chart_pie      = workbook.add_chart(:type => 'pie', :embedded => 1)
+chart_doughnut = workbook.add_chart(type: 'doughnut', embedded: 1)
+chart_pie      = workbook.add_chart(type: 'pie', embedded: 1)
 
 # Add some data for the Doughnut and Pie charts. This is set up so the
 # gauge goes from 0-100. It is initially set at 75%.
@@ -28,13 +28,13 @@ worksheet.write_col('I2', ['Pie', 75, 1, '=200-I4-I3'])
 
 # Configure the doughnut chart as the background for the gauge.
 chart_doughnut.add_series(
-  :name   => '=Sheet1!$H$2',
-  :values => '=Sheet1!$H$3:$H$6',
-  :points => [
-    { :fill => { :color => 'green' } },
-    { :fill => { :color => 'yellow' } },
-    { :fill => { :color => 'red' } },
-    { :fill => { :none  => 1 } }
+  name:   '=Sheet1!$H$2',
+  values: '=Sheet1!$H$3:$H$6',
+  points: [
+    { fill: { color: 'green' } },
+    { fill: { color: 'yellow' } },
+    { fill: { color: 'red' } },
+    { fill: { none: 1 } }
   ]
 )
 
@@ -42,22 +42,22 @@ chart_doughnut.add_series(
 chart_doughnut.set_rotation(270)
 
 # Turn off the chart legend.
-chart_doughnut.set_legend(:none => 1)
+chart_doughnut.set_legend(none: 1)
 
 # Turn off the chart fill and border.
 chart_doughnut.set_chartarea(
-  :border => { :none  => 1 },
-  :fill   => { :none  => 1 }
+  border: { none: 1 },
+  fill:   { none: 1 }
 )
 
 # Configure the pie chart as the needle for the gauge.
 chart_pie.add_series(
-  :name   => '=Sheet1!$I$2',
-  :values => '=Sheet1!$I$3:$I$6',
-  :points => [
-    { :fill => { :none  => 1 } },
-    { :fill => { :color => 'black' } },
-    { :fill => { :none  => 1 } }
+  name:   '=Sheet1!$I$2',
+  values: '=Sheet1!$I$3:$I$6',
+  points: [
+    { fill: { none: 1 } },
+    { fill: { color: 'black' } },
+    { fill: { none: 1 } }
   ]
 )
 

data/examples/chart_line.rb

@@ -13,7 +13,7 @@ require 'write_xlsx'
 
 workbook  = WriteXLSX.new('chart_line.xlsx')
 worksheet = workbook.add_worksheet
-bold      = workbook.add_format(:bold => 1)
+bold      = workbook.add_format(bold: 1)
 
 # Add the worksheet data that the charts will refer to.
 headings = ['Number', 'Batch 1', 'Batch 2']
@@ -27,27 +27,27 @@ worksheet.write('A1', headings, bold)
 worksheet.write('A2', data)
 
 # Create a new chart object. In this case an embedded chart.
-chart = workbook.add_chart(:type => 'line', :embedded => 1)
+chart = workbook.add_chart(type: 'line', embedded: 1)
 
 # 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_x_axis(:name => 'Test number')
-chart.set_y_axis(:name => 'Sample length (mm)')
+chart.set_title(name: 'Results of sample analysis')
+chart.set_x_axis(name: 'Test number')
+chart.set_y_axis(name: 'Sample length (mm)')
 
 # Set an Excel chart style. Blue colors with white outline and shadow.
 chart.set_style(10)
@@ -55,30 +55,30 @@ chart.set_style(10)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D2', chart,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 #
 # Create a stacked chart sub-type
 #
 chart2 = workbook.add_chart(
-  :type     => 'line',
-  :embedded => 1,
-  :subtype  => 'stacked'
+  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'
+  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]
+  name:       '=Sheet1!$C$1',
+  categories: ['Sheet1', 1, 6, 0, 0],
+  values:     ['Sheet1', 1, 6, 2, 2]
 )
 
 # Add a chart title and some axis labels.
@@ -92,30 +92,30 @@ chart2.set_style(12)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D18', chart2,
-  { :x_offset => 25, :y_offset => 10 }
+  { x_offset: 25, y_offset: 10 }
 )
 
 #
 # Create a percent stacked chart sub-type
 #
 chart3 = workbook.add_chart(
-  :type     => 'line',
-  :embedded => 1,
-  :subtype  => 'percent_stacked'
+  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'
+  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]
+  name:       '=Sheet1!$C$1',
+  categories: ['Sheet1', 1, 6, 0, 0],
+  values:     ['Sheet1', 1, 6, 2, 2]
 )
 
 # Add a chart title and some axis labels.
@@ -129,7 +129,7 @@ chart3.set_style(13)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D34', chart3,
-  { :x_offset => 25, :y_offset => 10 }
+  { x_offset: 25, y_offset: 10 }
 )
 
 workbook.close

data/examples/chart_pareto.rb

@@ -15,8 +15,8 @@ workbook  = WriteXLSX.new('chart_pareto.xlsx')
 worksheet = workbook.add_worksheet
 
 # Formats used in the workbook.
-bold           = workbook.add_format(:bold => 1)
-percent_format = workbook.add_format(:num_format => '0.0%')
+bold           = workbook.add_format(bold: 1)
+percent_format = workbook.add_format(num_format: '0.0%')
 
 # Widen the columns for visibility.
 worksheet.set_column('A:A', 15)
@@ -39,38 +39,38 @@ worksheet.write_col('B2', numbers)
 worksheet.write_col('C2', percents, percent_format)
 
 # Create a new column chart. This will be the primary chart.
-column_chart = workbook.add_chart(:type => 'column', :embedded => 1)
+column_chart = workbook.add_chart(type: 'column', embedded: 1)
 
 # Add a series
 column_chart.add_series(
-  :categories => 'Sheet1!$A$2:$A$7',
-  :values     => 'Sheet1!$B$2:$B$7'
+  categories: 'Sheet1!$A$2:$A$7',
+  values:     'Sheet1!$B$2:$B$7'
 )
 
 # Add a chart title.
-column_chart.set_title(:name => 'Reasons for lateness')
+column_chart.set_title(name: 'Reasons for lateness')
 
 # Turn off the chart legend.
-column_chart.set_legend(:position => 'none')
+column_chart.set_legend(position: 'none')
 
 # Set the title and scale of the Y axes. Note, the secondary axis is set from
 # the primary chart.
 column_chart.set_y_axis(
-  :name => 'Respondents (number)',
-  :min  => 0,
-  :max  => 120
+  name: 'Respondents (number)',
+  min:  0,
+  max:  120
 )
-column_chart.set_y2_axis(:max => 1)
+column_chart.set_y2_axis(max: 1)
 
 # Create a new line chart. This will be the secondary chart.
-line_chart = workbook.add_chart(:type => 'line', :embedded => 1)
+line_chart = workbook.add_chart(type: 'line', embedded: 1)
 
 # Add a series, on the secondary axis.
 line_chart.add_series(
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$C$2:$C$7',
-  :marker     => { :type => 'automatic' },
-  :y2_axis    => 1
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$C$2:$C$7',
+  marker:     { type: 'automatic' },
+  y2_axis:    1
 )
 
 # Combine the charts.