write_xlsx 0.0.2

data/lib/write_xlsx/chart/scatter.rb

@@ -0,0 +1,252 @@
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+# Scatter - A class for writing Excel Scatter charts.
+#
+# Used in conjunction with Chart.
+#
+# See formatting note in Chart.
+#
+# Copyright 2000-2011, John McNamara, jmcnamara@cpan.org
+# Convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/chart'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  class Chart
+    # The Scatter chart module also supports the following sub-types:
+    #
+    #     markers_only (the default)
+    #     straight_with_markers
+    #     straight
+    #     smooth_with_markers
+    #     smooth
+    # These can be specified at creation time via the add_chart() Worksheet
+    # method:
+    #
+    #     chart = workbook.add_chart(
+    #         :type    => 'scatter',
+    #         :subtype => 'straight_with_markers'
+    #     )
+    #
+    class Scatter < self
+      include Writexlsx::Utility
+
+      def initialize
+        super(self.class)
+        @subtype        = 'marker_only'
+        @cross_between  = 'midCat'
+        @horiz_val_axis = 0
+      end
+
+      #
+      # Override the virtual superclass method with a chart specific method.
+      #
+      def write_chart_type
+        # Write the c:areaChart element.
+        write_scatter_chart
+      end
+
+      #
+      # Write the <c:pieChart> element.
+      #
+      def write_scatter_chart
+        style   = 'lineMarker'
+        subtype = @subtype
+
+        # Set the user defined chart subtype
+        case subtype
+        when 'marker_only', 'straight_with_markers', 'straight'
+          style = 'lineMarker'
+        when 'smooth_with_markers', 'smooth'
+          style = 'smoothMarker'
+        end
+
+        # Add default formatting to the series data.
+        modify_series_formatting
+
+        @writer.start_tag('c:scatterChart')
+
+        # Write the c:scatterStyle element.
+        write_scatter_style(style)
+
+        # Write the series elements.
+        write_series
+
+        @writer.end_tag('c:scatterChart')
+      end
+
+      #
+      # Over-ridden to write c:xVal/c:yVal instead of c:cat/c:val elements.
+      #
+      # Write the <c:ser> element.
+      #
+      def write_ser(index, series)
+        @writer.start_tag('c:ser')
+
+        # Write the c:idx element.
+        write_idx(index)
+
+        # Write the c:order element.
+        write_order(index)
+
+        # Write the series name.
+        write_series_name(series)
+
+        # Write the c:spPr element.
+        write_sp_pr(series)
+
+        # Write the c:marker element.
+        write_marker(series[:_marker])
+
+        # Write the c:dLbls element.
+        write_d_lbls(series[:_labels])
+
+        # Write the c:trendline element.
+        write_trendline(series[:_trendline])
+
+        # Write the c:xVal element.
+        write_x_val(series)
+
+        # Write the c:yVal element.
+        write_y_val(series)
+
+        # Write the c:smooth element.
+        write_c_smooth
+
+        @writer.end_tag('c:ser')
+      end
+
+      #
+      # Over-ridden to have 2 valAx elements for scatter charts instead of
+      # catAx/valAx.
+      #
+      # Write the <c:plotArea> element.
+      #
+      def write_plot_area
+        @writer.start_tag('c:plotArea')
+
+        # Write the c:layout element.
+        write_layout
+
+        # Write the subclass chart type element.
+        write_chart_type
+
+        # Write the c:catAx element.
+        write_cat_val_axis('b', 1)
+
+        # Write the c:catAx element.
+        @horiz_val_axis = 1
+        write_val_axis('l')
+
+        @writer.end_tag('c:plotArea')
+      end
+
+      #
+      # Write the <c:xVal> element.
+      #
+      def write_x_val(series)
+        formula = series[:_categories]
+        data_id = series[:_cat_data_id]
+        data    = @formula_data[data_id]
+
+        @writer.start_tag('c:xVal')
+
+        # Check the type of cached data.
+        type = get_data_type(data)
+
+        # TODO. Can a scatter plot have non-numeric data.
+
+        if type == 'str'
+          # Write the c:numRef element.
+          write_str_ref(formula, data, type)
+        else
+          # Write the c:numRef element.
+          write_num_ref(formula, data, type)
+        end
+
+        @writer.end_tag('c:xVal')
+      end
+
+      #
+      # Write the <c:yVal> element.
+      #
+      def write_y_val(series)
+        formula = series[:_values]
+        data_id = series[:_val_data_id]
+        data    = @formula_data[data_id]
+
+        @writer.start_tag('c:yVal')
+
+        # Check the type of cached data.
+        type = get_data_type(data)
+
+        if type == 'str'
+          # Write the c:numRef element.
+          write_str_ref(formula, data, type)
+        else
+          # Write the c:numRef element.
+          write_num_ref(formula, data, type)
+        end
+
+        @writer.end_tag('c:yVal')
+      end
+
+      #
+      # Write the <c:scatterStyle> element.
+      #
+      def write_scatter_style(val)
+        attributes = ['val', val]
+
+        @writer.empty_tag('c:scatterStyle', attributes)
+      end
+
+      #
+      # Write the <c:smooth> element.
+      #
+      def write_c_smooth
+        subtype = @subtype
+        val     = 1
+
+        return unless subtype =~ /smooth/
+
+        attributes = ['val', val]
+
+        @writer.empty_tag('c:smooth', attributes)
+      end
+
+      #
+      # Add default formatting to the series data unless it has already been
+      # specified by the user.
+      #
+      def modify_series_formatting
+        subtype = @subtype
+
+        # The default scatter style "markers only" requires a line type
+        if subtype == 'marker_only'
+          # Go through each series and define default values.
+          @series.each do |series|
+            # Set a line type unless there is already a user defined type.
+            if series[:_line][:_defined] == 0
+              series[:_line] = { :width => 2.25, :none => 1, :_defined => 1 }
+            end
+          end
+        end
+
+        # Turn markers off for subtypes that don't have them
+        unless subtype =~ /marker/
+          # Go through each series and define default values.
+          @series.each do |series|
+            # Set a marker type unless there is already a user defined type.
+            if series[:_marker][:_defined] == 0
+              series[:_marker] = { :type => 'none', :_defined => 1 }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/write_xlsx/chart/stock.rb

