rubyXL 3.3.29 → 3.4.33

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (466) hide show
  1. checksums.yaml +5 -5
  2. data/.circleci/config.yml +60 -0
  3. data/.rubocop.yml +124 -0
  4. data/CHANGELOG.md +12 -0
  5. data/Gemfile +11 -8
  6. data/LICENSE.txt +1 -1
  7. data/README.rdoc +57 -19
  8. data/Rakefile +29 -29
  9. data/VERSION +1 -1
  10. data/lib/rubyXL/cell.rb +2 -29
  11. data/lib/rubyXL/convenience_methods/cell.rb +276 -0
  12. data/lib/rubyXL/convenience_methods/color.rb +156 -0
  13. data/lib/rubyXL/convenience_methods/font.rb +63 -0
  14. data/lib/rubyXL/convenience_methods/workbook.rb +137 -0
  15. data/lib/rubyXL/convenience_methods/worksheet.rb +734 -0
  16. data/lib/rubyXL/convenience_methods.rb +5 -1122
  17. data/lib/rubyXL/objects/border.rb +0 -3
  18. data/lib/rubyXL/objects/calculation_chain.rb +2 -2
  19. data/lib/rubyXL/objects/cell_style.rb +4 -6
  20. data/lib/rubyXL/objects/chartsheet.rb +8 -12
  21. data/lib/rubyXL/objects/color.rb +4 -6
  22. data/lib/rubyXL/objects/column_range.rb +16 -15
  23. data/lib/rubyXL/objects/comments.rb +1 -4
  24. data/lib/rubyXL/objects/connection.rb +175 -0
  25. data/lib/rubyXL/objects/container_nodes.rb +1 -5
  26. data/lib/rubyXL/objects/content_types.rb +3 -6
  27. data/lib/rubyXL/objects/data_validation.rb +2 -2
  28. data/lib/rubyXL/objects/document_properties.rb +12 -15
  29. data/lib/rubyXL/objects/extensions.rb +0 -2
  30. data/lib/rubyXL/objects/external_links.rb +38 -8
  31. data/lib/rubyXL/objects/fill.rb +2 -5
  32. data/lib/rubyXL/objects/filters.rb +5 -7
  33. data/lib/rubyXL/objects/font.rb +2 -7
  34. data/lib/rubyXL/objects/formula.rb +3 -5
  35. data/lib/rubyXL/objects/ooxml_object.rb +40 -31
  36. data/lib/rubyXL/objects/query_table.rb +106 -0
  37. data/lib/rubyXL/objects/reference.rb +26 -17
  38. data/lib/rubyXL/objects/relationships.rb +14 -14
  39. data/lib/rubyXL/objects/root.rb +0 -2
  40. data/lib/rubyXL/objects/shared_strings.rb +4 -7
  41. data/lib/rubyXL/objects/sheet_common.rb +1 -3
  42. data/lib/rubyXL/objects/sheet_data.rb +44 -17
  43. data/lib/rubyXL/objects/simple_types.rb +19 -2
  44. data/lib/rubyXL/objects/storage.rb +60 -49
  45. data/lib/rubyXL/objects/stylesheet.rb +9 -17
  46. data/lib/rubyXL/objects/text.rb +6 -8
  47. data/lib/rubyXL/objects/theme.rb +23 -9
  48. data/lib/rubyXL/objects/workbook.rb +144 -36
  49. data/lib/rubyXL/objects/worksheet.rb +48 -34
  50. data/lib/rubyXL/parser.rb +1 -3
  51. data/lib/rubyXL/worksheet.rb +86 -86
  52. data/lib/rubyXL.rb +1 -1
  53. data/rdoc/README_rdoc.html +212 -153
  54. data/rdoc/RubyXL/AExtension.html +33 -69
  55. data/rdoc/RubyXL/AExtensionStorageArea.html +12 -18
  56. data/rdoc/RubyXL/ActiveX.html +26 -52
  57. data/rdoc/RubyXL/ActiveXBinary.html +12 -23
  58. data/rdoc/RubyXL/AdjustHandleList.html +13 -20
  59. data/rdoc/RubyXL/Alignment.html +13 -20
  60. data/rdoc/RubyXL/AlternateContent.html +12 -18
  61. data/rdoc/RubyXL/AlternateUrls.html +99 -0
  62. data/rdoc/RubyXL/Authors.html +13 -20
  63. data/rdoc/RubyXL/AutoFilter.html +13 -20
  64. data/rdoc/RubyXL/AutoFilterColumn.html +13 -20
  65. data/rdoc/RubyXL/BinaryImageFile.html +12 -26
  66. data/rdoc/RubyXL/BodyProperties.html +13 -20
  67. data/rdoc/RubyXL/BooleanNode.html +12 -18
  68. data/rdoc/RubyXL/BooleanValue.html +12 -18
  69. data/rdoc/RubyXL/Border.html +49 -101
  70. data/rdoc/RubyXL/BorderEdge.html +32 -61
  71. data/rdoc/RubyXL/Borders.html +25 -44
  72. data/rdoc/RubyXL/Break.html +13 -20
  73. data/rdoc/RubyXL/BreakList.html +13 -20
  74. data/rdoc/RubyXL/CT_AdjPoint2D.html +13 -20
  75. data/rdoc/RubyXL/CT_AlphaBiLevelEffect.html +13 -20
  76. data/rdoc/RubyXL/CT_AlphaModulateEffect.html +13 -20
  77. data/rdoc/RubyXL/CT_AlphaModulateFixedEffect.html +13 -20
  78. data/rdoc/RubyXL/CT_AlphaOutsetEffect.html +13 -20
  79. data/rdoc/RubyXL/CT_AlphaReplaceEffect.html +13 -20
  80. data/rdoc/RubyXL/CT_Backdrop.html +13 -20
  81. data/rdoc/RubyXL/CT_Bevel.html +13 -20
  82. data/rdoc/RubyXL/CT_BiLevelEffect.html +13 -20
  83. data/rdoc/RubyXL/CT_BlendEffect.html +13 -20
  84. data/rdoc/RubyXL/CT_Blip.html +13 -20
  85. data/rdoc/RubyXL/CT_BlipFillProperties.html +13 -20
  86. data/rdoc/RubyXL/CT_BlurEffect.html +13 -20
  87. data/rdoc/RubyXL/CT_Camera.html +13 -20
  88. data/rdoc/RubyXL/CT_Color.html +13 -20
  89. data/rdoc/RubyXL/CT_ColorChangeEffect.html +13 -20
  90. data/rdoc/RubyXL/CT_ColorMapping.html +13 -20
  91. data/rdoc/RubyXL/CT_ColorScheme.html +13 -20
  92. data/rdoc/RubyXL/CT_ColorSchemeAndMapping.html +13 -20
  93. data/rdoc/RubyXL/CT_ConnectionSite.html +13 -20
  94. data/rdoc/RubyXL/CT_ConnectionSiteList.html +13 -20
  95. data/rdoc/RubyXL/CT_DashStop.html +13 -20
  96. data/rdoc/RubyXL/CT_DashStopList.html +13 -20
  97. data/rdoc/RubyXL/CT_DefaultShapeDefinition.html +13 -20
  98. data/rdoc/RubyXL/CT_DuotoneEffect.html +13 -20
  99. data/rdoc/RubyXL/CT_EffectContainer.html +13 -20
  100. data/rdoc/RubyXL/CT_EffectList.html +13 -20
  101. data/rdoc/RubyXL/CT_EffectReference.html +13 -20
  102. data/rdoc/RubyXL/CT_EffectStyleItem.html +13 -20
  103. data/rdoc/RubyXL/CT_EffectStyleList.html +13 -20
  104. data/rdoc/RubyXL/CT_EmbeddedWAVAudioFile.html +13 -20
  105. data/rdoc/RubyXL/CT_FillEffect.html +13 -20
  106. data/rdoc/RubyXL/CT_FillOverlayEffect.html +13 -20
  107. data/rdoc/RubyXL/CT_FillStyleList.html +13 -20
  108. data/rdoc/RubyXL/CT_FlatText.html +13 -20
  109. data/rdoc/RubyXL/CT_FontCollection.html +13 -20
  110. data/rdoc/RubyXL/CT_FontReference.html +13 -20
  111. data/rdoc/RubyXL/CT_GeomGuideList.html +13 -20
  112. data/rdoc/RubyXL/CT_GlowEffect.html +13 -20
  113. data/rdoc/RubyXL/CT_GradientFillProperties.html +13 -20
  114. data/rdoc/RubyXL/CT_GradientStop.html +13 -20
  115. data/rdoc/RubyXL/CT_GradientStopList.html +13 -20
  116. data/rdoc/RubyXL/CT_HSLEffect.html +13 -20
  117. data/rdoc/RubyXL/CT_HslColor.html +13 -20
  118. data/rdoc/RubyXL/CT_Hyperlink.html +13 -20
  119. data/rdoc/RubyXL/CT_InnerShadowEffect.html +13 -20
  120. data/rdoc/RubyXL/CT_LightRig.html +13 -20
  121. data/rdoc/RubyXL/CT_LineEndProperties.html +13 -20
  122. data/rdoc/RubyXL/CT_LineJoinMiterProperties.html +13 -20
  123. data/rdoc/RubyXL/CT_LineProperties.html +13 -20
  124. data/rdoc/RubyXL/CT_LineStyleList.html +13 -20
  125. data/rdoc/RubyXL/CT_LinearShadeProperties.html +13 -20
  126. data/rdoc/RubyXL/CT_LuminanceEffect.html +13 -20
  127. data/rdoc/RubyXL/CT_ObjectStyleDefaults.html +13 -20
  128. data/rdoc/RubyXL/CT_OuterShadowEffect.html +13 -20
  129. data/rdoc/RubyXL/CT_Path2D.html +13 -20
  130. data/rdoc/RubyXL/CT_Path2DArcTo.html +13 -20
  131. data/rdoc/RubyXL/CT_Path2DCubicBezierTo.html +13 -20
  132. data/rdoc/RubyXL/CT_Path2DList.html +13 -20
  133. data/rdoc/RubyXL/CT_Path2DQuadBezierTo.html +13 -20
  134. data/rdoc/RubyXL/CT_Path2DTo.html +13 -20
  135. data/rdoc/RubyXL/CT_PathShadeProperties.html +13 -20
  136. data/rdoc/RubyXL/CT_PatternFillProperties.html +13 -20
  137. data/rdoc/RubyXL/CT_Point3D.html +13 -20
  138. data/rdoc/RubyXL/CT_PolarAdjustHandle.html +13 -20
  139. data/rdoc/RubyXL/CT_PresetColor.html +13 -20
  140. data/rdoc/RubyXL/CT_PresetLineDashProperties.html +13 -20
  141. data/rdoc/RubyXL/CT_PresetShadowEffect.html +13 -20
  142. data/rdoc/RubyXL/CT_PresetTextShape.html +13 -20
  143. data/rdoc/RubyXL/CT_ReflectionEffect.html +13 -20
  144. data/rdoc/RubyXL/CT_RelativeOffsetEffect.html +13 -20
  145. data/rdoc/RubyXL/CT_RelativeRect.html +13 -20
  146. data/rdoc/RubyXL/CT_SRgbColor.html +13 -20
  147. data/rdoc/RubyXL/CT_ScRgbColor.html +13 -20
  148. data/rdoc/RubyXL/CT_Scene3D.html +13 -20
  149. data/rdoc/RubyXL/CT_SchemeColor.html +13 -20
  150. data/rdoc/RubyXL/CT_Shape3D.html +13 -20
  151. data/rdoc/RubyXL/CT_ShapeStyle.html +13 -20
  152. data/rdoc/RubyXL/CT_SoftEdgesEffect.html +13 -20
  153. data/rdoc/RubyXL/CT_SphereCoords.html +13 -20
  154. data/rdoc/RubyXL/CT_StretchInfoProperties.html +13 -20
  155. data/rdoc/RubyXL/CT_StyleMatrix.html +13 -20
  156. data/rdoc/RubyXL/CT_StyleMatrixReference.html +13 -20
  157. data/rdoc/RubyXL/CT_SupplementalFont.html +13 -20
  158. data/rdoc/RubyXL/CT_SystemColor.html +13 -20
  159. data/rdoc/RubyXL/CT_TextAutonumberBullet.html +13 -20
  160. data/rdoc/RubyXL/CT_TextBlipBullet.html +13 -20
  161. data/rdoc/RubyXL/CT_TextCharBullet.html +13 -20
  162. data/rdoc/RubyXL/CT_TextCharacterProperties.html +13 -20
  163. data/rdoc/RubyXL/CT_TextFont.html +13 -20
  164. data/rdoc/RubyXL/CT_TextListStyle.html +13 -20
  165. data/rdoc/RubyXL/CT_TextNormalAutofit.html +13 -20
  166. data/rdoc/RubyXL/CT_TextParagraphProperties.html +13 -20
  167. data/rdoc/RubyXL/CT_TextSpacing.html +13 -20
  168. data/rdoc/RubyXL/CT_TextTabStop.html +13 -20
  169. data/rdoc/RubyXL/CT_TextTabStopList.html +13 -20
  170. data/rdoc/RubyXL/CT_TileInfoProperties.html +13 -20
  171. data/rdoc/RubyXL/CT_TintEffect.html +13 -20
  172. data/rdoc/RubyXL/CT_Transform2D.html +13 -20
  173. data/rdoc/RubyXL/CT_TransformEffect.html +13 -20
  174. data/rdoc/RubyXL/CT_Vector3D.html +13 -20
  175. data/rdoc/RubyXL/CT_XYAdjustHandle.html +13 -20
  176. data/rdoc/RubyXL/CalculationChain.html +23 -50
  177. data/rdoc/RubyXL/CalculationChainCell.html +13 -20
  178. data/rdoc/RubyXL/CalculationProperties.html +13 -20
  179. data/rdoc/RubyXL/Cell.html +210 -258
  180. data/rdoc/RubyXL/CellConvenienceMethods.html +438 -572
  181. data/rdoc/RubyXL/CellExt.html +13 -20
  182. data/rdoc/RubyXL/CellSmartTag.html +13 -20
  183. data/rdoc/RubyXL/CellSmartTagProperty.html +13 -20
  184. data/rdoc/RubyXL/CellSmartTags.html +13 -20
  185. data/rdoc/RubyXL/CellStyle.html +13 -20
  186. data/rdoc/RubyXL/CellStyleXFs.html +25 -44
  187. data/rdoc/RubyXL/CellStyles.html +25 -44
  188. data/rdoc/RubyXL/CellValue.html +24 -43
  189. data/rdoc/RubyXL/CellWatch.html +13 -20
  190. data/rdoc/RubyXL/CellWatches.html +13 -20
  191. data/rdoc/RubyXL/CellXFs.html +26 -48
  192. data/rdoc/RubyXL/ChartColorsFile.html +12 -26
  193. data/rdoc/RubyXL/ChartFile.html +25 -54
  194. data/rdoc/RubyXL/ChartStyleFile.html +12 -26
  195. data/rdoc/RubyXL/ChartUserShapesFile.html +12 -26
  196. data/rdoc/RubyXL/Chartsheet.html +26 -73
  197. data/rdoc/RubyXL/ChartsheetPageSetup.html +13 -20
  198. data/rdoc/RubyXL/ChartsheetProperties.html +13 -20
  199. data/rdoc/RubyXL/ChartsheetProtection.html +13 -20
  200. data/rdoc/RubyXL/ChartsheetView.html +13 -20
  201. data/rdoc/RubyXL/ChartsheetViews.html +13 -20
  202. data/rdoc/RubyXL/Color.html +24 -48
  203. data/rdoc/RubyXL/ColorConvenienceClasses/HlsColor.html +246 -0
  204. data/rdoc/RubyXL/ColorConvenienceClasses/RgbColor.html +285 -0
  205. data/rdoc/RubyXL/ColorConvenienceClasses.html +91 -0
  206. data/rdoc/RubyXL/ColorConvenienceMethods.html +139 -0
  207. data/rdoc/RubyXL/ColorFilter.html +13 -20
  208. data/rdoc/RubyXL/ColorScale.html +13 -20
  209. data/rdoc/RubyXL/ColorSet.html +13 -20
  210. data/rdoc/RubyXL/Colors.html +13 -20
  211. data/rdoc/RubyXL/ColumnRange.html +76 -91
  212. data/rdoc/RubyXL/ColumnRanges.html +54 -106
  213. data/rdoc/RubyXL/Comment.html +13 -20
  214. data/rdoc/RubyXL/CommentList.html +13 -20
  215. data/rdoc/RubyXL/CommentsFile.html +24 -56
  216. data/rdoc/RubyXL/ConditionalFormatValue.html +13 -20
  217. data/rdoc/RubyXL/ConditionalFormatting.html +13 -20
  218. data/rdoc/RubyXL/ConditionalFormattingRule.html +13 -20
  219. data/rdoc/RubyXL/Connection.html +99 -0
  220. data/rdoc/RubyXL/ConnectionTable.html +99 -0
  221. data/rdoc/RubyXL/ConnectionTables.html +99 -0
  222. data/rdoc/RubyXL/ConnectionTextField.html +99 -0
  223. data/rdoc/RubyXL/ConnectionTextFields.html +99 -0
  224. data/rdoc/RubyXL/Connections.html +149 -0
  225. data/rdoc/RubyXL/ContentTypeDefault.html +12 -18
  226. data/rdoc/RubyXL/ContentTypeOverride.html +12 -18
  227. data/rdoc/RubyXL/ContentTypes.html +35 -72
  228. data/rdoc/RubyXL/ControlPropertiesFile.html +14 -23
  229. data/rdoc/RubyXL/CorePropertiesFile.html +89 -208
  230. data/rdoc/RubyXL/CustomColor.html +13 -20
  231. data/rdoc/RubyXL/CustomColorList.html +13 -20
  232. data/rdoc/RubyXL/CustomFilter.html +13 -20
  233. data/rdoc/RubyXL/CustomFilters.html +13 -20
  234. data/rdoc/RubyXL/CustomGeometry.html +13 -20
  235. data/rdoc/RubyXL/CustomProperties.html +13 -20
  236. data/rdoc/RubyXL/CustomPropertiesFile.html +12 -26
  237. data/rdoc/RubyXL/CustomProperty.html +13 -20
  238. data/rdoc/RubyXL/CustomPropertyFile.html +108 -0
  239. data/rdoc/RubyXL/CustomSheetView.html +13 -20
  240. data/rdoc/RubyXL/CustomSheetViews.html +13 -20
  241. data/rdoc/RubyXL/CustomWorkbookView.html +13 -20
  242. data/rdoc/RubyXL/CustomWorkbookViews.html +13 -20
  243. data/rdoc/RubyXL/CustomXMLFile.html +12 -23
  244. data/rdoc/RubyXL/DXF.html +13 -20
  245. data/rdoc/RubyXL/DXFs.html +13 -20
  246. data/rdoc/RubyXL/DataBar.html +13 -20
  247. data/rdoc/RubyXL/DataConsolidate.html +13 -20
  248. data/rdoc/RubyXL/DataConsolidationReference.html +13 -20
  249. data/rdoc/RubyXL/DataConsolidationReferences.html +13 -20
  250. data/rdoc/RubyXL/DataType.html +11 -40
  251. data/rdoc/RubyXL/DataValidation.html +13 -20
  252. data/rdoc/RubyXL/DataValidations.html +13 -20
  253. data/rdoc/RubyXL/DateGroupItem.html +13 -20
  254. data/rdoc/RubyXL/DefinedName.html +13 -20
  255. data/rdoc/RubyXL/DefinedNameExt.html +13 -20
  256. data/rdoc/RubyXL/DefinedNames.html +13 -20
  257. data/rdoc/RubyXL/DefinedNamesExt.html +13 -20
  258. data/rdoc/RubyXL/DocumentPropertiesFile.html +34 -76
  259. data/rdoc/RubyXL/DrawingFile.html +25 -54
  260. data/rdoc/RubyXL/DynamicFilter.html +13 -20
  261. data/rdoc/RubyXL/EmbeddedControl.html +13 -20
  262. data/rdoc/RubyXL/EmbeddedControls.html +13 -20
  263. data/rdoc/RubyXL/Extension.html +13 -20
  264. data/rdoc/RubyXL/ExtensionStorageArea.html +13 -20
  265. data/rdoc/RubyXL/Extents.html +13 -20
  266. data/rdoc/RubyXL/ExternalBook.html +13 -20
  267. data/rdoc/RubyXL/ExternalLinksFile.html +25 -54
  268. data/rdoc/RubyXL/ExternalReference.html +13 -20
  269. data/rdoc/RubyXL/ExternalReferences.html +13 -20
  270. data/rdoc/RubyXL/ExtraColorSchemeList.html +13 -20
  271. data/rdoc/RubyXL/FieldItem.html +13 -20
  272. data/rdoc/RubyXL/FileRecoveryProperties.html +13 -20
  273. data/rdoc/RubyXL/FileSharing.html +13 -20
  274. data/rdoc/RubyXL/FileVersion.html +13 -20
  275. data/rdoc/RubyXL/Fill.html +25 -44
  276. data/rdoc/RubyXL/Fills.html +25 -44
  277. data/rdoc/RubyXL/FilterContainer.html +13 -20
  278. data/rdoc/RubyXL/FloatNode.html +12 -18
  279. data/rdoc/RubyXL/FloatValue.html +12 -18
  280. data/rdoc/RubyXL/Font.html +28 -64
  281. data/rdoc/RubyXL/FontConvenienceMethods.html +133 -294
  282. data/rdoc/RubyXL/FontScheme.html +13 -20
  283. data/rdoc/RubyXL/Fonts.html +25 -44
  284. data/rdoc/RubyXL/Formula.html +13 -20
  285. data/rdoc/RubyXL/FunctionGroup.html +13 -20
  286. data/rdoc/RubyXL/FunctionGroups.html +13 -20
  287. data/rdoc/RubyXL/GenericStorageObject.html +41 -98
  288. data/rdoc/RubyXL/GradientFill.html +13 -20
  289. data/rdoc/RubyXL/HeaderFooterSettings.html +13 -20
  290. data/rdoc/RubyXL/Hyperlink.html +13 -20
  291. data/rdoc/RubyXL/HyperlinkRelFile.html +12 -23
  292. data/rdoc/RubyXL/Hyperlinks.html +13 -20
  293. data/rdoc/RubyXL/IconFilter.html +13 -20
  294. data/rdoc/RubyXL/IconSet.html +13 -20
  295. data/rdoc/RubyXL/IgnoredError.html +13 -20
  296. data/rdoc/RubyXL/IgnoredErrors.html +13 -20
  297. data/rdoc/RubyXL/IndexedColors.html +13 -20
  298. data/rdoc/RubyXL/InputCells.html +13 -20
  299. data/rdoc/RubyXL/IntegerNode.html +12 -18
  300. data/rdoc/RubyXL/IntegerValue.html +12 -18
  301. data/rdoc/RubyXL/LegacyCell.html +20 -71
  302. data/rdoc/RubyXL/LegacyWorksheet.html +77 -126
  303. data/rdoc/RubyXL/MRUColors.html +13 -20
  304. data/rdoc/RubyXL/MacrosFile.html +12 -26
  305. data/rdoc/RubyXL/MergedCell.html +13 -20
  306. data/rdoc/RubyXL/MergedCells.html +13 -20
  307. data/rdoc/RubyXL/NumFmt.html +13 -20
  308. data/rdoc/RubyXL/NumberFormat.html +25 -44
  309. data/rdoc/RubyXL/NumberFormats.html +25 -50
  310. data/rdoc/RubyXL/OLEObject.html +13 -20
  311. data/rdoc/RubyXL/OLEObjectFile.html +12 -26
  312. data/rdoc/RubyXL/OLEObjects.html +13 -20
  313. data/rdoc/RubyXL/OLESize.html +13 -20
  314. data/rdoc/RubyXL/OOXMLContainerObject.html +72 -157
  315. data/rdoc/RubyXL/OOXMLIgnored.html +32 -62
  316. data/rdoc/RubyXL/OOXMLObject.html +15 -26
  317. data/rdoc/RubyXL/OOXMLObjectClassMethods.html +126 -203
  318. data/rdoc/RubyXL/OOXMLObjectInstanceMethods.html +104 -226
  319. data/rdoc/RubyXL/OOXMLRelationshipsFile.html +109 -242
  320. data/rdoc/RubyXL/OOXMLTopLevelObject.html +67 -154
  321. data/rdoc/RubyXL/OdbcOleDbProperties.html +99 -0
  322. data/rdoc/RubyXL/Offset.html +13 -20
  323. data/rdoc/RubyXL/OlapProperties.html +99 -0
  324. data/rdoc/RubyXL/OleItem.html +99 -0
  325. data/rdoc/RubyXL/OleItems.html +99 -0
  326. data/rdoc/RubyXL/OleLink.html +99 -0
  327. data/rdoc/RubyXL/OutlineProperties.html +13 -20
  328. data/rdoc/RubyXL/PageMargins.html +13 -20
  329. data/rdoc/RubyXL/PageSetup.html +13 -20
  330. data/rdoc/RubyXL/PageSetupProperties.html +13 -20
  331. data/rdoc/RubyXL/Pane.html +13 -20
  332. data/rdoc/RubyXL/Parser.html +35 -65
  333. data/rdoc/RubyXL/PatternFill.html +13 -20
  334. data/rdoc/RubyXL/PersonMetadata.html +108 -0
  335. data/rdoc/RubyXL/PhoneticProperties.html +13 -20
  336. data/rdoc/RubyXL/PhoneticRun.html +13 -20
  337. data/rdoc/RubyXL/PivotArea.html +13 -20
  338. data/rdoc/RubyXL/PivotCache.html +13 -20
  339. data/rdoc/RubyXL/PivotCacheDefinitionFile.html +14 -31
  340. data/rdoc/RubyXL/PivotCacheRecordsFile.html +12 -26
  341. data/rdoc/RubyXL/PivotCaches.html +13 -20
  342. data/rdoc/RubyXL/PivotReference.html +13 -20
  343. data/rdoc/RubyXL/PivotReferences.html +13 -20
  344. data/rdoc/RubyXL/PivotTableFile.html +14 -31
  345. data/rdoc/RubyXL/PivotTableSelection.html +13 -20
  346. data/rdoc/RubyXL/PresetGeometry.html +13 -20
  347. data/rdoc/RubyXL/PrintOptions.html +13 -20
  348. data/rdoc/RubyXL/PrinterSettingsFile.html +12 -26
  349. data/rdoc/RubyXL/ProtectedRange.html +13 -20
  350. data/rdoc/RubyXL/ProtectedRanges.html +13 -20
  351. data/rdoc/RubyXL/Protection.html +13 -20
  352. data/rdoc/RubyXL/QueryParameter.html +99 -0
  353. data/rdoc/RubyXL/QueryParameters.html +99 -0
  354. data/rdoc/RubyXL/QueryTable.html +157 -0
  355. data/rdoc/RubyXL/QueryTableDeletedField.html +99 -0
  356. data/rdoc/RubyXL/QueryTableDeletedFields.html +99 -0
  357. data/rdoc/RubyXL/QueryTableField.html +99 -0
  358. data/rdoc/RubyXL/QueryTableFields.html +99 -0
  359. data/rdoc/RubyXL/QueryTableRefresh.html +99 -0
  360. data/rdoc/RubyXL/RID.html +12 -18
  361. data/rdoc/RubyXL/RawOOXML.html +33 -69
  362. data/rdoc/RubyXL/Reference.html +156 -286
  363. data/rdoc/RubyXL/Relationship.html +12 -18
  364. data/rdoc/RubyXL/RelationshipSupport/ClassMehods.html +20 -37
  365. data/rdoc/RubyXL/RelationshipSupport.html +62 -145
  366. data/rdoc/RubyXL/RevisionPointer.html +13 -23
  367. data/rdoc/RubyXL/RichText.html +27 -45
  368. data/rdoc/RubyXL/RichTextRun.html +24 -43
  369. data/rdoc/RubyXL/Row.html +88 -205
  370. data/rdoc/RubyXL/RowExt.html +13 -20
  371. data/rdoc/RubyXL/RunProperties.html +13 -20
  372. data/rdoc/RubyXL/Scenario.html +13 -20
  373. data/rdoc/RubyXL/Scenarios.html +13 -20
  374. data/rdoc/RubyXL/Selection.html +23 -42
  375. data/rdoc/RubyXL/ShapeGuide.html +13 -20
  376. data/rdoc/RubyXL/ShapeTextRectangle.html +13 -20
  377. data/rdoc/RubyXL/SharedStringsTable.html +81 -177
  378. data/rdoc/RubyXL/Sheet.html +13 -20
  379. data/rdoc/RubyXL/SheetCalculationProperties.html +13 -20
  380. data/rdoc/RubyXL/SheetData.html +32 -62
  381. data/rdoc/RubyXL/SheetDataExt.html +13 -20
  382. data/rdoc/RubyXL/SheetDataSet.html +13 -20
  383. data/rdoc/RubyXL/SheetMetadata.html +108 -0
  384. data/rdoc/RubyXL/SheetName.html +13 -20
  385. data/rdoc/RubyXL/SheetNames.html +13 -20
  386. data/rdoc/RubyXL/Sheets.html +13 -20
  387. data/rdoc/RubyXL/SlicerCacheFile.html +12 -26
  388. data/rdoc/RubyXL/SlicerFile.html +12 -26
  389. data/rdoc/RubyXL/SmartTagProperties.html +13 -20
  390. data/rdoc/RubyXL/SmartTagType.html +13 -20
  391. data/rdoc/RubyXL/SmartTagTypes.html +13 -20
  392. data/rdoc/RubyXL/SmartTags.html +13 -20
  393. data/rdoc/RubyXL/SortCondition.html +13 -20
  394. data/rdoc/RubyXL/SortState.html +13 -20
  395. data/rdoc/RubyXL/Sqref.html +33 -63
  396. data/rdoc/RubyXL/Stop.html +13 -20
  397. data/rdoc/RubyXL/StringNode.html +12 -18
  398. data/rdoc/RubyXL/StringNodeW3C.html +33 -63
  399. data/rdoc/RubyXL/StringValue.html +12 -18
  400. data/rdoc/RubyXL/Stylesheet.html +65 -138
  401. data/rdoc/RubyXL/TableFile.html +12 -26
  402. data/rdoc/RubyXL/TableParts.html +12 -18
  403. data/rdoc/RubyXL/TableStyle.html +13 -20
  404. data/rdoc/RubyXL/TableStyles.html +13 -20
  405. data/rdoc/RubyXL/Text.html +35 -76
  406. data/rdoc/RubyXL/TextImportSettings.html +99 -0
  407. data/rdoc/RubyXL/Theme.html +72 -72
  408. data/rdoc/RubyXL/ThemeElements.html +13 -20
  409. data/rdoc/RubyXL/ThumbnailFile.html +12 -26
  410. data/rdoc/RubyXL/Top10.html +13 -20
  411. data/rdoc/RubyXL/VMLDrawingFile.html +15 -33
  412. data/rdoc/RubyXL/Variant.html +13 -20
  413. data/rdoc/RubyXL/Vector.html +24 -43
  414. data/rdoc/RubyXL/VectorValue.html +12 -18
  415. data/rdoc/RubyXL/VisualProperties.html +13 -20
  416. data/rdoc/RubyXL/WebPublishObject.html +13 -20
  417. data/rdoc/RubyXL/WebPublishObjects.html +13 -20
  418. data/rdoc/RubyXL/WebPublishingItem.html +13 -20
  419. data/rdoc/RubyXL/WebPublishingItems.html +13 -20
  420. data/rdoc/RubyXL/WebPublishingProperties.html +13 -20
  421. data/rdoc/RubyXL/WebQueryProperties.html +99 -0
  422. data/rdoc/RubyXL/Workbook.html +581 -266
  423. data/rdoc/RubyXL/WorkbookConvenienceMethods.html +226 -951
  424. data/rdoc/RubyXL/WorkbookProperties.html +13 -20
  425. data/rdoc/RubyXL/WorkbookProtection.html +13 -20
  426. data/rdoc/RubyXL/WorkbookRoot.html +58 -135
  427. data/rdoc/RubyXL/WorkbookView.html +13 -20
  428. data/rdoc/RubyXL/WorkbookViews.html +13 -20
  429. data/rdoc/RubyXL/Worksheet.html +122 -137
  430. data/rdoc/RubyXL/WorksheetConvenienceMethods.html +717 -1373
  431. data/rdoc/RubyXL/WorksheetDimensions.html +13 -20
  432. data/rdoc/RubyXL/WorksheetFormatProperties.html +12 -18
  433. data/rdoc/RubyXL/WorksheetProperties.html +13 -20
  434. data/rdoc/RubyXL/WorksheetProtection.html +13 -20
  435. data/rdoc/RubyXL/WorksheetView.html +13 -20
  436. data/rdoc/RubyXL/WorksheetViews.html +13 -20
  437. data/rdoc/RubyXL/XF.html +13 -20
  438. data/rdoc/RubyXL.html +46 -306
  439. data/rdoc/created.rid +45 -38
  440. data/rdoc/css/rdoc.css +109 -12
  441. data/rdoc/fonts/SourceCodePro-Bold.ttf +0 -0
  442. data/rdoc/fonts/SourceCodePro-Regular.ttf +0 -0
  443. data/rdoc/index.html +403 -726
  444. data/rdoc/js/darkfish.js +33 -97
  445. data/rdoc/js/navigation.js +12 -49
  446. data/rdoc/js/navigation.js.gz +0 -0
  447. data/rdoc/js/search.js +35 -34
  448. data/rdoc/js/search_index.js +1 -1
  449. data/rdoc/js/search_index.js.gz +0 -0
  450. data/rdoc/js/searcher.js +6 -6
  451. data/rdoc/js/searcher.js.gz +0 -0
  452. data/rdoc/table_of_contents.html +287 -45
  453. data/rubyXL.gemspec +77 -43
  454. data/spec/lib/cell_spec.rb +119 -6
  455. data/spec/lib/color_spec.rb +9 -1
  456. data/spec/lib/parser_spec.rb +28 -28
  457. data/spec/lib/reference_spec.rb +41 -5
  458. data/spec/lib/rgb_color_spec.rb +29 -0
  459. data/spec/lib/stylesheet_spec.rb +10 -11
  460. data/spec/lib/text_spec.rb +4 -6
  461. data/spec/lib/workbook_spec.rb +31 -8
  462. data/spec/lib/worksheet_spec.rb +886 -480
  463. data/spec/spec_helper.rb +2 -0
  464. data/test/test_parse_write.rb +15 -15
  465. metadata +76 -10
  466. data/rdoc/js/jquery.js +0 -4
