write_xlsx 0.62.0 → 0.64.0

data/test/test_example_match.rb

@@ -541,32 +541,58 @@ def test_chart_pie
     # Add the worksheet data that the charts will refer to.
     headings = [ 'Category', 'Values' ]
     data = [
-        [ 'Apple', 'Cherry', 'Pecan' ],
-        [ 60,       30,       10     ]
-    ]
+            [ 'Apple', 'Cherry', 'Pecan' ],
+            [ 60,       30,       10     ]
+           ]
 
     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 => 'pie', :embedded => 1)
+    chart1 = workbook.add_chart(:type => 'pie', :embedded => 1)
 
     # Configure the series. Note the use of the array ref to define ranges:
     # [ $sheetname, $row_start, $row_end, $col_start, $col_end ].
-    chart.add_series(
-        :name       => 'Pie sales data',
-        :categories => [ 'Sheet1', 1, 3, 0, 0 ],
-        :values     => [ 'Sheet1', 1, 3, 1, 1 ]
-    )
+    # See below for an alternative syntax.
+    chart1.add_series(
+                      :name       => 'Pie sales data',
+                      :categories => [ 'Sheet1', 1, 3, 0, 0 ],
+                      :values     => [ 'Sheet1', 1, 3, 1, 1 ]
+                      )
 
     # Add a title.
-    chart.set_title(:name => 'Popular Pie Types')
+    chart1.set_title(:name => 'Popular Pie Types')
 
     # Set an Excel chart style. Blue colors with white outline and shadow.
-    chart.set_style(10)
+    chart1.set_style(10)
 
     # Insert the chart into the worksheet (with an offset).
-    worksheet.insert_chart('C2', chart, 25, 10)
+    worksheet.insert_chart('C2', chart1, 25, 10)
+
+    #
+    # Create a Pie chart with user defined segment colors.
+    #
+
+    # Create an example Pie chart like above.
+    chart2 = workbook.add_chart(:type => 'pie', :embedded => 1)
+
+    # Configure the series and add user defined segment colours.
+    chart2.add_series(
+                      :name       => 'Pie sales data',
+                      :categories => '=Sheet1!$A$2:$A$4',
+                      :values     => '=Sheet1!$B$2:$B$4',
+                      :points     => [
+                                      { :fill => { :color => '#5ABA10' } },
+                                      { :fill => { :color => '#FE110E' } },
+                                      { :fill => { :color => '#CA5C05' } }
+                                     ]
+                      )
+
+    # Add a title.
+    chart2.set_title(:name => 'Pie Chart with user defined colors')
+
+    worksheet.insert_chart('C18', chart2, 25, 10)
+
 
     workbook.close
     compare_xlsx(File.join(@perl_output, @xlsx), @xlsx)
@@ -3389,8 +3415,8 @@ def test_shape3
                                  )
 
     worksheet.insert_shape('A1', normal, 50, 50)
-    normal[:text] = 'Scaled 3w x 2h'
-    normal[:name] = 'Hope'
+    normal.text = 'Scaled 3w x 2h'
+    normal.name = 'Hope'
     worksheet.insert_shape('A1', normal, 250, 50, 3, 2)
 
     workbook.close
@@ -3408,14 +3434,14 @@ def test_shape4
       :type   => type,
       :width  => 90,
       :height => 90
-                                 )
+                               )
 
     (1..10).each do |n|
       # Change the last 5 rectangles to stars. Previously
       # inserted shapes stay as rectangles.
       type = 'star5' if n == 6
-      shape[:type] = type
-      shape[:text] = "#{type} #{n}"
+      shape.type = type
+      shape.text = "#{type} #{n}"
       worksheet.insert_shape('A1', shape, n * 100, 50)
     end
 
@@ -3427,15 +3453,15 @@ def test_shape4
                                  )
     worksheet.insert_shape('A1', stencil, 100, 150)
 
-    stencil[:stencil] = 0
+    stencil.stencil = 0
     worksheet.insert_shape('A1', stencil, 200, 150)
     worksheet.insert_shape('A1', stencil, 300, 150)
 
     # Ooopa! Changed my mind.
     # Change the rectangle to an ellipse (circle),
     # for the last two shapes.
-    stencil[:type] = 'ellipse'
-    stencil[:text] = 'Now its a circle'
+    stencil.type = 'ellipse'
+    stencil.text = 'Now its a circle'
 
     workbook.close
     compare_xlsx(File.join(@perl_output, @xlsx), @xlsx)
@@ -3464,14 +3490,14 @@ def test_shape5
     cxn_shape = workbook.add_shape(:type => 'bentConnector3')
 
     # Link the start of the connector to the right side.
