Module: Writexlsx::Worksheet::PrintOptions

Included in:
Writexlsx::Worksheet
Defined in:
lib/write_xlsx/worksheet/print_options.rb

Overview

Print and display options extracted from Worksheet to slim the main class.

Instance Method Summary collapse

Instance Method Details

#set_h_pagebreaks(*args) ⇒ Object

Store the horizontal page breaks on a worksheet.



57
58
59
60
61
62
 
# File 'lib/write_xlsx/worksheet/print_options.rb', line 57

def set_h_pagebreaks(*args)
  breaks = args.collect do |brk|
    Array(brk)
  end.flatten
  @page_setup.hbreaks += breaks
end

#set_landscape ⇒ Object

Set the page orientation as landscape.



20
21
22
23
 
# File 'lib/write_xlsx/worksheet/print_options.rb', line 20

def set_landscape
  @page_setup.orientation         = false
  @page_setup.page_setup_changed  = true
end

#set_page_view(flag = 1) ⇒ Object

This method is used to display the worksheet in “Page View/Layout” mode.



28
29
30
 
# File 'lib/write_xlsx/worksheet/print_options.rb', line 28

def set_page_view(flag = 1)
  @page_view = flag
end

#set_pagebreak_view ⇒ Object

set_pagebreak_view

Set the page view mode.



37
38
39
 
# File 'lib/write_xlsx/worksheet/print_options.rb', line 37

def set_pagebreak_view
  @page_view = 2
end

#set_portrait ⇒ Object

Set the page orientation as portrait. The default worksheet orientation is portrait, so you won’t generally need to call this method.



12
13
14
15
 
# File 'lib/write_xlsx/worksheet/print_options.rb', line 12

def set_portrait
  @page_setup.orientation        = true
  @page_setup.page_setup_changed = true
end

#set_tab_color(color) ⇒ Object

This method is deprecated. use tab_color=().



49
50
51
52
 
# File 'lib/write_xlsx/worksheet/print_options.rb', line 49

def set_tab_color(color)
  put_deprecate_message("#{self}.set_tab_color")
  self.tab_color = color
end

#set_v_pagebreaks(*args) ⇒ Object

Store the vertical page breaks on a worksheet.



67
68
69
 
# File 'lib/write_xlsx/worksheet/print_options.rb', line 67

def set_v_pagebreaks(*args)
  @page_setup.vbreaks += args
end

#tab_color=(color) ⇒ Object

Set the colour of the worksheet tab.



44
45
46
 
# File 'lib/write_xlsx/worksheet/print_options.rb', line 44

def tab_color=(color)
  @tab_color = Colors.new.color(color)
end