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,72 @@
1
+ # encoding: UTF-8
2
+ module Axlsx
3
+ # CellStyle defines named styles that reference defined formatting records and can be used in your worksheet.
4
+ # @note Using Styles#add_style is the recommended way to manage cell styling.
5
+ # @see Styles#add_style
6
+ class CellStyle
7
+
8
+ include Axlsx::OptionsParser
9
+ include Axlsx::SerializedAttributes
10
+
11
+ # Creats a new CellStyle object
12
+ # @option options [String] name
13
+ # @option options [Integer] xfId
14
+ # @option options [Integer] buildinId
15
+ # @option options [Integer] iLevel
16
+ # @option options [Boolean] hidden
17
+ # @option options [Boolean] customBuiltIn
18
+ def initialize(options={})
19
+ parse_options options
20
+ end
21
+
22
+ serializable_attributes :name, :xfId, :buildinId, :iLevel, :hidden, :customBuilin
23
+
24
+ # The name of this cell style
25
+ # @return [String]
26
+ attr_reader :name
27
+
28
+ # The formatting record id this named style utilizes
29
+ # @return [Integer]
30
+ # @see Axlsx::Xf
31
+ attr_reader :xfId
32
+
33
+ # The buildinId to use when this named style is applied
34
+ # @return [Integer]
35
+ # @see Axlsx::NumFmt
36
+ attr_reader :builtinId
37
+
38
+ # Determines if this formatting is for an outline style, and what level of the outline it is to be applied to.
39
+ # @return [Integer]
40
+ attr_reader :iLevel
41
+
42
+ # Determines if this named style should show in the list of styles when using excel
43
+ # @return [Boolean]
44
+ attr_reader :hidden
45
+
46
+ # Indicates that the build in style reference has been customized.
47
+ # @return [Boolean]
48
+ attr_reader :customBuiltin
49
+
50
+ # @see name
51
+ def name=(v) Axlsx::validate_string v; @name = v end
52
+ # @see xfId
53
+ def xfId=(v) Axlsx::validate_unsigned_int v; @xfId = v end
54
+ # @see builtinId
55
+ def builtinId=(v) Axlsx::validate_unsigned_int v; @builtinId = v end
56
+ # @see iLivel
57
+ def iLevel=(v) Axlsx::validate_unsigned_int v; @iLevel = v end
58
+ # @see hidden
59
+ def hidden=(v) Axlsx::validate_boolean v; @hidden = v end
60
+ # @see customBuiltin
61
+ def customBuiltin=(v) Axlsx::validate_boolean v; @customBuiltin = v end
62
+
63
+ # Serializes the object
64
+ # @param [String] str
65
+ # @return [String]
66
+ def to_xml_string(str = '')
67
+ serialized_tag('cellStyle', str)
68
+ end
69
+
70
+ end
71
+
72
+ end
@@ -0,0 +1,76 @@
1
+ # encoding: UTF-8
2
+ module Axlsx
3
+ # The color class represents a color used for borders, fills an fonts
4
+ class Color
5
+
6
+ include Axlsx::OptionsParser
7
+ include Axlsx::SerializedAttributes
8
+
9
+ # Creates a new Color object
10
+ # @option options [Boolean] auto
11
+ # @option options [String] rgb
12
+ # @option options [Float] tint
13
+ def initialize(options={})
14
+ @rgb = "FF000000"
15
+ parse_options options
16
+ end
17
+
18
+ serializable_attributes :auto, :rgb, :tint
19
+
20
+ # Determines if the color is system color dependant
21
+ # @return [Boolean]
22
+ attr_reader :auto
23
+
24
+ # The color as defined in rgb terms.
25
+ # @note
26
+ # rgb colors need to conform to ST_UnsignedIntHex. That basically means put 'FF' before you color
27
+ # When assigning the rgb value the behavior is much like CSS selectors and can use shorthand versions as follows:
28
+ # If you provide a two character value it will be repeated for each r, g, b assignment
29
+ # If you provide data that is not 2 characters in length, and is less than 8 characters it will be padded with "F"
30
+ # @example
31
+ # Color.new :rgb => "FF000000"
32
+ # => #<Axlsx::Color:0x102106b68 @rgb="FF000000">
33
+ # Color.new :rgb => "0A"
34
+ # => #<Axlsx::Color:0x102106b68 @rgb="FF0A0A0A">
35
+ # Color.new :rgb => "00BB"
36
+ # => #<Axlsx::Color:0x102106b68 @rgb="FFFF00BB">
37
+ # @return [String]
38
+ attr_reader :rgb
39
+
40
+ # no support for theme just yet
41
+ # @return [Integer]
42
+ #attr_reader :theme
43
+
44
+ # The tint value.
45
+ # @note valid values are between -1.0 and 1.0
46
+ # @return [Float]
47
+ attr_reader :tint
48
+
49
+ # @see auto
50
+ def auto=(v) Axlsx::validate_boolean v; @auto = v end
51
+ # @see color
52
+ def rgb=(v)
53
+ Axlsx::validate_string(v)
54
+ v = v.upcase
55
+ v = v * 3 if v.size == 2
56
+ v = v.rjust(8, 'FF')
57
+ raise ArgumentError, "Invalid color rgb value: #{v}." unless v.match(/[0-9A-F]{8}/)
58
+ @rgb = v
59
+ end
60
+ # @see tint
61
+ def tint=(v) Axlsx::validate_float v; @tint = v end
62
+
63
+ # This version does not support themes
64
+ # def theme=(v) Axlsx::validate_unsigned_integer v; @theme = v end
65
+
66
+ # Indexed colors are for backward compatability which I am choosing not to support
67
+ # def indexed=(v) Axlsx::validate_unsigned_integer v; @indexed = v end
68
+
69
+ # Serializes the object
70
+ # @param [String] str
71
+ # @return [String]
72
+ def to_xml_string(str = '', tag_name = 'color')
73
+ serialized_tag('' + tag_name + '', str)
74
+ end
75
+ end
76
+ end
@@ -0,0 +1,79 @@
1
+ # encoding: UTF-8
2
+ module Axlsx
3
+ # The Dxf class defines an incremental formatting record for use in Styles. The recommended way to manage styles for your workbook is with Styles#add_style
4
+ # @see Styles#add_style
5
+ class Dxf
6
+
7
+ include Axlsx::OptionsParser
8
+
9
+ # The order in which the child elements is put in the XML seems to
10
+ # be important for Excel
11
+ CHILD_ELEMENTS = [:font, :numFmt, :fill, :alignment, :border, :protection]
12
+ #does not support extList (ExtensionList)
13
+
14
+ # The cell alignment for this style
15
+ # @return [CellAlignment]
16
+ # @see CellAlignment
17
+ attr_reader :alignment
18
+
19
+ # The cell protection for this style
20
+ # @return [CellProtection]
21
+ # @see CellProtection
22
+ attr_reader :protection
23
+
24
+ # the child NumFmt to be used to this style
25
+ # @return [NumFmt]
26
+ attr_reader :numFmt
27
+
28
+ # the child font to be used for this style
29
+ # @return [Font]
30
+ attr_reader :font
31
+
32
+ # the child fill to be used in this style
33
+ # @return [Fill]
34
+ attr_reader :fill
35
+
36
+ # the border to be used in this style
37
+ # @return [Border]
38
+ attr_reader :border
39
+
40
+ # Creates a new Xf object
41
+ # @option options [Border] border
42
+ # @option options [NumFmt] numFmt
43
+ # @option options [Fill] fill
44
+ # @option options [Font] font
45
+ # @option options [CellAlignment] alignment
46
+ # @option options [CellProtection] protection
47
+ def initialize(options={})
48
+ parse_options options
49
+ end
50
+
51
+ # @see Dxf#alignment
52
+ def alignment=(v) DataTypeValidator.validate "Dxf.alignment", CellAlignment, v; @alignment = v end
53
+ # @see protection
54
+ def protection=(v) DataTypeValidator.validate "Dxf.protection", CellProtection, v; @protection = v end
55
+ # @see numFmt
56
+ def numFmt=(v) DataTypeValidator.validate "Dxf.numFmt", NumFmt, v; @numFmt = v end
57
+ # @see font
58
+ def font=(v) DataTypeValidator.validate "Dxf.font", Font, v; @font = v end
59
+ # @see border
60
+ def border=(v) DataTypeValidator.validate "Dxf.border", Border, v; @border = v end
61
+ # @see fill
62
+ def fill=(v) DataTypeValidator.validate "Dxf.fill", Fill, v; @fill = v end
63
+
64
+ # Serializes the object
65
+ # @param [String] str
66
+ # @return [String]
67
+ def to_xml_string(str = '')
68
+ str << '<dxf>'
69
+ # Dxf elements have no attributes. All of the instance variables
70
+ # are child elements.
71
+ CHILD_ELEMENTS.each do |element|
72
+ self.send(element).to_xml_string(str) if self.send(element)
73
+ end
74
+ str << '</dxf>'
75
+ end
76
+
77
+ end
78
+
79
+ end
@@ -0,0 +1,35 @@
1
+ # encoding: UTF-8
2
+ module Axlsx
3
+ # The Fill is a formatting object that manages the background color, and pattern for cells.
4
+ # @note The recommended way to manage styles in your workbook is to use Styles#add_style.
5
+ # @see Styles#add_style
6
+ # @see PatternFill
7
+ # @see GradientFill
8
+ class Fill
9
+
10
+ # The type of fill
11
+ # @return [PatternFill, GradientFill]
12
+ attr_reader :fill_type
13
+
14
+ # Creates a new Fill object
15
+ # @param [PatternFill, GradientFill] fill_type
16
+ # @raise [ArgumentError] if the fill_type parameter is not a PatternFill or a GradientFill instance
17
+ def initialize(fill_type)
18
+ self.fill_type = fill_type
19
+ end
20
+
21
+ # Serializes the object
22
+ # @param [String] str
23
+ # @return [String]
24
+ def to_xml_string(str = '')
25
+ str << '<fill>'
26
+ @fill_type.to_xml_string(str)
27
+ str << '</fill>'
28
+ end
29
+
30
+ # @see fill_type
31
+ def fill_type=(v) DataTypeValidator.validate "Fill.fill_type", [PatternFill, GradientFill], v; @fill_type = v; end
32
+
33
+
34
+ end
35
+ end
@@ -0,0 +1,148 @@
1
+ # encoding: UTF-8
2
+ module Axlsx
3
+ # The Font class details a font instance for use in styling cells.
4
+ # @note The recommended way to manage fonts, and other styles is Styles#add_style
5
+ # @see Styles#add_style
6
+ class Font
7
+ include Axlsx::OptionsParser
8
+
9
+ # Creates a new Font
10
+ # @option options [String] name
11
+ # @option options [Integer] charset
12
+ # @option options [Integer] family
13
+ # @option options [Integer] family
14
+ # @option options [Boolean] b
15
+ # @option options [Boolean] i
16
+ # @option options [Boolean] u
17
+ # @option options [Boolean] strike
18
+ # @option options [Boolean] outline
19
+ # @option options [Boolean] shadow
20
+ # @option options [Boolean] condense
21
+ # @option options [Boolean] extend
22
+ # @option options [Color] color
23
+ # @option options [Integer] sz
24
+ def initialize(options={})
25
+ parse_options options
26
+ end
27
+
28
+ # The name of the font
29
+ # @return [String]
30
+ attr_reader :name
31
+
32
+ # The charset of the font
33
+ # @return [Integer]
34
+ # @note
35
+ # The following values are defined in the OOXML specification and are OS dependant values
36
+ # 0 ANSI_CHARSET
37
+ # 1 DEFAULT_CHARSET
38
+ # 2 SYMBOL_CHARSET
39
+ # 77 MAC_CHARSET
40
+ # 128 SHIFTJIS_CHARSET
41
+ # 129 HANGUL_CHARSET
42
+ # 130 JOHAB_CHARSET
43
+ # 134 GB2312_CHARSET
44
+ # 136 CHINESEBIG5_CHARSET
45
+ # 161 GREEK_CHARSET
46
+ # 162 TURKISH_CHARSET
47
+ # 163 VIETNAMESE_CHARSET
48
+ # 177 HEBREW_CHARSET
49
+ # 178 ARABIC_CHARSET
50
+ # 186 BALTIC_CHARSET
51
+ # 204 RUSSIAN_CHARSET
52
+ # 222 THAI_CHARSET
53
+ # 238 EASTEUROPE_CHARSET
54
+ # 255 OEM_CHARSET
55
+ attr_reader :charset
56
+
57
+ # The font's family
58
+ # @note
59
+ # The following are defined OOXML specification
60
+ # 0 Not applicable.
61
+ # 1 Roman
62
+ # 2 Swiss
63
+ # 3 Modern
64
+ # 4 Script
65
+ # 5 Decorative
66
+ # 6..14 Reserved for future use
67
+ # @return [Integer]
68
+ attr_reader :family
69
+
70
+ # Indicates if the font should be rendered in *bold*
71
+ # @return [Boolean]
72
+ attr_reader :b
73
+
74
+ # Indicates if the font should be rendered italicized
75
+ # @return [Boolean]
76
+ attr_reader :i
77
+
78
+ # Indicates if the font should be rendered underlined
79
+ # @return [Boolean]
80
+ attr_reader :u
81
+
82
+ # Indicates if the font should be rendered with a strikthrough
83
+ # @return [Boolean]
84
+ attr_reader :strike
85
+
86
+ # Indicates if the font should be rendered with an outline
87
+ # @return [Boolean]
88
+ attr_reader :outline
89
+
90
+ # Indicates if the font should be rendered with a shadow
91
+ # @return [Boolean]
92
+ attr_reader :shadow
93
+
94
+ # Indicates if the font should be condensed
95
+ # @return [Boolean]
96
+ attr_reader :condense
97
+
98
+ # The font's extend property
99
+ # @return [Boolean]
100
+ attr_reader :extend
101
+
102
+ # The color of the font
103
+ # @return [Color]
104
+ attr_reader :color
105
+
106
+ # The size of the font.
107
+ # @return [Integer]
108
+ attr_reader :sz
109
+
110
+ # @see name
111
+ def name=(v) Axlsx::validate_string v; @name = v end
112
+ # @see charset
113
+ def charset=(v) Axlsx::validate_unsigned_int v; @charset = v end
114
+ # @see family
115
+ def family=(v) Axlsx::validate_unsigned_int v; @family = v end
116
+ # @see b
117
+ def b=(v) Axlsx::validate_boolean v; @b = v end
118
+ # @see i
119
+ def i=(v) Axlsx::validate_boolean v; @i = v end
120
+ # @see u
121
+ def u=(v) Axlsx::validate_boolean v; @u = v end
122
+ # @see strike
123
+ def strike=(v) Axlsx::validate_boolean v; @strike = v end
124
+ # @see outline
125
+ def outline=(v) Axlsx::validate_boolean v; @outline = v end
126
+ # @see shadow
127
+ def shadow=(v) Axlsx::validate_boolean v; @shadow = v end
128
+ # @see condense
129
+ def condense=(v) Axlsx::validate_boolean v; @condense = v end
130
+ # @see extend
131
+ def extend=(v) Axlsx::validate_boolean v; @extend = v end
132
+ # @see color
133
+ def color=(v) DataTypeValidator.validate "Font.color", Color, v; @color=v end
134
+ # @see sz
135
+ def sz=(v) Axlsx::validate_unsigned_int v; @sz=v end
136
+
137
+ # Serializes the object
138
+ # @param [String] str
139
+ # @return [String]
140
+ def to_xml_string(str = '')
141
+ str << '<font>'
142
+ instance_values.each do |k, v|
143
+ v.is_a?(Color) ? v.to_xml_string(str) : (str << ('<' << k.to_s << ' val="' << Axlsx.booleanize(v).to_s << '"/>'))
144
+ end
145
+ str << '</font>'
146
+ end
147
+ end
148
+ end
@@ -0,0 +1,103 @@
1
+ # encoding: UTF-8
2
+ module Axlsx
3
+ # A GradientFill defines the color and positioning for gradiant cell fill.
4
+ # @see Open Office XML Part 1 §18.8.24
5
+ class GradientFill
6
+
7
+ include Axlsx::OptionsParser
8
+ include Axlsx::SerializedAttributes
9
+
10
+ # Creates a new GradientFill object
11
+ # @option options [Symbol] type
12
+ # @option options [Float] degree
13
+ # @option options [Float] left
14
+ # @option options [Float] right
15
+ # @option options [Float] top
16
+ # @option options [Float] bottom
17
+ def initialize(options={})
18
+ options[:type] ||= :linear
19
+ parse_options options
20
+ @stop = SimpleTypedList.new GradientStop
21
+ end
22
+
23
+ serializable_attributes :type, :degree, :left, :right, :top, :bottom
24
+
25
+ # The type of gradient.
26
+ # @note
27
+ # valid options are
28
+ # :linear
29
+ # :path
30
+ # @return [Symbol]
31
+ attr_reader :type
32
+
33
+ # Angle of the linear gradient
34
+ # @return [Float]
35
+ attr_reader :degree
36
+
37
+ # Percentage format left
38
+ # @return [Float]
39
+ attr_reader :left
40
+
41
+ # Percentage format right
42
+ # @return [Float]
43
+ attr_reader :right
44
+
45
+ # Percentage format top
46
+ # @return [Float]
47
+ attr_reader :top
48
+
49
+ # Percentage format bottom
50
+ # @return [Float]
51
+ attr_reader :bottom
52
+
53
+ # Collection of stop objects
54
+ # @return [SimpleTypedList]
55
+ attr_reader :stop
56
+
57
+ # @see type
58
+ def type=(v) Axlsx::validate_gradient_type v; @type = v end
59
+
60
+ # @see degree
61
+ def degree=(v) Axlsx::validate_float v; @degree = v end
62
+
63
+ # @see left
64
+ def left=(v)
65
+ validate_format_percentage "GradientFill.left", v
66
+ @left = v
67
+ end
68
+
69
+ # @see right
70
+ def right=(v)
71
+ validate_format_percentage "GradientFill.right", v
72
+ @right = v
73
+ end
74
+
75
+ # @see top
76
+ def top=(v)
77
+ validate_format_percentage "GradientFill.top", v
78
+ @top = v
79
+ end
80
+
81
+ # @see bottom
82
+ def bottom=(v)
83
+ validate_format_percentage "GradientFill.bottom", v
84
+ @bottom = v
85
+ end
86
+
87
+ # validates that the value provided is between 0.0 and 1.0
88
+ def validate_format_percentage(name, value)
89
+ DataTypeValidator.validate name, Float, value, lambda { |arg| arg >= 0.0 && arg <= 1.0}
90
+ end
91
+
92
+ # Serializes the object
93
+ # @param [String] str
94
+ # @return [String]
95
+ def to_xml_string(str = '')
96
+ str << '<gradientFill '
97
+ serialized_attributes str
98
+ str << '>'
99
+ @stop.each { |s| s.to_xml_string(str) }
100
+ str << '</gradientFill>'
101
+ end
102
+ end
103
+ end