write_xlsx 0.81.1 → 0.83.0

data/lib/write_xlsx/chart/axis.rb

@@ -14,7 +14,7 @@ class Axis < Caption
       attr_reader :log_base, :crossing, :position_axis, :label_position, :visible
       attr_reader :num_format_linked, :num_font, :layout, :interval_unit
       attr_reader :major_gridlines, :minor_gridlines, :reverse
-      attr_reader :line, :fill
+      attr_reader :line, :fill, :text_axis
       #
       # Convert user defined axis values into axis instance.
       #
@@ -37,6 +37,10 @@ def merge_with_hash(params) # :nodoc:
         set_axis_name_layout(args)
         set_axis_line(args)
         set_axis_fill(args)
+        if ptrue?(args[:text_axis])
+          @chart.date_category = false
+          @text_axis = true
+        end
       end
 
       #

data/lib/write_xlsx/chart/bar.rb

@@ -42,6 +42,19 @@ def initialize(subtype)
         }
       end
 
+      #
+      # Override parent method to add an extra check that is required for Bar
+      # charts to ensure that their combined chart is on a secondary axis.
+      #
+      def combine(chart)
+
+        unless chart.is_secondary?
+          raise 'Charts combined with Bar charts must be on a secondary axis'
+        end
+
+        super
+      end
+
       #
       # Override the virtual superclass method with a chart specific method.
       #

data/lib/write_xlsx/chart/pie.rb

@@ -42,6 +42,13 @@ def initialize(subtype)
         }
       end
 
+      #
+      # Override parent method to add a warning.
+      #
+      def combine(chart)
+        raise "Combined chart not currently supported for Pie charts"
+      end
+
       #
       # Set the Pie/Doughnut chart rotation: the angle of the first slice.
       #

data/lib/write_xlsx/chart/scatter.rb

@@ -58,6 +58,13 @@ def initialize(subtype)
         }
       end
 
+      #
+      # Override parent method to add a warning.
+      #
+      def combine(chart)
+        raise 'Combined chart not currently supported with scatter chart as the primary chart'
+      end
+
       #
       # Override the virtual superclass method with a chart specific method.
       #
@@ -102,28 +109,8 @@ def write_scatter_chart(params)
       # Write the <c:ser> element.
       #
       def write_ser(series)
-        index = @series_index
-        @series_index += 1
-
         @writer.tag_elements('c:ser') do
-          # 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:dPt element.
-          write_d_pt(series.points)
-          # Write the c:dLbls element.
-          write_d_lbls(series.labels)
-          # Write the c:trendline element.
-          write_trendline(series.trendline)
-          # Write the c:errBars element.
-          write_error_bars(series.error_bars)
+          write_ser_base(series)
           # Write the c:xVal element.
           write_x_val(series)
           # Write the c:yVal element.
@@ -135,6 +122,7 @@ def write_ser(series)
             write_c_smooth(series.smooth)
           end
         end
+        @series_index += 1
       end
 
       #
@@ -148,41 +136,23 @@ def write_plot_area
           # Write the c:layout element.
           write_layout(@plotarea.layout, 'plot')
 
-          # Write the subclass chart type elements for primary and secondary axes
+          # Write the subclass chart type elements for primary and secondary axes.
           write_chart_type(:primary_axes => 1)
           write_chart_type(:primary_axes => 0)
 
-          # Write c:catAx and c:valAx elements for series using primary axes
-          write_cat_val_axis(
-                             :x_axis   => @x_axis,
-                             :y_axis   => @y_axis,
-                             :axis_ids => @axis_ids,
-                             :position => 'b'
-                             )
+          # Write c:catAx and c:valAx elements for series using primary axes.
+          write_cat_val_axis(@x_axis, @y_axis, @axis_ids, 'b')
+
           tmp = @horiz_val_axis
           @horiz_val_axis = 1
-          write_val_axis(
-                         :x_axis   => @x_axis,
-                         :y_axis   => @y_axis,
-                         :axis_ids => @axis_ids,
-                         :position => 'l'
-                         )
+          write_val_axis(@x_axis, @y_axis, @axis_ids, 'l')
           @horiz_val_axis = tmp
 
-          # Write c:valAx and c:catAx elements for series using secondary axes
-          write_cat_val_axis(
-                             :x_axis   => @x2_axis,
-                             :y_axis   => @y2_axis,
-                             :axis_ids => @axis2_ids,
-                             :position => 'b'
-                             )
+          # Write c:valAx and c:catAx elements for series using secondary axes.
+          write_cat_val_axis(@x2_axis, @y2_axis, @axis2_ids, 'b')
+
           @horiz_val_axis = 1
-          write_val_axis(
-                         :x_axis   => @x2_axis,
-                         :y_axis   => @y2_axis,
-                         :axis_ids => @axis2_ids,
-                         :position => 'l'
-                         )
+          write_val_axis(@x2_axis, @y2_axis, @axis2_ids, 'l')
 
           # Write the c:spPr element for the plotarea formatting.
           write_sp_pr(@plotarea)
