write_xlsx 0.85.9 → 1.09.2

data/lib/write_xlsx/chartsheet.rb

@@ -6,7 +6,7 @@
 # Used in conjunction with WriteXLSX
 #
 # Copyright 2000-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/worksheet'
@@ -19,7 +19,7 @@ module Writexlsx
 
     def initialize(workbook, index, name)
       super
-      @drawing           = Drawing.new
+      @drawings          = Drawings.new
       @is_chartsheet     = true
       @chart             = nil
       @charts            = [1]
@@ -57,11 +57,39 @@ module Writexlsx
       end
     end
 
-    def protect(password = '', options = {})
+    def protect(password = '', user_options = nil, options = {})
+      # Objects are default on for chartsheets.
+      if user_options
+        if user_options.has_key?(:objects)
+          if ptrue?(user_options[:objects])
+            options[:objects] = 0
+          else
+            options[:objects] = 1
+          end
+        else
+          options[:objects] = 0
+        end
+
+        if user_options.has_key?(:content)
+          options[:content] = user_options[:content]
+        else
+          options[:content] = 1
+        end
+      else
+        options[:objects] = 0
+        options[:content] = 1
+      end
+
+      # Is objects and content are off then the chartsheet isn't locked.
+      # except if it has a password.
+      if password == '' && ptrue?(options[:objects]) && !ptrue?(options[:content])
+        return
+      end
+
       @chart.protection = 1
 
+      # Turn off worksheet defaults.
       options[:sheet]     = 0
-      options[:content]   = 1
       options[:scenarios] = 1
 
       super(password, options)
@@ -148,9 +176,9 @@ module Writexlsx
     def prepare_chart(index, chart_id, drawing_id) # :nodoc:
       @chart.id = chart_id - 1
 
-      drawing = Drawing.new
-      @drawing = drawing
-      @drawing.orientation = @page_setup.orientation
+      drawings  = Drawings.new
+      @drawings = drawings
+      @drawings.orientation = @page_setup.orientation
 
       @external_drawing_links << [ '/drawing', "../drawings/drawing#{drawing_id}.xml" ]
 
@@ -176,9 +204,9 @@ module Writexlsx
       mc_preserve_attributes = 'mv:*'
 
       attributes = [
-                    ['xmlns',   xmlns],
-                    ['xmlns:r', xmlns_r]
-                   ]
+        ['xmlns',   xmlns],
+        ['xmlns:r', xmlns_r]
+      ]
 
       @writer.tag_elements('chartsheet', attributes) do
         yield

data/lib/write_xlsx/drawing.rb

@@ -4,6 +4,16 @@ require 'write_xlsx/utility'
 
 module Writexlsx
   class Drawing
+    attr_accessor :type, :dimensions, :width, :height, :description, :shape, :anchor, :rel_index, :url_rel_index
+    attr_reader :tip, :decorative
+
+    def initialize(type, dimensions, width, height, description, shape, anchor, rel_index = nil, url_rel_index = nil, tip = nil, decorative = nil)
+      @type, @dimensions, @width, @height, @description, @shape, @anchor, @rel_index, @url_rel_index, @tip, @decorative =
+                                                                                                            type, dimensions, width, height, description, shape, anchor, rel_index, url_rel_index, tip, decorative
+    end
+  end
+
+  class Drawings
     include Writexlsx::Utility
 
     attr_writer :embedded, :orientation
@@ -32,10 +42,10 @@ module Writexlsx
         write_drawing_workspace do
           if @embedded
             index = 0
-            @drawings.each do |dimensions|
+            @drawings.each do |drawing|
               # Write the xdr:twoCellAnchor element.
               index += 1
-              write_two_cell_anchor(index, *(dimensions.flatten))
+              write_two_cell_anchor(index, drawing)
             end
           else
             # Write the xdr:absoluteAnchor element.
@@ -48,8 +58,8 @@ module Writexlsx
     #
     # Add a chart, image or shape sub object to the drawing.
     #
-    def add_drawing_object(*args)
-      @drawings << args.flatten
+    def add_drawing_object(drawing)
+      @drawings << drawing
     end
 
     private
@@ -60,8 +70,8 @@ module Writexlsx
     def write_drawing_workspace
       schema    = 'http://schemas.openxmlformats.org/drawingml/'
       attributes = [
-          ['xmlns:xdr', "#{schema}2006/spreadsheetDrawing"],
-          ['xmlns:a',    "#{schema}2006/main"]
+        ['xmlns:xdr', "#{schema}2006/spreadsheetDrawing"],
+        ['xmlns:a',    "#{schema}2006/main"]
       ]
 
       @writer.tag_elements('xdr:wsDr', attributes) { yield }