@@ -4,21 +4,23 @@
4
4
  <head>
5
5
  <meta charset="UTF-8">
6
6
 
7
- <title>class RubyXL::Workbook - rubyXL 3.3.29</title>
7
+ <title>class RubyXL::Workbook - rubyXL 3.4.33</title>
8
8
 
9
9
  <script type="text/javascript">
10
10
  var rdoc_rel_prefix = "../";
11
11
  var index_rel_prefix = "../";
12
12
  </script>
13
13
 
14
- <script src="../js/jquery.js"></script>
15
- <script src="../js/darkfish.js"></script>
14
+ <script src="../js/navigation.js" defer></script>
15
+ <script src="../js/search.js" defer></script>
16
+ <script src="../js/search_index.js" defer></script>
17
+ <script src="../js/searcher.js" defer></script>
18
+ <script src="../js/darkfish.js" defer></script>
16
19
 
17
20
  <link href="../css/fonts.css" rel="stylesheet">
18
21
  <link href="../css/rdoc.css" rel="stylesheet">
19
22
 
20
23
 
21
-
22
24
  <body id="top" role="document" class="class">
23
25
  <nav role="navigation">
24
26
  <div id="project-navigation">
@@ -39,7 +41,7 @@
39
41
  <div id="search-field-wrapper">
