caxlsx 3.2.0 → 3.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (301) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +9 -9
  3. data/.yardopts_guide +18 -18
  4. data/CHANGELOG.md +394 -354
  5. data/LICENSE +21 -21
  6. data/README.md +184 -168
  7. data/Rakefile +28 -29
  8. data/examples/generate.rb +15 -15
  9. data/lib/axlsx/content_type/abstract_content_type.rb +29 -32
  10. data/lib/axlsx/content_type/content_type.rb +22 -26
  11. data/lib/axlsx/content_type/default.rb +21 -25
  12. data/lib/axlsx/content_type/override.rb +21 -25
  13. data/lib/axlsx/doc_props/app.rb +230 -235
  14. data/lib/axlsx/doc_props/core.rb +34 -39
  15. data/lib/axlsx/drawing/area_chart.rb +96 -99
  16. data/lib/axlsx/drawing/area_series.rb +107 -110
  17. data/lib/axlsx/drawing/ax_data_source.rb +21 -26
  18. data/lib/axlsx/drawing/axes.rb +60 -61
  19. data/lib/axlsx/drawing/axis.rb +185 -190
  20. data/lib/axlsx/drawing/bar_3D_chart.rb +145 -148
  21. data/lib/axlsx/drawing/bar_chart.rb +135 -138
  22. data/lib/axlsx/drawing/bar_series.rb +91 -97
  23. data/lib/axlsx/drawing/bubble_chart.rb +56 -59
  24. data/lib/axlsx/drawing/bubble_series.rb +60 -63
  25. data/lib/axlsx/drawing/cat_axis.rb +80 -85
  26. data/lib/axlsx/drawing/chart.rb +294 -276
  27. data/lib/axlsx/drawing/d_lbls.rb +92 -90
  28. data/lib/axlsx/drawing/drawing.rb +163 -167
  29. data/lib/axlsx/drawing/graphic_frame.rb +51 -54
  30. data/lib/axlsx/drawing/hyperlink.rb +97 -100
  31. data/lib/axlsx/drawing/line_3D_chart.rb +64 -68
  32. data/lib/axlsx/drawing/line_chart.rb +96 -99
  33. data/lib/axlsx/drawing/line_series.rb +107 -110
  34. data/lib/axlsx/drawing/marker.rb +80 -84
  35. data/lib/axlsx/drawing/num_data.rb +47 -52
  36. data/lib/axlsx/drawing/num_data_source.rb +58 -62
  37. data/lib/axlsx/drawing/num_val.rb +31 -34
  38. data/lib/axlsx/drawing/one_cell_anchor.rb +97 -99
  39. data/lib/axlsx/drawing/pic.rb +244 -211
  40. data/lib/axlsx/drawing/picture_locking.rb +39 -42
  41. data/lib/axlsx/drawing/pie_3D_chart.rb +42 -47
  42. data/lib/axlsx/drawing/pie_series.rb +69 -74
  43. data/lib/axlsx/drawing/scaling.rb +57 -60
  44. data/lib/axlsx/drawing/scatter_chart.rb +71 -74
  45. data/lib/axlsx/drawing/scatter_series.rb +126 -129
  46. data/lib/axlsx/drawing/ser_axis.rb +41 -45
  47. data/lib/axlsx/drawing/series.rb +67 -69
  48. data/lib/axlsx/drawing/series_title.rb +23 -25
  49. data/lib/axlsx/drawing/str_data.rb +37 -42
  50. data/lib/axlsx/drawing/str_val.rb +31 -34
  51. data/lib/axlsx/drawing/title.rb +104 -97
  52. data/lib/axlsx/drawing/two_cell_anchor.rb +95 -97
  53. data/lib/axlsx/drawing/val_axis.rb +34 -37
  54. data/lib/axlsx/drawing/view_3D.rb +115 -115
  55. data/lib/axlsx/drawing/vml_drawing.rb +39 -42
  56. data/lib/axlsx/drawing/vml_shape.rb +63 -66
  57. data/lib/axlsx/package.rb +397 -388
  58. data/lib/axlsx/rels/relationship.rb +127 -130
  59. data/lib/axlsx/rels/relationships.rb +29 -32
  60. data/lib/axlsx/stylesheet/border.rb +70 -73
  61. data/lib/axlsx/stylesheet/border_pr.rb +69 -71
  62. data/lib/axlsx/stylesheet/cell_alignment.rb +124 -132
  63. data/lib/axlsx/stylesheet/cell_protection.rb +38 -41
  64. data/lib/axlsx/stylesheet/cell_style.rb +68 -72
  65. data/lib/axlsx/stylesheet/color.rb +77 -76
  66. data/lib/axlsx/stylesheet/dxf.rb +75 -79
  67. data/lib/axlsx/stylesheet/fill.rb +31 -35
  68. data/lib/axlsx/stylesheet/font.rb +157 -156
  69. data/lib/axlsx/stylesheet/gradient_fill.rb +101 -103
  70. data/lib/axlsx/stylesheet/gradient_stop.rb +36 -37
  71. data/lib/axlsx/stylesheet/num_fmt.rb +83 -86
  72. data/lib/axlsx/stylesheet/pattern_fill.rb +71 -73
  73. data/lib/axlsx/stylesheet/styles.rb +543 -494
  74. data/lib/axlsx/stylesheet/table_style.rb +51 -54
  75. data/lib/axlsx/stylesheet/table_style_element.rb +74 -77
  76. data/lib/axlsx/stylesheet/table_styles.rb +42 -46
  77. data/lib/axlsx/stylesheet/xf.rb +144 -147
  78. data/lib/axlsx/util/accessors.rb +62 -64
  79. data/lib/axlsx/util/constants.rb +414 -410
  80. data/lib/axlsx/util/mime_type_utils.rb +24 -11
  81. data/lib/axlsx/util/options_parser.rb +15 -16
  82. data/lib/axlsx/util/serialized_attributes.rb +88 -89
  83. data/lib/axlsx/util/simple_typed_list.rb +180 -179
  84. data/lib/axlsx/util/storage.rb +142 -146
  85. data/lib/axlsx/util/validators.rb +315 -312
  86. data/lib/axlsx/util/zip_command.rb +71 -73
  87. data/lib/axlsx/version.rb +4 -5
  88. data/lib/axlsx/workbook/defined_name.rb +129 -128
  89. data/lib/axlsx/workbook/defined_names.rb +20 -21
  90. data/lib/axlsx/workbook/shared_strings_table.rb +74 -77
  91. data/lib/axlsx/workbook/workbook.rb +430 -395
  92. data/lib/axlsx/workbook/workbook_view.rb +75 -80
  93. data/lib/axlsx/workbook/workbook_views.rb +20 -22
  94. data/lib/axlsx/workbook/worksheet/auto_filter/auto_filter.rb +78 -77
  95. data/lib/axlsx/workbook/worksheet/auto_filter/filter_column.rb +94 -94
  96. data/lib/axlsx/workbook/worksheet/auto_filter/filters.rb +243 -244
  97. data/lib/axlsx/workbook/worksheet/border_creator.rb +79 -0
  98. data/lib/axlsx/workbook/worksheet/break.rb +32 -35
  99. data/lib/axlsx/workbook/worksheet/cell.rb +552 -506
  100. data/lib/axlsx/workbook/worksheet/cell_serializer.rb +164 -164
  101. data/lib/axlsx/workbook/worksheet/cfvo.rb +60 -60
  102. data/lib/axlsx/workbook/worksheet/cfvos.rb +16 -18
  103. data/lib/axlsx/workbook/worksheet/col.rb +142 -145
  104. data/lib/axlsx/workbook/worksheet/col_breaks.rb +34 -35
  105. data/lib/axlsx/workbook/worksheet/color_scale.rb +108 -110
  106. data/lib/axlsx/workbook/worksheet/cols.rb +23 -23
  107. data/lib/axlsx/workbook/worksheet/comment.rb +90 -91
  108. data/lib/axlsx/workbook/worksheet/comments.rb +78 -82
  109. data/lib/axlsx/workbook/worksheet/conditional_formatting.rb +81 -82
  110. data/lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb +216 -220
  111. data/lib/axlsx/workbook/worksheet/conditional_formattings.rb +23 -25
  112. data/lib/axlsx/workbook/worksheet/data_bar.rb +127 -129
  113. data/lib/axlsx/workbook/worksheet/data_validation.rb +266 -246
  114. data/lib/axlsx/workbook/worksheet/data_validations.rb +25 -28
  115. data/lib/axlsx/workbook/worksheet/date_time_converter.rb +28 -30
  116. data/lib/axlsx/workbook/worksheet/dimension.rb +65 -64
  117. data/lib/axlsx/workbook/worksheet/header_footer.rb +51 -52
  118. data/lib/axlsx/workbook/worksheet/icon_set.rb +80 -81
  119. data/lib/axlsx/workbook/worksheet/merged_cells.rb +37 -37
  120. data/lib/axlsx/workbook/worksheet/outline_pr.rb +32 -33
  121. data/lib/axlsx/workbook/worksheet/page_margins.rb +97 -97
  122. data/lib/axlsx/workbook/worksheet/page_set_up_pr.rb +42 -44
  123. data/lib/axlsx/workbook/worksheet/page_setup.rb +237 -240
  124. data/lib/axlsx/workbook/worksheet/pane.rb +138 -139
  125. data/lib/axlsx/workbook/worksheet/pivot_table.rb +332 -296
  126. data/lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb +63 -66
  127. data/lib/axlsx/workbook/worksheet/pivot_tables.rb +23 -24
  128. data/lib/axlsx/workbook/worksheet/print_options.rb +38 -39
  129. data/lib/axlsx/workbook/worksheet/protected_range.rb +46 -47
  130. data/lib/axlsx/workbook/worksheet/protected_ranges.rb +37 -37
  131. data/lib/axlsx/workbook/worksheet/rich_text.rb +53 -55
  132. data/lib/axlsx/workbook/worksheet/rich_text_run.rb +266 -250
  133. data/lib/axlsx/workbook/worksheet/row.rb +173 -164
  134. data/lib/axlsx/workbook/worksheet/row_breaks.rb +32 -33
  135. data/lib/axlsx/workbook/worksheet/selection.rb +99 -101
  136. data/lib/axlsx/workbook/worksheet/sheet_calc_pr.rb +28 -29
  137. data/lib/axlsx/workbook/worksheet/sheet_data.rb +25 -27
  138. data/lib/axlsx/workbook/worksheet/sheet_format_pr.rb +18 -18
  139. data/lib/axlsx/workbook/worksheet/sheet_pr.rb +87 -87
  140. data/lib/axlsx/workbook/worksheet/sheet_protection.rb +117 -118
  141. data/lib/axlsx/workbook/worksheet/sheet_view.rb +206 -213
  142. data/lib/axlsx/workbook/worksheet/table.rb +100 -102
  143. data/lib/axlsx/workbook/worksheet/table_style_info.rb +48 -49
  144. data/lib/axlsx/workbook/worksheet/tables.rb +34 -34
  145. data/lib/axlsx/workbook/worksheet/worksheet.rb +857 -786
  146. data/lib/axlsx/workbook/worksheet/worksheet_comments.rb +58 -58
  147. data/lib/axlsx/workbook/worksheet/worksheet_drawing.rb +59 -58
  148. data/lib/axlsx/workbook/worksheet/worksheet_hyperlink.rb +73 -74
  149. data/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb +38 -38
  150. data/lib/axlsx.rb +218 -185
  151. data/lib/caxlsx.rb +1 -2
  152. data/lib/schema/dc.xsd +118 -118
  153. data/lib/schema/dcmitype.xsd +51 -51
  154. data/lib/schema/dcterms.xsd +331 -331
  155. data/lib/schema/dml-chartDrawing.xsd +146 -146
  156. data/lib/schema/dml-compatibility.xsd +14 -14
  157. data/lib/schema/dml-lockedCanvas.xsd +11 -11
  158. data/lib/schema/dml-main.xsd +3048 -3048
  159. data/lib/schema/dml-picture.xsd +23 -23
  160. data/lib/schema/dml-spreadsheetDrawing.xsd +185 -185
  161. data/lib/schema/dml-wordprocessingDrawing.xsd +185 -185
  162. data/lib/schema/shared-additionalCharacteristics.xsd +28 -28
  163. data/lib/schema/shared-bibliography.xsd +144 -144
  164. data/lib/schema/shared-commonSimpleTypes.xsd +166 -166
  165. data/lib/schema/shared-customXmlDataProperties.xsd +25 -25
  166. data/lib/schema/shared-customXmlSchemaProperties.xsd +18 -18
  167. data/lib/schema/shared-documentPropertiesCustom.xsd +59 -59
  168. data/lib/schema/shared-documentPropertiesExtended.xsd +56 -56
  169. data/lib/schema/shared-documentPropertiesVariantTypes.xsd +195 -195
  170. data/lib/schema/shared-relationshipReference.xsd +25 -25
  171. data/lib/schema/vml-main.xsd +569 -569
  172. data/lib/schema/vml-officeDrawing.xsd +509 -509
  173. data/lib/schema/vml-presentationDrawing.xsd +12 -12
  174. data/lib/schema/vml-spreadsheetDrawing.xsd +108 -108
  175. data/lib/schema/vml-wordprocessingDrawing.xsd +96 -96
  176. data/lib/schema/xml.xsd +116 -116
  177. metadata +5 -252
  178. data/test/benchmark.rb +0 -72
  179. data/test/content_type/tc_content_type.rb +0 -76
  180. data/test/content_type/tc_default.rb +0 -16
  181. data/test/content_type/tc_override.rb +0 -14
  182. data/test/doc_props/tc_app.rb +0 -43
  183. data/test/doc_props/tc_core.rb +0 -42
  184. data/test/drawing/tc_area_chart.rb +0 -39
  185. data/test/drawing/tc_area_series.rb +0 -71
  186. data/test/drawing/tc_axes.rb +0 -8
  187. data/test/drawing/tc_axis.rb +0 -112
  188. data/test/drawing/tc_bar_3D_chart.rb +0 -86
  189. data/test/drawing/tc_bar_chart.rb +0 -86
  190. data/test/drawing/tc_bar_series.rb +0 -46
  191. data/test/drawing/tc_bubble_chart.rb +0 -44
  192. data/test/drawing/tc_bubble_series.rb +0 -21
  193. data/test/drawing/tc_cat_axis.rb +0 -31
  194. data/test/drawing/tc_cat_axis_data.rb +0 -27
  195. data/test/drawing/tc_chart.rb +0 -123
  196. data/test/drawing/tc_d_lbls.rb +0 -57
  197. data/test/drawing/tc_data_source.rb +0 -23
  198. data/test/drawing/tc_drawing.rb +0 -80
  199. data/test/drawing/tc_graphic_frame.rb +0 -27
  200. data/test/drawing/tc_hyperlink.rb +0 -64
  201. data/test/drawing/tc_line_3d_chart.rb +0 -47
  202. data/test/drawing/tc_line_chart.rb +0 -39
  203. data/test/drawing/tc_line_series.rb +0 -71
  204. data/test/drawing/tc_marker.rb +0 -44
  205. data/test/drawing/tc_named_axis_data.rb +0 -27
  206. data/test/drawing/tc_num_data.rb +0 -31
  207. data/test/drawing/tc_num_val.rb +0 -29
  208. data/test/drawing/tc_one_cell_anchor.rb +0 -66
  209. data/test/drawing/tc_pic.rb +0 -103
  210. data/test/drawing/tc_picture_locking.rb +0 -72
  211. data/test/drawing/tc_pie_3D_chart.rb +0 -28
  212. data/test/drawing/tc_pie_series.rb +0 -33
  213. data/test/drawing/tc_scaling.rb +0 -36
  214. data/test/drawing/tc_scatter_chart.rb +0 -48
  215. data/test/drawing/tc_scatter_series.rb +0 -74
  216. data/test/drawing/tc_ser_axis.rb +0 -31
  217. data/test/drawing/tc_series.rb +0 -23
  218. data/test/drawing/tc_series_title.rb +0 -54
  219. data/test/drawing/tc_str_data.rb +0 -18
  220. data/test/drawing/tc_str_val.rb +0 -30
  221. data/test/drawing/tc_title.rb +0 -70
  222. data/test/drawing/tc_two_cell_anchor.rb +0 -36
  223. data/test/drawing/tc_val_axis.rb +0 -24
  224. data/test/drawing/tc_view_3D.rb +0 -54
  225. data/test/drawing/tc_vml_drawing.rb +0 -25
  226. data/test/drawing/tc_vml_shape.rb +0 -106
  227. data/test/fixtures/image1.gif +0 -0
  228. data/test/fixtures/image1.jpeg +0 -0
  229. data/test/fixtures/image1.jpg +0 -0
  230. data/test/fixtures/image1.png +0 -0
  231. data/test/fixtures/image1_fake.jpg +0 -0
  232. data/test/profile.rb +0 -24
  233. data/test/rels/tc_relationship.rb +0 -52
  234. data/test/rels/tc_relationships.rb +0 -37
  235. data/test/stylesheet/tc_border.rb +0 -37
  236. data/test/stylesheet/tc_border_pr.rb +0 -32
  237. data/test/stylesheet/tc_cell_alignment.rb +0 -81
  238. data/test/stylesheet/tc_cell_protection.rb +0 -29
  239. data/test/stylesheet/tc_cell_style.rb +0 -57
  240. data/test/stylesheet/tc_color.rb +0 -43
  241. data/test/stylesheet/tc_dxf.rb +0 -81
  242. data/test/stylesheet/tc_fill.rb +0 -18
  243. data/test/stylesheet/tc_font.rb +0 -133
  244. data/test/stylesheet/tc_gradient_fill.rb +0 -72
  245. data/test/stylesheet/tc_gradient_stop.rb +0 -31
  246. data/test/stylesheet/tc_num_fmt.rb +0 -30
  247. data/test/stylesheet/tc_pattern_fill.rb +0 -43
  248. data/test/stylesheet/tc_styles.rb +0 -309
  249. data/test/stylesheet/tc_table_style.rb +0 -44
  250. data/test/stylesheet/tc_table_style_element.rb +0 -45
  251. data/test/stylesheet/tc_table_styles.rb +0 -29
  252. data/test/stylesheet/tc_xf.rb +0 -120
  253. data/test/tc_axlsx.rb +0 -109
  254. data/test/tc_helper.rb +0 -10
  255. data/test/tc_package.rb +0 -317
  256. data/test/util/tc_mime_type_utils.rb +0 -13
  257. data/test/util/tc_serialized_attributes.rb +0 -19
  258. data/test/util/tc_simple_typed_list.rb +0 -77
  259. data/test/util/tc_validators.rb +0 -210
  260. data/test/workbook/tc_defined_name.rb +0 -49
  261. data/test/workbook/tc_shared_strings_table.rb +0 -59
  262. data/test/workbook/tc_workbook.rb +0 -165
  263. data/test/workbook/tc_workbook_view.rb +0 -50
  264. data/test/workbook/worksheet/auto_filter/tc_auto_filter.rb +0 -38
  265. data/test/workbook/worksheet/auto_filter/tc_filter_column.rb +0 -76
  266. data/test/workbook/worksheet/auto_filter/tc_filters.rb +0 -50
  267. data/test/workbook/worksheet/tc_break.rb +0 -49
  268. data/test/workbook/worksheet/tc_cell.rb +0 -465
  269. data/test/workbook/worksheet/tc_cfvo.rb +0 -31
  270. data/test/workbook/worksheet/tc_col.rb +0 -93
  271. data/test/workbook/worksheet/tc_color_scale.rb +0 -58
  272. data/test/workbook/worksheet/tc_comment.rb +0 -72
  273. data/test/workbook/worksheet/tc_comments.rb +0 -57
  274. data/test/workbook/worksheet/tc_conditional_formatting.rb +0 -224
  275. data/test/workbook/worksheet/tc_data_bar.rb +0 -46
  276. data/test/workbook/worksheet/tc_data_validation.rb +0 -265
  277. data/test/workbook/worksheet/tc_date_time_converter.rb +0 -124
  278. data/test/workbook/worksheet/tc_header_footer.rb +0 -151
  279. data/test/workbook/worksheet/tc_icon_set.rb +0 -45
  280. data/test/workbook/worksheet/tc_outline_pr.rb +0 -19
  281. data/test/workbook/worksheet/tc_page_margins.rb +0 -97
  282. data/test/workbook/worksheet/tc_page_set_up_pr.rb +0 -15
  283. data/test/workbook/worksheet/tc_page_setup.rb +0 -143
  284. data/test/workbook/worksheet/tc_pane.rb +0 -54
  285. data/test/workbook/worksheet/tc_pivot_table.rb +0 -180
  286. data/test/workbook/worksheet/tc_pivot_table_cache_definition.rb +0 -62
  287. data/test/workbook/worksheet/tc_print_options.rb +0 -72
  288. data/test/workbook/worksheet/tc_protected_range.rb +0 -17
  289. data/test/workbook/worksheet/tc_rich_text.rb +0 -44
  290. data/test/workbook/worksheet/tc_rich_text_run.rb +0 -173
  291. data/test/workbook/worksheet/tc_row.rb +0 -160
  292. data/test/workbook/worksheet/tc_selection.rb +0 -55
  293. data/test/workbook/worksheet/tc_sheet_calc_pr.rb +0 -18
  294. data/test/workbook/worksheet/tc_sheet_format_pr.rb +0 -88
  295. data/test/workbook/worksheet/tc_sheet_pr.rb +0 -49
  296. data/test/workbook/worksheet/tc_sheet_protection.rb +0 -117
  297. data/test/workbook/worksheet/tc_sheet_view.rb +0 -214
  298. data/test/workbook/worksheet/tc_table.rb +0 -77
  299. data/test/workbook/worksheet/tc_table_style_info.rb +0 -53
  300. data/test/workbook/worksheet/tc_worksheet.rb +0 -632
  301. data/test/workbook/worksheet/tc_worksheet_hyperlink.rb +0 -55
