Class: Axlsx::Worksheet
- Inherits:
-
Object
- Object
- Axlsx::Worksheet
- Includes:
- OptionsParser, SerializedAttributes
- Defined in:
- lib/axlsx/workbook/worksheet/worksheet.rb
Overview
The Worksheet class represents a worksheet in the workbook.
Constant Summary collapse
- THIN_CHARS =
definition of characters which are less than the maximum width of 0-9 in the default font for use in String#count. This is used for autowidth calculations
'^.acfijklrstxzFIJL()-'.freeze
Instance Attribute Summary collapse
-
#preserve_spaces ⇒ Object
Accessor for controlling whether leading and trailing spaces in cells are preserved or ignored.
-
#workbook ⇒ Workbook
readonly
The workbook that owns this worksheet.
Instance Method Summary collapse
-
#[](cell_def) ⇒ Cell, Array
Returns the cell or cells defined using excel style A1:B3 references.
-
#add_chart(chart_type, options = {}) {|chart| ... } ⇒ Object
Adds a chart to this worksheets drawing.
-
#add_comment(options = {}) ⇒ Object
Shortcut to worsksheet_comments#add_comment.
-
#add_conditional_formatting(cells, rules) ⇒ Object
Add conditional formatting to this worksheet.
-
#add_data_validation(cells, data_validation) ⇒ Object
Add data validation to this worksheet.
-
#add_hyperlink(options = {}) ⇒ WorksheetHyperlink
Adds a new hyperlink to the worksheet.
-
#add_image(options = {}) {|image| ... } ⇒ Object
Adds a media item to the worksheets drawing.
-
#add_page_break(cell) ⇒ Object
Adds a page break (row break) to the worksheet should be added to the sheet.
- #add_pivot_table(ref, range, options = {}) {|pivot_tables.last| ... } ⇒ Object
-
#add_row(values = [], options = {}) {|row| ... } ⇒ Row
(also: #<<)
Adds a row to the worksheet and updates auto fit data.
-
#add_table(ref, options = {}) {|tables.last| ... } ⇒ Object
needs documentation.
-
#auto_filter ⇒ Object
A range that excel will apply an auto-filter to "A1:B3" This will turn filtering on for the cells in the range.
-
#auto_filter=(v) ⇒ Object
The auto filter range for the worksheet.
-
#cells ⇒ Array
convenience method to access all cells in this worksheet.
-
#col_breaks ⇒ Object
A collection of column breaks added to this worksheet add_page_break.
-
#col_style(index, style, options = {}) ⇒ Object
Set the style for cells in a specific column.
-
#cols(&block) ⇒ Object
returns the sheet data as columns If you pass a block, it will be evaluated whenever a row does not have a cell at a specific index.
-
#column_info ⇒ SimpleTypedList
Column info for the sheet.
-
#column_widths(*widths) ⇒ Object
This is a helper method that Lets you specify a fixed width for multiple columns in a worksheet in one go.
-
#comments ⇒ Array|SimpleTypedList
The a shortcut to the worksheet_comments list of comments.
-
#dimension ⇒ Dimension
The dimensions of a worksheet.
-
#drawing ⇒ Drawing
The drawing associated with this worksheet.
-
#fit_to_page? ⇒ Boolean
Indicates if the worksheet will be fit by witdh or height to a specific number of pages.
-
#header_footer {|@header_footer| ... } ⇒ HeaderFooter
Options for headers and footers.
-
#hyperlinks ⇒ WorksheetHyperlinks
A typed collection of hyperlinks associated with this worksheet.
-
#index ⇒ Integer
The index of this worksheet in the owning Workbook's worksheets list.
-
#initialize(wb, options = {}) {|_self| ... } ⇒ Worksheet
constructor
Creates a new worksheet.
-
#initialize_page_options(options) ⇒ Object
Initalizes page margin, setup and print options.
-
#merge_cells(cells) ⇒ Object
Creates merge information for this worksheet.
-
#name ⇒ String
The name of the worksheet.
-
#name=(name) ⇒ Object
The name of the worksheet The name of a worksheet must be unique in the workbook, and must not exceed 31 characters.
-
#name_to_cell(name) ⇒ Cell
returns the column and row index for a named based cell.
-
#outline_level_columns(start_index, end_index, level = 1, collapsed = true) ⇒ Object
shortcut level to specify the outline level for a series of columns Oulining is what lets you add collapse and expand to a data set.
-
#outline_level_rows(start_index, end_index, level = 1, collapsed = true) ⇒ Object
shortcut level to specify the outline level for a series of rows Oulining is what lets you add collapse and expand to a data set.
-
#page_margins {|@page_margins| ... } ⇒ PageMargins
Page margins for printing the worksheet.
-
#page_setup {|@page_setup| ... } ⇒ PageSetup
Page setup settings for printing the worksheet.
-
#pivot_tables ⇒ Array
The pivot tables in this worksheet.
-
#pn ⇒ String
The part name of this worksheet.
-
#print_options {|@print_options| ... } ⇒ PrintOptions
Options for printing the worksheet.
-
#protect_range(cells) ⇒ ProtectedRange
Adds a new protected cell range to the worksheet.
-
#relationships ⇒ Relationships
The worksheet relationships.
-
#rels_pn ⇒ String
The relationship part name of this worksheet.
-
#rId ⇒ String
The relationship id of this worksheet.
-
#row_breaks ⇒ Object
A collection of row breaks added to this worksheet add_page_break.
-
#row_style(index, style, options = {}) ⇒ Object
Set the style for cells in a specific row.
-
#rows ⇒ SimpleTypedList
The rows in this worksheet.
-
#sheet_calc_pr ⇒ SheetCalcPr
The sheet calculation properties.
-
#sheet_format_pr {|@sheet_format_pr| ... } ⇒ SheetFormatPr
The sheet format pr for this worksheet.
-
#sheet_pr ⇒ SheetPr
The sheet properties for this workbook.
-
#sheet_protection {|@sheet_protection| ... } ⇒ SheetProtection
The sheet protection object for this workbook.
-
#sheet_view {|@sheet_view| ... } ⇒ SheetView
The sheet view object for this worksheet.
-
#state ⇒ Object
The visibility of this sheet.
-
#state=(sheet_state) ⇒ Object
Specifies the visible state of this sheet.
-
#styles ⇒ Object
shortcut method to access styles direclty from the worksheet This lets us do stuff like:.
-
#tables ⇒ Array
The tables in this worksheet.
-
#to_sheet_node_xml_string(str = '') ⇒ Object
Returns a sheet node serialization for this sheet in the workbook.
-
#to_xml_string(str = '') ⇒ String
Serializes the worksheet object to an xml string This intentionally does not use nokogiri for performance reasons.
Methods included from SerializedAttributes
#declared_attributes, included, #serialized_attributes, #serialized_element_attributes, #serialized_tag
Methods included from OptionsParser
Constructor Details
#initialize(wb, options = {}) {|_self| ... } ⇒ Worksheet
the recommended way to manage worksheets is Workbook#add_worksheet
Creates a new worksheet.
20 21 22 23 24 25 26 27 28 29 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 20 def initialize(wb, ={}) self.workbook = wb @sheet_protection = nil () @workbook.worksheets << self @sheet_id = index + 1 name yield self if block_given? end |
Instance Attribute Details
#preserve_spaces ⇒ Object
Accessor for controlling whether leading and trailing spaces in cells are preserved or ignored. The default is to preserve spaces.
327 328 329 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 327 def preserve_spaces @preserve_spaces end |
#workbook ⇒ Workbook
The workbook that owns this worksheet
101 102 103 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 101 def workbook @workbook end |
Instance Method Details
#[](cell_def) ⇒ Cell, Array
Returns the cell or cells defined using excel style A1:B3 references.
590 591 592 593 594 595 596 597 598 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 590 def [](cell_def) return rows[cell_def] if cell_def.is_a?(Integer) parts = cell_def.split(':').map{ |part| name_to_cell part } if parts.size == 1 parts.first else range(*parts) end end |
#add_chart(chart_type, options = {}) {|chart| ... } ⇒ Object
each chart type also specifies additional options
Adds a chart to this worksheets drawing. This is the recommended way to create charts for your worksheet. This method wraps the complexity of dealing with ooxml drawing, anchors, markers graphic frames chart objects and all the other dirty details.
459 460 461 462 463 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 459 def add_chart(chart_type, ={}) chart = worksheet_drawing.add_chart(chart_type, ) yield chart if block_given? chart end |
#add_comment(options = {}) ⇒ Object
Shortcut to worsksheet_comments#add_comment
479 480 481 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 479 def add_comment(={}) worksheet_comments.add_comment() end |
#add_conditional_formatting(cells, rules) ⇒ Object
Add conditional formatting to this worksheet.
420 421 422 423 424 425 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 420 def add_conditional_formatting(cells, rules) cf = ConditionalFormatting.new( :sqref => cells ) cf.add_rules rules conditional_formattings << cf conditional_formattings end |
#add_data_validation(cells, data_validation) ⇒ Object
Add data validation to this worksheet.
432 433 434 435 436 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 432 def add_data_validation(cells, data_validation) dv = DataValidation.new(data_validation) dv.sqref = cells data_validations << dv end |
#add_hyperlink(options = {}) ⇒ WorksheetHyperlink
Adds a new hyperlink to the worksheet
442 443 444 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 442 def add_hyperlink(={}) hyperlinks.add() end |
#add_image(options = {}) {|image| ... } ⇒ Object
Adds a media item to the worksheets drawing
485 486 487 488 489 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 485 def add_image(={}) image = worksheet_drawing.add_image() yield image if block_given? image end |
#add_page_break(cell) ⇒ Object
Adds a page break (row break) to the worksheet should be added to the sheet.
496 497 498 499 500 501 502 503 504 505 506 507 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 496 def add_page_break(cell) DataTypeValidator.validate :worksheet_page_break, [String, Cell], cell column_index, row_index = if cell.is_a?(String) Axlsx.name_to_indices(cell) else cell.pos end if column_index > 0 col_breaks.add_break(:id => column_index) end row_breaks.add_break(:id => row_index) end |
#add_pivot_table(ref, range, options = {}) {|pivot_tables.last| ... } ⇒ Object
472 473 474 475 476 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 472 def add_pivot_table(ref, range, ={}) pivot_tables << PivotTable.new(ref, range, self, ) yield pivot_tables.last if block_given? pivot_tables.last end |
#add_row(values = [], options = {}) {|row| ... } ⇒ Row Also known as: <<
Adds a row to the worksheet and updates auto fit data.
401 402 403 404 405 406 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 401 def add_row(values=[], ={}) row = Row.new(self, values, ) update_column_info row, .delete(:widths) yield row if block_given? row end |
#add_table(ref, options = {}) {|tables.last| ... } ⇒ Object
needs documentation
466 467 468 469 470 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 466 def add_table(ref, ={}) tables << Table.new(ref, self, ) yield tables.last if block_given? tables.last end |
#auto_filter ⇒ Object
A range that excel will apply an auto-filter to "A1:B3" This will turn filtering on for the cells in the range. The first row is considered the header, while subsequent rows are considered to be data.
165 166 167 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 165 def auto_filter @auto_filter ||= AutoFilter.new self end |
#auto_filter=(v) ⇒ Object
The auto filter range for the worksheet
320 321 322 323 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 320 def auto_filter=(v) DataTypeValidator.validate :worksheet_auto_filter, String, v auto_filter.range = v end |
#cells ⇒ Array
convenience method to access all cells in this worksheet
270 271 272 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 270 def cells rows.flatten end |
#col_breaks ⇒ Object
Please do not use this directly. Instead use
A collection of column breaks added to this worksheet add_page_break
119 120 121 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 119 def col_breaks @col_breaks ||= ColBreaks.new end |
#col_style(index, style, options = {}) ⇒ Object
You can also specify the style for specific columns in the call to add_row by using an array for the :styles option
Set the style for cells in a specific column
532 533 534 535 536 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 532 def col_style(index, style, ={}) offset = .delete(:row_offset) || 0 cells = @rows[(offset..-1)].map { |row| row[index] }.flatten.compact cells.each { |cell| cell.style = style } end |
#cols(&block) ⇒ Object
returns the sheet data as columns If you pass a block, it will be evaluated whenever a row does not have a cell at a specific index. The block will be called with the row and column index in the missing cell was found.
157 158 159 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 157 def cols(&block) @rows.transpose(&block) end |
#column_info ⇒ SimpleTypedList
Column info for the sheet
182 183 184 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 182 def column_info @column_info ||= Cols.new self end |
#column_widths(*widths) ⇒ Object
For updating only a single column it is probably easier to just set the width of the ws.column_info[col_index].width directly
This is a helper method that Lets you specify a fixed width for multiple columns in a worksheet in one go. Note that you must call column_widths AFTER adding data, otherwise the width will not be set successfully. Setting a fixed column width to nil will revert the behaviour back to calculating the width for you on the next call to add_row.
516 517 518 519 520 521 522 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 516 def column_widths(*widths) widths.each_with_index do |value, index| next if value == nil Axlsx::validate_unsigned_numeric(value) unless value == nil find_or_create_column_info(index).width = value end end |
#comments ⇒ Array|SimpleTypedList
The a shortcut to the worksheet_comments list of comments
139 140 141 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 139 def comments worksheet_comments.comments if worksheet_comments.has_comments? end |
#dimension ⇒ Dimension
The dimensions of a worksheet. This is not actually a required element by the spec, but at least a few other document readers expect this for conversion
298 299 300 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 298 def dimension @dimension ||= Dimension.new self end |
#drawing ⇒ Drawing
the recommended way to work with drawings and charts is Worksheet#add_chart
The drawing associated with this worksheet.
358 359 360 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 358 def drawing worksheet_drawing.drawing end |
#fit_to_page? ⇒ Boolean
Indicates if the worksheet will be fit by witdh or height to a specific number of pages. To alter the width or height for page fitting, please use page_setup.fit_to_widht or page_setup.fit_to_height. If you want the worksheet to fit on more pages (e.g. 2x2), set PageSetup#fit_to_width and PageSetup#fit_to_height accordingly.
174 175 176 177 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 174 def fit_to_page? return false unless self.instance_values.keys.include?('page_setup') page_setup.fit_to_page? end |
#header_footer {|@header_footer| ... } ⇒ HeaderFooter
Options for headers and footers.
262 263 264 265 266 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 262 def @header_footer ||= HeaderFooter.new yield @header_footer if block_given? @header_footer end |
#hyperlinks ⇒ WorksheetHyperlinks
A typed collection of hyperlinks associated with this worksheet
133 134 135 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 133 def hyperlinks @hyperlinks ||= WorksheetHyperlinks.new self end |
#index ⇒ Integer
The index of this worksheet in the owning Workbook's worksheets list.
350 351 352 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 350 def index @workbook.worksheets.index(self) end |
#initialize_page_options(options) ⇒ Object
Initalizes page margin, setup and print options
35 36 37 38 39 40 41 42 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 35 def () @page_margins = PageMargins.new [:page_margins] if [:page_margins] @page_setup = PageSetup.new [:page_setup] if [:page_setup] @print_options = PrintOptions.new [:print_options] if [:print_options] @header_footer = HeaderFooter.new [:header_footer] if [:header_footer] @row_breaks = RowBreaks.new @col_breaks = ColBreaks.new end |
#merge_cells(cells) ⇒ Object
Creates merge information for this worksheet. Cells can be merged by calling the merge_cells method on a worksheet.
283 284 285 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 283 def merge_cells(cells) merged_cells.add cells end |
#name ⇒ String
The name of the worksheet
46 47 48 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 46 def name @name ||= "Sheet" + (index+1).to_s end |
#name=(name) ⇒ Object
The name of the worksheet The name of a worksheet must be unique in the workbook, and must not exceed 31 characters
312 313 314 315 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 312 def name=(name) validate_sheet_name name @name=Axlsx::coder.encode(name) end |
#name_to_cell(name) ⇒ Cell
returns the column and row index for a named based cell
603 604 605 606 607 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 603 def name_to_cell(name) col_index, row_index = *Axlsx::name_to_indices(name) r = rows[row_index] r[col_index] if r end |
#outline_level_columns(start_index, end_index, level = 1, collapsed = true) ⇒ Object
shortcut level to specify the outline level for a series of columns Oulining is what lets you add collapse and expand to a data set.
638 639 640 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 638 def outline_level_columns(start_index, end_index, level = 1, collapsed = true) outline column_info, (start_index..end_index), level, collapsed end |
#outline_level_rows(start_index, end_index, level = 1, collapsed = true) ⇒ Object
shortcut level to specify the outline level for a series of rows Oulining is what lets you add collapse and expand to a data set.
628 629 630 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 628 def outline_level_rows(start_index, end_index, level = 1, collapsed = true) outline rows, (start_index..end_index), level, collapsed end |
#page_margins {|@page_margins| ... } ⇒ PageMargins
Page margins for printing the worksheet.
202 203 204 205 206 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 202 def page_margins @page_margins ||= PageMargins.new yield @page_margins if block_given? @page_margins end |
#page_setup {|@page_setup| ... } ⇒ PageSetup
Page setup settings for printing the worksheet.
225 226 227 228 229 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 225 def page_setup @page_setup ||= PageSetup.new yield @page_setup if block_given? @page_setup end |
#pivot_tables ⇒ Array
The pivot tables in this worksheet
111 112 113 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 111 def pivot_tables @pivot_tables ||= PivotTables.new self end |
#pn ⇒ String
The part name of this worksheet
331 332 333 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 331 def pn "#{WORKSHEET_PN % (index+1)}" end |
#print_options {|@print_options| ... } ⇒ PrintOptions
Options for printing the worksheet.
247 248 249 250 251 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 247 def @print_options ||= PrintOptions.new yield @print_options if block_given? @print_options end |
#protect_range(cells) ⇒ ProtectedRange
When using an array of cells, a contiguous range is created from the minimum top left to the maximum top bottom of the cells provided.
Adds a new protected cell range to the worksheet. Note that protected ranges are only in effect when sheet protection is enabled.
291 292 293 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 291 def protect_range(cells) protected_ranges.add_range(cells) end |
#relationships ⇒ Relationships
The worksheet relationships. This is managed automatically by the worksheet
577 578 579 580 581 582 583 584 585 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 577 def relationships r = Relationships.new r + [tables.relationships, worksheet_comments.relationships, hyperlinks.relationships, worksheet_drawing.relationship, pivot_tables.relationships].flatten.compact || [] r end |
#rels_pn ⇒ String
The relationship part name of this worksheet
337 338 339 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 337 def rels_pn "#{WORKSHEET_RELS_PN % (index+1)}" end |
#rId ⇒ String
The relationship id of this worksheet.
344 345 346 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 344 def rId @workbook.relationships.for(self).Id end |
#row_breaks ⇒ Object
Please do not use this directly. Instead use
A collection of row breaks added to this worksheet add_page_break
127 128 129 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 127 def row_breaks @row_breaks ||= RowBreaks.new end |
#row_style(index, style, options = {}) ⇒ Object
You can also specify the style in the add_row call
Set the style for cells in a specific row
546 547 548 549 550 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 546 def row_style(index, style, ={}) offset = .delete(:col_offset) || 0 cells = cols[(offset..-1)].map { |column| column[index] }.flatten.compact cells.each { |cell| cell.style = style } end |
#rows ⇒ SimpleTypedList
The recommended way to manage rows is Worksheet#add_row
The rows in this worksheet
147 148 149 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 147 def rows @rows ||= SimpleTypedList.new Row end |
#sheet_calc_pr ⇒ SheetCalcPr
The sheet calculation properties
68 69 70 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 68 def sheet_calc_pr @sheet_calc_pr ||= SheetCalcPr.new end |
#sheet_format_pr {|@sheet_format_pr| ... } ⇒ SheetFormatPr
The sheet format pr for this worksheet
93 94 95 96 97 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 93 def sheet_format_pr @sheet_format_pr ||= SheetFormatPr.new yield @sheet_format_pr if block_given? @sheet_format_pr end |
#sheet_pr ⇒ SheetPr
The sheet properties for this workbook. Currently only pageSetUpPr -> fitToPage is implemented
305 306 307 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 305 def sheet_pr @sheet_pr ||= SheetPr.new self end |
#sheet_protection {|@sheet_protection| ... } ⇒ SheetProtection
The sheet protection object for this workbook
75 76 77 78 79 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 75 def sheet_protection @sheet_protection ||= SheetProtection.new yield @sheet_protection if block_given? @sheet_protection end |
#sheet_view {|@sheet_view| ... } ⇒ SheetView
The sheet view object for this worksheet
84 85 86 87 88 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 84 def sheet_view @sheet_view ||= SheetView.new yield @sheet_view if block_given? @sheet_view end |
#state ⇒ Object
The visibility of this sheet
62 63 64 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 62 def state @state ||= :visible end |
#state=(sheet_state) ⇒ Object
Specifies the visible state of this sheet. Allowed states are :visible, :hidden or :very_hidden. The default value is :visible.
Worksheets in the :hidden state can be shown using the sheet formatting properties in excel. :very_hidden sheets should be inaccessible to end users.
56 57 58 59 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 56 def state=(sheet_state) RestrictionValidator.validate :worksheet_state, [:visible, :hidden, :very_hidden], sheet_state @state = sheet_state end |
#styles ⇒ Object
shortcut method to access styles direclty from the worksheet This lets us do stuff like:
618 619 620 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 618 def styles @styles ||= self.workbook.styles end |
#tables ⇒ Array
The tables in this worksheet
105 106 107 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 105 def tables @tables ||= Tables.new self end |
#to_sheet_node_xml_string(str = '') ⇒ Object
Returns a sheet node serialization for this sheet in the workbook.
553 554 555 556 557 558 559 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 553 def to_sheet_node_xml_string(str='') add_autofilter_defined_name_to_workbook str << '<sheet ' serialized_attributes str str << ('name="' << name << '" ') str << ('r:id="' << rId << '"></sheet>') end |
#to_xml_string(str = '') ⇒ String
Serializes the worksheet object to an xml string This intentionally does not use nokogiri for performance reasons
564 565 566 567 568 569 570 571 572 573 |
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 564 def to_xml_string str='' add_autofilter_defined_name_to_workbook auto_filter.apply if auto_filter.range str << '<?xml version="1.0" encoding="UTF-8"?>' str << worksheet_node serializable_parts.each do |item| item.to_xml_string(str) if item end str << '</worksheet>' end |