40
42
  <input id="search-field" role="combobox" aria-label="Search"
41
43
  aria-autocomplete="list" aria-controls="search-results"
42
- type="text" name="search" placeholder="Search" spellcheck="false"
44
+ type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
43
45
  title="Type to search, Up and Down to navigate, Enter to load">
44
46
  </div>
45
47
 
@@ -55,61 +57,58 @@
55
57
 
56
58
  <div id="class-metadata">
57
59
 
58
- <div id="parent-class-section" class="nav-section">
60
+
61
+ <div id="parent-class-section" class="nav-section">
59
62
  <h3>Parent</h3>
60
63
 
61
-
62
64
  <p class="link"><a href="OOXMLTopLevelObject.html">RubyXL::OOXMLTopLevelObject</a>
63
-
64
65
  </div>
65
66
 
66
- <div id="includes-section" class="nav-section">
67
+
68
+ <div id="includes-section" class="nav-section">
67
69
  <h3>Included Modules</h3>
68
70
 
69
71
  <ul class="link-list">
70
-
71
-
72
72
  <li><a class="include" href="RelationshipSupport.html">RubyXL::RelationshipSupport</a>
73
-
74
-
75
-
76
73
  <li><span class="include">Enumerable</span>
77
-
78
-
79
-
80
- <li><a class="include" href="WorkbookConvenienceMethods.html">RubyXL::WorkbookConvenienceMethods</a>
81
-
82
-
83
74
  </ul>