@@ -71,14 +81,30 @@ module Writexlsx
     # Write the <xdr:twoCellAnchor> element.
     #
     def write_two_cell_anchor(*args)
-      index, type, col_from, row_from, col_from_offset, row_from_offset,
-      col_to, row_to, col_to_offset, row_to_offset, col_absolute, row_absolute,
-      width, height, description, shape = args
+      index, drawing = args
+
+      type          = drawing.type
+      width         = drawing.width
+      height        = drawing.height
+      description   = drawing.description
+      shape         = drawing.shape
+      anchor        = drawing.anchor
+      rel_index     = drawing.rel_index
+      url_rel_index = drawing.url_rel_index
+      tip           = drawing.tip
+      decorative    = drawing.decorative
+
+      col_from, row_from, col_from_offset, row_from_offset,
+      col_to, row_to, col_to_offset, row_to_offset, col_absolute, row_absolute = drawing.dimensions
 
       attributes      = []
 
       # Add attribute for images.
-      attributes << [:editAs, 'oneCell'] if type == 2
+      if anchor == 2
+        attributes << [:editAs, 'oneCell']
+      elsif anchor == 3
+        attributes << [:editAs, 'absolute']
+      end
 
       # Add attribute for shapes.
       attributes << [:editAs, shape.edit_as] if shape && shape.edit_as
@@ -93,10 +119,14 @@ module Writexlsx
           # Graphic frame.
 
           # Write the xdr:graphicFrame element for charts.
-          write_graphic_frame(index, description)
+          write_graphic_frame(index, rel_index, description)
         elsif type == 2
           # Write the xdr:pic element.
-          write_pic(index, col_absolute, row_absolute, width, height, description)
+          write_pic(
+            index,        rel_index,      col_absolute,
+            row_absolute, width,          height,
+            description,  url_rel_index , tip, decorative
+          )
         else
           # Write the xdr:sp element for shapes.
           write_sp(index, col_absolute, row_absolute, width, height, shape)
@@ -119,24 +149,24 @@ module Writexlsx
           write_pos(0, 0)
 
           # Write the xdr:ext element.
-          write_ext(9308969, 6078325)
+          write_xdr_ext(9308969, 6078325)
         else
           # Write the xdr:pos element.
           write_pos(0, -47625)
 
           # Write the xdr:ext element.
-          write_ext(6162675, 6124575)
+          write_xdr_ext(6162675, 6124575)
         end
 
         # Write the xdr:graphicFrame element.
-        write_graphic_frame(index)
+        write_graphic_frame(index, index)
 
         # Write the xdr:clientData element.
         write_client_data
       end
     end
 
-      #
+    #
     # Write the <xdr:from> element.
     #
     def write_from(col, row, col_offset, row_offset)
@@ -203,9 +233,9 @@ module Writexlsx
     #
     def write_pos(x, y)
       attributes = [
-                    ['x', x],
-                    ['y', y]
-                   ]
+        ['x', x],
+        ['y', y]
+      ]
 
       @writer.empty_tag('xdr:pos', attributes)
     end
@@ -213,11 +243,11 @@ module Writexlsx
     #
     # Write the <xdr:ext> element.
     #
-    def write_ext(cx, cy)
+    def write_xdr_ext(cx, cy)
       attributes = [
-                    ['cx', cx],
-                    ['cy', cy]
-                   ]
+        ['cx', cx],
+        ['cy', cy]
+      ]
 
       @writer.empty_tag('xdr:ext', attributes)
     end
@@ -225,7 +255,7 @@ module Writexlsx
     #
     # Write the <xdr:graphicFrame> element.
     #
-    def write_graphic_frame(index, name = nil)
+    def write_graphic_frame(index, rel_index, name = nil)
       macro  = ''
 
       attributes = [ ['macro', macro] ]
@@ -236,7 +266,7 @@ module Writexlsx
         # Write the xdr:xfrm element.
         write_xfrm
         # Write the a:graphic element.
-        write_atag_graphic(index)
+        write_atag_graphic(rel_index)
       end
     end
 
@@ -257,18 +287,104 @@ module Writexlsx
     #
     # Write the <xdr:cNvPr> element.
     #