-    cxn_shape[:start]       = s1[:id]
-    cxn_shape[:start_index] = 4  # 4th connection pt, clockwise from top(0).
-    cxn_shape[:start_side]  = 'b' # r)ight or b)ottom.
+    cxn_shape.start       = s1.id
+    cxn_shape.start_index = 4  # 4th connection pt, clockwise from top(0).
+    cxn_shape.start_side  = 'b' # r)ight or b)ottom.
 
     # Link the end of the connector to the left side.
-    cxn_shape[:end]         = s2[:id]
-    cxn_shape[:end_index]   = 0  # clockwise from top(0).
-    cxn_shape[:end_side]    = 't' # t)op.
+    cxn_shape.end         = s2.id
+    cxn_shape.end_index   = 0  # clockwise from top(0).
+    cxn_shape.end_side    = 't' # t)op.
 
     worksheet.insert_shape('A1', cxn_shape, 0, 0)
 
@@ -3502,14 +3528,14 @@ def test_shape6
     cxn_shape = workbook.add_shape(:type => 'curvedConnector3')
 
     # Link the start of the connector to the right side.
-    cxn_shape[:start]       = s1[:id]
-    cxn_shape[:start_index] = 2  # 2nd connection pt, clockwise from top(0).
-    cxn_shape[:start_side]  = 'r' # r)ight or b)ottom.
+    cxn_shape.start       = s1.id
+    cxn_shape.start_index = 2  # 2nd connection pt, clockwise from top(0).
+    cxn_shape.start_side  = 'r' # r)ight or b)ottom.
 
     # Link the end of the connector to the left side.
-    cxn_shape[:end]         = s2[:id]
-    cxn_shape[:end_index]   = 4  # 4th connection pt, clockwise from top(0).
-    cxn_shape[:end_side]    = 'l' # l)eft or t)op.
+    cxn_shape.end         = s2.id
+    cxn_shape.end_index   = 4  # 4th connection pt, clockwise from top(0).
+    cxn_shape.end_side    = 'l' # l)eft or t)op.
 
     worksheet.insert_shape('A1', cxn_shape, 0, 0)
 
@@ -3553,28 +3579,28 @@ def test_shape7
     p1 = worksheet.insert_shape('A1', plus, 350, 350)
     p2 = worksheet.insert_shape('A1', plus, 150, 350)
     p3 = worksheet.insert_shape('A1', plus, 350, 150)
-    plus[:adjustments] = 35  # change shape of plus symbol.
+    plus.adjustments = 35  # change shape of plus symbol.
     p4 = worksheet.insert_shape('A1', plus, 150, 150)
 
     cxn_shape = workbook.add_shape(:type => 'bentConnector3', :fill => 0)
 
-    cxn_shape[:start]       = ellipse[:id]
-    cxn_shape[:start_index] = 4   # 4th connection pt, clockwise from top(0).
-    cxn_shape[:start_side]  = 'b' # r)ight or b)ottom.
+    cxn_shape.start       = ellipse.id
+    cxn_shape.start_index = 4   # 4th connection pt, clockwise from top(0).
+    cxn_shape.start_side  = 'b' # r)ight or b)ottom.
 
-    cxn_shape[:end]         = p1[:id]
-    cxn_shape[:end_index]   = 0
-    cxn_shape[:end_side]    = 't' # l)eft or t)op.
+    cxn_shape.end         = p1.id
+    cxn_shape.end_index   = 0
+    cxn_shape.end_side    = 't' # l)eft or t)op.
     worksheet.insert_shape('A1', cxn_shape, 0, 0)
 
-    cxn_shape[:end]  = p2[:id]
+    cxn_shape.end  = p2.id
     worksheet.insert_shape('A1', cxn_shape, 0, 0)
 
-    cxn_shape[:end]  = p3[:id]
+    cxn_shape.end  = p3.id
     worksheet.insert_shape('A1', cxn_shape, 0, 0)
 
-    cxn_shape[:end]  = p4[:id]
-    cxn_shape[:adjustments] = [-50, 45, 120]
+    cxn_shape.end  = p4.id
+    cxn_shape.adjustments = [-50, 45, 120]
     worksheet.insert_shape('A1', cxn_shape, 0, 0)
 
     workbook.close
@@ -3621,23 +3647,23 @@ def test_shape8
 
     cxn_shape = workbook.add_shape(:type => 'bentConnector3', :fill => 0)
 
-    cxn_shape[:start]       = ellipse[:id]
-    cxn_shape[:start_index] = 2   # 2nd connection pt, clockwise from top(0).
-    cxn_shape[:start_side]  = 'r' # r)ight or b)ottom.
+    cxn_shape.start       = ellipse.id
+    cxn_shape.start_index = 2   # 2nd connection pt, clockwise from top(0).
+    cxn_shape.start_side  = 'r' # r)ight or b)ottom.
 