84
75
  </div>
85
76
 
86
77
 
87
- <!-- Method Quickref -->
78
+
79
+ <!-- Method Quickref -->
88
80
  <div id="method-list-section" class="nav-section">
89
81
  <h3>Methods</h3>
90
82
 
91
83
  <ul class="link-list" role="directory">
92
-
93
84
  <li class="calls-super" ><a href="#method-c-new">::new</a>
94
-
85
+ <li ><a href="#method-i-5B-5D">#[]</a>
86
+ <li ><a href="#method-i-add_worksheet">#add_worksheet</a>
87
+ <li ><a href="#method-i-application">#application</a>
88
+ <li ><a href="#method-i-application-3D">#application=</a>
89
+ <li ><a href="#method-i-appversion">#appversion</a>
90
+ <li ><a href="#method-i-appversion-3D">#appversion=</a>
95
91
  <li ><a href="#method-i-before_write_xml">#before_write_xml</a>
96
-
92
+ <li ><a href="#method-i-company">#company</a>
93
+ <li ><a href="#method-i-company-3D">#company=</a>
97
94
  <li ><a href="#method-i-content_type">#content_type</a>
98
-
95
+ <li ><a href="#method-i-created_at">#created_at</a>
96
+ <li ><a href="#method-i-created_at-3D">#created_at=</a>
97
+ <li ><a href="#method-i-creator">#creator</a>
98
+ <li ><a href="#method-i-creator-3D">#creator=</a>
99
+ <li ><a href="#method-i-date1904">#date1904</a>
100
+ <li ><a href="#method-i-date1904-3D">#date1904=</a>
99
101
  <li ><a href="#method-i-date_to_num">#date_to_num</a>
100
-
102
+ <li ><a href="#method-i-modified_at">#modified_at</a>
103
+ <li ><a href="#method-i-modified_at-3D">#modified_at=</a>
104
+ <li ><a href="#method-i-modifier">#modifier</a>
105
+ <li ><a href="#method-i-modifier-3D">#modifier=</a>
101
106
  <li ><a href="#method-i-num_to_date">#num_to_date</a>
102
-
103
107
  <li ><a href="#method-i-related_objects">#related_objects</a>
104
-
105
108
  <li ><a href="#method-i-save">#save</a>
106
-
107
109
  <li ><a href="#method-i-stream">#stream</a>
108
-
109
110
  <li ><a href="#method-i-write">#write</a>
110
-
111
111
  <li ><a href="#method-i-xlsx_path">#xlsx_path</a>
112
-
113
112
  </ul>
114
113
  </div>
115
114
 
@@ -123,84 +122,62 @@
123
122
 
124
123
  <section class="description">
125
124
 
126
- <p><a
127
- href="http://www.datypic.com/sc/ooxml/e-ssml_workbook.html">www.datypic.com/sc/ooxml/e-ssml_workbook.html</a></p>
125
+ <p><a href="http://www.datypic.com/sc/ooxml/e-ssml_workbook.html">www.datypic.com/sc/ooxml/e-ssml_workbook.html</a></p>
128
126
 
129
127
  </section>
130
128
 
131
-
132
-
133
-
134
129
  <section id="5Buntitled-5D" class="documentation-section">
135
-
136
130
 
137
-
138
131
 
139
-
140
132
  <section class="constants-list">
141
133
  <header>
142
134
  <h3>Constants</h3>
143
135
  </header>
144
136
  <dl>
145
-
146
137
  <dt id="APPLICATION">APPLICATION
147
-
148
138
  <dd>
149
-
150
-
151
139
  <dt id="APPVERSION">APPVERSION
152
-
153
140
  <dd>
154
-
155
-
156
141
  <dt id="CONTENT_TYPE">CONTENT_TYPE
157
-
158
142
  <dd>
159
-
160
-
143
+ <dt id="CONTENT_TYPE_TEMPLATE">CONTENT_TYPE_TEMPLATE
144
+ <dd>
145
+ <dt id="CONTENT_TYPE_TEMPLATE_WITH_MACROS">CONTENT_TYPE_TEMPLATE_WITH_MACROS
146
+ <dd>
161
147
  <dt id="CONTENT_TYPE_WITH_MACROS">CONTENT_TYPE_WITH_MACROS
