write_xlsx 0.85.9 → 1.09.2

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/chart_data_table.rb

@@ -7,7 +7,7 @@
 # WriteXLSX.
 #
 # reverse ('(c)'), December 2012, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -54,7 +54,10 @@ chart1.set_y_axis(:name => 'Sample length (mm)')
 chart1.set_table
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D2', chart1, 25, 10)
+worksheet.insert_chart(
+  'D2', chart1,
+  :x_offset => 25, :y_offset => 10
+)
 
 #
 # Create a second charat.
@@ -88,6 +91,9 @@ chart2.set_table(:show_keys => true)
 chart2.set_legend(:position => 'none')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D18', chart2, 25, 11)
+worksheet.insert_chart(
+  'D18', chart2,
+  :x_offset => 25, :y_offset => 11
+)
 
 workbook.close

data/examples/chart_data_tools.rb

@@ -10,7 +10,7 @@
 # High-Low Lines and Up-Down Bars.
 #
 # reverse ('(c)'), December 2012, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -62,7 +62,10 @@ chart1.add_series(
 chart1.set_title(:name => 'Chart with Trendlines')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D2', chart1, 25, 10)
+worksheet.insert_chart(
+  'D2', chart1,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #######################################################################
@@ -91,7 +94,10 @@ chart2.add_series(
 chart2.set_title(:name => 'Chart with Data Labels and Markers')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D18', chart2, 25, 10)
+worksheet.insert_chart(
+  'D18', chart2,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #######################################################################
@@ -119,7 +125,10 @@ chart3.add_series(
 chart3.set_title(:name => 'Chart with Error Bars')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D34', chart3, 25, 10)
+worksheet.insert_chart(
+  'D34', chart3,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #######################################################################
@@ -149,7 +158,10 @@ chart4.add_series(
 chart4.set_title(:name => 'Chart with Up-Down Bars')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D50', chart4, 25, 10)
+worksheet.insert_chart(
+  'D50', chart4,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #######################################################################
@@ -179,7 +191,10 @@ chart5.add_series(
 chart5.set_title(:name => 'Chart with High-Low Lines')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D66', chart5, 25, 10)
+worksheet.insert_chart(
+  'D66', chart5,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #######################################################################
@@ -209,6 +224,9 @@ chart6.add_series(
 chart6.set_title(:name => 'Chart with Drop Lines')
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D82', chart6, 25, 10)
+worksheet.insert_chart(
+  'D82', chart6,
+  :x_offset => 25, :y_offset => 10
+)
 
 workbook.close

data/examples/chart_doughnut.rb

@@ -12,7 +12,7 @@
 # formatting to each point in the series.
 #
 # reverse ('(c)'), March 2011, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -50,7 +50,10 @@ chart1.set_title(:name => 'Popular Doughnut Types')
 chart1.set_style(10)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('C2', chart1, 25, 10)
+worksheet.insert_chart(
+  'C2', chart1,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #
@@ -77,7 +80,10 @@ chart2.set_title(:name => 'Doughnut Chart with user defined colors')
 
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('C18', chart2, 25, 10)
+worksheet.insert_chart(
+  'C18', chart2,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #
@@ -101,7 +107,10 @@ chart3.set_title(:name => 'Doughnut Chart with segment rotation')
 chart3.set_rotation(90)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('C34', chart3, 25, 10)
+worksheet.insert_chart(
+  'C34', chart3,
+  :x_offset => 25, :y_offset => 10
+)
 
 
 #
@@ -125,6 +134,9 @@ chart4.set_title(:name => 'Doughnut Chart with user defined hole size')
 chart4.set_hole_size(33)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('C50', chart4, 25, 10)
+worksheet.insert_chart(
+  'C50', chart4,
+  :x_offset => 25, :y_offset => 10
+)
 
 workbook.close

data/examples/chart_gauge.rb

@@ -0,0 +1,73 @@
+# #!/usr/bin/env ruby
+
+# #######################################################################
+# #
+# # A demo of an Gauge Chart in WriteXLSX gem.
+# #
+# # A Gauge Chart isn't a native chart type in Excel. It is constructed by
+# # combining a doughnut chart and a pie chart and by using some non-filled
+# # elements. This example follows the following online example of how to create
+# # a Gauge Chart in Excel: https://www.excel-easy.com/examples/gauge-chart.html
+# #
+# # reverse ('(c)'), May 2019, John McNamara, jmcnamara@cpan.org
+# # convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
+# #
+
+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)
+
+# 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%.
+worksheet.write_col('H2', ['Donut', 25, 50, 25, 100])
+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 } }
+    ]
+)
+
+# Rotate chart so the gauge parts are above the horizontal.
+chart_doughnut.set_rotation(270)
+
+# Turn off the chart legend.
+chart_doughnut.set_legend(:none => 1)
+
+# Turn off the chart fill and border.
+chart_doughnut.set_chartarea(
+    :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 } }
+    ]
+)
+
+# Rotate the pie chart/needle to align with the doughnut/gauge.
+chart_pie.set_rotation(270)
+
+# Combine the pie and doughnut charts.
+chart_doughnut.combine(chart_pie)
+
+# Insert the chart into the worksheet.
+worksheet.insert_chart('A1', chart_doughnut)
+
+workbook.close

data/examples/chart_line.rb

@@ -6,7 +6,7 @@
 # A demo of a Line chart in Excel::Writer::XLSX.
 #
 # reverse('ｩ'), March 2011, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -18,9 +18,9 @@ bold      = workbook.add_format(:bold => 1)
 # Add the worksheet data that the charts will refer to.
 headings = [ 'Number', 'Batch 1', 'Batch 2' ]
 data = [
-    [ 2, 3, 4, 5, 6, 7 ],
-    [ 10, 40, 50, 20, 10, 50 ],
-    [ 30, 60, 70, 50, 40, 30 ]
+  [  2,  3,  4,  5,  6,  7 ],
+  [ 10, 40, 50, 20, 10, 50 ],
+  [ 30, 60, 70, 50, 40, 30 ]
 ]
 
 worksheet.write('A1', headings, bold)
@@ -31,21 +31,21 @@ 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_title(:name  => 'Results of sample analysis')
 chart.set_x_axis(:name => 'Test number')
 chart.set_y_axis(:name => 'Sample length (mm)')
 
@@ -53,6 +53,84 @@ chart.set_y_axis(:name => 'Sample length (mm)')
 chart.set_style(10)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D2', chart, 25, 10)
+worksheet.insert_chart(
+  'D2', chart,
+  :x_offset => 25, :y_offset => 10
+)
+
+#
+# Create a stacked chart sub-type
+#
+chart2 = workbook.add_chart(
+    :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'
+)
+
+# Configure second series.
+chart2.add_series(
+    :name       => '=Sheet1!$C$1',
+    :categories => [ 'Sheet1', 1, 6, 0, 0 ],
+    :values     => [ 'Sheet1', 1, 6, 2, 2 ]
+)
+
+# Add a chart title and some axis labels.
+chart2.set_title ( :name => 'Stacked Chart' )
+chart2.set_x_axis( :name => 'Test number' )
+chart2.set_y_axis( :name => 'Sample length (mm)' )
+
+# Set an Excel chart style. Blue colors with white outline and shadow.
+chart2.set_style( 12 )
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart(
+  'D18', chart2,
+  { :x_offset => 25, :y_offset => 10 }
+)
+
+
+#
+# Create a percent stacked chart sub-type
+#
+chart3 = workbook.add_chart(
+  :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'
+)
+
+# Configure second series.
+chart3.add_series(
+  :name       => '=Sheet1!$C$1',
+  :categories => [ 'Sheet1', 1, 6, 0, 0 ],
+  :values     => [ 'Sheet1', 1, 6, 2, 2 ]
+)
+
+# Add a chart title and some axis labels.
+chart3.set_title ( :name => 'Percent Stacked Chart' )
+chart3.set_x_axis( :name => 'Test number' )
+chart3.set_y_axis( :name => 'Sample length (mm)' )
+
+# Set an Excel chart style. Blue colors with white outline and shadow.
+chart3.set_style( 13 )
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart(
+  'D34', chart3,
+  { :x_offset => 25, :y_offset => 10 }
+)
 
 workbook.close

data/examples/chart_pareto.rb

@@ -6,7 +6,7 @@
 # A demo of a Pareto chart in Excel::Writer::XLSX.
 #
 # reverse ('(c)'), March 2015, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'