axlsx 1.1.4 → 1.2.0

data/lib/axlsx/workbook/worksheet/sheet_view.rb

@@ -0,0 +1,379 @@
+# encoding: UTF-8
+module Axlsx
+  # View options for a worksheet.
+  #
+  # @note The recommended way to manage the sheet view is via Worksheet#sheet_view
+  # @see Worksheet#sheet_view
+  class SheetView
+    
+    # instance values that must be serialized as their own elements - e.g. not attributes.
+    CHILD_ELEMENTS = [ :pane, :selections ]
+    
+    # The pane object for the sheet view
+    # @return [Pane]
+    # @see [Pane]
+    def pane
+      @pane ||= Pane.new
+      yield @pane if block_given?
+      @pane
+    end
+    
+    # A hash of selection objects keyed by pane type associated with this sheet view.
+    # @return [Hash]
+    attr_reader :selections
+
+    #  
+    # Color Id
+    # Index to the color value for row/column
+    # text headings and gridlines. This is an 
+    # 'index color value' (ICV) rather than 
+    # rgb value.
+    # @see type
+    # @return [Integer]
+    # default nil
+    attr_reader :color_id
+    
+    
+    # Default Grid Color
+    # Flag indicating that the consuming application 
+    # should use the default grid lines color
+    # (system dependent). Overrides any color 
+    # specified in colorId.
+    # @see type
+    # @return [Boolean]
+    # default true
+    attr_reader :default_grid_color
+    
+    
+    # Right To Left
+    # Flag indicating whether the sheet is in 
+    # 'right to left' display mode. When in this 
+    # mode, Column A is on the far right, Column B ;
+    # is one column left of Column A, and so on. Also,
+    # information in cells is displayed in the Right 
+    # to Left format.
+    # @see type
+    # @return [Boolean]
+    # default false
+    attr_reader :right_to_left
+    
+    
+    # Show Formulas
+    # Flag indicating whether this sheet should 
+    # display formulas.
+    # @see type
+    # @return [Boolean]
+    # default false
+    attr_reader :show_formulas
+    
+    
+    # Show Grid Lines
+    # Flag indicating whether this sheet 
+    # should display gridlines.
+    # @see type
+    # @return [Boolean]
+    # default true
+    attr_reader :show_grid_lines
+    
+    
+    # Show Outline Symbols
+    # Flag indicating whether the sheet has outline 
+    # symbols visible. This flag shall always override 
+    # SheetPr element's outlinePr child element 
+    # whose attribute is named showOutlineSymbols 
+    # when there is a conflict.
+    # @see type
+    # @return [Boolean]
+    # default false
+    attr_reader :show_outline_symbols
+    
+    
+    # Show Headers
+    # Flag indicating whether the sheet should 
+    # display row and column headings.
+    # @see type
+    # @return [Boolean]
+    # default true
+    attr_reader :show_row_col_headers
+    
+    
+    # Show Ruler
+    # Show the ruler in Page Layout View.
+    # @see type
+    # @return [Boolean]
+    # default true
+    attr_reader :show_ruler
+    
+    
+    # Show White Space
+    # Flag indicating whether page layout 
+    # view shall display margins. False means 
+    # do not display left, right, top (header), 
+    # and bottom (footer) margins (even when 
+    # there is data in the header or footer).
+    # @see type
+    # @return [Boolean]
+    # default false
+    attr_reader :show_white_space
+    
+    
+    # Show Zero Values
+    # Flag indicating whether the window should 
+    # show 0 (zero) in cells containing zero value.
+    # When false, cells with zero value appear 
+    # blank instead of showing the number zero.
+    # @see type
+    # @return [Boolean]
+    # default true
+    attr_reader :show_zeros
+    
+    
+    # Sheet Tab Selected
+    # Flag indicating whether this sheet is selected. 
+    # When only 1 sheet is selected and active, this 
+    # value should be in synch with the activeTab value. 
+    # In case of a conflict, the Start Part setting 
+    # wins and sets the active sheet tab. Multiple 
+    # sheets can be selected, but only one sheet shall 
+    # be active at one time.
+    # @see type
+    # @return [Boolean]
+    # default false
+    attr_reader :tab_selected
+    
+    
+    # Top Left Visible Cell
+    # Location of the top left visible cell Location 
+    # of the top left visible cell in the bottom right
+    # pane (when in Left-to-Right mode).
+    # @see type
+    # @return [String]
+    # default nil
+    attr_reader :top_left_cell
+    
+    
+    # View Type
+    # Indicates the view type.
+    # Options are 
+    #  * normal: Normal view
+    #  * page_break_preview: Page break preview
+    #  * page_layout: Page Layout View
+    # @see type
+    # @return [Symbol]
+    # default :normal
+    attr_reader :view
+    
+    
+    # Window Protection
+    # Flag indicating whether the panes in the window 
+    # are locked due to workbook protection.
+    # This is an option when the workbook structure is 
+    # protected.
+    # @see type
+    # @return [Boolean] 
+    # default true
+    attr_reader :window_protection
+    
+    
+    # Workbook View Index
+    # Zero-based index of this workbook view, pointing 
+    # to a workbookView element in the bookViews collection.
+    # @see type
+    # @return [Integer] 
+    # default 0
+    attr_reader :workbook_view_id
+    
+    
+    # Zoom Scale
+    # Window zoom magnification for current view 
+    # representing percent values. This attribute
+    # is restricted to values ranging from 10 to 400. 
+    # Horizontal & Vertical scale together.
+    # Current view can be Normal, Page Layout, or 
+    # Page Break Preview.
+    # @see type
+    # @return [Integer] 
+    # default 100
+    attr_reader :zoom_scale
+    
+    
+    # Zoom Scale Normal View
+    # Zoom magnification to use when in normal view, 
+    # representing percent values. This attribute is 
+    # restricted to values ranging from 10 to 400. 
+    # Horizontal & Vertical scale together.
+    # Applies for worksheets only; zero implies the 
+    # automatic setting.
+    # @see type
+    # @return [Integer] 
+    # default 0
+    attr_reader :zoom_scale_normal
+    
+    
+    # Zoom Scale Page Layout View
+    # Zoom magnification to use when in page layout 
+    # view, representing percent values. This attribute 
+    # is restricted to values ranging from 10 to 400. 
+    # Horizontal & Vertical scale together.
+    # Applies for worksheets only; zero implies 
+    # the automatic setting.
+    # @see type
+    # @return [Integer] 
+    # default 0
+    attr_reader :zoom_scale_page_layout_view
+    
+    
+    # Zoom Scale Page Break Preview
+    # Zoom magnification to use when in page break 
+    # preview, representing percent values. This 
+    # attribute is restricted to values ranging 
+    # from 10 to 400. Horizontal & Vertical scale
+    # together.
+    # Applies for worksheet only; zero implies 
+    # the automatic setting.
+    # @see type
+    # @return [Integer] 
+    # default 0
+    attr_reader :zoom_scale_sheet_layout_view
+    
+    
+    # Creates a new {SheetView} object
+    # @option options [Integer] color_id Color Id
+    # @option options [Boolean] default_grid_color Default Grid Color
+    # @option options [Boolean] right_to_left Right To Left
+    # @option options [Boolean] show_formulas Show Formulas
+    # @option options [Boolean] show_grid_lines Show Grid Lines
+    # @option options [Boolean] show_outline_symbols Show Outline Symbols
+    # @option options [Boolean] show_row_col_headers Show Headers
+    # @option options [Boolean] show_ruler Show Ruler
+    # @option options [Boolean] show_white_space Show White Space
+    # @option options [Boolean] show_zeros Show Zero Values
+    # @option options [Boolean] tab_selected Sheet Tab Selected
+    # @option options [String, Cell] top_left_cell Top Left Visible Cell
+    # @option options [Symbol] view View Type
+    # @option options [Boolean] window_protection Window Protection
+    # @option options [Integer] workbook_view_id Workbook View Index
+    # @option options [Integer] zoom_scale_normal Zoom Scale Normal View
+    # @option options [Integer] zoom_scale_page_layout_view Zoom Scale Page Layout View
+    # @option options [Integer] zoom_scale_sheet_layout_view Zoom Scale Page Break Preview
+    def initialize(options={})
+      #defaults
+      @color_id = @top_left_cell = @pane = nil
+      @right_to_left = @show_formulas = @show_outline_symbols = @show_white_space = @tab_selected = @window_protection = false
+      @default_grid_color = @show_grid_lines = @show_row_col_headers = @show_ruler = @show_zeros = true
+      @zoom_scale = 100
+      @zoom_scale_normal = @zoom_scale_page_layout_view = @zoom_scale_sheet_layout_view = @workbook_view_id = 0
+      @selections = {}
+      
+      # write options to instance variables
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end
+    
+    
+    # Adds a new selection
+    # param [Symbol] pane
+    # param [Hash] options
+    # return [Selection]
+    def add_selection(pane, options = {})
+      @selections[pane] = Selection.new(options.merge(:pane => pane))
+    end
+    
+    # @see color_id
+    def color_id=(v); Axlsx::validate_unsigned_int(v); @color_id = v end
+    
+    
+    # @see default_grid_color
+    def default_grid_color=(v); Axlsx::validate_boolean(v); @default_grid_color = v end
+    
+    
+    # @see right_to_left
+    def right_to_left=(v); Axlsx::validate_boolean(v); @right_to_left = v end
+    
+    
+    # @see show_formulas
+    def show_formulas=(v); Axlsx::validate_boolean(v); @show_formulas = v end
+    
+    
+    # @see show_grid_lines
+    def show_grid_lines=(v); Axlsx::validate_boolean(v); @show_grid_lines = v end
+    
+    
+    # @see show_outline_symbols
+    def show_outline_symbols=(v); Axlsx::validate_boolean(v); @show_outline_symbols = v end
+    
+    
+    # @see show_row_col_headers
+    def show_row_col_headers=(v); Axlsx::validate_boolean(v); @show_row_col_headers = v end
+    
+    
+    # @see show_ruler
+    def show_ruler=(v); Axlsx::validate_boolean(v); @show_ruler = v end
+    
+    
+    # @see show_white_space
+    def show_white_space=(v); Axlsx::validate_boolean(v); @show_white_space = v end
+    
+    
+    # @see show_zeros
+    def show_zeros=(v); Axlsx::validate_boolean(v); @show_zeros = v end
+    
+    
+    # @see tab_selected
+    def tab_selected=(v); Axlsx::validate_boolean(v); @tab_selected = v end
+    
+    
+    # @see top_left_cell
+    def top_left_cell=(v)
+      cell = (v.class == Axlsx::Cell ? v.r_abs : v)
+      Axlsx::validate_string(cell)  
+      @top_left_cell = cell 
+    end
+    
+    
+    # @see view
+    def view=(v); Axlsx::validate_sheet_view_type(v); @view = v end
+    
+    
+    # @see window_protection
+    def window_protection=(v); Axlsx::validate_boolean(v); @window_protection = v end
+    
+    
+    # @see workbook_view_id
+    def workbook_view_id=(v); Axlsx::validate_unsigned_int(v); @workbook_view_id = v end
+    
+    
+    # @see zoom_scale
+    def zoom_scale=(v); Axlsx::validate_scale_0_10_400(v); @zoom_scale = v end
+    
+    
+    # @see zoom_scale_normal
+    def zoom_scale_normal=(v); Axlsx::validate_scale_0_10_400(v); @zoom_scale_normal = v end
+    
+    
+    # @see zoom_scale_page_layout_view
+    def zoom_scale_page_layout_view=(v); Axlsx::validate_scale_0_10_400(v); @zoom_scale_page_layout_view = v end
+    
+    
+    # @see zoom_scale_sheet_layout_view
+    def zoom_scale_sheet_layout_view=(v); Axlsx::validate_scale_0_10_400(v); @zoom_scale_sheet_layout_view = v end
+    
+    
+    # Serializes the data validation
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<sheetViews>'
+      str << '<sheetView '
+      str << instance_values.map { |key, value| (Axlsx::camel(key.to_s, false) << '="' << value.to_s << '"') unless CHILD_ELEMENTS.include?(key.to_sym) || value == nil }.join(' ')
+      str << '>'
+      @pane.to_xml_string(str) if @pane
+      @selections.each do |key, selection|
+        selection.to_xml_string(str)
+      end
+      str << '</sheetView>'
+      str << '</sheetViews>'
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/table.rb

@@ -19,8 +19,8 @@ module Axlsx
     attr_reader :style
 
     # Creates a new Table object
-    # @param [String] ref The reference to the table data.
-    # @param [Sheet] ref The sheet containing the table data.
+    # @param [String] ref The reference to the table data like 'A1:G24'.
+    # @param [Worksheet] sheet The sheet containing the table data.
     # @option options [Cell, String] name
     # @option options [TableStyle] style
     def initialize(ref, sheet, options={})

data/lib/axlsx/workbook/worksheet/tables.rb

@@ -0,0 +1,31 @@
+module Axlsx
+
+  # A simple, self serializing class for storing tables
+  class Tables < SimpleTypedList
+
+    # creates a new Tables object
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      super Table
+      @worksheet = worksheet
+    end
+
+    # The worksheet that owns this collection of tables
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # returns the relationships required by this collection
+    def relationships
+      return [] if empty?
+      map{ |table| Relationship.new(TABLE_R, "../#{table.pn}") }
+    end
+
+    def to_xml_string(str = "")
+      return if empty?
+      str << "<tableParts count='#{size}'>"
+      @list.each { |table| str << "<tablePart r:id='#{table.rId}'/>" }
+      str << '</tableParts>'
+    end
+  end
+
+end