162
-
163
148
  <dd>
164
-
165
-
166
149
  <dt id="DATE1899">DATE1899
167
-
168
- <dd><p>Subtracting one day to accomodate for erroneous 1900 leap year
169
- compatibility only for 1900 based dates</p>
170
-
171
-
150
+ <dd><p>Subtracting one day to accommodate for erroneous 1900 leap year compatibility only for 1900 based dates</p>
172
151
  <dt id="DATE1904">DATE1904
173
-
174
152
  <dd>
175
-
176
-
177
153
  <dt id="MARCH_1_1900">MARCH_1_1900
178
-
179
154
  <dd>
180
-
181
-
182
155
  <dt id="REL_TYPE">REL_TYPE
183
-
184
156
  <dd>
185
-
186
-
187
157
  <dt id="SHEET_NAME_FORBIDDEN_CHARS">SHEET_NAME_FORBIDDEN_CHARS
188
-
189
- <dd><p><a
190
- href="http://www.accountingweb.com/technology/excel/seven-characters-you-cant-use-in-worksheet-names">www.accountingweb.com/technology/excel/seven-characters-you-cant-use-in-worksheet-names</a></p>
191
-
192
-
158
+ <dd><p><a href="http://www.accountingweb.com/technology/excel/seven-characters-you-cant-use-in-worksheet-names">www.accountingweb.com/technology/excel/seven-characters-you-cant-use-in-worksheet-names</a></p>
159
+ <dt id="SHEET_NAME_FORBIDDEN_NAMES">SHEET_NAME_FORBIDDEN_NAMES
160
+ <dd><p><a href="https://answers.microsoft.com/en-us/msoffice/forum/all/excel-history-is-a-reserved-name-help/f8a398a4-b72c-48e3-82da-4f132c305e91">answers.microsoft.com/en-us/msoffice/forum/all/excel-history-is-a-reserved-name-help/f8a398a4-b72c-48e3-82da-4f132c305e91</a></p>
161
+ <dt id="SHEET_NAME_TEMPLATE">SHEET_NAME_TEMPLATE
162
+ <dd>
193
163
  </dl>
194
164
  </section>
195
-
196
165
 
197
-
198
166
  <section class="attribute-method-details" class="method-section">
199
167
  <header>
200
168
  <h3>Attributes</h3>
201
169
  </header>
202
170
 
203
-
171
+ <div id="attribute-i-is_template" class="method-detail">
172
+ <div class="method-heading attribute-method-heading">
173
+ <span class="method-name">is_template</span><span
174
+ class="attribute-access-type">[RW]</span>
175
+ </div>
176
+
177
+ <div class="method-description">
178
+
179
+ </div>
180
+ </div>
204
181
  <div id="attribute-i-worksheets" class="method-detail">
205
182
  <div class="method-heading attribute-method-heading">
206
183
  <span class="method-name">worksheets</span><span
@@ -209,48 +186,37 @@ href="http://www.accountingweb.com/technology/excel/seven-characters-you-cant-us
209
186
 
210
187
  <div class="method-description">
211
188
 
212
-
213
-
214
189
  </div>
215
190
  </div>
216
-
217
191
  </section>
218
-
219
192
 
220
-
193
+
221
194
  <section id="public-class-5Buntitled-5D-method-details" class="method-section">
222
195
  <header>
223
196
  <h3>Public Class Methods</h3>
224
197
  </header>
225
198
 
226
-
227
199
  <div id="method-c-new" class="method-detail ">
228
-
229
- <div class="method-heading">
230
- <span class="method-name">new</span><span
231
- class="method-args">(worksheets = [], src_file_path = nil, creator = nil, modifier = nil, created_at = nil, company = '', application = APPLICATION, appversion = APPVERSION, date1904 = 0)</span>
232
-
233
- <span class="method-click-advice">click to toggle source</span>
234
-
200
+ <div class="method-header">
201
+ <div class="method-heading">
202
+ <span class="method-name">new</span><span
203
+ class="method-args">(worksheets = [], src_file_path = nil, creator = nil, modifier = nil, created_at = nil, company = &#39;&#39;, application = APPLICATION, appversion = APPVERSION, date1904 = 0, is_template = false)</span>
204
+ <span class="method-click-advice">click to toggle source</span>
205
+ </div>
235
206
  </div>
236
-
237
207
 
238
208
  <div class="method-description">
239
209
 
240
-
241
-
242
-
243
210
  <div class="method-calls-super">
244
211
  Calls superclass method
245
- <a href="OOXMLObjectInstanceMethods.html#method-c-new">RubyXL::OOXMLObjectInstanceMethods.new</a>
212
+ <a href="OOXMLObjectInstanceMethods.html#method-c-new"><code>RubyXL::OOXMLObjectInstanceMethods::new</code></a>
246
213
  </div>
247
-
248
214
 
249
-
250
215
  <div class="method-source-code" id="new-source">
251
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 433</span>
252
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">worksheets</span> = [], <span class="ruby-identifier">src_file_path</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">creator</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">modifier</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">created_at</span> = <span class="ruby-keyword">nil</span>,
253
- <span class="ruby-identifier">company</span> = <span class="ruby-string">&#39;&#39;</span>, <span class="ruby-identifier">application</span> = <span class="ruby-constant">APPLICATION</span>, <span class="ruby-identifier">appversion</span> = <span class="ruby-constant">APPVERSION</span>, <span class="ruby-identifier">date1904</span> = <span class="ruby-value">0</span>)
216
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 447</span>
217
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">worksheets</span> = [], <span class="ruby-identifier">src_file_path</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">creator</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">modifier</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">created_at</span> = <span class="ruby-keyword">nil</span>,
218
+ <span class="ruby-identifier">company</span> = <span class="ruby-string">&#39;&#39;</span>, <span class="ruby-identifier">application</span> = <span class="ruby-constant">APPLICATION</span>, <span class="ruby-identifier">appversion</span> = <span class="ruby-constant">APPVERSION</span>, <span class="ruby-identifier">date1904</span> = <span class="ruby-value">0</span>,
219
+ <span class="ruby-identifier">is_template</span> = <span class="ruby-keyword">false</span>)
254
220
  <span class="ruby-keyword">super</span>()
255
221
 
256
222
  <span class="ruby-comment"># Order of sheets in the +worksheets+ array corresponds to the order of pages in Excel UI.</span>
@@ -275,46 +241,191 @@ href="http://www.accountingweb.com/technology/excel/seven-characters-you-cant-us
275
241
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">creator</span> = <span class="ruby-identifier">creator</span>
276
242
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">modifier</span> = <span class="ruby-identifier">modifier</span>
277
243
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">date1904</span> = <span class="ruby-identifier">date1904</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
244
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_template</span> = <span class="ruby-identifier">is_template</span>
278
245
  <span class="ruby-keyword">end</span></pre>
279
246
  </div>
280
-
281
247
  </div>
282
248
 
283
-
284
249
 
285
-
286
250
  </div>
287
251
 
288
-
289
252
  </section>
290
-
253
+
291
254
  <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
292
255
  <header>
293
256
  <h3>Public Instance Methods</h3>
294
257
  </header>
295
258
 
296
-
297
- <div id="method-i-before_write_xml" class="method-detail ">
298
-
299
- <div class="method-heading">
300
- <span class="method-name">before_write_xml</span><span
301
- class="method-args">()</span>
302
-
303
- <span class="method-click-advice">click to toggle source</span>
304
-
259
+ <div id="method-i-5B-5D" class="method-detail ">
260
+ <div class="method-header">
261
+ <div class="method-heading">
262
+ <span class="method-name">[]</span><span
263
+ class="method-args">(ind)</span>
264
+ <span class="method-click-advice">click to toggle source</span>
265
+ </div>
266
+ </div>
267
+
268
+ <div class="method-description">
269
+ <p>Finds worksheet by its name or numerical index</p>
270
+
271
+ <div class="method-source-code" id="5B-5D-source">
272
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 480</span>
273
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">ind</span>)
274
+ <span class="ruby-keyword">case</span> <span class="ruby-identifier">ind</span>
275
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">Integer</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">worksheets</span>[<span class="ruby-identifier">ind</span>]
276
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">String</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">worksheets</span>.<span class="ruby-identifier">find</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">ws</span><span class="ruby-operator">|</span> <span class="ruby-identifier">ws</span>.<span class="ruby-identifier">sheet_name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">ind</span> }
277
+ <span class="ruby-keyword">end</span>
278
+ <span class="ruby-keyword">end</span></pre>
279
+ </div>
280
+ </div>
281
+
282
+
283
+ </div>
284
+
285
+ <div id="method-i-add_worksheet" class="method-detail ">
286
+ <div class="method-header">
287
+ <div class="method-heading">
288
+ <span class="method-name">add_worksheet</span><span
289
+ class="method-args">(name = nil)</span>
290
+ <span class="method-click-advice">click to toggle source</span>
291
+ </div>
292
+ </div>
293
+
294
+ <div class="method-description">
295
+ <p>Create new simple worksheet and add it to the workbook worksheets</p>
296
+
297
+ <p>@param [String] The name for the new worksheet</p>
298
+
299
+ <div class="method-source-code" id="add_worksheet-source">
300
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 490</span>
301
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_worksheet</span>(<span class="ruby-identifier">name</span> = <span class="ruby-keyword">nil</span>)
302
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">then</span>
303
+ <span class="ruby-identifier">n</span> = <span class="ruby-value">0</span>
304
+
305
+ <span class="ruby-keyword">begin</span>
306
+ <span class="ruby-identifier">name</span> = <span class="ruby-constant">SHEET_NAME_TEMPLATE</span> <span class="ruby-operator">%</span> (<span class="ruby-identifier">n</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>)
307
+ <span class="ruby-keyword">end</span> <span class="ruby-keyword">until</span> <span class="ruby-keyword">self</span>[<span class="ruby-identifier">name</span>].<span class="ruby-identifier">nil?</span>
308
+ <span class="ruby-keyword">end</span>
309
+
310
+ <span class="ruby-identifier">new_worksheet</span> = <span class="ruby-constant">Worksheet</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:workbook</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">self</span>, <span class="ruby-value">:sheet_name</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">name</span>)
311
+ <span class="ruby-identifier">worksheets</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">new_worksheet</span>
312
+ <span class="ruby-identifier">new_worksheet</span>
313
+ <span class="ruby-keyword">end</span></pre>
314
+ </div>
315
+ </div>
316
+
317
+
318
+ </div>
319
+
320
+ <div id="method-i-application" class="method-detail ">
321
+ <div class="method-header">
322
+ <div class="method-heading">
323
+ <span class="method-name">application</span><span
324
+ class="method-args">()</span>
325
+ <span class="method-click-advice">click to toggle source</span>
326
+ </div>
305
327
  </div>