-    def write_c_nv_pr(id, name, descr = nil)
+    def write_c_nv_pr(index, name, description = nil, url_rel_index = nil, tip = nil, decorative = nil)
       attributes = [
-          ['id',   id],
-          ['name', name]
+        ['id',   index],
+        ['name', name]
       ]
 
       # Add description attribute for images.
-      attributes << ['descr', descr] if descr
+      attributes << ['descr', description] if ptrue?(description) && !ptrue?(decorative)
+
+      if ptrue?(url_rel_index) || ptrue?(decorative)
+        @writer.tag_elements('xdr:cNvPr', attributes) do
+          if ptrue?(url_rel_index)
+            # Write the a:hlinkClick element.
+            write_a_hlink_click(url_rel_index, tip)
+          end
+          if ptrue?(decorative)
+            # Write the adec:decorative element.
+            write_decorative
+          end
+        end
+      else
+        @writer.empty_tag('xdr:cNvPr', attributes)
+      end
+    end
+
+    #
+    # Write the <a:hlinkClick> element.
+    #
+    def write_a_hlink_click(index, tip)
+      schema  = 'http://schemas.openxmlformats.org/officeDocument/'
+      xmlns_r = "#{schema}2006/relationships"
+      r_id    = "rId#{index}"
+
+      attributes = [
+        ['xmlns:r', xmlns_r],
+        ['r:id', r_id]
+      ]
+
+      attributes << ['tooltip', tip] if tip
+
+      @writer.empty_tag('a:hlinkClick', attributes)
+    end
+
+    #
+    # Write the <adec:decorative> element.
+    #
+    def write_decorative
+      @writer.tag_elements('a:extLst') do
+        write_a_uri_ext('{FF2B5EF4-FFF2-40B4-BE49-F238E27FC236}')
+        write_a16_creation_id
+        @writer.end_tag('a:ext')
+
+        write_a_uri_ext('{C183D7F6-B498-43B3-948B-1728B52AA6E4}')
+        write_adec_decorative
+        @writer.end_tag('a:ext')
+      end
+    end
+
+    #
+    # Write the <a:ext> element.
+    #
+    def write_a_uri_ext(uri)
+      attributes = [
+        ['uri', uri]
+      ]
+
+      @writer.start_tag('a:ext', attributes)
+    end
 
-      @writer.empty_tag('xdr:cNvPr', attributes)
+    #
+    # Write the <adec:decorative> element.
+    #
+    def write_adec_decorative
+      xmlns_adec = 'http://schemas.microsoft.com/office/drawing/2017/decorative'
+      val        = 1
+
+      attributes = [
+        ['xmlns:adec', xmlns_adec],
+        ['val',        val]
+      ]
+
+      @writer.empty_tag('adec:decorative', attributes)
     end
 
+    #
+    # Write the <a16:creationId> element.
+    #
+    def write_a16_creation_id
+      xmlns_a_16 = 'http://schemas.microsoft.com/office/drawing/2014/main'
+      id         = '{00000000-0008-0000-0000-000002000000}'
+
+      attributes = [
+        ['xmlns:a16', xmlns_a_16],
+        ['id',        id]
+      ]
+
+      @writer.empty_tag('a16:creationId', attributes)
+    end
 
     #
     # Write the <xdr:cNvGraphicFramePr> element.
@@ -351,7 +467,7 @@ module Writexlsx
     # Write the <a:graphicData> element.
     #
     def write_atag_graphic_data(index)
-      uri   = 'http://schemas.openxmlformats.org/drawingml/2006/chart'
+      uri = 'http://schemas.openxmlformats.org/drawingml/2006/chart'
 
       attributes = [ ['uri', uri] ]
 
@@ -371,9 +487,9 @@ module Writexlsx
 
 
       attributes = [
-                    ['xmlns:c', xmlns_c],
-                    ['xmlns:r', xmlns_r]
-                   ]
+        ['xmlns:c', xmlns_c],
+        ['xmlns:r', xmlns_r]
+      ]
       attributes << r_id_attributes(id)
 
       @writer.empty_tag('c:chart', attributes)
@@ -403,9 +519,9 @@ module Writexlsx
       else
         # Add attribute for shapes.
         attributes = [
-                      [:macro, ''],
-                      [:textlink, '']
-                     ]
+          [:macro, ''],
+          [:textlink, '']
+        ]
         @writer.tag_elements('xdr:sp', attributes) do
 
           # Write the xdr:nvSpPr element.
