bonio-axlsx 2.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (325) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +9 -0
  3. data/.yardopts_guide +19 -0
  4. data/CHANGELOG.md +239 -0
  5. data/LICENSE +22 -0
  6. data/README.md +258 -0
  7. data/Rakefile +30 -0
  8. data/examples/2010_comments.rb +17 -0
  9. data/examples/anchor_swapping.rb +28 -0
  10. data/examples/auto_filter.rb +25 -0
  11. data/examples/basic_charts.rb +58 -0
  12. data/examples/chart_colors.rb +88 -0
  13. data/examples/colored_links.rb +59 -0
  14. data/examples/conditional_formatting/example_conditional_formatting.rb +89 -0
  15. data/examples/conditional_formatting/getting_barred.rb +37 -0
  16. data/examples/conditional_formatting/hitting_the_high_notes.rb +37 -0
  17. data/examples/conditional_formatting/scaled_colors.rb +39 -0
  18. data/examples/conditional_formatting/stop_and_go.rb +37 -0
  19. data/examples/data_validation.rb +50 -0
  20. data/examples/example.rb +875 -0
  21. data/examples/extractive.rb +45 -0
  22. data/examples/image1.jpeg +0 -0
  23. data/examples/ios_preview.rb +14 -0
  24. data/examples/merge_cells.rb +17 -0
  25. data/examples/no_grid_with_borders.rb +18 -0
  26. data/examples/page_setup.rb +11 -0
  27. data/examples/pivot_table.rb +39 -0
  28. data/examples/pivot_test.rb +63 -0
  29. data/examples/sheet_protection.rb +10 -0
  30. data/examples/skydrive/real_example.rb +63 -0
  31. data/examples/split.rb +16 -0
  32. data/examples/styles.rb +66 -0
  33. data/examples/underline.rb +13 -0
  34. data/examples/wrap_text.rb +21 -0
  35. data/lib/axlsx.rb +168 -0
  36. data/lib/axlsx/content_type/abstract_content_type.rb +32 -0
  37. data/lib/axlsx/content_type/content_type.rb +26 -0
  38. data/lib/axlsx/content_type/default.rb +25 -0
  39. data/lib/axlsx/content_type/override.rb +25 -0
  40. data/lib/axlsx/doc_props/app.rb +235 -0
  41. data/lib/axlsx/doc_props/core.rb +39 -0
  42. data/lib/axlsx/drawing/ax_data_source.rb +26 -0
  43. data/lib/axlsx/drawing/axes.rb +61 -0
  44. data/lib/axlsx/drawing/axis.rb +190 -0
  45. data/lib/axlsx/drawing/bar_3D_chart.rb +151 -0
  46. data/lib/axlsx/drawing/bar_series.rb +82 -0
  47. data/lib/axlsx/drawing/bubble_chart.rb +59 -0
  48. data/lib/axlsx/drawing/bubble_series.rb +63 -0
  49. data/lib/axlsx/drawing/cat_axis.rb +85 -0
  50. data/lib/axlsx/drawing/chart.rb +274 -0
  51. data/lib/axlsx/drawing/d_lbls.rb +90 -0
  52. data/lib/axlsx/drawing/drawing.rb +164 -0
  53. data/lib/axlsx/drawing/graphic_frame.rb +54 -0
  54. data/lib/axlsx/drawing/hyperlink.rb +100 -0
  55. data/lib/axlsx/drawing/line_3D_chart.rb +68 -0
  56. data/lib/axlsx/drawing/line_chart.rb +99 -0
  57. data/lib/axlsx/drawing/line_series.rb +110 -0
  58. data/lib/axlsx/drawing/marker.rb +84 -0
  59. data/lib/axlsx/drawing/num_data.rb +52 -0
  60. data/lib/axlsx/drawing/num_data_source.rb +62 -0
  61. data/lib/axlsx/drawing/num_val.rb +34 -0
  62. data/lib/axlsx/drawing/one_cell_anchor.rb +98 -0
  63. data/lib/axlsx/drawing/pic.rb +213 -0
  64. data/lib/axlsx/drawing/picture_locking.rb +42 -0
  65. data/lib/axlsx/drawing/pie_3D_chart.rb +47 -0
  66. data/lib/axlsx/drawing/pie_series.rb +74 -0
  67. data/lib/axlsx/drawing/scaling.rb +60 -0
  68. data/lib/axlsx/drawing/scatter_chart.rb +74 -0
  69. data/lib/axlsx/drawing/scatter_series.rb +98 -0
  70. data/lib/axlsx/drawing/ser_axis.rb +45 -0
  71. data/lib/axlsx/drawing/series.rb +69 -0
  72. data/lib/axlsx/drawing/series_title.rb +23 -0
  73. data/lib/axlsx/drawing/str_data.rb +42 -0
  74. data/lib/axlsx/drawing/str_val.rb +34 -0
  75. data/lib/axlsx/drawing/title.rb +96 -0
  76. data/lib/axlsx/drawing/two_cell_anchor.rb +92 -0
  77. data/lib/axlsx/drawing/val_axis.rb +37 -0
  78. data/lib/axlsx/drawing/view_3D.rb +115 -0
  79. data/lib/axlsx/drawing/vml_drawing.rb +42 -0
  80. data/lib/axlsx/drawing/vml_shape.rb +66 -0
  81. data/lib/axlsx/package.rb +363 -0
  82. data/lib/axlsx/rels/relationship.rb +129 -0
  83. data/lib/axlsx/rels/relationships.rb +29 -0
  84. data/lib/axlsx/stylesheet/border.rb +71 -0
  85. data/lib/axlsx/stylesheet/border_pr.rb +71 -0
  86. data/lib/axlsx/stylesheet/cell_alignment.rb +132 -0
  87. data/lib/axlsx/stylesheet/cell_protection.rb +41 -0
  88. data/lib/axlsx/stylesheet/cell_style.rb +72 -0
  89. data/lib/axlsx/stylesheet/color.rb +76 -0
  90. data/lib/axlsx/stylesheet/dxf.rb +79 -0
  91. data/lib/axlsx/stylesheet/fill.rb +35 -0
  92. data/lib/axlsx/stylesheet/font.rb +148 -0
  93. data/lib/axlsx/stylesheet/gradient_fill.rb +103 -0
  94. data/lib/axlsx/stylesheet/gradient_stop.rb +37 -0
  95. data/lib/axlsx/stylesheet/num_fmt.rb +86 -0
  96. data/lib/axlsx/stylesheet/pattern_fill.rb +73 -0
  97. data/lib/axlsx/stylesheet/styles.rb +420 -0
  98. data/lib/axlsx/stylesheet/table_style.rb +54 -0
  99. data/lib/axlsx/stylesheet/table_style_element.rb +77 -0
  100. data/lib/axlsx/stylesheet/table_styles.rb +46 -0
  101. data/lib/axlsx/stylesheet/xf.rb +147 -0
  102. data/lib/axlsx/util/accessors.rb +64 -0
  103. data/lib/axlsx/util/constants.rb +397 -0
  104. data/lib/axlsx/util/mime_type_utils.rb +11 -0
  105. data/lib/axlsx/util/options_parser.rb +16 -0
  106. data/lib/axlsx/util/parser.rb +44 -0
  107. data/lib/axlsx/util/serialized_attributes.rb +89 -0
  108. data/lib/axlsx/util/simple_typed_list.rb +179 -0
  109. data/lib/axlsx/util/storage.rb +146 -0
  110. data/lib/axlsx/util/string.rb +7 -0
  111. data/lib/axlsx/util/validators.rb +311 -0
  112. data/lib/axlsx/version.rb +5 -0
  113. data/lib/axlsx/workbook/defined_name.rb +128 -0
  114. data/lib/axlsx/workbook/defined_names.rb +21 -0
  115. data/lib/axlsx/workbook/shared_strings_table.rb +77 -0
  116. data/lib/axlsx/workbook/workbook.rb +375 -0
  117. data/lib/axlsx/workbook/workbook_view.rb +78 -0
  118. data/lib/axlsx/workbook/workbook_views.rb +22 -0
  119. data/lib/axlsx/workbook/worksheet/auto_filter/auto_filter.rb +77 -0
  120. data/lib/axlsx/workbook/worksheet/auto_filter/filter_column.rb +94 -0
  121. data/lib/axlsx/workbook/worksheet/auto_filter/filters.rb +244 -0
  122. data/lib/axlsx/workbook/worksheet/break.rb +35 -0
  123. data/lib/axlsx/workbook/worksheet/cell.rb +475 -0
  124. data/lib/axlsx/workbook/worksheet/cell_serializer.rb +166 -0
  125. data/lib/axlsx/workbook/worksheet/cfvo.rb +60 -0
  126. data/lib/axlsx/workbook/worksheet/cfvos.rb +15 -0
  127. data/lib/axlsx/workbook/worksheet/col.rb +141 -0
  128. data/lib/axlsx/workbook/worksheet/col_breaks.rb +35 -0
  129. data/lib/axlsx/workbook/worksheet/color_scale.rb +110 -0
  130. data/lib/axlsx/workbook/worksheet/cols.rb +20 -0
  131. data/lib/axlsx/workbook/worksheet/comment.rb +91 -0
  132. data/lib/axlsx/workbook/worksheet/comments.rb +82 -0
  133. data/lib/axlsx/workbook/worksheet/conditional_formatting.rb +82 -0
  134. data/lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb +220 -0
  135. data/lib/axlsx/workbook/worksheet/conditional_formattings.rb +25 -0
  136. data/lib/axlsx/workbook/worksheet/data_bar.rb +129 -0
  137. data/lib/axlsx/workbook/worksheet/data_validation.rb +246 -0
  138. data/lib/axlsx/workbook/worksheet/data_validations.rb +28 -0
  139. data/lib/axlsx/workbook/worksheet/date_time_converter.rb +30 -0
  140. data/lib/axlsx/workbook/worksheet/dimension.rb +64 -0
  141. data/lib/axlsx/workbook/worksheet/header_footer.rb +52 -0
  142. data/lib/axlsx/workbook/worksheet/icon_set.rb +81 -0
  143. data/lib/axlsx/workbook/worksheet/merged_cells.rb +37 -0
  144. data/lib/axlsx/workbook/worksheet/outline_pr.rb +33 -0
  145. data/lib/axlsx/workbook/worksheet/page_margins.rb +97 -0
  146. data/lib/axlsx/workbook/worksheet/page_set_up_pr.rb +44 -0
  147. data/lib/axlsx/workbook/worksheet/page_setup.rb +240 -0
  148. data/lib/axlsx/workbook/worksheet/pane.rb +139 -0
  149. data/lib/axlsx/workbook/worksheet/pivot_table.rb +289 -0
  150. data/lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb +66 -0
  151. data/lib/axlsx/workbook/worksheet/pivot_tables.rb +24 -0
  152. data/lib/axlsx/workbook/worksheet/print_options.rb +39 -0
  153. data/lib/axlsx/workbook/worksheet/protected_range.rb +47 -0
  154. data/lib/axlsx/workbook/worksheet/protected_ranges.rb +34 -0
  155. data/lib/axlsx/workbook/worksheet/rich_text.rb +35 -0
  156. data/lib/axlsx/workbook/worksheet/rich_text_run.rb +254 -0
  157. data/lib/axlsx/workbook/worksheet/row.rb +161 -0
  158. data/lib/axlsx/workbook/worksheet/row_breaks.rb +33 -0
  159. data/lib/axlsx/workbook/worksheet/selection.rb +101 -0
  160. data/lib/axlsx/workbook/worksheet/sheet_calc_pr.rb +29 -0
  161. data/lib/axlsx/workbook/worksheet/sheet_data.rb +27 -0
  162. data/lib/axlsx/workbook/worksheet/sheet_format_pr.rb +60 -0
  163. data/lib/axlsx/workbook/worksheet/sheet_pr.rb +87 -0
  164. data/lib/axlsx/workbook/worksheet/sheet_protection.rb +118 -0
  165. data/lib/axlsx/workbook/worksheet/sheet_view.rb +213 -0
  166. data/lib/axlsx/workbook/worksheet/table.rb +102 -0
  167. data/lib/axlsx/workbook/worksheet/table_style_info.rb +49 -0
  168. data/lib/axlsx/workbook/worksheet/tables.rb +31 -0
  169. data/lib/axlsx/workbook/worksheet/worksheet.rb +799 -0
  170. data/lib/axlsx/workbook/worksheet/worksheet_comments.rb +58 -0
  171. data/lib/axlsx/workbook/worksheet/worksheet_drawing.rb +58 -0
  172. data/lib/axlsx/workbook/worksheet/worksheet_hyperlink.rb +74 -0
  173. data/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb +38 -0
  174. data/lib/schema/dc.xsd +118 -0
  175. data/lib/schema/dcmitype.xsd +52 -0
  176. data/lib/schema/dcterms.xsd +331 -0
  177. data/lib/schema/dml-chart.xsd +1499 -0
  178. data/lib/schema/dml-chartDrawing.xsd +146 -0
  179. data/lib/schema/dml-compatibility.xsd +14 -0
  180. data/lib/schema/dml-diagram.xsd +1091 -0
  181. data/lib/schema/dml-lockedCanvas.xsd +11 -0
  182. data/lib/schema/dml-main.xsd +3048 -0
  183. data/lib/schema/dml-picture.xsd +23 -0
  184. data/lib/schema/dml-spreadsheetDrawing.xsd +185 -0
  185. data/lib/schema/dml-wordprocessingDrawing.xsd +185 -0
  186. data/lib/schema/opc-contentTypes.xsd +42 -0
  187. data/lib/schema/opc-coreProperties.xsd +54 -0
  188. data/lib/schema/opc-digSig.xsd +49 -0
  189. data/lib/schema/opc-relationships.xsd +33 -0
  190. data/lib/schema/pml.xsd +1676 -0
  191. data/lib/schema/shared-additionalCharacteristics.xsd +28 -0
  192. data/lib/schema/shared-bibliography.xsd +144 -0
  193. data/lib/schema/shared-commonSimpleTypes.xsd +166 -0
  194. data/lib/schema/shared-customXmlDataProperties.xsd +25 -0
  195. data/lib/schema/shared-customXmlSchemaProperties.xsd +18 -0
  196. data/lib/schema/shared-documentPropertiesCustom.xsd +59 -0
  197. data/lib/schema/shared-documentPropertiesExtended.xsd +56 -0
  198. data/lib/schema/shared-documentPropertiesVariantTypes.xsd +195 -0
  199. data/lib/schema/shared-math.xsd +582 -0
  200. data/lib/schema/shared-relationshipReference.xsd +25 -0
  201. data/lib/schema/sml.xsd +4434 -0
  202. data/lib/schema/vml-main.xsd +569 -0
  203. data/lib/schema/vml-officeDrawing.xsd +509 -0
  204. data/lib/schema/vml-presentationDrawing.xsd +12 -0
  205. data/lib/schema/vml-spreadsheetDrawing.xsd +108 -0
  206. data/lib/schema/vml-wordprocessingDrawing.xsd +96 -0
  207. data/lib/schema/wml.xsd +3644 -0
  208. data/lib/schema/xml.xsd +116 -0
  209. data/test/benchmark.rb +72 -0
  210. data/test/content_type/tc_content_type.rb +76 -0
  211. data/test/content_type/tc_default.rb +16 -0
  212. data/test/content_type/tc_override.rb +14 -0
  213. data/test/doc_props/tc_app.rb +43 -0
  214. data/test/doc_props/tc_core.rb +42 -0
  215. data/test/drawing/tc_axes.rb +8 -0
  216. data/test/drawing/tc_axis.rb +112 -0
  217. data/test/drawing/tc_bar_3D_chart.rb +71 -0
  218. data/test/drawing/tc_bar_series.rb +37 -0
  219. data/test/drawing/tc_bubble_chart.rb +44 -0
  220. data/test/drawing/tc_bubble_series.rb +21 -0
  221. data/test/drawing/tc_cat_axis.rb +31 -0
  222. data/test/drawing/tc_cat_axis_data.rb +27 -0
  223. data/test/drawing/tc_chart.rb +110 -0
  224. data/test/drawing/tc_d_lbls.rb +57 -0
  225. data/test/drawing/tc_data_source.rb +23 -0
  226. data/test/drawing/tc_drawing.rb +80 -0
  227. data/test/drawing/tc_graphic_frame.rb +27 -0
  228. data/test/drawing/tc_hyperlink.rb +64 -0
  229. data/test/drawing/tc_line_3d_chart.rb +47 -0
  230. data/test/drawing/tc_line_chart.rb +39 -0
  231. data/test/drawing/tc_line_series.rb +71 -0
  232. data/test/drawing/tc_marker.rb +44 -0
  233. data/test/drawing/tc_named_axis_data.rb +27 -0
  234. data/test/drawing/tc_num_data.rb +31 -0
  235. data/test/drawing/tc_num_val.rb +29 -0
  236. data/test/drawing/tc_one_cell_anchor.rb +66 -0
  237. data/test/drawing/tc_pic.rb +106 -0
  238. data/test/drawing/tc_picture_locking.rb +72 -0
  239. data/test/drawing/tc_pie_3D_chart.rb +28 -0
  240. data/test/drawing/tc_pie_series.rb +32 -0
  241. data/test/drawing/tc_scaling.rb +36 -0
  242. data/test/drawing/tc_scatter_chart.rb +48 -0
  243. data/test/drawing/tc_scatter_series.rb +45 -0
  244. data/test/drawing/tc_ser_axis.rb +31 -0
  245. data/test/drawing/tc_series.rb +23 -0
  246. data/test/drawing/tc_series_title.rb +33 -0
  247. data/test/drawing/tc_str_data.rb +18 -0
  248. data/test/drawing/tc_str_val.rb +30 -0
  249. data/test/drawing/tc_title.rb +49 -0
  250. data/test/drawing/tc_two_cell_anchor.rb +36 -0
  251. data/test/drawing/tc_val_axis.rb +24 -0
  252. data/test/drawing/tc_view_3D.rb +54 -0
  253. data/test/drawing/tc_vml_drawing.rb +25 -0
  254. data/test/drawing/tc_vml_shape.rb +106 -0
  255. data/test/profile.rb +24 -0
  256. data/test/rels/tc_relationship.rb +44 -0
  257. data/test/rels/tc_relationships.rb +37 -0
  258. data/test/stylesheet/tc_border.rb +37 -0
  259. data/test/stylesheet/tc_border_pr.rb +32 -0
  260. data/test/stylesheet/tc_cell_alignment.rb +81 -0
  261. data/test/stylesheet/tc_cell_protection.rb +29 -0
  262. data/test/stylesheet/tc_cell_style.rb +57 -0
  263. data/test/stylesheet/tc_color.rb +43 -0
  264. data/test/stylesheet/tc_dxf.rb +81 -0
  265. data/test/stylesheet/tc_fill.rb +18 -0
  266. data/test/stylesheet/tc_font.rb +121 -0
  267. data/test/stylesheet/tc_gradient_fill.rb +72 -0
  268. data/test/stylesheet/tc_gradient_stop.rb +31 -0
  269. data/test/stylesheet/tc_num_fmt.rb +30 -0
  270. data/test/stylesheet/tc_pattern_fill.rb +43 -0
  271. data/test/stylesheet/tc_styles.rb +235 -0
  272. data/test/stylesheet/tc_table_style.rb +44 -0
  273. data/test/stylesheet/tc_table_style_element.rb +45 -0
  274. data/test/stylesheet/tc_table_styles.rb +29 -0
  275. data/test/stylesheet/tc_xf.rb +120 -0
  276. data/test/tc_axlsx.rb +82 -0
  277. data/test/tc_helper.rb +10 -0
  278. data/test/tc_package.rb +233 -0
  279. data/test/util/tc_mime_type_utils.rb +13 -0
  280. data/test/util/tc_serialized_attributes.rb +19 -0
  281. data/test/util/tc_simple_typed_list.rb +77 -0
  282. data/test/util/tc_validators.rb +210 -0
  283. data/test/workbook/tc_defined_name.rb +49 -0
  284. data/test/workbook/tc_shared_strings_table.rb +58 -0
  285. data/test/workbook/tc_workbook.rb +145 -0
  286. data/test/workbook/tc_workbook_view.rb +50 -0
  287. data/test/workbook/worksheet/auto_filter/tc_auto_filter.rb +38 -0
  288. data/test/workbook/worksheet/auto_filter/tc_filter_column.rb +76 -0
  289. data/test/workbook/worksheet/auto_filter/tc_filters.rb +50 -0
  290. data/test/workbook/worksheet/tc_break.rb +49 -0
  291. data/test/workbook/worksheet/tc_cell.rb +373 -0
  292. data/test/workbook/worksheet/tc_cfvo.rb +31 -0
  293. data/test/workbook/worksheet/tc_col.rb +78 -0
  294. data/test/workbook/worksheet/tc_color_scale.rb +58 -0
  295. data/test/workbook/worksheet/tc_comment.rb +72 -0
  296. data/test/workbook/worksheet/tc_comments.rb +57 -0
  297. data/test/workbook/worksheet/tc_conditional_formatting.rb +224 -0
  298. data/test/workbook/worksheet/tc_data_bar.rb +46 -0
  299. data/test/workbook/worksheet/tc_data_validation.rb +265 -0
  300. data/test/workbook/worksheet/tc_date_time_converter.rb +124 -0
  301. data/test/workbook/worksheet/tc_header_footer.rb +151 -0
  302. data/test/workbook/worksheet/tc_icon_set.rb +45 -0
  303. data/test/workbook/worksheet/tc_outline_pr.rb +19 -0
  304. data/test/workbook/worksheet/tc_page_margins.rb +97 -0
  305. data/test/workbook/worksheet/tc_page_set_up_pr.rb +15 -0
  306. data/test/workbook/worksheet/tc_page_setup.rb +143 -0
  307. data/test/workbook/worksheet/tc_pane.rb +54 -0
  308. data/test/workbook/worksheet/tc_pivot_table.rb +140 -0
  309. data/test/workbook/worksheet/tc_pivot_table_cache_definition.rb +54 -0
  310. data/test/workbook/worksheet/tc_print_options.rb +72 -0
  311. data/test/workbook/worksheet/tc_protected_range.rb +17 -0
  312. data/test/workbook/worksheet/tc_rich_text.rb +44 -0
  313. data/test/workbook/worksheet/tc_rich_text_run.rb +172 -0
  314. data/test/workbook/worksheet/tc_row.rb +122 -0
  315. data/test/workbook/worksheet/tc_selection.rb +55 -0
  316. data/test/workbook/worksheet/tc_sheet_calc_pr.rb +18 -0
  317. data/test/workbook/worksheet/tc_sheet_format_pr.rb +88 -0
  318. data/test/workbook/worksheet/tc_sheet_pr.rb +49 -0
  319. data/test/workbook/worksheet/tc_sheet_protection.rb +117 -0
  320. data/test/workbook/worksheet/tc_sheet_view.rb +214 -0
  321. data/test/workbook/worksheet/tc_table.rb +68 -0
  322. data/test/workbook/worksheet/tc_table_style_info.rb +53 -0
  323. data/test/workbook/worksheet/tc_worksheet.rb +594 -0
  324. data/test/workbook/worksheet/tc_worksheet_hyperlink.rb +55 -0
  325. metadata +582 -0