306
-
307
328
 
308
329
  <div class="method-description">
309
330
 
331
+
332
+ <div class="method-source-code" id="application-source">
333
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 529</span>
334
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">application</span>
335
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">document_properties</span>.<span class="ruby-identifier">application</span>&amp;.<span class="ruby-identifier">value</span>
336
+ <span class="ruby-keyword">end</span></pre>
337
+ </div>
338
+ </div>
339
+
340
+
341
+ </div>
342
+
343
+ <div id="method-i-application-3D" class="method-detail ">
344
+ <div class="method-header">
345
+ <div class="method-heading">
346
+ <span class="method-name">application=</span><span
347
+ class="method-args">(v)</span>
348
+ <span class="method-click-advice">click to toggle source</span>
349
+ </div>
350
+ </div>
351
+
352
+ <div class="method-description">
310
353
 
354
+
355
+ <div class="method-source-code" id="application-3D-source">
356
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 533</span>
357
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">application=</span>(<span class="ruby-identifier">v</span>)
358
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">document_properties</span>.<span class="ruby-identifier">application</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">StringNode</span>.<span class="ruby-identifier">new</span>
359
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">document_properties</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">value</span> = <span class="ruby-identifier">v</span>
360
+ <span class="ruby-keyword">end</span></pre>
361
+ </div>
362
+ </div>
363
+
364
+
365
+ </div>
366
+
367
+ <div id="method-i-appversion" class="method-detail ">
368
+ <div class="method-header">
369
+ <div class="method-heading">
370
+ <span class="method-name">appversion</span><span
371
+ class="method-args">()</span>
372
+ <span class="method-click-advice">click to toggle source</span>
373
+ </div>
374
+ </div>
375
+
376
+ <div class="method-description">
311
377
 
378
+
379
+ <div class="method-source-code" id="appversion-source">
380
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 538</span>
381
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">appversion</span>
382
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">document_properties</span>.<span class="ruby-identifier">app_version</span>&amp;.<span class="ruby-identifier">value</span>
383
+ <span class="ruby-keyword">end</span></pre>
384
+ </div>
385
+ </div>
386
+
387
+
388
+ </div>
389
+
390
+ <div id="method-i-appversion-3D" class="method-detail ">
391
+ <div class="method-header">
392
+ <div class="method-heading">
393
+ <span class="method-name">appversion=</span><span
394
+ class="method-args">(v)</span>
395
+ <span class="method-click-advice">click to toggle source</span>
396
+ </div>
397
+ </div>
398
+
399
+ <div class="method-description">
312
400
 
313
401
 
402
+ <div class="method-source-code" id="appversion-3D-source">
403
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 542</span>
404
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">appversion=</span>(<span class="ruby-identifier">v</span>)
405
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">document_properties</span>.<span class="ruby-identifier">app_version</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">StringNode</span>.<span class="ruby-identifier">new</span>
406
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">document_properties</span>.<span class="ruby-identifier">app_version</span>.<span class="ruby-identifier">value</span> = <span class="ruby-identifier">v</span>
407
+ <span class="ruby-keyword">end</span></pre>
408
+ </div>
409
+ </div>
410
+
411
+
412
+ </div>
413
+
414
+ <div id="method-i-before_write_xml" class="method-detail ">
415
+ <div class="method-header">
416
+ <div class="method-heading">
417
+ <span class="method-name">before_write_xml</span><span
418
+ class="method-args">()</span>
419
+ <span class="method-click-advice">click to toggle source</span>
420
+ </div>
421
+ </div>
422
+
423
+ <div class="method-description">
314
424
 
425
+
315
426
  <div class="method-source-code" id="before_write_xml-source">
316
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 362</span>
317
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">before_write_xml</span>
427
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 369</span>
428
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">before_write_xml</span>
318
429
  <span class="ruby-identifier">max_sheet_id</span> = <span class="ruby-identifier">worksheets</span>.<span class="ruby-identifier">collect</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:sheet_id</span>).<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">max</span> <span class="ruby-operator">||</span> <span class="ruby-value">0</span>
319
430
 
320
431
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">sheets</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Sheets</span>.<span class="ruby-identifier">new</span>
@@ -323,311 +434,515 @@ href="http://www.accountingweb.com/technology/excel/seven-characters-you-cant-us
323
434
  <span class="ruby-identifier">rel</span> = <span class="ruby-identifier">relationship_container</span>.<span class="ruby-identifier">find_by_target</span>(<span class="ruby-identifier">sheet</span>.<span class="ruby-identifier">xlsx_path</span>)
324
435
 
325
436
  <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Worksheet name &#39;#{sheet.sheet_name}&#39; contains forbidden characters&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">sheet</span>.<span class="ruby-identifier">sheet_name</span> <span class="ruby-operator">=~</span> <span class="ruby-constant">SHEET_NAME_FORBIDDEN_CHARS</span>
437
+ <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Worksheet name &#39;#{sheet.sheet_name}&#39; is forbidden&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">SHEET_NAME_FORBIDDEN_NAMES</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">sheet</span>.<span class="ruby-identifier">sheet_name</span>)
326
438
 
327
- <span class="ruby-identifier">sheets</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Sheet</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">sheet</span>.<span class="ruby-identifier">sheet_name</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">30</span>], <span class="ruby-comment"># Max sheet name length is 31 char</span>
328
- <span class="ruby-value">:sheet_id</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">sheet</span>.<span class="ruby-identifier">sheet_id</span> <span class="ruby-operator">||</span> (<span class="ruby-identifier">max_sheet_id</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>),
329
- <span class="ruby-value">:state</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">sheet</span>.<span class="ruby-identifier">state</span>,
330
- <span class="ruby-value">:r_id</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">rel</span>.<span class="ruby-identifier">id</span>)
439
+ <span class="ruby-identifier">sheets</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Sheet</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:name</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">sheet</span>.<span class="ruby-identifier">sheet_name</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">30</span>], <span class="ruby-comment"># Max sheet name length is 31 char</span>
440
+ <span class="ruby-value">:sheet_id</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">sheet</span>.<span class="ruby-identifier">sheet_id</span> <span class="ruby-operator">||</span> (<span class="ruby-identifier">max_sheet_id</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>),
441
+ <span class="ruby-value">:state</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">sheet</span>.<span class="ruby-identifier">state</span>,
442
+ <span class="ruby-value">:r_id</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">rel</span>.<span class="ruby-identifier">id</span>)
331
443
  }
332
444
 
333
445
  <span class="ruby-keyword">true</span>
334
446
  <span class="ruby-keyword">end</span></pre>
335
447
  </div>
336
-
337
448
  </div>
338
449
 
339
-
340
450
 
341
-
342
451
  </div>
343
452
 
344
-
345
- <div id="method-i-content_type" class="method-detail ">
346
-
347
- <div class="method-heading">
348
- <span class="method-name">content_type</span><span
349
- class="method-args">()</span>
350
-
351
- <span class="method-click-advice">click to toggle source</span>
352
-
453
+ <div id="method-i-company" class="method-detail ">
454
+ <div class="method-header">
455
+ <div class="method-heading">
456
+ <span class="method-name">company</span><span
457
+ class="method-args">()</span>
458
+ <span class="method-click-advice">click to toggle source</span>
459
+ </div>
353
460
  </div>
354
-
355
461
 
356
462
  <div class="method-description">
357
463
 
464
+
465
+ <div class="method-source-code" id="company-source">
466
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 520</span>
467
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">company</span>
468
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">document_properties</span>.<span class="ruby-identifier">company</span>&amp;.<span class="ruby-identifier">value</span>
469
+ <span class="ruby-keyword">end</span></pre>
470
+ </div>
471
+ </div>
472
+
473
+
474
+ </div>
475
+
476
+ <div id="method-i-company-3D" class="method-detail ">
477
+ <div class="method-header">
478
+ <div class="method-heading">
479
+ <span class="method-name">company=</span><span
480
+ class="method-args">(v)</span>
481
+ <span class="method-click-advice">click to toggle source</span>
482
+ </div>
483
+ </div>
484
+
485
+ <div class="method-description">
358
486
 
359
-
360
-
361
487
 
488
+ <div class="method-source-code" id="company-3D-source">
489
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 524</span>
490
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">company=</span>(<span class="ruby-identifier">v</span>)
491
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">document_properties</span>.<span class="ruby-identifier">company</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">StringNode</span>.<span class="ruby-identifier">new</span>
492
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">document_properties</span>.<span class="ruby-identifier">company</span>.<span class="ruby-identifier">value</span> = <span class="ruby-identifier">v</span>
493
+ <span class="ruby-keyword">end</span></pre>
494
+ </div>
495
+ </div>
496
+
497
+
498
+ </div>
499
+
500
+ <div id="method-i-content_type" class="method-detail ">
501
+ <div class="method-header">
502
+ <div class="method-heading">
503
+ <span class="method-name">content_type</span><span
504
+ class="method-args">()</span>
505
+ <span class="method-click-advice">click to toggle source</span>
506
+ </div>
507
+ </div>
508
+
509
+ <div class="method-description">
362
510
 
511
+
363
512
  <div class="method-source-code" id="content_type-source">
364
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 311</span>
365
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">content_type</span>
366
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">macros</span> <span class="ruby-keyword">then</span> <span class="ruby-constant">CONTENT_TYPE_WITH_MACROS</span> <span class="ruby-keyword">else</span> <span class="ruby-constant">CONTENT_TYPE</span> <span class="ruby-keyword">end</span>
513
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 313</span>
514
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">content_type</span>
515
+ <span class="ruby-identifier">content_type_name</span> = <span class="ruby-string">&#39;CONTENT_TYPE&#39;</span>
516
+ <span class="ruby-identifier">content_type_name</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&#39;_TEMPLATE&#39;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">is_template</span>
517
+ <span class="ruby-identifier">content_type_name</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&#39;_WITH_MACROS&#39;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">macros</span>
518
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">content_type_name</span>)
367
519
  <span class="ruby-keyword">end</span></pre>
368
520
  </div>
369
-
370
521
  </div>
371
522
 
372
-
373
523
 
374
-
375
524
  </div>
376
525
 
