writeexcel 0.1.0 → 0.3.0

data/lib/writeexcel/charts/external.rb

@@ -0,0 +1,61 @@
+###############################################################################
+#
+# External - A writer class for Excel external charts.
+#
+# Used in conjunction with WriteExcel
+#
+# perltidy with options: -mbl=2 -pt=0 -nola
+#
+# Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel/chart'
+
+class External < Chart # :nodoc:
+  ###############################################################################
+  #
+  # new()
+  #
+  def initialize(external_filename, *args)
+    super(*args)
+
+    @filename     = external_filename
+    @external_bin = true
+
+    _initialize    # Requires overridden initialize().
+    self
+  end
+
+  ###############################################################################
+  #
+  # _initialize()
+  #
+  # Read all the data into memory for the external binary style chart.
+  #
+  def _initialize
+    filename   = @filename
+    filehandle = File.open(filename, 'rb')
+
+    @filehandle    = filehandle
+    @datasize      = FileTest.size(filename)
+    @using_tmpfile = false
+
+    # Read the entire external chart binary into the the data buffer.
+    # This will be retrieved by _get_data() when the chart is closed().
+    @data = @filehandle.read(@datasize)
+  end
+
+  ###############################################################################
+  #
+  # _close()
+  #
+  # We don't need to create or store Chart data structures when using an
+  # external binary, so we have a default close method.
+  #
+  def close
+    return nil
+  end
+end

data/lib/writeexcel/charts/line.rb

@@ -0,0 +1,152 @@
+###############################################################################
+#
+# Line - A writer class for Excel Line charts.
+#
+# Used in conjunction with Chart.
+#
+# See formatting note in Chart.
+#
+# Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel/chart'
+
+class Chart
+
+  #
+  # ==SYNOPSIS
+  #
+  # To create a simple Excel file with a Line chart using WriteExcel:
+  #
+  #    #!/usr/bin/ruby -w
+  #
+  #    require 'writeexcel'
+  #
+  #    workbook  = WriteExcel.new('chart.xls')
+  #    worksheet = workbook.add_worksheet
+  #
+  #    chart     = workbook.add_chart(:type => Chart::Line)
+  #
+  #    # Configure the chart.
+  #    chart.add_series(
+  #      :categories => '=Sheet1!$A$2:$A$7',
+  #      :values     => '=Sheet1!$B$2:$B$7',
+  #   )
+  #
+  #    # Add the worksheet data the chart refers to.
+  #    data = [
+  #        [ 'Category', 2, 3, 4, 5, 6, 7 ],
+  #        [ 'Value',    1, 4, 5, 2, 1, 5 ]
+  #    ]
+  #
+  #    worksheet.write('A1', data)
+  #
+  #    workbook.close
+  #
+  # ==DESCRIPTION
+  #
+  # This module implements Line charts for WriteExcel. The chart object is
+  #  created via the Workbook add_chart method:
+  #
+  #    chart = workbook.add_chart(:type => Chart::Line)
+  #
+  # Once the object is created it can be configured via the following methods
+  # that are common to all chart classes:
+  #
+  #    chart.add_series
+  #    chart.set_x_axis
+  #    chart.set_y_axis
+  #    chart.set_title
+  #
+  # These methods are explained in detail in Chart section of WriteExcel.
+  # Class specific methods or settings, if any, are explained below.
+  #
+  # ==Line Chart Methods
+  #
+  # There aren't currently any Line chart specific methods. See the TODO
+  # section of Chart of Writeexcel.
+  #
+  # ==EXAMPLE
+  #
+  # Here is a complete example that demonstrates most of the available
+  # features when creating a chart.
+  #
+  #    #!/usr/bin/ruby -w
+  #
+  #    require 'writeexcel'
+  #
+  #    workbook  = WriteExcel.new('chart_line.xls')
+  #    worksheet = workbook.add_worksheet
+  #    bold      = workbook.add_format(:bold => 1)
+  #
+  #    # Add the worksheet data that the charts will refer to.
+  #    headings = [ 'Number', 'Sample 1', 'Sample 2' ]
+  #    data = [
+  #        [ 2, 3, 4, 5, 6, 7 ],
+  #        [ 1, 4, 5, 2, 1, 5 ],
+  #        [ 3, 6, 7, 5, 4, 3 ]
+  #    ]
+  #
+  #    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 => Chart::Line, :embedded => 1)
+  #
+  #    # Configure the first series. (Sample 1)
+  #    chart.add_series(
+  #      :name       => 'Sample 1',
+  #      :categories => '=Sheet1!$A$2:$A$7',
+  #      :values     => '=Sheet1!$B$2:$B$7',
+  #   )
+  #
+  #    # Configure the second series. (Sample 2)
+  #    chart.add_series(
+  #      :name       => 'Sample 2',
+  #      :categories => '=Sheet1!$A$2:$A$7',
+  #      :values     => '=Sheet1!$C$2:$C$7',
+  #   )
+  #
+  #    # 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 (cm)')
+  #
+  #    # Insert the chart into the worksheet (with an offset).
+  #    worksheet.insert_chart('D2', chart, 25, 10)
+  #
+  #    workbook.close
+  #
+  class Line < Chart
+    ###############################################################################
+    #
+    # new()
+    #
+    #
+    def initialize(*args)   # :nodoc:
+      super(*args)
+    end
+
+    ###############################################################################
+    #
+    # _store_chart_type()
+    #
+    # Implementation of the abstract method from the specific chart class.
+    #
+    # Write the LINE chart BIFF record. Defines a line chart type.
+    #
+    def store_chart_type   # :nodoc:
+      record = 0x1018     # Record identifier.
+      length = 0x0002     # Number of bytes to follow.
+      grbit  = 0x0000     # Option flags.
+
+      header = [record, length].pack('vv')
+      data   = [grbit].pack('v')
+
+      append(header, data)
+    end
+  end
+end