@@ -269,17 +239,15 @@ def modify_series_formatting
       #
       # Usually the X axis.
       #
-      def write_cat_val_axis(params) # :nodoc:
-        axis_ids = params[:axis_ids]
+      def write_cat_val_axis(x_axis, y_axis, axis_ids, position) # :nodoc:
         return unless axis_ids && !axis_ids.empty?
 
-        x_axis   = params[:y_axis]
-        y_axis   = params[:x_axis]
-        axis_ids_0 = axis_ids[1]
-        axis_ids_1 = axis_ids[0]
-        position = y_axis.position || params[:position] || @val_axis_position
-
-        write_val_axis_base(x_axis, y_axis, axis_ids_0, axis_ids_1, position)
+        write_val_axis_base(
+          y_axis, x_axis,
+          axis_ids[1],
+          axis_ids[0],
+          x_axis.position || position || @val_axis_position
+        )
       end
     end
   end

data/lib/write_xlsx/format.rb

@@ -784,6 +784,46 @@ def write_font_rpr(writer, worksheet) #:nodoc:
       end
     end
 
+    def border_attributes
+      attributes = []
+
+      # Diagonal borders add attributes to the <border> element.
+      if diag_type == 1
+        attributes << ['diagonalUp',   1]
+      elsif diag_type == 2
+        attributes << ['diagonalDown', 1]
+      elsif diag_type == 3
+        attributes << ['diagonalUp',   1]
+        attributes << ['diagonalDown', 1]
+      end
+      attributes
+    end
+
+    def xf_attributes
+      attributes = [
+        ['numFmtId', num_format_index],
+        ['fontId'  , font_index],
+        ['fillId'  , fill_index],
+        ['borderId', border_index],
+        ['xfId'    , 0]
+      ]
+      attributes << ['applyNumberFormat', 1] if num_format_index > 0
+      # Add applyFont attribute if XF format uses a font element.
+      attributes << ['applyFont', 1] if font_index > 0
+      # Add applyFill attribute if XF format uses a fill element.
+      attributes << ['applyFill', 1] if fill_index > 0
+      # Add applyBorder attribute if XF format uses a border element.
+      attributes << ['applyBorder', 1] if border_index > 0
+
+      # Check if XF format has alignment properties set.
+      apply_align, align = get_align_properties
+      # We can also have applyAlignment without a sub-element.
+      attributes << ['applyAlignment', 1] if apply_align
+      attributes << ['applyProtection', 1] if get_protection_properties
+
+      attributes
+    end
+
     private
 
     def write_font_shapes(writer)

data/lib/write_xlsx/package/app.rb

@@ -8,8 +8,9 @@ class App
 
       include Writexlsx::Utility
 
-      def initialize
+      def initialize(workbook)
         @writer = Package::XMLWriterSimple.new
+        @workbook      = workbook
         @part_names    = []
         @heading_pairs = []
         @properties    = {}
@@ -37,10 +38,47 @@ def assemble_xml_file
         end
       end
 
+      def add_worksheet_heading_pairs
+        add_heading_pair(
+          [
+            'Worksheets',
+            @workbook.worksheets.reject {|s| s.is_chartsheet?}.count
+          ]
+        )
+      end
+
+      def add_chartsheet_heading_pairs
+        add_heading_pair(['Charts', @workbook.chartsheet_count])
+      end
+
+      def add_worksheet_part_names
+        @workbook.worksheets.
+          reject { |sheet| sheet.is_chartsheet? }.
+          each   { |sheet| add_part_name(sheet.name) }
+      end
+
+      def add_chartsheet_part_names
+        @workbook.worksheets.
+          select { |sheet| sheet.is_chartsheet? }.
+          each   { |sheet| add_part_name(sheet.name) }
+      end
+
       def add_part_name(part_name)
         @part_names.push(part_name)
       end
 
+      def add_named_range_heading_pairs
+        range_count = @workbook.named_ranges.size
+
+        if range_count != 0
+          add_heading_pair([ 'Named Ranges', range_count ])
+        end
+      end
+
+      def add_named_ranges_parts
+        @workbook.named_ranges.each { |named_range| add_part_name(named_range) }
+      end
+
       def add_heading_pair(heading_pair)
         return if heading_pair[1] == 0
 

data/lib/write_xlsx/package/comments.rb

@@ -311,11 +311,7 @@ def comments_visible?
       # Write the <comments> element.
       #
       def write_comments
-        xmlns = 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'
-
-        attributes = [
-                      ['xmlns', xmlns]
-                     ]
+        attributes = [ ['xmlns', XMLWriterSimple::XMLNS] ]
 
         @writer.tag_elements('comments', attributes) { yield }
       end

data/lib/write_xlsx/package/content_types.rb