377
-
378
- <div id="method-i-date_to_num" class="method-detail ">
379
-
380
- <div class="method-heading">
381
- <span class="method-name">date_to_num</span><span
382
- class="method-args">(date)</span>
526
+ <div id="method-i-created_at" class="method-detail ">
527
+ <div class="method-header">
528
+ <div class="method-heading">
529
+ <span class="method-name">created_at</span><span
530
+ class="method-args">()</span>
531
+ <span class="method-click-advice">click to toggle source</span>
532
+ </div>
533
+ </div>
534
+
535
+ <div class="method-description">
383
536
 
384
- <span class="method-click-advice">click to toggle source</span>
537
+
538
+ <div class="method-source-code" id="created_at-source">
539
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 504</span>
540
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">created_at</span>
541
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">core_properties</span>.<span class="ruby-identifier">created_at</span>
542
+ <span class="ruby-keyword">end</span></pre>
543
+ </div>
544
+ </div>
545
+
546
+
547
+ </div>
548
+
549
+ <div id="method-i-created_at-3D" class="method-detail ">
550
+ <div class="method-header">
551
+ <div class="method-heading">
552
+ <span class="method-name">created_at=</span><span
553
+ class="method-args">(v)</span>
554
+ <span class="method-click-advice">click to toggle source</span>
555
+ </div>
556
+ </div>
557
+
558
+ <div class="method-description">
385
559
 
560
+
561
+ <div class="method-source-code" id="created_at-3D-source">
562
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 508</span>
563
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">created_at=</span>(<span class="ruby-identifier">v</span>)
564
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">core_properties</span>.<span class="ruby-identifier">created_at</span> = <span class="ruby-identifier">v</span>
565
+ <span class="ruby-keyword">end</span></pre>
566
+ </div>
567
+ </div>
568
+
569
+
570
+ </div>
571
+
572
+ <div id="method-i-creator" class="method-detail ">
573
+ <div class="method-header">
574
+ <div class="method-heading">
575
+ <span class="method-name">creator</span><span
576
+ class="method-args">()</span>
577
+ <span class="method-click-advice">click to toggle source</span>
578
+ </div>
386
579
  </div>
387
-
388
580
 
389
581
  <div class="method-description">
390
582
 
583
+
584
+ <div class="method-source-code" id="creator-source">
585
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 547</span>
586
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">creator</span>
587
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">core_properties</span>.<span class="ruby-identifier">creator</span>
588
+ <span class="ruby-keyword">end</span></pre>
589
+ </div>
590
+ </div>
591
+
592
+
593
+ </div>
594
+
595
+ <div id="method-i-creator-3D" class="method-detail ">
596
+ <div class="method-header">
597
+ <div class="method-heading">
598
+ <span class="method-name">creator=</span><span
599
+ class="method-args">(v)</span>
600
+ <span class="method-click-advice">click to toggle source</span>
601
+ </div>
602
+ </div>
603
+
604
+ <div class="method-description">
391
605
 
606
+
607
+ <div class="method-source-code" id="creator-3D-source">
608
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 551</span>
609
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">creator=</span>(<span class="ruby-identifier">v</span>)
610
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">core_properties</span>.<span class="ruby-identifier">creator</span> = <span class="ruby-identifier">v</span>
611
+ <span class="ruby-keyword">end</span></pre>
612
+ </div>
613
+ </div>
614
+
615
+
616
+ </div>
617
+
618
+ <div id="method-i-date1904" class="method-detail ">
619
+ <div class="method-header">
620
+ <div class="method-heading">
621
+ <span class="method-name">date1904</span><span
622
+ class="method-args">()</span>
623
+ <span class="method-click-advice">click to toggle source</span>
624
+ </div>
625
+ </div>
626
+
627
+ <div class="method-description">
392
628
 
629
+
630
+ <div class="method-source-code" id="date1904-source">
631
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 563</span>
632
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">date1904</span>
633
+ <span class="ruby-identifier">workbook_properties</span>&amp;.<span class="ruby-identifier">date1904</span>
634
+ <span class="ruby-keyword">end</span></pre>
635
+ </div>
636
+ </div>
637
+
638
+
639
+ </div>
640
+
641
+ <div id="method-i-date1904-3D" class="method-detail ">
642
+ <div class="method-header">
643
+ <div class="method-heading">
644
+ <span class="method-name">date1904=</span><span
645
+ class="method-args">(v)</span>
646
+ <span class="method-click-advice">click to toggle source</span>
647
+ </div>
648
+ </div>
649
+
650
+ <div class="method-description">
393
651
 
394
652
 
653
+ <div class="method-source-code" id="date1904-3D-source">
654
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 567</span>
655
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">date1904=</span>(<span class="ruby-identifier">v</span>)
656
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">workbook_properties</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">WorkbookProperties</span>.<span class="ruby-identifier">new</span>
657
+ <span class="ruby-identifier">workbook_properties</span>.<span class="ruby-identifier">date1904</span> = <span class="ruby-identifier">v</span>
658
+ <span class="ruby-keyword">end</span></pre>
659
+ </div>
660
+ </div>
661
+
662
+
663
+ </div>
664
+
665
+ <div id="method-i-date_to_num" class="method-detail ">
666
+ <div class="method-header">
667
+ <div class="method-heading">
668
+ <span class="method-name">date_to_num</span><span
669
+ class="method-args">(date)</span>
670
+ <span class="method-click-advice">click to toggle source</span>
671
+ </div>
672
+ </div>
673
+
674
+ <div class="method-description">
395
675
 
676
+
396
677
  <div class="method-source-code" id="date_to_num-source">
397
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 415</span>
398
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">date_to_num</span>(<span class="ruby-identifier">date</span>)
399
- <span class="ruby-identifier">date</span> <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">date</span>.<span class="ruby-identifier">ajd</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">base_date</span>().<span class="ruby-identifier">ajd</span>).<span class="ruby-identifier">to_f</span>
678
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 423</span>
679
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">date_to_num</span>(<span class="ruby-identifier">date</span>)
680
+ <span class="ruby-keyword">case</span> <span class="ruby-identifier">date</span>
681
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">Date</span>, <span class="ruby-constant">DateTime</span> <span class="ruby-keyword">then</span> (<span class="ruby-identifier">date</span>.<span class="ruby-identifier">ajd</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">base_date</span>.<span class="ruby-identifier">ajd</span>).<span class="ruby-identifier">to_f</span>
682
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">Time</span> <span class="ruby-keyword">then</span> ((<span class="ruby-identifier">date</span>.<span class="ruby-identifier">to_r</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">base_date</span>.<span class="ruby-identifier">to_time</span>.<span class="ruby-identifier">to_r</span>) <span class="ruby-operator">/</span> <span class="ruby-value">86400</span>).<span class="ruby-identifier">to_f</span>
683
+ <span class="ruby-keyword">end</span>
400
684
  <span class="ruby-keyword">end</span></pre>
401
685
  </div>
402
-
403
686
  </div>
404
687
 
405
-
406
688
 
407
-
408
689
  </div>
409
690
 
410
-
411
- <div id="method-i-num_to_date" class="method-detail ">
412
-
413
- <div class="method-heading">
414
- <span class="method-name">num_to_date</span><span
415
- class="method-args">(num)</span>
416
-
417
- <span class="method-click-advice">click to toggle source</span>
418
-
691
+ <div id="method-i-modified_at" class="method-detail ">
692
+ <div class="method-header">
693
+ <div class="method-heading">
694
+ <span class="method-name">modified_at</span><span
695
+ class="method-args">()</span>
696
+ <span class="method-click-advice">click to toggle source</span>
697
+ </div>
419
698
  </div>
420
-
421
699
 
422
700
  <div class="method-description">
423
701
 
702
+
703
+ <div class="method-source-code" id="modified_at-source">
704
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 512</span>
705
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">modified_at</span>
706
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">core_properties</span>.<span class="ruby-identifier">modified_at</span>
707
+ <span class="ruby-keyword">end</span></pre>
708
+ </div>
709
+ </div>
710
+
711
+
712
+ </div>
713
+
714
+ <div id="method-i-modified_at-3D" class="method-detail ">
715
+ <div class="method-header">
716
+ <div class="method-heading">
717
+ <span class="method-name">modified_at=</span><span
718
+ class="method-args">(v)</span>
719
+ <span class="method-click-advice">click to toggle source</span>
720
+ </div>
721
+ </div>
722
+
723
+ <div class="method-description">
424
724
 
725
+
726
+ <div class="method-source-code" id="modified_at-3D-source">
727
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 516</span>
728
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">modified_at=</span>(<span class="ruby-identifier">v</span>)
729
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">core_properties</span>.<span class="ruby-identifier">modified_at</span> = <span class="ruby-identifier">v</span>
730
+ <span class="ruby-keyword">end</span></pre>
731
+ </div>
732
+ </div>
733
+
734
+
735
+ </div>
736
+
737
+ <div id="method-i-modifier" class="method-detail ">
738
+ <div class="method-header">
739
+ <div class="method-heading">
740
+ <span class="method-name">modifier</span><span
741
+ class="method-args">()</span>
742
+ <span class="method-click-advice">click to toggle source</span>
743
+ </div>
744
+ </div>
745
+
746
+ <div class="method-description">
425
747
 
748
+
749
+ <div class="method-source-code" id="modifier-source">
750
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 555</span>
751
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">modifier</span>
752
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">core_properties</span>.<span class="ruby-identifier">modifier</span>
753
+ <span class="ruby-keyword">end</span></pre>
754
+ </div>
755
+ </div>
756
+
757
+
758
+ </div>
759
+
760
+ <div id="method-i-modifier-3D" class="method-detail ">
761
+ <div class="method-header">
762
+ <div class="method-heading">
763
+ <span class="method-name">modifier=</span><span
764
+ class="method-args">(v)</span>
765
+ <span class="method-click-advice">click to toggle source</span>
766
+ </div>
767
+ </div>
768
+
769
+ <div class="method-description">
426
770
 
427
771
 
772
+ <div class="method-source-code" id="modifier-3D-source">
773
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 559</span>
774
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">modifier=</span>(<span class="ruby-identifier">v</span>)
775
+ <span class="ruby-identifier">root</span>.<span class="ruby-identifier">core_properties</span>.<span class="ruby-identifier">modifier</span> = <span class="ruby-identifier">v</span>
776
+ <span class="ruby-keyword">end</span></pre>
777
+ </div>
778
+ </div>
779
+
780
+
781
+ </div>
782
+
783
+ <div id="method-i-num_to_date" class="method-detail ">
784
+ <div class="method-header">
785
+ <div class="method-heading">
786
+ <span class="method-name">num_to_date</span><span
787
+ class="method-args">(num)</span>
788
+ <span class="method-click-advice">click to toggle source</span>
789
+ </div>
790
+ </div>
791
+
792
+ <div class="method-description">
428
793
 