@@ -438,17 +554,17 @@ module Writexlsx
 
           if shape.start
             attributes = [
-                          ['id', shape.start],
-                          ['idx', shape.start_index]
-                         ]
+              ['id', shape.start],
+              ['idx', shape.start_index]
+            ]
             @writer.empty_tag('a:stCxn', attributes)
           end
 
           if shape.end
             attributes = [
-                          ['id', shape.end],
-                          ['idx', shape.end_index]
-                         ]
+              ['id', shape.end],
+              ['idx', shape.end_index]
+            ]
             @writer.empty_tag('a:endCxn', attributes)
           end
         end
@@ -474,12 +590,12 @@ module Writexlsx
     #
     # Write the <xdr:pic> element.
     #
-    def write_pic(index, col_absolute, row_absolute, width, height, description)
+    def write_pic(index, rel_index, col_absolute, row_absolute, width, height, description, url_rel_index, tip, decorative)
       @writer.tag_elements('xdr:pic') do
         # Write the xdr:nvPicPr element.
-        write_nv_pic_pr(index, description)
+        write_nv_pic_pr(index, rel_index, description, url_rel_index, tip, decorative)
         # Write the xdr:blipFill element.
-        write_blip_fill(index)
+        write_blip_fill(rel_index)
 
         # Pictures are rectangle shapes by default.
         shape = Shape.new
@@ -493,10 +609,13 @@ module Writexlsx
     #
     # Write the <xdr:nvPicPr> element.
     #
-    def write_nv_pic_pr(index, description)
+    def write_nv_pic_pr(index, rel_index, description, url_rel_index, tip, decorative)
       @writer.tag_elements('xdr:nvPicPr') do
         # Write the xdr:cNvPr element.
-        write_c_nv_pr( index + 1, "Picture #{index}", description )
+        write_c_nv_pr(
+          index + 1, "Picture #{index}", description,
+          url_rel_index, tip, decorative
+        )
         # Write the xdr:cNvPicPr element.
         write_c_nv_pic_pr
       end
@@ -689,9 +808,9 @@ module Writexlsx
             adj_int = (adj * 1000).to_i
 
             attributes = [
-                          [:name, "adj#{suffix}"],
-                          [:fmla, "val #{adj_int}"]
-                         ]
+              [:name, "adj#{suffix}"],
+              [:fmla, "val #{adj_int}"]
+            ]
             @writer.empty_tag('a:gd', attributes)
           end
         end
@@ -748,15 +867,15 @@ module Writexlsx
     #
     def write_tx_body(shape)
       attributes = [
-                    [:vertOverflow, "clip"],
-                    [:wrap,         "square"],
-                    [:lIns,         "27432"],
-                    [:tIns,         "22860"],
-                    [:rIns,         "27432"],
-                    [:bIns,         "22860"],
-                    [:anchor,       shape.valign],
-                    [:upright,      "1"]
-                   ]
+        [:vertOverflow, "clip"],
+        [:wrap,         "square"],
+        [:lIns,         "27432"],
+        [:tIns,         "22860"],
+        [:rIns,         "27432"],
+        [:bIns,         "22860"],
+        [:anchor,       shape.valign],
+        [:upright,      "1"]
+      ]
       @writer.tag_elements('xdr:txBody') do
         @writer.empty_tag('a:bodyPr', attributes)
         @writer.empty_tag('a:lstStyle')
@@ -766,9 +885,9 @@ module Writexlsx
           rotation *= 60000
 
           attributes = [
-                        [:algn, shape.align],
-                        [:rtl, rotation]
-                       ]
+            [:algn, shape.align],
+            [:rtl, rotation]
+          ]
           @writer.tag_elements('a:pPr', attributes) do
             attributes = [ [:sz, "1000"] ]
             @writer.empty_tag('a:defRPr', attributes)
@@ -784,14 +903,14 @@ module Writexlsx
             strike    = ptrue?(shape.format[:font_strikeout]) ? 'Strike' : 'noStrike'
 
             attributes = [
-                          [:lang,     "en-US"],
-                          [:sz,       size],
-                          [:b,        bold],
-                          [:i,        italic],
-                          [:u,        underline],
-                          [:strike,   strike],
-                          [:baseline, 0]
-                         ]
+              [:lang,     "en-US"],
+              [:sz,       size],
+              [:b,        bold],
+              [:i,        italic],
+              [:u,        underline],
+              [:strike,   strike],
+              [:baseline, 0]
+            ]
             @writer.tag_elements('a:rPr', attributes) do
               color = shape.format[:color]
               if color