data/lib/writeexcel/charts/pie.rb

@@ -0,0 +1,169 @@
+###############################################################################
+#
+# Pie - A writer class for Excel Pie charts.
+#
+# Used in conjunction with Spreadsheet::WriteExcel::Chart.
+#
+# See formatting note in Spreadsheet::WriteExcel::Chart.
+#
+# Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel'
+
+class Chart
+
+  # ==SYNOPSIS
+  #
+  # To create a simple Excel file with a Pie chart using WriteExcel:
+  #
+  #     #!/usr/bin/ruby -w
+  #
+  #     require 'writeexcel'
+  #
+  #     workbook  = Spreadsheet::WriteExcel.new('chart.xls')
+  #     worksheet = workbook.add_worksheet
+  #
+  #     chart     = workbook.add_chart(:type => Chart::Pie)
+  #
+  #     # Configure the chart.
+  #     chart.add_series(
+  #       :categories => '=Sheet1!$A$2:$A$7',
+  #       :values     => '=Sheet1!$B$2:$B$7'
+  #    )
+  #
+  #     # Add the worksheet data the chart refers to.
+  #     data = [
+  #         [ 'Category', 2, 3, 4, 5, 6, 7 ],
+  #         [ 'Value',    1, 4, 5, 2, 1, 5 ]
+  #     ]
+  #
+  #     worksheet.write('A1', data)
+  #
+  #     workbook.close
+  #
+  # ==DESCRIPTION
+  #
+  # This module implements Pie charts for Spreadsheet::WriteExcel. The chart
+  # object is created via the Workbook add_chart() method:
+  #
+  #     chart = workbook.add_chart(:type => Chart::Pie)
+  #
+  # Once the object is created it can be configured via the following methods
+  # that are common to all chart classes:
+  #
+  #     chart.add_series
+  #     chart.set_title
+  #
+  # These methods are explained in detail in Chart section of WriteExcel.
+  # Class specific methods or settings, if any, are explained below.
+  #
+  # ==Pie Chart Methods
+  #
+  # There aren't currently any pie chart specific methods. See the TODO
+  # section of Chart section in WriteExcel.
+  #
+  # A Pie chart doesn't have an X or Y axis so the following common chart
+  # methods are ignored.
+  #
+  #     chart.set_x_axis
+  #     chart.set_y_axis
+  #
+  # ==EXAMPLE
+  #
+  # Here is a complete example that demonstrates most of the available
+  # features when creating a chart.
+  #
+  #     #!/usr/bin/ruby -w
+  #
+  #     require 'writeexcel'
+  #
+  #     workbook  = Spreadsheet::WriteExcel.new('chart_pie.xls')
+  #     worksheet = workbook.add_worksheet
+  #     bold      = workbook.add_format(:bold => 1)
+  #
+  #     # Add the worksheet data that the charts will refer to.
+  #     headings = [ 'Category', 'Values' ]
+  #     data = [
+  #         [ '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 => Chart::Pie, :embedded => 1)
+  #
+  #     # Configure the series.
+  #     chart.add_series(
+  #       :name       => 'Pie sales data',
+  #       :categories => '=Sheet1!$A$2:$A$4',
+  #       :values     => '=Sheet1!$B$2:$B$4',
+  #    )
+  #
+  #     # Add a title.
+  #     chart.set_title(name => 'Popular Pie Types')
+  #
+  #
+  #     # Insert the chart into the worksheet (with an offset).
+  #     worksheet.insert_chart('C2', chart, 25, 10)
+  #
+  #     workbook.close
+  #
+  class Pie < Chart
+    ###############################################################################
+    #
+    # new()
+    #
+    #
+    def initialize(*args)   # :nodoc:
+      super
+      @vary_data_color = 1
+    end
+
+    ###############################################################################
+    #
+    # _store_chart_type()
+    #
+    # Implementation of the abstract method from the specific chart class.
+    #
+    # Write the Pie chart BIFF record.
+    #
+    def store_chart_type   # :nodoc:
+      record = 0x1019     # Record identifier.
+      length = 0x0006     # Number of bytes to follow.
+      angle  = 0x0000     # Angle.
+      donut  = 0x0000     # Donut hole size.
+      grbit  = 0x0002     # Option flags.
+
+      header = [record, length].pack('vv')
+      data  = [angle].pack('v')
+      data += [donut].pack('v')
+      data += [grbit].pack('v')
+
+      append(header, data)
+    end
+
+    ###############################################################################
+    #
+    # _store_axisparent_stream(). Overridden.
+    #
+    # Write the AXISPARENT chart substream.
+    #
+    # A Pie chart has no X or Y axis so we override this method to remove them.
+    #
+    def store_axisparent_stream   # :nodoc:
+      store_axisparent(*@config[:axisparent])
+
+      store_begin
+      store_pos(*@config[:axisparent_pos])
+
+      store_chartformat_stream
+      store_end
+    end
+  end
+end