@@ -1,80 +1,75 @@
1
- # <xsd:complexType name="CT_BookView">
2
- # <xsd:sequence>
3
- # <xsd:element name="extLst" type="CT_ExtensionList" minOccurs="0" maxOccurs="1"/>
4
- # </xsd:sequence>
5
- # <xsd:attribute name="visibility" type="ST_Visibility" use="optional" default="visible"/>
6
- # <xsd:attribute name="minimized" type="xsd:boolean" use="optional" default="false"/>
7
- # <xsd:attribute name="showHorizontalScroll" type="xsd:boolean" use="optional" default="true"/>
8
- # <xsd:attribute name="showVerticalScroll" type="xsd:boolean" use="optional" default="true"/>
9
- # <xsd:attribute name="showSheetTabs" type="xsd:boolean" use="optional" default="true"/>
10
- # <xsd:attribute name="xWindow" type="xsd:int" use="optional"/>
11
- # <xsd:attribute name="yWindow" type="xsd:int" use="optional"/>
12
- # <xsd:attribute name="windowWidth" type="xsd:unsignedInt" use="optional"/>
13
- # <xsd:attribute name="windowHeight" type="xsd:unsignedInt" use="optional"/>
14
- # <xsd:attribute name="tabRatio" type="xsd:unsignedInt" use="optional" default="600"/>
15
- # <xsd:attribute name="firstSheet" type="xsd:unsignedInt" use="optional" default="0"/>
16
- # <xsd:attribute name="activeTab" type="xsd:unsignedInt" use="optional" default="0"/>
17
- # <xsd:attribute name="autoFilterDateGrouping" type="xsd:boolean" use="optional"
18
- # default="true"/>
19
- # </xsd:complexType>
20
-
21
- module Axlsx
22
-
23
- # A BookView defines the display properties for a workbook.
24
- # Units for window widths and other dimensions are expressed in twips.
25
- # Twip measurements are portable between different display resolutions.
26
- # The formula is (screen pixels) * (20 * 72) / (logical device dpi),
27
- # where the logical device dpi can be different for x and y coordinates.
28
- class WorkbookView
29
-
30
- include Axlsx::SerializedAttributes
31
- include Axlsx::OptionsParser
32
- include Axlsx::Accessors
33
-
34
-
35
- # Creates a new BookView object
36
- # @param [Hash] options A hash of key/value pairs that will be mapped to this instances attributes.
37
- # @option [Symbol] visibility Specifies visible state of the workbook window. The default value for this attribute is :visible.
38
- # @option [Boolean] minimized Specifies a boolean value that indicates whether the workbook window is minimized.
39
- # @option [Boolean] show_horizontal_scroll Specifies a boolean value that indicates whether to display the horizontal scroll bar in the user interface.
40
- # @option [Boolean] show_vertical_scroll Specifies a boolean value that indicates whether to display the vertical scroll bar.
41
- # @option [Boolean] show_sheet_tabs Specifies a boolean value that indicates whether to display the sheet tabs in the user interface.
42
- # @option [Integer] tab_ratio Specifies ratio between the workbook tabs bar and the horizontal scroll bar.
43
- # @option [Integer] first_sheet Specifies the index to the first sheet in this book view.
44
- # @option [Integer] active_tab Specifies an unsignedInt that contains the index to the active sheet in this book view.
45
- # @option [Integer] x_window Specifies the X coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.
46
- # @option [Integer] y_window Specifies the Y coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.
47
- # @option [Integer] window_width Specifies the width of the workbook window. The unit of measurement for this value is twips.
48
- # @option [Integer] window_height Specifies the height of the workbook window. The unit of measurement for this value is twips.
49
- # @option [Boolean] auto_filter_date_grouping Specifies a boolean value that indicates whether to group dates when presenting the user with filtering options in the user interface.
50
- def initialize(options={})
51
- parse_options options
52
- yield self if block_given?
53
- end
54
-
55
-
56
- unsigned_int_attr_accessor :x_window, :y_window, :window_width, :window_height,
57
- :tab_ratio, :first_sheet, :active_tab
58
-
59
- validated_attr_accessor [:visibility], :validate_view_visibility
60
-
61
- serializable_attributes :visibility, :minimized,
62
- :show_horizontal_scroll, :show_vertical_scroll,
63
- :show_sheet_tabs, :tab_ratio, :first_sheet, :active_tab,
64
- :x_window, :y_window, :window_width, :window_height,
65
- :auto_filter_date_grouping
66
-
67
- boolean_attr_accessor :minimized, :show_horizontal_scroll, :show_vertical_scroll,
68
- :show_sheet_tabs, :auto_filter_date_grouping
69
-
70
-
71
- # Serialize the WorkbookView
72
- # @param [String] str
73
- # @return [String]
74
- def to_xml_string(str = '')
75
- str << '<workbookView '
76
- serialized_attributes str
77
- str << '></workbookView>'
78
- end
79
- end
80
- end
1
+ # <xsd:complexType name="CT_BookView">
2
+ # <xsd:sequence>
3
+ # <xsd:element name="extLst" type="CT_ExtensionList" minOccurs="0" maxOccurs="1"/>
4
+ # </xsd:sequence>
5
+ # <xsd:attribute name="visibility" type="ST_Visibility" use="optional" default="visible"/>
6
+ # <xsd:attribute name="minimized" type="xsd:boolean" use="optional" default="false"/>
7
+ # <xsd:attribute name="showHorizontalScroll" type="xsd:boolean" use="optional" default="true"/>
8
+ # <xsd:attribute name="showVerticalScroll" type="xsd:boolean" use="optional" default="true"/>
9
+ # <xsd:attribute name="showSheetTabs" type="xsd:boolean" use="optional" default="true"/>
10
+ # <xsd:attribute name="xWindow" type="xsd:int" use="optional"/>
11
+ # <xsd:attribute name="yWindow" type="xsd:int" use="optional"/>
12
+ # <xsd:attribute name="windowWidth" type="xsd:unsignedInt" use="optional"/>
13
+ # <xsd:attribute name="windowHeight" type="xsd:unsignedInt" use="optional"/>
14
+ # <xsd:attribute name="tabRatio" type="xsd:unsignedInt" use="optional" default="600"/>
15
+ # <xsd:attribute name="firstSheet" type="xsd:unsignedInt" use="optional" default="0"/>
16
+ # <xsd:attribute name="activeTab" type="xsd:unsignedInt" use="optional" default="0"/>
17
+ # <xsd:attribute name="autoFilterDateGrouping" type="xsd:boolean" use="optional"
18
+ # default="true"/>
19
+ # </xsd:complexType>
20
+
21
+ module Axlsx
22
+ # A BookView defines the display properties for a workbook.
23
+ # Units for window widths and other dimensions are expressed in twips.
24
+ # Twip measurements are portable between different display resolutions.
25
+ # The formula is (screen pixels) * (20 * 72) / (logical device dpi),
26
+ # where the logical device dpi can be different for x and y coordinates.
27
+ class WorkbookView
28
+ include Axlsx::SerializedAttributes
29
+ include Axlsx::OptionsParser
30
+ include Axlsx::Accessors
31
+
32
+ # Creates a new BookView object
33
+ # @param [Hash] options A hash of key/value pairs that will be mapped to this instances attributes.
34
+ # @option [Symbol] visibility Specifies visible state of the workbook window. The default value for this attribute is :visible.
35
+ # @option [Boolean] minimized Specifies a boolean value that indicates whether the workbook window is minimized.
36
+ # @option [Boolean] show_horizontal_scroll Specifies a boolean value that indicates whether to display the horizontal scroll bar in the user interface.
37
+ # @option [Boolean] show_vertical_scroll Specifies a boolean value that indicates whether to display the vertical scroll bar.
38
+ # @option [Boolean] show_sheet_tabs Specifies a boolean value that indicates whether to display the sheet tabs in the user interface.
39
+ # @option [Integer] tab_ratio Specifies ratio between the workbook tabs bar and the horizontal scroll bar.
40
+ # @option [Integer] first_sheet Specifies the index to the first sheet in this book view.
41
+ # @option [Integer] active_tab Specifies an unsignedInt that contains the index to the active sheet in this book view.
42
+ # @option [Integer] x_window Specifies the X coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.
43
+ # @option [Integer] y_window Specifies the Y coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.
44
+ # @option [Integer] window_width Specifies the width of the workbook window. The unit of measurement for this value is twips.
45
+ # @option [Integer] window_height Specifies the height of the workbook window. The unit of measurement for this value is twips.
46
+ # @option [Boolean] auto_filter_date_grouping Specifies a boolean value that indicates whether to group dates when presenting the user with filtering options in the user interface.
47
+ def initialize(options = {})
48
+ parse_options options
49
+ yield self if block_given?
50
+ end
51
+
52
+ unsigned_int_attr_accessor :x_window, :y_window, :window_width, :window_height,
53
+ :tab_ratio, :first_sheet, :active_tab
54
+
55
+ validated_attr_accessor [:visibility], :validate_view_visibility
56
+
57
+ serializable_attributes :visibility, :minimized,
58
+ :show_horizontal_scroll, :show_vertical_scroll,
59
+ :show_sheet_tabs, :tab_ratio, :first_sheet, :active_tab,
60
+ :x_window, :y_window, :window_width, :window_height,
61
+ :auto_filter_date_grouping
62
+
63
+ boolean_attr_accessor :minimized, :show_horizontal_scroll, :show_vertical_scroll,
64
+ :show_sheet_tabs, :auto_filter_date_grouping
65
+
66
+ # Serialize the WorkbookView
67
+ # @param [String] str
68
+ # @return [String]
69
+ def to_xml_string(str = '')
70
+ str << '<workbookView '
71
+ serialized_attributes str
72
+ str << '></workbookView>'
73
+ end
74
+ end
75
+ end
@@ -1,22 +1,20 @@
1
- module Axlsx
2
- # a simple types list of BookView objects
3
- class WorkbookViews < SimpleTypedList
4
-
5
- # creates the book views object
6
- def initialize
7
- super WorkbookView
8
- end
9
-
10
- # Serialize to xml
11
- # @param [String] str
12
- # @return [String]
13
- def to_xml_string(str = '')
14
- return if empty?
15
- str << "<bookViews>"
16
- each { |view| view.to_xml_string(str) }
17
- str << '</bookViews>'
18
- end
19
- end
20
- end
21
-
22
-
1
+ module Axlsx
2
+ # a simple types list of BookView objects
3
+ class WorkbookViews < SimpleTypedList
4
+ # creates the book views object
5
+ def initialize
6
+ super WorkbookView
7
+ end
8
+
9
+ # Serialize to xml
10
+ # @param [String] str
11
+ # @return [String]
12
+ def to_xml_string(str = '')
13
+ return if empty?
14
+
15
+ str << "<bookViews>"
16
+ each { |view| view.to_xml_string(str) }
17
+ str << '</bookViews>'
18
+ end
19
+ end
20
+ end
@@ -1,77 +1,78 @@
1
-
2
- require 'axlsx/workbook/worksheet/auto_filter/filter_column.rb'
3
- require 'axlsx/workbook/worksheet/auto_filter/filters.rb'
4
-
5
- module Axlsx
6
-
7
- #This class represents an auto filter range in a worksheet
8
- class AutoFilter
9
-
10
- # creates a new Autofilter object
11
- # @param [Worksheet] worksheet
12
- def initialize(worksheet)
13
- raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
14
- @worksheet = worksheet
15
- end
16
-
17
- attr_reader :worksheet
18
-
19
- # The range the autofilter should be applied to.
20
- # This should be a string like 'A1:B8'
21
- # @return [String]
22
- attr_accessor :range
23
-
24
- # the formula for the defined name required for this auto filter
25
- # This prepends the worksheet name to the absolute cell reference
26
- # e.g. A1:B2 -> 'Sheet1'!$A$1:$B$2
27
- # @return [String]
28
- def defined_name
29
- return unless range
30
- Axlsx.cell_range(range.split(':').collect { |name| worksheet.name_to_cell(name)})
31
- end
32
-
33
- # A collection of filterColumns for this auto_filter
34
- # @return [SimpleTypedList]
35
- def columns
36
- @columns ||= SimpleTypedList.new FilterColumn
37
- end
38
-
39
- # Adds a filter column. This is the recommended way to create and manage filter columns for your autofilter.
40
- # In addition to the require id and type parameters, options will be passed to the filter column during instantiation.
41
- # @param [String] col_id Zero-based index indicating the AutoFilter column to which this filter information applies.
42
- # @param [Symbol] filter_type A symbol representing one of the supported filter types.
43
- # @param [Hash] options a hash of options to pass into the generated filter
44
- # @return [FilterColumn]
45
- def add_column(col_id, filter_type, options = {})
46
- columns << FilterColumn.new(col_id, filter_type, options)
47
- columns.last
48
- end
49
-
50
- # actually performs the filtering of rows who's cells do not
51
- # match the filter.
52
- def apply
53
- first_cell, last_cell = range.split(':')
54
- start_point = Axlsx::name_to_indices(first_cell)
55
- end_point = Axlsx::name_to_indices(last_cell)
56
- # The +1 is so we skip the header row with the filter drop downs
57
- rows = worksheet.rows[(start_point.last+1)..end_point.last] || []
58
-
59
- column_offset = start_point.first
60
- columns.each do |column|
61
- rows.each do |row|
62
- next if row.hidden
63
- column.apply(row, column_offset)
64
- end
65
- end
66
- end
67
- # serialize the object
68
- # @return [String]
69
- def to_xml_string(str='')
70
- return unless range
71
- str << "<autoFilter ref='#{range}'>"
72
- columns.each { |filter_column| filter_column.to_xml_string(str) }
73
- str << "</autoFilter>"
74
- end
75
-
76
- end
77
- end
1
+ require 'axlsx/workbook/worksheet/auto_filter/filter_column.rb'
2
+ require 'axlsx/workbook/worksheet/auto_filter/filters.rb'
3
+
4
+ module Axlsx
5
+ # This class represents an auto filter range in a worksheet
6
+ class AutoFilter
7
+ # creates a new Autofilter object
8
+ # @param [Worksheet] worksheet
9
+ def initialize(worksheet)
10
+ raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
11
+
12
+ @worksheet = worksheet
13
+ end
14
+
15
+ attr_reader :worksheet
16
+
17
+ # The range the autofilter should be applied to.
18
+ # This should be a string like 'A1:B8'
19
+ # @return [String]
20
+ attr_accessor :range
21
+
22
+ # the formula for the defined name required for this auto filter
23
+ # This prepends the worksheet name to the absolute cell reference
24
+ # e.g. A1:B2 -> 'Sheet1'!$A$1:$B$2
25
+ # @return [String]
26
+ def defined_name
27
+ return unless range
28
+
29
+ Axlsx.cell_range(range.split(':').collect { |name| worksheet.name_to_cell(name) })
30
+ end
31
+
32
+ # A collection of filterColumns for this auto_filter
33
+ # @return [SimpleTypedList]
34
+ def columns
35
+ @columns ||= SimpleTypedList.new FilterColumn
36
+ end
37
+
38
+ # Adds a filter column. This is the recommended way to create and manage filter columns for your autofilter.
39
+ # In addition to the require id and type parameters, options will be passed to the filter column during instantiation.
40
+ # @param [String] col_id Zero-based index indicating the AutoFilter column to which this filter information applies.
41
+ # @param [Symbol] filter_type A symbol representing one of the supported filter types.
42
+ # @param [Hash] options a hash of options to pass into the generated filter
43
+ # @return [FilterColumn]
44
+ def add_column(col_id, filter_type, options = {})
45
+ columns << FilterColumn.new(col_id, filter_type, options)
46
+ columns.last
47
+ end
48
+
49
+ # actually performs the filtering of rows who's cells do not
50
+ # match the filter.
51
+ def apply
52
+ first_cell, last_cell = range.split(':')
53
+ start_point = Axlsx::name_to_indices(first_cell)
54
+ end_point = Axlsx::name_to_indices(last_cell)
55
+ # The +1 is so we skip the header row with the filter drop downs
56
+ rows = worksheet.rows[(start_point.last + 1)..end_point.last] || []
57
+
58
+ column_offset = start_point.first
59
+ columns.each do |column|
60
+ rows.each do |row|
61
+ next if row.hidden
62
+
63
+ column.apply(row, column_offset)
64
+ end
65
+ end
66
+ end
67
+
68
+ # serialize the object
69
+ # @return [String]
70
+ def to_xml_string(str = '')
71
+ return unless range
72
+
73
+ str << "<autoFilter ref='#{range}'>"
74
+ columns.each { |filter_column| filter_column.to_xml_string(str) }
75
+ str << "</autoFilter>"
76
+ end
77
+ end
78
+ end
@@ -1,94 +1,94 @@
1
- module Axlsx
2
- # The filterColumn collection identifies a particular column in the AutoFilter
3
- # range and specifies filter information that has been applied to this column.
4
- # If a column in the AutoFilter range has no criteria specified,
5
- # then there is no corresponding filterColumn collection expressed for that column.
6
- class FilterColumn
7
-
8
- include Axlsx::OptionsParser
9
- include Axlsx::SerializedAttributes
10
-
11
- # Creates a new FilterColumn object
12
- # @note This class yeilds its filter object as that is where the vast majority of processing will be done
13
- # @param [Integer|Cell] col_id The zero based index for the column to which this filter will be applied
14
- # @param [Symbol] filter_type The symbolized class name of the filter to apply to this column.
15
- # @param [Hash] options options for this object and the filter
16
- # @option [Boolean] hidden_button @see hidden_button
17
- # @option [Boolean] show_button @see show_button
18
- def initialize(col_id, filter_type, options = {})
19
- RestrictionValidator.validate 'FilterColumn.filter', FILTERS, filter_type
20
- #Axlsx::validate_unsigned_int(col_id)
21
- self.col_id = col_id
22
- parse_options options
23
- @filter = Axlsx.const_get(Axlsx.camel(filter_type)).new(options)
24
- yield @filter if block_given?
25
- end
26
-
27
- serializable_attributes :col_id, :hidden_button, :show_button
28
-
29
- # Allowed filters
30
- FILTERS = [:filters] #, :top10, :custom_filters, :dynamic_filters, :color_filters, :icon_filters]
31
-
32
- # Zero-based index indicating the AutoFilter column to which this filter information applies.
33
- # @return [Integer]
34
- attr_reader :col_id
35
-
36
- # The actual filter being dealt with here
37
- # This could be any one of the allowed filter types
38
- attr_reader :filter
39
-
40
- # Flag indicating whether the filter button is visible.
41
- # When the cell containing the filter button is merged with another cell,
42
- # the filter button can be hidden, and not drawn.
43
- # @return [Boolean]
44
- def show_button
45
- @show_button ||= true
46
- end
47
-
48
- # Flag indicating whether the AutoFilter button for this column is hidden.
49
- # @return [Boolean]
50
- def hidden_button
51
- @hidden_button ||= false
52
- end
53
-
54
- # Sets the col_id attribute for this filter column.
55
- # @param [Integer | Cell] column_index The zero based index of the column to which this filter applies.
56
- # When you specify a cell, the column index will be read off the cell
57
- # @return [Integer]
58
- def col_id=(column_index)
59
- column_index = column_index.col if column_index.is_a?(Cell)
60
- Axlsx.validate_unsigned_int column_index
61
- @col_id = column_index
62
- end
63
-
64
- # Apply the filters for this column
65
- # @param [Array] row A row from a worksheet that needs to be
66
- # filtered.
67
- def apply(row, offset)
68
- row.hidden = @filter.apply(row.cells[offset+col_id.to_i])
69
- end
70
- # @param [Boolean] hidden Flag indicating whether the AutoFilter button for this column is hidden.
71
- # @return [Boolean]
72
- def hidden_button=(hidden)
73
- Axlsx.validate_boolean hidden
74
- @hidden_button = hidden
75
- end
76
-
77
- # Flag indicating whether the AutoFilter button is show. This is
78
- # undocumented in the spec, but exists in the schema file as an
79
- # optional attribute.
80
- # @param [Boolean] show Show or hide the button
81
- # @return [Boolean]
82
- def show_button=(show)
83
- Axlsx.validate_boolean show
84
- @show_botton = show
85
- end
86
-
87
- # Serialize the object to xml
88
- def to_xml_string(str='')
89
- str << "<filterColumn #{serialized_attributes}>"
90
- @filter.to_xml_string(str)
91
- str << "</filterColumn>"
92
- end
93
- end
94
- end
1
+ module Axlsx
2
+ # The filterColumn collection identifies a particular column in the AutoFilter
3
+ # range and specifies filter information that has been applied to this column.
4
+ # If a column in the AutoFilter range has no criteria specified,
5
+ # then there is no corresponding filterColumn collection expressed for that column.
6
+ class FilterColumn
7
+ include Axlsx::OptionsParser
8
+ include Axlsx::SerializedAttributes
9
+
10
+ # Creates a new FilterColumn object
11
+ # @note This class yeilds its filter object as that is where the vast majority of processing will be done
12
+ # @param [Integer|Cell] col_id The zero based index for the column to which this filter will be applied
13
+ # @param [Symbol] filter_type The symbolized class name of the filter to apply to this column.
14
+ # @param [Hash] options options for this object and the filter
15
+ # @option [Boolean] hidden_button @see hidden_button
16
+ # @option [Boolean] show_button @see show_button
17
+ def initialize(col_id, filter_type, options = {})
18
+ RestrictionValidator.validate 'FilterColumn.filter', FILTERS, filter_type
19
+ # Axlsx::validate_unsigned_int(col_id)
20
+ self.col_id = col_id
21
+ parse_options options
22
+ @filter = Axlsx.const_get(Axlsx.camel(filter_type)).new(options)
23
+ yield @filter if block_given?
24
+ end
25
+
26
+ serializable_attributes :col_id, :hidden_button, :show_button
27
+
28
+ # Allowed filters
29
+ FILTERS = [:filters] # , :top10, :custom_filters, :dynamic_filters, :color_filters, :icon_filters]
30
+
31
+ # Zero-based index indicating the AutoFilter column to which this filter information applies.
32
+ # @return [Integer]
33
+ attr_reader :col_id
34
+
35
+ # The actual filter being dealt with here
36
+ # This could be any one of the allowed filter types
37
+ attr_reader :filter
38
+
39
+ # Flag indicating whether the filter button is visible.
40
+ # When the cell containing the filter button is merged with another cell,
41
+ # the filter button can be hidden, and not drawn.
42
+ # @return [Boolean]
43
+ def show_button
44
+ @show_button ||= true
45
+ end
46
+
47
+ # Flag indicating whether the AutoFilter button for this column is hidden.
48
+ # @return [Boolean]
49
+ def hidden_button
50
+ @hidden_button ||= false
51
+ end
52
+
53
+ # Sets the col_id attribute for this filter column.
54
+ # @param [Integer | Cell] column_index The zero based index of the column to which this filter applies.
55
+ # When you specify a cell, the column index will be read off the cell
56
+ # @return [Integer]
57
+ def col_id=(column_index)
58
+ column_index = column_index.col if column_index.is_a?(Cell)
59
+ Axlsx.validate_unsigned_int column_index
60
+ @col_id = column_index
61
+ end
62
+
63
+ # Apply the filters for this column
64
+ # @param [Array] row A row from a worksheet that needs to be
65
+ # filtered.
66
+ def apply(row, offset)
67
+ row.hidden = @filter.apply(row.cells[offset + col_id.to_i])
68
+ end
69
+
70
+ # @param [Boolean] hidden Flag indicating whether the AutoFilter button for this column is hidden.
71
+ # @return [Boolean]
72
+ def hidden_button=(hidden)
73
+ Axlsx.validate_boolean hidden
74
+ @hidden_button = hidden
75
+ end
76
+
77
+ # Flag indicating whether the AutoFilter button is show. This is
78
+ # undocumented in the spec, but exists in the schema file as an
79
+ # optional attribute.
80
+ # @param [Boolean] show Show or hide the button
81
+ # @return [Boolean]
82
+ def show_button=(show)
83
+ Axlsx.validate_boolean show
84
+ @show_botton = show
85
+ end
86
+
87
+ # Serialize the object to xml
88
+ def to_xml_string(str = '')
89
+ str << "<filterColumn #{serialized_attributes}>"
90
+ @filter.to_xml_string(str)
91
+ str << "</filterColumn>"
92
+ end
93
+ end
94
+ end