@@ -11,8 +11,9 @@ class ContentTypes
       App_package  = 'application/vnd.openxmlformats-package.'
       App_document = 'application/vnd.openxmlformats-officedocument.'
 
-      def initialize
+      def initialize(workbook)
         @writer = Package::XMLWriterSimple.new
+        @workbook  = workbook
         @defaults  = [
           [ 'rels', "#{App_package}relationships+xml" ],
           [ 'xml', 'application/xml' ]
@@ -52,6 +53,12 @@ def add_override(part_name, content_type)
         @overrides.push([part_name, content_type])
       end
 
+      def add_worksheet_names
+        @workbook.non_chartsheet_count.times do |index|
+          add_worksheet_name("sheet#{index+1}")
+        end
+      end
+
       #
       # Add the name of a worksheet to the ContentTypes overrides.
       #
@@ -61,6 +68,12 @@ def add_worksheet_name(name)
         add_override(worksheet_name, "#{App_document}spreadsheetml.worksheet+xml")
       end
 
+      def add_chartsheet_names
+        @workbook.chartsheet_count.times do |index|
+          add_chartsheet_name("sheet#{index+1}")
+        end
+      end
+
       #
       # Add the name of a chartsheet to the ContentTypes overrides.
       #
@@ -70,6 +83,10 @@ def add_chartsheet_name(name)
         add_override(chartsheet_name, "#{App_document}spreadsheetml.chartsheet+xml")
       end
 
+      def add_chart_names
+        (1 .. @workbook.charts.size).each { |i| add_chart_name("chart#{i}") }
+      end
+
       #
       # Add the name of a chart to the ContentTypes overrides.
       #
@@ -79,6 +96,12 @@ def add_chart_name(name)
         add_override(chart_name, "#{App_document}drawingml.chart+xml")
       end
 
+      def add_drawing_names
+        (1 .. @workbook.drawings.size).each do |i|
+          add_drawing_name("drawing#{i}")
+        end
+      end
+
       #
       # Add the name of a drawing to the ContentTypes overrides.
       #
@@ -95,6 +118,12 @@ def add_vml_name
         add_default('vml', "#{App_document}vmlDrawing")
       end
 
+      def add_comment_names
+        (1 .. @workbook.num_comment_files).each do |i|
+          add_comment_name("comments#{i}")
+        end
+      end
+
       #
       # Add the name of a comment to the ContentTypes overrides.
       #
@@ -121,8 +150,14 @@ def add_calc_chain
       #
       # Add the image default types.
       #
-      def add_image_types(types)
-        types.each_key { |type| add_default(type, "image/#{type}") }
+      def add_image_types
+        @workbook.image_types.each_key do |type|
+          add_default(type, "image/#{type}")
+        end
+      end
+
+      def add_table_names(table_count)
+        (1 .. table_count).each { |i| add_table_name("table#{i}") }
       end
 
       #
@@ -159,11 +194,7 @@ def change_the_workbook_xml_content_type_from_xlsx_to_xlsm
       #
       def write_defaults
         @defaults.each do |a|
-          @writer.empty_tag('Default',
-                            [
-                             ['Extension', a[0]],
-                             ['ContentType', a[1]]
-                            ])
+          write_default_or_override('Default', 'Extension', a)
         end
       end
 
@@ -172,14 +203,18 @@ def write_defaults
       #
       def write_overrides
         @overrides.each do |a|
-          @writer.empty_tag('Override',
-                            [
-                             ['PartName', a[0]],
-                             ['ContentType', a[1]]
-                            ])
+          write_default_or_override('Override', 'PartName', a)
         end
       end
 
+      def write_default_or_override(tag, param0, a)
+        @writer.empty_tag(tag,
+          [
+            [param0, a[0]],
+            ['ContentType', a[1]]
+          ])
+      end
+
       #
       # Write the <Types> element.
       #

data/lib/write_xlsx/package/core.rb

@@ -23,18 +23,7 @@ def set_xml_writer(filename)
 
       def assemble_xml_file
         write_xml_declaration do
-          write_cp_core_properties do
-            write_dc_title
-            write_dc_subject
-            write_dc_creator
-            write_cp_keywords
-            write_dc_description
-            write_cp_last_modified_by
-            write_dcterms_created
-            write_dcterms_modified
-            write_cp_category
-            write_cp_content_status
-          end
+          write_cp_core_properties { write_cp_core_properties_base }
         end
       end
 
@@ -44,6 +33,19 @@ def set_properties(properties)
 
       private
 
+      def write_cp_core_properties_base
+        write_dc_title
+        write_dc_subject
+        write_dc_creator
+        write_cp_keywords
+        write_dc_description
+        write_cp_last_modified_by
+        write_dcterms_created
+        write_dcterms_modified
+        write_cp_category
+        write_cp_content_status
+      end
+
       #
       # Convert a localtime() date to a ISO 8601 style "2010-01-01T00:00:00Z" date.
       #