@@ -0,0 +1,134 @@
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+# Stock - A class for writing Excel Stock charts.
+#
+# Used in conjunction with Chart.
+#
+# See formatting note in Chart.
+#
+# Copyright 2000-2011, John McNamara, jmcnamara@cpan.org
+# Convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/chart'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  class Chart
+    #
+    # The default Stock chart is an High-Low-Close chart.
+    # A series must be added for each of these data sources.
+    #
+    class Stock < self
+      include Writexlsx::Utility
+
+      def initialize
+        super(self.class)
+      end
+
+      #
+      # Override the virtual superclass method with a chart specific method.
+      #
+      def write_chart_type
+        # Write the c:areaChart element.
+        write_stock_chart
+      end
+
+      #
+      # Write the <c:stockChart> element.
+      #
+      def write_stock_chart
+        # Add default formatting to the series data.
+        modify_series_formatting
+
+        @writer.start_tag('c:stockChart')
+
+        # Write the series elements.
+        write_series
+
+        @writer.end_tag('c:stockChart')
+      end
+
+      #
+      # Over-ridden to add hi_low_lines(). TODO. Refactor up into the SUPER class.
+      #
+      # Write the series elements.
+      #
+      def write_series
+        # Write each series with subelements.
+        index = 0
+        @series.each do |series|
+          write_ser(index, series)
+          index += 1
+        end
+
+        # Write the c:hiLowLines element.
+        write_hi_low_lines
+
+        # Write the c:marker element.
+        write_marker_value
+
+        # Generate the axis ids.
+        add_axis_id
+        add_axis_id
+
+        # Write the c:axId element.
+        write_axis_id(@axis_ids[0])
+        write_axis_id(@axis_ids[1])
+      end
+
+      #
+      # Write the <c:plotArea> element.
+      #
+      def write_plot_area
+        @writer.start_tag('c:plotArea')
+
+        # Write the c:layout element.
+        write_layout
+
+        # Write the subclass chart type element.
+        write_chart_type
+
+        # Write the c:dateAx element.
+        write_date_axis
+
+        # Write the c:catAx element.
+        write_val_axis
+
+        @writer.end_tag('c:plotArea')
+      end
+
+      #
+      # Add default formatting to the series data.
+      #
+      def modify_series_formatting
+        index = 0
+        array = []
+        @series.each do |series|
+          if index % 4 != 3
+            if series[:_line][:_defined].nil? || series[:_line][:_defined] == 0
+              series[:_line] = {
+                :width    => 2.25,
+                :none     => 1,
+                :_defined => 1
+              }
+            end
+
+            if series[:_marker].nil? || series[:_marker] == 0
+              if index % 4 == 2
+                series[:_marker] = { :type => 'dot', :size => 3 }
+              else
+                series[:_marker] = { :type => 'none' }
+              end
+            end
+          end
+          index += 1
+          array << series
+        end
+        @series = array
+      end
+    end
+  end
+end