-    cxn_shape[:end]         = p1[:id]
-    cxn_shape[:end_index]   = 3   # 3rd connection point on plus, right side
-    cxn_shape[:end_side]    = 'l' # l)eft or t)op.
+    cxn_shape.end         = p1.id
+    cxn_shape.end_index   = 3   # 3rd connection point on plus, right side
+    cxn_shape.end_side    = 'l' # l)eft or t)op.
     worksheet.insert_shape('A1', cxn_shape, 0, 0)
 
-    cxn_shape[:end]  = p2[:id]
+    cxn_shape.end  = p2.id
     worksheet.insert_shape('A1', cxn_shape, 0, 0)
 
-    cxn_shape[:end]  = p3[:id]
+    cxn_shape.end  = p3.id
     worksheet.insert_shape('A1', cxn_shape, 0, 0)
 
-    cxn_shape[:end]  = p4[:id]
-    cxn_shape[:adjustments] = [-50, 45, 120]
+    cxn_shape.end  = p4.id
+    cxn_shape.adjustments = [-50, 45, 120]
     worksheet.insert_shape('A1', cxn_shape, 0, 0)
 
     workbook.close
@@ -4064,9 +4090,9 @@ def test_tab_colors
     worksheet4 = workbook.add_worksheet
 
     # Worksheet1 will have the default tab colour.
-    worksheet2.set_tab_color('red')
-    worksheet3.set_tab_color('green')
-    worksheet4.set_tab_color(0x35)    # Orange
+    worksheet2.tab_color = 'red'
+    worksheet3.tab_color = 'green'
+    worksheet4.tab_color = 0x35    # Orange
 
     workbook.close
     compare_xlsx(File.join(@perl_output, @xlsx), @xlsx)
@@ -4472,7 +4498,7 @@ def test_sparklines2
     # Set the columns widths to make the output clearer.
     worksheet1.set_column('A:A', 14)
     worksheet1.set_column('B:B', 50)
-    worksheet1.set_zoom(150)
+    worksheet1.zoom = 150
 
     # Headings.
     worksheet1.write('A1', 'Sparkline',   bold)
@@ -4965,4 +4991,199 @@ def test_chart_data_table
     workbook.close
     compare_xlsx(File.join(@perl_output, @xlsx), @xlsx)
   end
+
+  def test_chart_data_tools
+    @xlsx = 'chart_data_tools.xlsx'
+    workbook = WriteXLSX.new(@xlsx)
+    worksheet = workbook.add_worksheet
+    bold      = workbook.add_format(:bold => 1)
+
+    # Add the worksheet data that the charts will refer to.
+    headings = [ 'Number', 'Data 1', 'Data 2' ]
+    data = [
+            [ 2,  3,  4,  5,  6,  7 ],
+            [ 10, 40, 50, 20, 10, 50 ],
+            [ 30, 60, 70, 50, 40, 30 ]
+           ]
+
+    worksheet.write('A1', headings, bold)
+    worksheet.write('A2', data)
+
+
+    #######################################################################
+    #
+    # Trendline example.
+    #
+
+    # Create a Line chart.
+    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,
+                      }
+                      )
+
+    # 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' }
+                      )
+
+    # Add a chart title. and some axis labels.
+    chart1.set_title(:name => 'Chart with Trendlines')
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D2', chart1, 25, 10)
+
+    #######################################################################
+    #
+    # Data Labels and Markers example.
+    #
+
+    # Create a Line chart.
+    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' }
+                      )
+
+    # Configure the second series.
+    chart2.add_series(
+                      :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')
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D18', chart2, 25, 10)
+
+    #######################################################################
+    #
+    # Error Bars example.
+    #
+
+    # Create a Line chart.
+    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' }
+                      )
+
+    # Configure the second series.
+    chart3.add_series(
+                      :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')
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D34', chart3, 25, 10)
+
+    #######################################################################
+    #
+    # Up-Down Bars example.
+    #
+
+    # Create a Line chart.
+    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'
+                      )
+
+    # Configure the second series.
+    chart4.add_series(
+                      :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')
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D50', chart4, 25, 10)
+
+    #######################################################################
+    #
+    # High-Low Lines example.
+    #
+
+    # Create a Line chart.
+    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'
+                      )
+
+    # Configure the second series.
+    chart5.add_series(
+                      :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')
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D66', chart5, 25, 10)
+
+    #######################################################################
+    #
+    # Drop Lines example.
+    #
+
+    # Create a Line chart.
+    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'
+                      )
+
+    # Configure the second series.
+    chart6.add_series(
+                      :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')
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D82', chart6, 25, 10)
+
+    workbook.close
+    compare_xlsx(File.join(@perl_output, @xlsx), @xlsx)
+  end
 end