class Axlsx::Break

The Break class stores the details for row and column page breaks. @see RowBreaks, ColBreaks

Public Class Methods

new(options={}) { |self| ... } click to toggle source

Creates a new Break object @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. @option options [Integer] max Zero-based index of end row or column of the break. For row breaks, specifies column index; for column breaks, specifies row index. @option options [Boolean] man Manual Break flag. 1 means the break is a manually inserted break. @option option [Boolean] pt Flag indicating that a PivotTable created this break.

# File lib/axlsx/workbook/worksheet/break.rb, line 18
def initialize(options={})
  parse_options options
  yield self if block_given?
end

Public Instance Methods

to_xml_string(str='') click to toggle source

serializes the break to xml

# File lib/axlsx/workbook/worksheet/break.rb, line 30
def to_xml_string(str='')
  serialized_tag('brk', str)
end