data/lib/write_xlsx/chartsheet.rb

@@ -0,0 +1,173 @@
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+# Chartsheet - A class for writing the Excel XLSX Chartsheet files.
+#
+# Used in conjunction with WriteXLSX
+#
+# Copyright 2000-2011, John McNamara, jmcnamara@cpan.org
+# Convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'write_xlsx/worksheet'
+
+module Writexlsx
+  class Chartsheet < Worksheet
+    include Writexlsx::Utility
+
+    def initialize(workbook, index, name)
+      super
+      @drawing = 1
+      @is_chartsheet     = true
+      @chart             = nil
+      @charts            = [1]
+      @zoom_scale_normal = 0
+      @oriantation       = 0
+    end
+
+    #
+    # Assemble and write the XML file.
+    #
+    def assemble_xml_file # :nodoc:
+      return unless @writer
+      write_xml_declaration
+
+      # Write the root chartsheet element.
+      write_chartsheet
+
+      # Write the worksheet properties.
+      write_sheet_pr
+
+      # Write the sheet view properties.
+      write_sheet_views
+
+      # Write the sheetProtection element.
+      write_sheet_protection
+
+      # Write the printOptions element.
+      write_print_options
+
+      # Write the worksheet page_margins.
+      write_page_margins
+
+      # Write the worksheet page setup.
+      write_page_setup
+
+      # Write the headerFooter element.
+      write_header_footer
+
+      # Write the drawing element.
+      write_drawings
+
+      # Close the worksheet tag.
+      @writer.end_tag('chartsheet')
+
+      # Close the XML writer object and filehandle.
+      @writer.crlf
+      @writer.getOutput->close
+    end
+
+    def protect(password = '', options = {})
+      @chart.protection = 1
+
+      options[:sheet]     = 0
+      options[:content]   = 1
+      options[:scenarios] = 1
+
+      super(password, options)
+    end
+
+
+    ###############################################################################
+    #
+    # Encapsulated Chart methods.
+    #
+    ###############################################################################
+
+    def add_series(*args)
+      @chart.add_series(*args)
+    end
+
+    def set_x_axis(*args)
+      @chart.set_x_axis(*args)
+    end
+
+    def set_y_axis(*args)
+      @chart.set_y_axis(*args)
+    end
+
+    def set_title(*args)
+      @chart.set_title(*args)
+    end
+
+    def set_legend(*args)
+      @chart.set_legend(*args)
+    end
+
+    def set_plotarea(*args)
+      @chart.set_plotarea(*args)
+    end
+
+    def set_chartarea(*args)
+      @chart.set_chartarea(*args)
+    end
+
+    def set_style(*args)
+      @chart.set_style(*args)
+    end
+
+    private
+
+    #
+    # Set up chart/drawings.
+    #
+    def prepare_chart(index, chart_id, drawing_id) # :nodoc:
+      drawing = Drawing.new
+      @drawing = $drawing
+      @drawing.orientation = @orientation
+
+      @external_drawing_links << [ '/drawing', '../drawings/drawing' << drawing_id << '.xml' ]
+
+      @drawing_links << [ '/chart', '../charts/chart' << chart_id << '.xml' ]
+    end
+
+    #
+    # Write the <chartsheet> element. This is the root element of Chartsheet.
+    #
+    def write_chartsheet # :nodoc:
+      schema                 = 'http://schemas.openxmlformats.org/'
+      xmlns                  = schema + 'spreadsheetml/2006/main'
+      xmlns_r                = schema + 'officeDocument/2006/relationships'
+      xmlns_mc               = schema + 'markup-compatibility/2006'
+      xmlns_mv               = 'urn:schemas-microsoft-com:mac:vml'
+      mc_ignorable           = 'mv'
+      mc_preserve_attributes = 'mv:*'
+
+      attributes = [
+                    'xmlns',   xmlns,
+                    'xmlns:r', xmlns_r
+                   ]
+
+      @writer.start_tag('chartsheet', attributes)
+    end
+
+    #
+    # Write the <sheetPr> element for Sheet level properties.
+    #
+    def _write_sheet_pr # :nodoc:
+
+      attributes = []
+
+      attributes << {'filterMode' => 1} if @filter_on
+
+      if @fit_page || @tab_color
+        @writer.start_tag('sheetPr', attributes)
+        write_tab_color
+        write_page_set_up_pr
+        @writer.end_tag('sheetPr')
+      else
+        @writer.empty_tag('sheetPr', attributes)
+      end
+    end
+  end
+end