diff options
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/axlsx/workbook/worksheet/break.rb | 1 | ||||
| -rw-r--r-- | lib/axlsx/workbook/worksheet/pivot_table.rb | 2 | ||||
| -rw-r--r-- | lib/axlsx/workbook/worksheet/row_breaks.rb | 5 | ||||
| -rw-r--r-- | lib/axlsx/workbook/worksheet/worksheet.rb | 8 |
4 files changed, 14 insertions, 2 deletions
diff --git a/lib/axlsx/workbook/worksheet/break.rb b/lib/axlsx/workbook/worksheet/break.rb index 493aeafd..b2902248 100644 --- a/lib/axlsx/workbook/worksheet/break.rb +++ b/lib/axlsx/workbook/worksheet/break.rb @@ -9,7 +9,6 @@ module Axlsx include Axlsx::SerializedAttributes # Creates a new Break object - # @param worksheet The worksheet that owns this break # @param options A hash of attribute options for this break. # @option options [Integer] id Zero-based row or column Id of the page break. Breaks occur above the specified row and left of the specified column. # @option options [Integer] min Zero-based index of start row or column of the break. For row breaks, specifies column index; for column breaks, specifies row index. diff --git a/lib/axlsx/workbook/worksheet/pivot_table.rb b/lib/axlsx/workbook/worksheet/pivot_table.rb index d27e08ad..9e09f52c 100644 --- a/lib/axlsx/workbook/worksheet/pivot_table.rb +++ b/lib/axlsx/workbook/worksheet/pivot_table.rb @@ -44,7 +44,7 @@ module Axlsx # @return [Worksheet] attr_writer :data_sheet - # (see #data_sheet) + # @see #data_sheet def data_sheet @data_sheet || @sheet end diff --git a/lib/axlsx/workbook/worksheet/row_breaks.rb b/lib/axlsx/workbook/worksheet/row_breaks.rb index 968cf2f7..1765c241 100644 --- a/lib/axlsx/workbook/worksheet/row_breaks.rb +++ b/lib/axlsx/workbook/worksheet/row_breaks.rb @@ -8,11 +8,16 @@ module Axlsx super Break end + # Adds a row break + # @param [Hash] options The options for the break to be created. + # max and man values are fixed. + # @see Break def add_break(options) # force feed the excel default @list << Break.new(options.merge(:max => 16383, :man => true)) last end + # <rowBreaks count="3" manualBreakCount="3"> # <brk id="1" max="16383" man="1"/> # <brk id="7" max="16383" man="1"/> diff --git a/lib/axlsx/workbook/worksheet/worksheet.rb b/lib/axlsx/workbook/worksheet/worksheet.rb index 1498677c..9937a3f4 100644 --- a/lib/axlsx/workbook/worksheet/worksheet.rb +++ b/lib/axlsx/workbook/worksheet/worksheet.rb @@ -96,10 +96,18 @@ module Axlsx @pivot_tables ||= PivotTables.new self end + # A collection of column breaks added to this worksheet + # @note Please do not use this directly. Instead use + # add_page_break + # @see Worksheet#add_page_break def col_breaks @col_breaks ||= ColBreaks.new end + # A collection of row breaks added to this worksheet + # @note Please do not use this directly. Instead use + # add_page_break + # @see Worksheet#add_page_break def row_breaks @row_breaks ||= RowBreaks.new end |
