Class: Axlsx::SheetView
- Inherits:
-
Object
- Object
- Axlsx::SheetView
- Includes:
- Accessors, OptionsParser, SerializedAttributes
- Defined in:
- lib/axlsx/workbook/worksheet/sheet_view.rb
Overview
The recommended way to manage the sheet view is via Worksheet#sheet_view
View options for a worksheet.
Constant Summary collapse
- CHILD_ELEMENTS =
instance values that must be serialized as their own elements - e.g. not attributes.
[:pane, :selections].freeze
Instance Attribute Summary collapse
-
#color_id ⇒ Integer
Color Id Index to the color value for row/column text headings and gridlines.
-
#selections ⇒ Hash
readonly
A hash of selection objects keyed by pane type associated with this sheet view.
-
#top_left_cell ⇒ String
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).
-
#view ⇒ Symbol
View Type Indicates the view type.
-
#workbook_view_id ⇒ Integer
Workbook View Index Zero-based index of this workbook view, pointing to a workbookView element in the bookViews collection.
-
#zoom_scale ⇒ Integer
Zoom Scale Window zoom magnification for current view representing percent values.
-
#zoom_scale_normal ⇒ Integer
Zoom Scale Normal View Zoom magnification to use when in normal view, representing percent values.
-
#zoom_scale_page_layout_view ⇒ Integer
Zoom Scale Page Layout View Zoom magnification to use when in page layout view, representing percent values.
-
#zoom_scale_sheet_layout_view ⇒ Integer
Zoom Scale Page Break Preview Zoom magnification to use when in page break preview, representing percent values.
Instance Method Summary collapse
-
#add_selection(pane, options = {}) ⇒ Object
Adds a new selection param [Symbol] pane param [Hash] options return [Selection].
-
#initialize(options = {}) ⇒ SheetView
constructor
Creates a new SheetView object.
-
#pane {|@pane| ... } ⇒ Pane
The pane object for the sheet view.
-
#to_xml_string(str = +'')) ⇒ String
Serializes the data validation.
Methods included from SerializedAttributes
included, #serialized_attributes, #serialized_element_attributes, #serialized_tag
Methods included from OptionsParser
Constructor Details
#initialize(options = {}) ⇒ SheetView
Creates a new Axlsx::SheetView object
33 34 35 36 37 38 39 40 41 42 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 33 def initialize( = {}) # 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 = {} end |
Instance Attribute Details
#color_id ⇒ Integer
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. default nil
77 78 79 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 77 def color_id @color_id end |
#selections ⇒ Hash (readonly)
A hash of selection objects keyed by pane type associated with this sheet view.
66 67 68 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 66 def selections @selections end |
#top_left_cell ⇒ String
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). default nil
86 87 88 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 86 def top_left_cell @top_left_cell end |
#view ⇒ Symbol
View Type Indicates the view type. Options are
- normal: Normal view
- page_break_preview: Page break preview
- page_layout: Page Layout View default :normal
97 98 99 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 97 def view @view end |
#workbook_view_id ⇒ Integer
Workbook View Index Zero-based index of this workbook view, pointing to a workbookView element in the bookViews collection. default 0
105 106 107 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 105 def workbook_view_id @workbook_view_id end |
#zoom_scale ⇒ Integer
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. default 100
117 118 119 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 117 def zoom_scale @zoom_scale end |
#zoom_scale_normal ⇒ Integer
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. default 0
129 130 131 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 129 def zoom_scale_normal @zoom_scale_normal end |
#zoom_scale_page_layout_view ⇒ Integer
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. default 0
141 142 143 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 141 def zoom_scale_page_layout_view @zoom_scale_page_layout_view end |
#zoom_scale_sheet_layout_view ⇒ Integer
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. default 0
154 155 156 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 154 def zoom_scale_sheet_layout_view @zoom_scale_sheet_layout_view end |
Instance Method Details
#add_selection(pane, options = {}) ⇒ Object
Adds a new selection param [Symbol] pane param [Hash] options return [Selection]
160 161 162 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 160 def add_selection(pane, = {}) @selections[pane] = Selection.new(.merge(pane: pane)) end |
#pane {|@pane| ... } ⇒ Pane
The pane object for the sheet view
58 59 60 61 62 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 58 def pane @pane ||= Pane.new yield @pane if block_given? @pane end |
#to_xml_string(str = +'')) ⇒ String
Serializes the data validation
216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/axlsx/workbook/worksheet/sheet_view.rb', line 216 def to_xml_string(str = +'') str << '<sheetViews>' str << '<sheetView ' serialized_attributes str str << '>' @pane.to_xml_string(str) if @pane @selections.each_value do |selection| selection.to_xml_string(str) end str << '</sheetView>' str << '</sheetViews>' end |