data/lib/writeexcel/charts/scatter.rb

@@ -0,0 +1,192 @@
+###############################################################################
+#
+# Scatter - A writer class for Excel Scatter charts.
+#
+# Used in conjunction with Spreadsheet::WriteExcel::Chart.
+#
+# See formatting note in Spreadsheet::WriteExcel::Chart.
+#
+# Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel'
+
+class Chart
+
+  # ==SYNOPSIS
+  #
+  # To create a simple Excel file with a Scatter chart using WriteExcel:
+  #
+  #     #!/usr/bin/ruby -w
+  #
+  #     require 'writeexcel'
+  #
+  #     workbook  = Spreadsheet::WriteExcel.new('chart.xls')
+  #     worksheet = workbook.add_worksheet
+  #
+  #     chart     = workbook.add_chart(:type => Chart::Scatter)
+  #
+  #     # Configure the chart.
+  #     chart.add_series(
+  #       :categories => '=Sheet1!$A$2:$A$7',
+  #       :values     => '=Sheet1!$B$2:$B$7'
+  #    )
+  #
+  #     # Add the worksheet data the chart refers to.
+  #     data = [
+  #         [ 'Category', 2, 3, 4, 5, 6, 7 ],
+  #         [ 'Value',    1, 4, 5, 2, 1, 5 ]
+  #     ]
+  #
+  #     worksheet.write('A1', data)
+  #
+  #     workbook.close
+  #
+  # ==DESCRIPTION
+  #
+  # This module implements Scatter charts for WriteExcel.
+  # The chart object is created via the Workbook add_chart() method:
+  #
+  #     chart = workbook.add_chart(:type => Chart::Scatter)
+  #
+  # Once the object is created it can be configured via the following
+  # methods that are common to all chart classes:
+  #
+  #     chart.add_series
+  #     chart.set_x_axis
+  #     chart.set_y_axis
+  #     chart.set_title
+  #
+  # These methods are explained in detail in Chart section of WriteExcel.
+  # Class specific methods or settings, if any, are explained below.
+  #
+  # ==Scatter Chart Methods
+  #
+  # There aren't currently any scatter chart specific methods. See the TODO
+  # section of Chart section in WriteExcel.
+  #
+  # ==EXAMPLE
+  #
+  # Here is a complete example that demonstrates most of the available
+  # features when creating a chart.
+  #
+  #     #!/usr/bin/ruby -w
+  #
+  #     require 'writeexcel'
+  #
+  #     workbook  = Spreadsheet::WriteExcel.new('chart_scatter.xls')
+  #     worksheet = workbook.add_worksheet
+  #     bold      = workbook.add_format(:bold => 1)
+  #
+  #     # Add the worksheet data that the charts will refer to.
+  #     headings = [ 'Number', 'Sample 1', 'Sample 2' ]
+  #     data = [
+  #         [ 2, 3, 4, 5, 6, 7 ],
+  #         [ 1, 4, 5, 2, 1, 5 ],
+  #         [ 3, 6, 7, 5, 4, 3 ]
+  #     ]
+  #
+  #     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 => Chart::Scatter, :embedded => 1)
+  #
+  #     # Configure the first series. (Sample 1)
+  #     chart.add_series(
+  #       :name       => 'Sample 1',
+  #       :categories => '=Sheet1!$A$2:$A$7',
+  #       :values     => '=Sheet1!$B$2:$B$7'
+  #    )
+  #
+  #     # Configure the second series. (Sample 2)
+  #     chart.add_series(
+  #       :name       => 'Sample 2',
+  #       :categories => '=Sheet1!$A$2:$A$7',
+  #       :values     => '=Sheet1!$C$2:$C$7'
+  #    )
+  #
+  #     # 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 (cm)')
+  #
+  #     # Insert the chart into the worksheet (with an offset).
+  #     worksheet.insert_chart('D2', chart, 25, 10)
+  #
+  #     workbook.close
+  #
+  class Scatter < Chart
+    ###############################################################################
+    #
+    # new()
+    #
+    #
+    def initialize(*args)   # :nodoc:
+      super
+    end
+
+    ###############################################################################
+    #
+    # _store_chart_type()
+    #
+    # Implementation of the abstract method from the specific chart class.
+    #
+    # Write the AREA chart BIFF record. Defines a area chart type.
+    #
+    def store_chart_type   # :nodoc:
+      record       = 0x101B     # Record identifier.
+      length       = 0x0006     # Number of bytes to follow.
+      bubble_ratio = 0x0064     # Bubble ratio.
+      bubble_type  = 0x0001     # Bubble type.
+      grbit        = 0x0000     # Option flags.
+
+      header = [record, length].pack('vv')
+      data   = [bubble_ratio].pack('v')
+      data  += [bubble_type].pack('v')
+      data  += [grbit].pack('v')
+
+      append(header, data)
+    end
+
+    ###############################################################################
+    #
+    # _store_axis_category_stream(). Overridden.
+    #
+    # Write the AXIS chart substream for the chart category.
+    #
+    # For a Scatter chart the category stream is replace with a values stream. We
+    # override this method and turn it into a values stream.
+    #
+    def store_axis_category_stream   # :nodoc:
+      store_axis(0)
+
+      store_begin
+      store_valuerange
+      store_tick
+      store_end
+    end
+
+    ###############################################################################
+    #
+    # _store_marker_dataformat_stream(). Overridden.
+    #
+    # This is an implementation of the parent abstract method  to define
+    # properties of markers, linetypes, pie formats and other.
+    #
+    def store_marker_dataformat_stream   # :nodoc:
+      store_dataformat(0x0000, 0xFFFD, 0x0000)
+
+      store_begin
+      store_3dbarshape
+      store_lineformat(0x00000000, 0x0005, 0xFFFF, 0x0008, 0x004D)
+      store_areaformat(0x00FFFFFF, 0x0000, 0x01, 0x01, 0x4E, 0x4D)
+      store_pieformat
+      store_markerformat(0x00, 0x00, 0x02, 0x01, 0x4D, 0x4D, 0x3C)
+      store_end
+    end
+  end
+end