@@ -0,0 +1,139 @@
1
+ module Axlsx
2
+ # Pane options for a worksheet.
3
+ #
4
+ # @note The recommended way to manage the pane options is via SheetView#pane
5
+ # @see SheetView#pane
6
+ class Pane
7
+
8
+ include Axlsx::OptionsParser
9
+ include Axlsx::SerializedAttributes
10
+ # Creates a new {Pane} object
11
+ # @option options [Symbol] active_pane Active Pane
12
+ # @option options [Symbol] state Split State
13
+ # @option options [Cell, String] top_left_cell Top Left Visible Cell
14
+ # @option options [Integer] x_split Horizontal Split Position
15
+ # @option options [Integer] y_split Vertical Split Position
16
+ def initialize(options={})
17
+ #defaults
18
+ @active_pane = @state = @top_left_cell = nil
19
+ @x_split = @y_split = 0
20
+ parse_options options
21
+ end
22
+
23
+ serializable_attributes :active_pane, :state, :top_left_cell, :x_split, :y_split
24
+
25
+ # Active Pane
26
+ # The pane that is active.
27
+ # Options are
28
+ # * bottom_left: Bottom left pane, when both vertical and horizontal
29
+ # splits are applied. This value is also used when only
30
+ # a horizontal split has been applied, dividing the pane
31
+ # into upper and lower regions. In that case, this value
32
+ # specifies the bottom pane.
33
+ # * bottom_right: Bottom right pane, when both vertical and horizontal
34
+ # splits are applied.
35
+ # * top_left: Top left pane, when both vertical and horizontal splits
36
+ # are applied. This value is also used when only a horizontal
37
+ # split has been applied, dividing the pane into upper and lower
38
+ # regions. In that case, this value specifies the top pane.
39
+ # This value is also used when only a vertical split has
40
+ # been applied, dividing the pane into right and left
41
+ # regions. In that case, this value specifies the left pane
42
+ # * top_right: Top right pane, when both vertical and horizontal
43
+ # splits are applied. This value is also used when only
44
+ # a vertical split has been applied, dividing the pane
45
+ # into right and left regions. In that case, this value
46
+ # specifies the right pane.
47
+ # @see type
48
+ # @return [Symbol]
49
+ # default nil
50
+ attr_reader :active_pane
51
+
52
+
53
+ # Split State
54
+ # Indicates whether the pane has horizontal / vertical
55
+ # splits, and whether those splits are frozen.
56
+ # Options are
57
+ # * frozen: Panes are frozen, but were not split being frozen. In
58
+ # this state, when the panes are unfrozen again, a single
59
+ # pane results, with no split. In this state, the split
60
+ # bars are not adjustable.
61
+ # * frozen_split: Panes are frozen and were split before being frozen. In
62
+ # this state, when the panes are unfrozen again, the split
63
+ # remains, but is adjustable.
64
+ # * split: Panes are split, but not frozen. In this state, the split
65
+ # bars are adjustable by the user.
66
+ # @see type
67
+ # @return [Symbol]
68
+ # default nil
69
+ attr_reader :state
70
+
71
+ # Top Left Visible Cell
72
+ # Location of the top left visible cell in the bottom
73
+ # right pane (when in Left-To-Right mode).
74
+ # @see type
75
+ # @return [String]
76
+ # default nil
77
+ attr_reader :top_left_cell
78
+
79
+ # Horizontal Split Position
80
+ # Horizontal position of the split, in 1/20th of a point; 0 (zero)
81
+ # if none. If the pane is frozen, this value indicates the number
82
+ # of columns visible in the top pane.
83
+ # @see type
84
+ # @return [Integer]
85
+ # default 0
86
+ attr_reader :x_split
87
+
88
+ # Vertical Split Position
89
+ # Vertical position of the split, in 1/20th of a point; 0 (zero)
90
+ # if none. If the pane is frozen, this value indicates the number
91
+ # of rows visible in the left pane.
92
+ # @see type
93
+ # @return [Integer]
94
+ # default 0
95
+ attr_reader :y_split
96
+
97
+ # @see active_pane
98
+ def active_pane=(v)
99
+ Axlsx::validate_pane_type(v)
100
+ @active_pane = Axlsx::camel(v.to_s, false)
101
+ end
102
+
103
+ # @see state
104
+ def state=(v)
105
+ Axlsx::validate_split_state_type(v)
106
+ @state = Axlsx::camel(v.to_s, false)
107
+ end
108
+
109
+ # @see top_left_cell
110
+ def top_left_cell=(v)
111
+ cell = (v.class == Axlsx::Cell ? v.r_abs : v)
112
+ Axlsx::validate_string(cell)
113
+ @top_left_cell = cell
114
+ end
115
+
116
+ # @see x_split
117
+ def x_split=(v); Axlsx::validate_unsigned_int(v); @x_split = v end
118
+
119
+ # @see y_split
120
+ def y_split=(v); Axlsx::validate_unsigned_int(v); @y_split = v end
121
+
122
+ # Serializes the data validation
123
+ # @param [String] str
124
+ # @return [String]
125
+ def to_xml_string(str = '')
126
+ finalize
127
+ serialized_tag 'pane', str
128
+ end
129
+ private
130
+
131
+ def finalize
132
+ if @state == 'frozen' && @top_left_cell.nil?
133
+ row = @y_split || 0
134
+ column = @x_split || 0
135
+ @top_left_cell = "#{('A'..'ZZ').to_a[column]}#{row+1}"
136
+ end
137
+ end
138
+ end
139
+ end
@@ -0,0 +1,289 @@
1
+ # encoding: UTF-8
2
+ module Axlsx
3
+ # Table
4
+ # @note Worksheet#add_pivot_table is the recommended way to create tables for your worksheets.
5
+ # @see README for examples
6
+ class PivotTable
7
+
8
+ include Axlsx::OptionsParser
9
+
10
+ # Creates a new PivotTable object
11
+ # @param [String] ref The reference to where the pivot table lives like 'G4:L17'.
12
+ # @param [String] range The reference to the pivot table data like 'A1:D31'.
13
+ # @param [Worksheet] sheet The sheet containing the table data.
14
+ # @option options [Cell, String] name
15
+ # @option options [TableStyle] style
16
+ def initialize(ref, range, sheet, options={})
17
+ @ref = ref
18
+ self.range = range
19
+ @sheet = sheet
20
+ @sheet.workbook.pivot_tables << self
21
+ @name = "PivotTable#{index+1}"
22
+ @data_sheet = nil
23
+ @rows = []
24
+ @columns = []
25
+ @data = []
26
+ @pages = []
27
+ @subtotal = nil
28
+ @no_subtotals_on_headers = []
29
+ @style_info = {}
30
+ parse_options options
31
+ yield self if block_given?
32
+ end
33
+
34
+ # Defines the headers in which subtotals are not to be included
35
+ # @return[Array]
36
+ attr_accessor :no_subtotals_on_headers
37
+
38
+ # Style info for the pivot table
39
+ # @return[Hash]
40
+ attr_accessor :style_info
41
+
42
+ # The reference to the table data
43
+ # @return [String]
44
+ attr_reader :ref
45
+
46
+ # The name of the table.
47
+ # @return [String]
48
+ attr_reader :name
49
+
50
+ # The name of the sheet.
51
+ # @return [String]
52
+ attr_reader :sheet
53
+
54
+ # The sheet used as data source for the pivot table
55
+ # @return [Worksheet]
56
+ attr_writer :data_sheet
57
+
58
+ # @see #data_sheet
59
+ def data_sheet
60
+ @data_sheet || @sheet
61
+ end
62
+
63
+ # The range where the data for this pivot table lives.
64
+ # @return [String]
65
+ attr_reader :range
66
+
67
+ # (see #range)
68
+ def range=(v)
69
+ DataTypeValidator.validate "#{self.class}.range", [String], v
70
+ if v.is_a?(String)
71
+ @range = v
72
+ end
73
+ end
74
+
75
+ # The rows
76
+ # @return [Array]
77
+ attr_reader :rows
78
+
79
+
80
+ # (see #rows)
81
+ def rows=(v)
82
+ DataTypeValidator.validate "#{self.class}.rows", [Array], v
83
+ v.each do |ref|
84
+ DataTypeValidator.validate "#{self.class}.rows[]", [String], ref
85
+ end
86
+ @rows = v
87
+ end
88
+
89
+ # The columns
90
+ # @return [Array]
91
+ attr_reader :columns
92
+
93
+ # (see #columns)
94
+ def columns=(v)
95
+ DataTypeValidator.validate "#{self.class}.columns", [Array], v
96
+ v.each do |ref|
97
+ DataTypeValidator.validate "#{self.class}.columns[]", [String], ref
98
+ end
99
+ @columns = v
100
+ end
101
+
102
+ # The data
103
+ # @return [Array]
104
+ attr_reader :data
105
+
106
+ # (see #data)
107
+ def data=(v)
108
+ DataTypeValidator.validate "#{self.class}.data", [Array], v
109
+ @data = []
110
+ v.each do |data_field|
111
+ if data_field.is_a? String
112
+ data_field = {:ref => data_field}
113
+ end
114
+ data_field.values.each do |value|
115
+ DataTypeValidator.validate "#{self.class}.data[]", [String], value
116
+ end
117
+ @data << data_field
118
+ end
119
+ @data
120
+ end
121
+
122
+ # The pages
123
+ # @return [String]
124
+ attr_reader :pages
125
+
126
+ # (see #pages)
127
+ def pages=(v)
128
+ DataTypeValidator.validate "#{self.class}.pages", [Array], v
129
+ v.each do |ref|
130
+ DataTypeValidator.validate "#{self.class}.pages[]", [String], ref
131
+ end
132
+ @pages = v
133
+ end
134
+
135
+ # The index of this chart in the workbooks charts collection
136
+ # @return [Integer]
137
+ def index
138
+ @sheet.workbook.pivot_tables.index(self)
139
+ end
140
+
141
+ # The part name for this table
142
+ # @return [String]
143
+ def pn
144
+ "#{PIVOT_TABLE_PN % (index+1)}"
145
+ end
146
+
147
+ # The relationship part name of this pivot table
148
+ # @return [String]
149
+ def rels_pn
150
+ "#{PIVOT_TABLE_RELS_PN % (index+1)}"
151
+ end
152
+
153
+ # The cache_definition for this pivot table
154
+ # @return [PivotTableCacheDefinition]
155
+ def cache_definition
156
+ @cache_definition ||= PivotTableCacheDefinition.new(self)
157
+ end
158
+
159
+ # The relationships for this pivot table.
160
+ # @return [Relationships]
161
+ def relationships
162
+ r = Relationships.new
163
+ r << Relationship.new(cache_definition, PIVOT_TABLE_CACHE_DEFINITION_R, "../#{cache_definition.pn}")
164
+ r
165
+ end
166
+
167
+ # Serializes the object
168
+ # @param [String] str
169
+ # @return [String]
170
+ def to_xml_string(str = '')
171
+ str << '<?xml version="1.0" encoding="UTF-8"?>'
172
+ str << ('<pivotTableDefinition xmlns="' << XML_NS << '" name="' << name << '" cacheId="' << cache_definition.cache_id.to_s << '" dataOnRows="1" applyNumberFormats="0" applyBorderFormats="0" applyFontFormats="0" applyPatternFormats="0" applyAlignmentFormats="0" applyWidthHeightFormats="1" dataCaption="Data" showMultipleLabel="0" showMemberPropertyTips="0" useAutoFormatting="1" indent="0" compact="0" compactData="0" gridDropZones="1" multipleFieldFilters="0">')
173
+ str << ( '<location firstDataCol="1" firstDataRow="1" firstHeaderRow="1" ref="' << ref << '"/>')
174
+ str << ( '<pivotFields count="' << header_cells_count.to_s << '">')
175
+ header_cell_values.each do |cell_value|
176
+ str << pivot_field_for(cell_value,!no_subtotals_on_headers.include?(cell_value))
177
+ end
178
+ str << '</pivotFields>'
179
+ if rows.empty?
180
+ str << '<rowFields count="1"><field x="-2"/></rowFields>'
181
+ str << '<rowItems count="2"><i><x/></i> <i i="1"><x v="1"/></i></rowItems>'
182
+ else
183
+ str << ('<rowFields count="' << rows.size.to_s << '">')
184
+ rows.each do |row_value|
185
+ str << ('<field x="' << header_index_of(row_value).to_s << '"/>')
186
+ end
187
+ str << '</rowFields>'
188
+ str << ('<rowItems count="' << rows.size.to_s << '">')
189
+ rows.size.times do |i|
190
+ str << '<i/>'
191
+ end
192
+ str << '</rowItems>'
193
+ end
194
+ if columns.empty?
195
+ str << '<colItems count="1"><i/></colItems>'
196
+ else
197
+ str << ('<colFields count="' << columns.size.to_s << '">')
198
+ columns.each do |column_value|
199
+ str << ('<field x="' << header_index_of(column_value).to_s << '"/>')
200
+ end
201
+ str << '</colFields>'
202
+ end
203
+ unless pages.empty?
204
+ str << ('<pageFields count="' << pages.size.to_s << '">')
205
+ pages.each do |page_value|
206
+ str << ('<pageField fld="' << header_index_of(page_value).to_s << '"/>')
207
+ end
208
+ str << '</pageFields>'
209
+ end
210
+ unless data.empty?
211
+ str << "<dataFields count=\"#{data.size}\">"
212
+ data.each do |datum_value|
213
+ # The correct name prefix in ["Sum","Average", etc...]
214
+ str << "<dataField name='#{(datum_value[:subtotal]||'')} of #{datum_value[:ref]}' fld='#{header_index_of(datum_value[:ref])}' baseField='0' baseItem='0'"
215
+ str << " subtotal='#{datum_value[:subtotal]}' " if datum_value[:subtotal]
216
+ str << "/>"
217
+ end
218
+ str << '</dataFields>'
219
+ end
220
+ # custom pivot table style
221
+ unless style_info.empty?
222
+ str << '<pivotTableStyleInfo'
223
+ style_info.each do |k,v|
224
+ str << ' ' << k.to_s << '="' << v.to_s << '"'
225
+ end
226
+ str << ' />'
227
+ end
228
+ str << '</pivotTableDefinition>'
229
+ end
230
+
231
+ # References for header cells
232
+ # @return [Array]
233
+ def header_cell_refs
234
+ Axlsx::range_to_a(header_range).first
235
+ end
236
+
237
+ # The header cells for the pivot table
238
+ # @return [Array]
239
+ def header_cells
240
+ data_sheet[header_range]
241
+ end
242
+
243
+ # The values in the header cells collection
244
+ # @return [Array]
245
+ def header_cell_values
246
+ header_cells.map(&:value)
247
+ end
248
+
249
+ # The number of cells in the header_cells collection
250
+ # @return [Integer]
251
+ def header_cells_count
252
+ header_cells.count
253
+ end
254
+
255
+ # The index of a given value in the header cells
256
+ # @return [Integer]
257
+ def header_index_of(value)
258
+ header_cell_values.index(value)
259
+ end
260
+
261
+ private
262
+
263
+ def pivot_field_for(cell_ref, subtotal=true)
264
+ if rows.include? cell_ref
265
+ if subtotal
266
+ '<pivotField axis="axisRow" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' + '<items count="1"><item t="default"/></items>' + '</pivotField>'
267
+ else
268
+ '<pivotField axis="axisRow" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1" defaultSubtotal="0">' + '</pivotField>'
269
+ end
270
+ elsif columns.include? cell_ref
271
+ '<pivotField axis="axisCol" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' + '<items count="1"><item t="default"/></items>' + '</pivotField>'
272
+ elsif pages.include? cell_ref
273
+ '<pivotField axis="axisPage" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' + '<items count="1"><item t="default"/></items>' + '</pivotField>'
274
+ elsif data_refs.include? cell_ref
275
+ '<pivotField dataField="1" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' + '</pivotField>'
276
+ else
277
+ '<pivotField compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' + '</pivotField>'
278
+ end
279
+ end
280
+
281
+ def data_refs
282
+ data.map { |hash| hash[:ref] }
283
+ end
284
+
285
+ def header_range
286
+ range.gsub(/^(\w+?)(\d+)\:(\w+?)\d+$/, '\1\2:\3\2')
287
+ end
288
+ end
289
+ end
@@ -0,0 +1,66 @@
1
+ # encoding: UTF-8
2
+ module Axlsx
3
+ # Table
4
+ # @note Worksheet#add_pivot_table is the recommended way to create tables for your worksheets.
5
+ # @see README for examples
6
+ class PivotTableCacheDefinition
7
+
8
+ include Axlsx::OptionsParser
9
+
10
+ # Creates a new PivotTable object
11
+ # @param [String] pivot_table The pivot table this cache definition is in
12
+ def initialize(pivot_table)
13
+ @pivot_table = pivot_table
14
+ end
15
+
16
+ # # The reference to the pivot table data
17
+ # # @return [PivotTable]
18
+ attr_reader :pivot_table
19
+
20
+ # The index of this chart in the workbooks charts collection
21
+ # @return [Integer]
22
+ def index
23
+ pivot_table.sheet.workbook.pivot_tables.index(pivot_table)
24
+ end
25
+
26
+ # The part name for this table
27
+ # @return [String]
28
+ def pn
29
+ "#{PIVOT_TABLE_CACHE_DEFINITION_PN % (index+1)}"
30
+ end
31
+
32
+ # The identifier for this cache
33
+ # @return [Integer]
34
+ def cache_id
35
+ index + 1
36
+ end
37
+
38
+ # The relationship id for this pivot table cache definition.
39
+ # @see Relationship#Id
40
+ # @return [String]
41
+ def rId
42
+ pivot_table.relationships.for(self).Id
43
+ end
44
+
45
+ # Serializes the object
46
+ # @param [String] str
47
+ # @return [String]
48
+ def to_xml_string(str = '')
49
+ str << '<?xml version="1.0" encoding="UTF-8"?>'
50
+ str << ('<pivotCacheDefinition xmlns="' << XML_NS << '" xmlns:r="' << XML_NS_R << '" invalid="1" refreshOnLoad="1" recordCount="0">')
51
+ str << '<cacheSource type="worksheet">'
52
+ str << ( '<worksheetSource ref="' << pivot_table.range << '" sheet="' << pivot_table.data_sheet.name << '"/>')
53
+ str << '</cacheSource>'
54
+ str << ( '<cacheFields count="' << pivot_table.header_cells_count.to_s << '">')
55
+ pivot_table.header_cells.each do |cell|
56
+ str << ( '<cacheField name="' << cell.value << '" numFmtId="0">')
57
+ str << '<sharedItems count="0">'
58
+ str << '</sharedItems>'
59
+ str << '</cacheField>'
60
+ end
61
+ str << '</cacheFields>'
62
+ str << '</pivotCacheDefinition>'
63
+ end
64
+
65
+ end
66
+ end