794
+
429
795
  <div class="method-source-code" id="num_to_date-source">
430
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 419</span>
431
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">num_to_date</span>(<span class="ruby-identifier">num</span>)
796
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 430</span>
797
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">num_to_date</span>(<span class="ruby-identifier">num</span>)
798
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">num</span>.<span class="ruby-identifier">nil?</span>
799
+
432
800
  <span class="ruby-comment"># Bug-for-bug Excel compatibility (https://support.microsoft.com/kb/214058/)</span>
433
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">num</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">num</span> <span class="ruby-operator">&lt;</span> <span class="ruby-constant">MARCH_1_1900</span> <span class="ruby-keyword">then</span>
434
- <span class="ruby-identifier">num</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">workbook_properties</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">workbook_properties</span>.<span class="ruby-identifier">date1904</span>
801
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">num</span> <span class="ruby-operator">&lt;</span> <span class="ruby-constant">MARCH_1_1900</span> <span class="ruby-keyword">then</span>
802
+ <span class="ruby-identifier">num</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">workbook_properties</span>&amp;.<span class="ruby-identifier">date1904</span>
435
803
  <span class="ruby-keyword">end</span>
436
804
 
437
- <span class="ruby-identifier">num</span> <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">base_date</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">num</span>)
805
+ <span class="ruby-identifier">dateparts</span> = <span class="ruby-identifier">num</span>.<span class="ruby-identifier">divmod</span>(<span class="ruby-value">1</span>)
806
+ <span class="ruby-identifier">base_date</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">dateparts</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">+</span> ((<span class="ruby-identifier">dateparts</span>[<span class="ruby-value">1</span>] <span class="ruby-operator">*</span> <span class="ruby-value">86400</span>).<span class="ruby-identifier">round</span>(<span class="ruby-value">6</span>) <span class="ruby-operator">/</span> <span class="ruby-value">86400</span>))
438
807
  <span class="ruby-keyword">end</span></pre>
439
808
  </div>
440
-
441
809
  </div>
442
810
 
443
-
444
811
 
445
-
446
812
  </div>
447
813
 
448
-
449
814
  <div id="method-i-related_objects" class="method-detail ">
450
-
451
- <div class="method-heading">
452
- <span class="method-name">related_objects</span><span
453
- class="method-args">()</span>
454
-
455
- <span class="method-click-advice">click to toggle source</span>
456
-
815
+ <div class="method-header">
816
+ <div class="method-heading">
817
+ <span class="method-name">related_objects</span><span
818
+ class="method-args">()</span>
819
+ <span class="method-click-advice">click to toggle source</span>
820
+ </div>
457
821
  </div>
458
-
459
822
 
460
823
  <div class="method-description">
461
824
 
462
-
463
-
464
-
465
825
 
466
-
467
826
  <div class="method-source-code" id="related_objects-source">
468
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 315</span>
469
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">related_objects</span>
827
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 320</span>
828
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">related_objects</span>
470
829
  [ <span class="ruby-identifier">calculation_chain</span>, <span class="ruby-identifier">stylesheet</span>, <span class="ruby-identifier">theme</span>, <span class="ruby-identifier">shared_strings_container</span>, <span class="ruby-identifier">macros</span> ] <span class="ruby-operator">+</span> <span class="ruby-ivar">@worksheets</span>
471
830
  <span class="ruby-keyword">end</span></pre>
472
831
  </div>
473
-
474
832
  </div>
475
833
 
476
-
477
834
 
478
-
479
835
  </div>
480
836
 
481
-
482
837
  <div id="method-i-save" class="method-detail ">
483
-
484
- <div class="method-heading">
485
- <span class="method-name">save</span><span
486
- class="method-args">(dst_file_path = nil)</span>
487
-
488
- <span class="method-click-advice">click to toggle source</span>
489
-
838
+ <div class="method-header">
839
+ <div class="method-heading">
840
+ <span class="method-name">save</span><span
841
+ class="method-args">(dst_file_path = nil)</span>
842
+ <span class="method-click-advice">click to toggle source</span>
843
+ </div>
490
844
  </div>
491
-
492
845
 
493
846
  <div class="method-description">
494
-
495
847
  <p>Save the resulting XLSX file to the specified location</p>
496
-
497
-
498
848
 
499
-
500
849
  <div class="method-source-code" id="save-source">
501
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 391</span>
502
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">save</span>(<span class="ruby-identifier">dst_file_path</span> = <span class="ruby-keyword">nil</span>)
850
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 399</span>
851
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">save</span>(<span class="ruby-identifier">dst_file_path</span> = <span class="ruby-keyword">nil</span>)
503
852
  <span class="ruby-identifier">dst_file_path</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">root</span>.<span class="ruby-identifier">source_file_path</span>
504
853
 
505
854
  <span class="ruby-identifier">extension</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">extname</span>(<span class="ruby-identifier">dst_file_path</span>)
506
- <span class="ruby-keyword">unless</span> <span class="ruby-node">%w{.xlsx .xlsm}</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">extension</span>.<span class="ruby-identifier">downcase</span>)
507
- <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Unsupported extension: #{extension} (only .xlsx and .xlsm files are supported).&quot;</span>
855
+ <span class="ruby-keyword">unless</span> <span class="ruby-node">%w{.xlsx .xlsm .xltx .xltm}</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">extension</span>.<span class="ruby-identifier">downcase</span>)
856
+ <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Unsupported extension: #{extension} (only .xlsx, .xlsm, .xltx and .xltm files are supported).&quot;</span>
508
857
  <span class="ruby-keyword">end</span>
509
858
 
510
- <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">dst_file_path</span>, <span class="ruby-string">&quot;wb&quot;</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">output_file</span><span class="ruby-operator">|</span> <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">copy_stream</span>(<span class="ruby-identifier">root</span>.<span class="ruby-identifier">stream</span>, <span class="ruby-identifier">output_file</span>) }
859
+ <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">dst_file_path</span>, <span class="ruby-string">&#39;wb&#39;</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">output_file</span><span class="ruby-operator">|</span> <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">copy_stream</span>(<span class="ruby-identifier">root</span>.<span class="ruby-identifier">stream</span>, <span class="ruby-identifier">output_file</span>) }
511
860
 
512
861
  <span class="ruby-keyword">return</span> <span class="ruby-identifier">dst_file_path</span>
513
862
  <span class="ruby-keyword">end</span></pre>
514
863
  </div>
515
-
516
864
  </div>
517
865
 
518
-
519
866
  <div class="aliases">
520
867
  Also aliased as: <a href="Workbook.html#method-i-write">write</a>
521
868
  </div>
522
-
523
869
 
524
-
525
870
  </div>
526
871
 
527
-
528
872
  <div id="method-i-stream" class="method-detail ">
529
-
530
- <div class="method-heading">
531
- <span class="method-name">stream</span><span
532
- class="method-args">()</span>
533
-
534
- <span class="method-click-advice">click to toggle source</span>
535
-
873
+ <div class="method-header">
874
+ <div class="method-heading">
875
+ <span class="method-name">stream</span><span
876
+ class="method-args">()</span>
877
+ <span class="method-click-advice">click to toggle source</span>
878
+ </div>
536
879
  </div>
537
-
538
880
 
539
881
  <div class="method-description">
540
-
541
882
  <p>Return the resulting XLSX file in a stream (useful for sending over HTTP)</p>
542
-
543
-
544
883
 
545
-
546
884
  <div class="method-source-code" id="stream-source">
547
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 386</span>
548
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">stream</span>
885
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 394</span>
886
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">stream</span>
549
887
  <span class="ruby-identifier">root</span>.<span class="ruby-identifier">stream</span>
550
888
  <span class="ruby-keyword">end</span></pre>
551
889
  </div>
552
-
553
890
  </div>
554
891
 
555
-
556
892
 
557
-
558
893
  </div>
559
894
 
560
-
561
895
  <div id="method-i-write" class="method-detail method-alias">
562
-
563
- <div class="method-heading">
564
- <span class="method-name">write</span><span
565
- class="method-args">(dst_file_path = nil)</span>
566
-
896
+ <div class="method-header">
897
+ <div class="method-heading">
898
+ <span class="method-name">write</span><span
899
+ class="method-args">(dst_file_path = nil)</span>
900
+ </div>
567
901
  </div>
568
-
569
902
 
570
903
  <div class="method-description">
571
904
 
572
-
573
-
574
-
575
905
 
576
-
577
906
  </div>
578
907
 
579
-
580
908
 
581
-
582
909
  <div class="aliases">
583
910
  Alias for: <a href="Workbook.html#method-i-save">save</a>
584
911
  </div>
585
-
586
912
  </div>
587
913
 
588
-
589
914
  <div id="method-i-xlsx_path" class="method-detail ">
590
-
591
- <div class="method-heading">
592
- <span class="method-name">xlsx_path</span><span
593
- class="method-args">()</span>
594
-
595
- <span class="method-click-advice">click to toggle source</span>
596
-
915
+ <div class="method-header">
916
+ <div class="method-heading">
917
+ <span class="method-name">xlsx_path</span><span
918
+ class="method-args">()</span>
919
+ <span class="method-click-advice">click to toggle source</span>
920
+ </div>
597
921
  </div>
598
-
599
922
 
600
923
  <div class="method-description">
601
924
 
602
-
603
-
604
-
605
925
 
606
-
607
926
  <div class="method-source-code" id="xlsx_path-source">
608
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 381</span>
609
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">xlsx_path</span>
927
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/workbook.rb, line 389</span>
928
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">xlsx_path</span>
610
929
  <span class="ruby-constant">ROOT</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39;xl&#39;</span>, <span class="ruby-string">&#39;workbook.xml&#39;</span>)
611
930
  <span class="ruby-keyword">end</span></pre>
612
931
  </div>
613
-
614
932
  </div>
615
933
 
616
-
617
934
 
618
-
619
935
  </div>
620
936
 
621
-
622
937
  </section>
623
-
938
+
624
939
  </section>
625
940
  </main>
626
941
 
627
942
 
628
943
  <footer id="validator-badges" role="contentinfo">
629
- <p><a href="http://validator.w3.org/check/referer">Validate</a>
630
- <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0.
944
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
945
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.3.1.
631
946
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
632
947
  </footer>
633
948